refactoring

Author: cyrille-leclerc

src/main/java/com/cloudbees/syslog/SyslogMessageFormat.java renamed to src/main/java/com/cloudbees/syslog/MessageFormat.java

@@ -20,7 +20,7 @@
  *
  * @author <a href="mailto:[email protected]">Cyrille Le Clerc</a>
  */
-public enum SyslogMessageFormat {
+public enum MessageFormat {
     /**
      * <a href="http://tools.ietf.org/html/rfc3164">RFC 3614 - BSD syslog Protocol</a>
      */

src/main/java/com/cloudbees/syslog/SyslogMessage.java

@@ -33,6 +33,8 @@
 
 /**
  * Syslog message as defined in <a href="https://tools.ietf.org/html/rfc5424">RFC 5424 - The Syslog Protocol</a>.
+ * <p/>
+ * Also compatible with <a href="http://tools.ietf.org/html/rfc3164">RFC-3164: The BSD syslog Protocol</a>,
  *
  * @author <a href="mailto:[email protected]">Cyrille Le Clerc</a>
  */
@@ -208,36 +210,36 @@ public SyslogMessage withMsg(final String msg) {
      * Generates a Syslog message complying to the <a href="http://tools.ietf.org/html/rfc5424">RFC-5424</a> format
      * or to the <a href="http://tools.ietf.org/html/rfc3164">RFC-3164</a> format.
      *
-     * @param syslogMessageFormat message format, not {@code null}
+     * @param messageFormat message format, not {@code null}
      */
-    public String toSyslogMessage(SyslogMessageFormat syslogMessageFormat) {
-        switch (syslogMessageFormat) {
+    public String toSyslogMessage(MessageFormat messageFormat) {
+        switch (messageFormat) {
             case RFC_3164:
                 return toRfc3164SyslogMessage();
             case RFC_5424:
                 return toRfc5424SyslogMessage();
             default:
-                throw new IllegalStateException("Unsupported message format '" + syslogMessageFormat + "'");
+                throw new IllegalStateException("Unsupported message format '" + messageFormat + "'");
         }
     }
 
     /**
      * Generates a Syslog message complying to the <a href="http://tools.ietf.org/html/rfc5424">RFC-5424</a> format
      * or to the <a href="http://tools.ietf.org/html/rfc3164">RFC-3164</a> format.
      *
-     * @param syslogMessageFormat message format
+     * @param messageFormat message format
      * @param out                 output {@linkplain Writer}
      */
-    public void toSyslogMessage(@Nonnull SyslogMessageFormat syslogMessageFormat, @Nonnull Writer out) throws IOException {
-        switch (syslogMessageFormat) {
+    public void toSyslogMessage(@Nonnull MessageFormat messageFormat, @Nonnull Writer out) throws IOException {
+        switch (messageFormat) {
             case RFC_3164:
                 toRfc3164SyslogMessage(out);
                 break;
             case RFC_5424:
                 toRfc5424SyslogMessage(out);
                 break;
             default:
-                throw new IllegalStateException("Unsupported message format '" + syslogMessageFormat + "'");
+                throw new IllegalStateException("Unsupported message format '" + messageFormat + "'");
         }
     }
 

src/main/java/com/cloudbees/syslog/sender/AbstractSyslogMessageSender.java

@@ -3,13 +3,11 @@
 import com.cloudbees.syslog.Facility;
 import com.cloudbees.syslog.Severity;
 import com.cloudbees.syslog.SyslogMessage;
-import com.cloudbees.syslog.SyslogMessageFormat;
-import com.cloudbees.syslog.util.CachingReference;
+import com.cloudbees.syslog.MessageFormat;
 
 import javax.annotation.Nonnull;
 import java.io.CharArrayWriter;
 import java.io.IOException;
-import java.net.InetAddress;
 import java.nio.charset.Charset;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -30,10 +28,10 @@ public abstract class AbstractSyslogMessageSender implements SyslogMessageSender
     // remote syslog server config
     /**
      * Format of messages accepted by the remote syslog server
-     * ({@link com.cloudbees.syslog.SyslogMessageFormat#RFC_3164 RFC_3164} or
-     * {@link com.cloudbees.syslog.SyslogMessageFormat#RFC_5424 RFC_5424})
+     * ({@link com.cloudbees.syslog.MessageFormat#RFC_3164 RFC_3164} or
+     * {@link com.cloudbees.syslog.MessageFormat#RFC_5424 RFC_5424})
      */
-    protected SyslogMessageFormat messageFormat = DEFAULT_SYSLOG_MESSAGE_FORMAT;
+    protected MessageFormat messageFormat = DEFAULT_SYSLOG_MESSAGE_FORMAT;
     // statistics
     protected final AtomicInteger sendCounter = new AtomicInteger();
     protected final AtomicLong sendDurationInNanosCounter = new AtomicLong();
@@ -81,7 +79,7 @@ public Facility getDefaultFacility() {
         return defaultFacility;
     }
 
-    public SyslogMessageFormat getMessageFormat() {
+    public MessageFormat getMessageFormat() {
         return messageFormat;
     }
 
@@ -131,8 +129,8 @@ public void setDefaultFacility(Facility defaultFacility) {
         this.defaultFacility = defaultFacility;
     }
 
-    public void setMessageFormat(SyslogMessageFormat syslogMessageFormat) {
-        this.messageFormat = syslogMessageFormat;
+    public void setMessageFormat(MessageFormat messageFormat) {
+        this.messageFormat = messageFormat;
     }
 
     public void setDefaultSeverity(Severity defaultSeverity) {

src/main/java/com/cloudbees/syslog/sender/SyslogMessageSender.java

@@ -16,7 +16,7 @@
 package com.cloudbees.syslog.sender;
 
 import com.cloudbees.syslog.SyslogMessage;
-import com.cloudbees.syslog.SyslogMessageFormat;
+import com.cloudbees.syslog.MessageFormat;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
@@ -31,7 +31,7 @@ public interface SyslogMessageSender {
     public static final long DEFAULT_INET_ADDRESS_TTL_IN_MILLIS = TimeUnit.MILLISECONDS.convert(30, TimeUnit.SECONDS);
     public static final long DEFAULT_INET_ADDRESS_TTL_IN_NANOS = TimeUnit.NANOSECONDS.convert(DEFAULT_INET_ADDRESS_TTL_IN_MILLIS, TimeUnit.MILLISECONDS);
     public static final String DEFAULT_SYSLOG_HOST = "localhost";
-    public static final SyslogMessageFormat DEFAULT_SYSLOG_MESSAGE_FORMAT = SyslogMessageFormat.RFC_3164;
+    public static final MessageFormat DEFAULT_SYSLOG_MESSAGE_FORMAT = MessageFormat.RFC_3164;
     public static final int DEFAULT_SYSLOG_PORT = 514;
 
     /**