You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by gg...@apache.org on 2014/10/04 01:08:03 UTC

git commit: Specify scale (millis in this case) in attribute name and add alias for backward compatibility.

Repository: logging-log4j2
Updated Branches:
  refs/heads/master f6bd93ce9 -> 8fde30c71


Specify scale (millis in this case) in attribute name and add alias for
backward compatibility.

Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/8fde30c7
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/8fde30c7
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/8fde30c7

Branch: refs/heads/master
Commit: 8fde30c71a7d4d03a41b5efbfb9b7a2114e7012b
Parents: f6bd93c
Author: Gary Gregory <ga...@gmail.com>
Authored: Fri Oct 3 19:08:00 2014 -0400
Committer: Gary Gregory <ga...@gmail.com>
Committed: Fri Oct 3 19:08:00 2014 -0400

----------------------------------------------------------------------
 .../log4j/core/appender/SocketAppender.java     | 16 +++++++------
 .../log4j/core/net/SslSocketManager.java        | 18 +++++++--------
 .../log4j/core/net/TcpSocketManager.java        | 24 ++++++++++----------
 src/site/xdoc/manual/appenders.xml              |  2 +-
 4 files changed, 31 insertions(+), 29 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/8fde30c7/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java
index b134a83..49a9bcb 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SocketAppender.java
@@ -24,6 +24,7 @@ import org.apache.logging.log4j.core.Filter;
 import org.apache.logging.log4j.core.Layout;
 import org.apache.logging.log4j.core.config.Configuration;
 import org.apache.logging.log4j.core.config.plugins.Plugin;
+import org.apache.logging.log4j.core.config.plugins.PluginAliases;
 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
 import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
 import org.apache.logging.log4j.core.config.plugins.PluginElement;
@@ -82,7 +83,7 @@ public class SocketAppender extends AbstractOutputStreamAppender<AbstractSocketM
      *        The Protocol to use.
      * @param sslConfig
      *        The SSL configuration file for TCP/SSL, ignored for UPD.
-     * @param delay
+     * @param delayMillis
      *        The interval in which failed writes should be retried.
      * @param immediateFail
      *        True if the write should fail if no socket is immediately available.
@@ -110,7 +111,8 @@ public class SocketAppender extends AbstractOutputStreamAppender<AbstractSocketM
             @PluginAttribute("port") final String portNum,
             @PluginAttribute("protocol") final String protocolStr,
             @PluginElement("SSL") final SslConfiguration sslConfig,
-            @PluginAttribute("reconnectionDelay") final String delay,
+            @PluginAliases("reconnectionDelay") // deprecated
+            @PluginAttribute("reconnectionDelayMillis") final String delayMillis,
             @PluginAttribute("immediateFail") final String immediateFail,
             @PluginAttribute("name") final String name,
             @PluginAttribute("immediateFlush") final String immediateFlush,
@@ -124,7 +126,7 @@ public class SocketAppender extends AbstractOutputStreamAppender<AbstractSocketM
         final boolean isAdvertise = Boolean.parseBoolean(advertise);
         final boolean ignoreExceptions = Booleans.parseBoolean(ignore, true);
         final boolean fail = Booleans.parseBoolean(immediateFail, true);
-        final int reconnectDelay = AbstractAppender.parseInt(delay, 0);
+        final int reconnectDelayMillis = AbstractAppender.parseInt(delayMillis, 0);
         final int port = AbstractAppender.parseInt(portNum, 0);
         if (layout == null) {
             layout = SerializedLayout.createLayout();
@@ -142,7 +144,7 @@ public class SocketAppender extends AbstractOutputStreamAppender<AbstractSocketM
         }
 
         final AbstractSocketManager manager = createSocketManager(name, protocol, host, port, sslConfig,
-                reconnectDelay, fail, layout);
+                reconnectDelayMillis, fail, layout);
 
         return new SocketAppender(name, layout, filter, manager, ignoreExceptions, isFlush,
                 isAdvertise ? config.getAdvertiser() : null);
@@ -155,7 +157,7 @@ public class SocketAppender extends AbstractOutputStreamAppender<AbstractSocketM
      *         if the protocol cannot be handled.
      */
     protected static AbstractSocketManager createSocketManager(final String name, Protocol protocol, final String host,
-            final int port, final SslConfiguration sslConfig, final int delay, final boolean immediateFail,
+            final int port, final SslConfiguration sslConfig, final int delayMillis, final boolean immediateFail,
             final Layout<? extends Serializable> layout) {
         if (protocol == Protocol.TCP && sslConfig != null) {
             // Upgrade TCP to SSL if an SSL config is specified.
@@ -166,11 +168,11 @@ public class SocketAppender extends AbstractOutputStreamAppender<AbstractSocketM
         }
         switch (protocol) {
         case TCP:
-            return TcpSocketManager.getSocketManager(host, port, delay, immediateFail, layout);
+            return TcpSocketManager.getSocketManager(host, port, delayMillis, immediateFail, layout);
         case UDP:
             return DatagramSocketManager.getSocketManager(host, port, layout);
         case SSL:
-            return SslSocketManager.getSocketManager(sslConfig, host, port, delay, immediateFail, layout);
+            return SslSocketManager.getSocketManager(sslConfig, host, port, delayMillis, immediateFail, layout);
         default:
             throw new IllegalArgumentException(protocol.toString());
         }

http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/8fde30c7/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SslSocketManager.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SslSocketManager.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SslSocketManager.java
index 4eb6bd0..01b5cc7 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SslSocketManager.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/SslSocketManager.java
@@ -64,15 +64,15 @@ public class SslSocketManager extends TcpSocketManager {
         protected SslConfiguration sslConfig;
         private final String host;
         private final int port;
-        private final int delay;
+        private final int delayMillis;
         private final boolean immediateFail;
         private final Layout<? extends Serializable> layout;
 
-        public SslFactoryData(final SslConfiguration sslConfig, final String host, final int port, final int delay, final boolean immediateFail,
+        public SslFactoryData(final SslConfiguration sslConfig, final String host, final int port, final int delayMillis, final boolean immediateFail,
                               final Layout<? extends Serializable> layout) {
             this.host = host;
             this.port = port;
-            this.delay = delay;
+            this.delayMillis = delayMillis;
             this.immediateFail = immediateFail;
             this.layout = layout;
             this.sslConfig = sslConfig;
@@ -80,18 +80,18 @@ public class SslSocketManager extends TcpSocketManager {
     }
 
     public static SslSocketManager getSocketManager(final SslConfiguration sslConfig, final String host, int port,
-                                                    int delay, final boolean immediateFail, final Layout<? extends Serializable> layout ) {
+                                                    int delayMillis, final boolean immediateFail, final Layout<? extends Serializable> layout ) {
         if (Strings.isEmpty(host)) {
             throw new IllegalArgumentException("A host name is required");
         }
         if (port <= 0) {
             port = DEFAULT_PORT;
         }
-        if (delay == 0) {
-            delay = DEFAULT_RECONNECTION_DELAY;
+        if (delayMillis == 0) {
+            delayMillis = DEFAULT_RECONNECTION_DELAY_MILLIS;
         }
         return (SslSocketManager) getManager("TLS:" + host + ':' + port,
-                new SslFactoryData(sslConfig, host, port, delay, immediateFail, layout), FACTORY);
+                new SslFactoryData(sslConfig, host, port, delayMillis, immediateFail, layout), FACTORY);
     }
 
     @Override
@@ -130,7 +130,7 @@ public class SslSocketManager extends TcpSocketManager {
                 inetAddress = resolveAddress(data.host);
                 socket = createSocket(data);
                 os = socket.getOutputStream();
-                checkDelay(data.delay, os);
+                checkDelay(data.delayMillis, os);
             }
             catch (final IOException e) {
                 LOGGER.error("SslSocketManager ({})", name, e);
@@ -140,7 +140,7 @@ public class SslSocketManager extends TcpSocketManager {
                 LOGGER.catching(Level.DEBUG, e);
                 return null;
             }
-            return createManager(name, os, socket, data.sslConfig, inetAddress, data.host, data.port, data.delay, data.immediateFail, data.layout);
+            return createManager(name, os, socket, data.sslConfig, inetAddress, data.host, data.port, data.delayMillis, data.immediateFail, data.layout);
         }
 
         private InetAddress resolveAddress(final String hostName) throws TlsSocketManagerFactoryException {

http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/8fde30c7/log4j-core/src/main/java/org/apache/logging/log4j/core/net/TcpSocketManager.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/TcpSocketManager.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/TcpSocketManager.java
index af1e3c9..15cf403 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/net/TcpSocketManager.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/net/TcpSocketManager.java
@@ -41,7 +41,7 @@ public class TcpSocketManager extends AbstractSocketManager {
     /**
       The default reconnection delay (30000 milliseconds or 30 seconds).
      */
-    public static final int DEFAULT_RECONNECTION_DELAY   = 30000;
+    public static final int DEFAULT_RECONNECTION_DELAY_MILLIS   = 30000;
     /**
       The default port number of remote logging server (4560).
      */
@@ -91,10 +91,10 @@ public class TcpSocketManager extends AbstractSocketManager {
      * Obtain a TcpSocketManager.
      * @param host The host to connect to.
      * @param port The port on the host.
-     * @param delay The interval to pause between retries.
+     * @param delayMillis The interval to pause between retries.
      * @return A TcpSocketManager.
      */
-    public static TcpSocketManager getSocketManager(final String host, int port, int delay,
+    public static TcpSocketManager getSocketManager(final String host, int port, int delayMillis,
                                                     final boolean immediateFail, final Layout<? extends Serializable> layout ) {
         if (Strings.isEmpty(host)) {
             throw new IllegalArgumentException("A host name is required");
@@ -102,11 +102,11 @@ public class TcpSocketManager extends AbstractSocketManager {
         if (port <= 0) {
             port = DEFAULT_PORT;
         }
-        if (delay == 0) {
-            delay = DEFAULT_RECONNECTION_DELAY;
+        if (delayMillis == 0) {
+            delayMillis = DEFAULT_RECONNECTION_DELAY_MILLIS;
         }
         return (TcpSocketManager) getManager("TCP:" + host + ':' + port,
-            new FactoryData(host, port, delay, immediateFail, layout), FACTORY);
+            new FactoryData(host, port, delayMillis, immediateFail, layout), FACTORY);
     }
 
     @Override
@@ -237,15 +237,15 @@ public class TcpSocketManager extends AbstractSocketManager {
     private static class FactoryData {
         private final String host;
         private final int port;
-        private final int delay;
+        private final int delayMillis;
         private final boolean immediateFail;
         private final Layout<? extends Serializable> layout;
 
-        public FactoryData(final String host, final int port, final int delay, final boolean immediateFail,
+        public FactoryData(final String host, final int port, final int delayMillis, final boolean immediateFail,
                            final Layout<? extends Serializable> layout) {
             this.host = host;
             this.port = port;
-            this.delay = delay;
+            this.delayMillis = delayMillis;
             this.immediateFail = immediateFail;
             this.layout = layout;
         }
@@ -269,16 +269,16 @@ public class TcpSocketManager extends AbstractSocketManager {
             try {
                 final Socket socket = new Socket(data.host, data.port);
                 os = socket.getOutputStream();
-                return new TcpSocketManager(name, os, socket, inetAddress, data.host, data.port, data.delay,
+                return new TcpSocketManager(name, os, socket, inetAddress, data.host, data.port, data.delayMillis,
                     data.immediateFail, data.layout);
             } catch (final IOException ex) {
                 LOGGER.error("TcpSocketManager (" + name + ") " + ex);
                 os = new ByteArrayOutputStream();
             }
-            if (data.delay == 0) {
+            if (data.delayMillis == 0) {
                 return null;
             }
-            return new TcpSocketManager(name, os, null, inetAddress, data.host, data.port, data.delay, data.immediateFail,
+            return new TcpSocketManager(name, os, null, inetAddress, data.host, data.port, data.delayMillis, data.immediateFail,
                 data.layout);
         }
     }

http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/8fde30c7/src/site/xdoc/manual/appenders.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/manual/appenders.xml b/src/site/xdoc/manual/appenders.xml
index fe203c4..f49a89f 100644
--- a/src/site/xdoc/manual/appenders.xml
+++ b/src/site/xdoc/manual/appenders.xml
@@ -2868,7 +2868,7 @@ public class JpaLogEntity extends AbstractLogEventWrapperEntity {
               <td>The Layout to use to format the LogEvent. The default is SerializedLayout.</td>
             </tr>
             <tr>
-              <td>reconnectionDelay</td>
+              <td>reconnectionDelayMillis</td>
               <td>integer</td>
               <td>If set to a value greater than 0, after an error the SocketManager will attempt to reconnect to
                 the server after waiting the specified number of milliseconds. If the reconnect fails then