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 2022/02/05 14:35:56 UTC

[logging-log4j2] branch release-2.x updated: Continue replacing with*() builder methods with set*() methods.

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git


The following commit(s) were added to refs/heads/release-2.x by this push:
     new 70cabdf  Continue replacing with*() builder methods with set*() methods.
70cabdf is described below

commit 70cabdfebd02b5a934298a9473b8aaae733620d2
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Feb 5 09:35:52 2022 -0500

    Continue replacing with*() builder methods with set*() methods.
---
 .../builders/appender/SocketAppenderBuilder.java   |  6 +-
 .../builders/appender/SyslogAppenderBuilder.java   |  6 +-
 .../log4j/core/appender/SocketAppender.java        | 70 +++++++++++++++++++---
 .../log4j/core/appender/SyslogAppender.java        | 18 +++---
 .../log4j/core/appender/SocketAppenderTest.java    | 50 ++++++++--------
 .../log4j/core/appender/SyslogAppenderTest.java    |  6 +-
 .../template/json/JsonTemplateLayoutTest.java      | 10 ++--
 .../log4j/layout/template/json/LogstashIT.java     | 10 ++--
 8 files changed, 115 insertions(+), 61 deletions(-)

diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/SocketAppenderBuilder.java b/log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/SocketAppenderBuilder.java
index e16e140..82c74ae 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/SocketAppenderBuilder.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/SocketAppenderBuilder.java
@@ -82,9 +82,9 @@ public class SocketAppenderBuilder extends AbstractBuilder implements AppenderBu
         final org.apache.logging.log4j.core.Filter actualFilter = buildFilters(level, filter);
         // @formatter:off
         return new AppenderWrapper(SocketAppender.newBuilder()
-            .withHost(host)
-            .withPort(port)
-            .withReconnectDelayMillis(reconnectDelayMillis)
+            .setHost(host)
+            .setPort(port)
+            .setReconnectDelayMillis(reconnectDelayMillis)
             .setName(name)
             .setLayout(actualLayout)
             .setFilter(actualFilter)
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/SyslogAppenderBuilder.java b/log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/SyslogAppenderBuilder.java
index ca479ec..83fe788 100644
--- a/log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/SyslogAppenderBuilder.java
+++ b/log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/SyslogAppenderBuilder.java
@@ -145,9 +145,9 @@ public class SyslogAppenderBuilder extends AbstractBuilder implements AppenderBu
                 .setConfiguration(configuration)
                 .setLayout(appenderLayout)
                 .setFilter(fileFilter)
-                .withPort(port.get())
-                .withProtocol(protocol)
-                .withHost(host.get())
+                .setPort(port.get())
+                .setProtocol(protocol)
+                .setHost(host.get())
                 .build());
     }
 
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 316663c..ebdea20 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
@@ -130,46 +130,100 @@ public class SocketAppender extends AbstractOutputStreamAppender<AbstractSocketM
             return immediateFail;
         }
 
+        public B setAdvertise(final boolean advertise) {
+            this.advertise = advertise;
+            return asBuilder();
+        }
+
+        public B setConnectTimeoutMillis(final int connectTimeoutMillis) {
+            this.connectTimeoutMillis = connectTimeoutMillis;
+            return asBuilder();
+        }
+
+        public B setHost(final String host) {
+            this.host = host;
+            return asBuilder();
+        }
+
+        public B setImmediateFail(final boolean immediateFail) {
+            this.immediateFail = immediateFail;
+            return asBuilder();
+        }
+
+        public B setPort(final int port) {
+            this.port = port;
+            return asBuilder();
+        }
+
+        public B setProtocol(final Protocol protocol) {
+            this.protocol = protocol;
+            return asBuilder();
+        }
+
+        public B setReconnectDelayMillis(final int reconnectDelayMillis) {
+            this.reconnectDelayMillis = reconnectDelayMillis;
+            return asBuilder();
+        }
+
+        public B setSocketOptions(final SocketOptions socketOptions) {
+            this.socketOptions = socketOptions;
+            return asBuilder();
+        }
+
+        public B setSslConfiguration(final SslConfiguration sslConfiguration) {
+            this.sslConfiguration = sslConfiguration;
+            return asBuilder();
+        }
+
+        @Deprecated
         public B withAdvertise(final boolean advertise) {
             this.advertise = advertise;
             return asBuilder();
         }
 
+        @Deprecated
         public B withConnectTimeoutMillis(final int connectTimeoutMillis) {
             this.connectTimeoutMillis = connectTimeoutMillis;
             return asBuilder();
         }
 
+        @Deprecated
         public B withHost(final String host) {
             this.host = host;
             return asBuilder();
         }
 
+        @Deprecated
         public B withImmediateFail(final boolean immediateFail) {
             this.immediateFail = immediateFail;
             return asBuilder();
         }
 
+        @Deprecated
         public B withPort(final int port) {
             this.port = port;
             return asBuilder();
         }
 
+        @Deprecated
         public B withProtocol(final Protocol protocol) {
             this.protocol = protocol;
             return asBuilder();
         }
 
+        @Deprecated
         public B withReconnectDelayMillis(final int reconnectDelayMillis) {
             this.reconnectDelayMillis = reconnectDelayMillis;
             return asBuilder();
         }
 
+        @Deprecated
         public B withSocketOptions(final SocketOptions socketOptions) {
             this.socketOptions = socketOptions;
             return asBuilder();
         }
 
+        @Deprecated
         public B withSslConfiguration(final SslConfiguration sslConfiguration) {
             this.sslConfiguration = sslConfiguration;
             return asBuilder();
@@ -329,15 +383,15 @@ public class SocketAppender extends AbstractOutputStreamAppender<AbstractSocketM
 
         // @formatter:off
         return newBuilder()
-        .withAdvertise(advertise)
+        .setAdvertise(advertise)
         .setConfiguration(configuration)
-        .withConnectTimeoutMillis(connectTimeoutMillis).setFilter(filter)
-            .withHost(host).setIgnoreExceptions(ignoreExceptions)
-            .withImmediateFail(immediateFail).setLayout(layout).setName(name)
-            .withPort(port)
-            .withProtocol(protocol)
-            .withReconnectDelayMillis(reconnectDelayMillis)
-            .withSslConfiguration(sslConfig)
+        .setConnectTimeoutMillis(connectTimeoutMillis).setFilter(filter)
+            .setHost(host).setIgnoreExceptions(ignoreExceptions)
+            .setImmediateFail(immediateFail).setLayout(layout).setName(name)
+            .setPort(port)
+            .setProtocol(protocol)
+            .setReconnectDelayMillis(reconnectDelayMillis)
+            .setSslConfiguration(sslConfig)
             .build();
         // @formatter:on
     }
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SyslogAppender.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SyslogAppender.java
index 67ea602..c65b1e5 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SyslogAppender.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/SyslogAppender.java
@@ -398,16 +398,16 @@ public class SyslogAppender extends SocketAppender {
 
         // @formatter:off
         return SyslogAppender.<B>newSyslogAppenderBuilder()
-        .withHost(host)
-        .withPort(port)
-        .withProtocol(EnglishEnums.valueOf(Protocol.class, protocolStr))
-        .withSslConfiguration(sslConfiguration)
-        .withConnectTimeoutMillis(connectTimeoutMillis)
-        .withReconnectDelayMillis(reconnectDelayMillis)
-        .withImmediateFail(immediateFail).setName(appName)
-        .withImmediateFlush(immediateFlush).setIgnoreExceptions(ignoreExceptions).setFilter(filter)
+        .setHost(host)
+        .setPort(port)
+        .setProtocol(EnglishEnums.valueOf(Protocol.class, protocolStr))
+        .setSslConfiguration(sslConfiguration)
+        .setConnectTimeoutMillis(connectTimeoutMillis)
+        .setReconnectDelayMillis(reconnectDelayMillis)
+        .setImmediateFail(immediateFail).setName(appName)
+        .setImmediateFlush(immediateFlush).setIgnoreExceptions(ignoreExceptions).setFilter(filter)
                 .setConfiguration(configuration)
-                .withAdvertise(advertise)
+                .setAdvertise(advertise)
                 .setFacility(facility)
                 .setId(id)
                 .setEnterpriseNumber(enterpriseNumber)
diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SocketAppenderTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SocketAppenderTest.java
index a817814..a5157b4 100644
--- a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SocketAppenderTest.java
+++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SocketAppenderTest.java
@@ -128,12 +128,12 @@ public class SocketAppenderTest {
             throws Exception {
         // @formatter:off
         final SocketAppender appender = SocketAppender.newBuilder()
-        .withHost("localhost")
-        .withPort(tcpTestServer.getLocalPort())
-        .withReconnectDelayMillis(-1).setName("test")
-                .withImmediateFail(false)
-                .withBufferSize(bufferSize).setLayout((Layout<? extends Serializable>) JsonLayout.newBuilder().setProperties(true).build())
-                .build();
+            .setHost("localhost")
+            .setPort(tcpTestServer.getLocalPort())
+            .setReconnectDelayMillis(-1).setName("test")
+            .setImmediateFail(false)
+            .setBufferSize(bufferSize).setLayout((Layout<? extends Serializable>) JsonLayout.newBuilder().setProperties(true).build())
+            .build();
         // @formatter:on
         appender.start();
         Assert.assertEquals(bufferSize, appender.getManager().getByteBuffer().capacity());
@@ -175,10 +175,10 @@ public class SocketAppenderTest {
     public void testDefaultProtocol() throws Exception {
         // @formatter:off
         final SocketAppender appender = SocketAppender.newBuilder()
-        .withPort(tcpServer.getLocalPort())
-        .withReconnectDelayMillis(-1).setName("test")
-                .withImmediateFail(false).setLayout((Layout<? extends Serializable>) JsonLayout.newBuilder().setProperties(true).build())
-                .build();
+            .setPort(tcpServer.getLocalPort())
+            .setReconnectDelayMillis(-1).setName("test")
+            .setImmediateFail(false).setLayout((Layout<? extends Serializable>) JsonLayout.newBuilder().setProperties(true).build())
+            .build();
         // @formatter:on
         assertNotNull(appender);
         appender.stop();
@@ -194,11 +194,11 @@ public class SocketAppenderTest {
 
         // @formatter:off
         final SocketAppender appender = SocketAppender.newBuilder()
-        .withProtocol(Protocol.UDP)
-        .withPort(tcpServer.getLocalPort())
-        .withReconnectDelayMillis(-1).setName("test")
-                .withImmediateFail(false).setLayout((Layout<? extends Serializable>) JsonLayout.newBuilder().setProperties(true).build())
-                .build();
+            .setProtocol(Protocol.UDP)
+            .setPort(tcpServer.getLocalPort())
+            .setReconnectDelayMillis(-1).setName("test")
+            .setImmediateFail(false).setLayout((Layout<? extends Serializable>) JsonLayout.newBuilder().setProperties(true).build())
+            .build();
         // @formatter:on
         appender.start();
 
@@ -218,11 +218,11 @@ public class SocketAppenderTest {
 
         // @formatter:off
         final SocketAppender appender = SocketAppender.newBuilder()
-        .withHost("localhost")
-        .withPort(DYN_PORT)
-        .withReconnectDelayMillis(100).setName("test")
-                .withImmediateFail(false).setLayout((Layout<? extends Serializable>) JsonLayout.newBuilder().setProperties(true).build())
-                .build();
+            .setHost("localhost")
+            .setPort(DYN_PORT)
+            .setReconnectDelayMillis(100).setName("test")
+            .setImmediateFail(false).setLayout((Layout<? extends Serializable>) JsonLayout.newBuilder().setProperties(true).build())
+            .build();
         // @formatter:on
         appender.start();
         // set appender on root and set level to debug
@@ -247,11 +247,11 @@ public class SocketAppenderTest {
     public void testTcpAppenderNoWait() throws Exception {
         // @formatter:off
         final SocketAppender appender = SocketAppender.newBuilder()
-        .withHost("localhost")
-        .withPort(ERROR_PORT)
-        .withReconnectDelayMillis(100).setName("test")
-                .withImmediateFail(false).setIgnoreExceptions(false).setLayout((Layout<? extends Serializable>) JsonLayout.newBuilder().setProperties(true).build())
-                .build();
+            .setHost("localhost")
+            .setPort(ERROR_PORT)
+            .setReconnectDelayMillis(100).setName("test")
+            .setImmediateFail(false).setIgnoreExceptions(false).setLayout((Layout<? extends Serializable>) JsonLayout.newBuilder().setProperties(true).build())
+            .build();
         // @formatter:on
         appender.start();
         // set appender on root and set level to debug
diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SyslogAppenderTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SyslogAppenderTest.java
index 3684375..6918aa6 100644
--- a/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SyslogAppenderTest.java
+++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/appender/SyslogAppenderTest.java
@@ -116,9 +116,9 @@ public class SyslogAppenderTest extends SyslogAppenderTestBase {
     protected Builder newSyslogAppenderBuilder(final String protocol, final String format, final boolean newLine) {
         // @formatter:off
         return SyslogAppender.newSyslogAppenderBuilder()
-            .withPort(PORTNUM)
-            .withProtocol(EnglishEnums.valueOf(Protocol.class, protocol))
-            .withReconnectDelayMillis(-1).setName("TestApp").setIgnoreExceptions(false)
+            .setPort(PORTNUM)
+            .setProtocol(EnglishEnums.valueOf(Protocol.class, protocol))
+            .setReconnectDelayMillis(-1).setName("TestApp").setIgnoreExceptions(false)
             .setId("Audit")
             .setEnterpriseNumber(18060)
             .setMdcId("RequestContext")
diff --git a/log4j-layout-template-json/src/test/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutTest.java b/log4j-layout-template-json/src/test/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutTest.java
index 95210b8..2cd2518 100644
--- a/log4j-layout-template-json/src/test/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutTest.java
+++ b/log4j-layout-template-json/src/test/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutTest.java
@@ -1455,12 +1455,12 @@ class JsonTemplateLayoutTest {
             // Create the appender.
             final SocketAppender appender = SocketAppender
                     .newBuilder()
-                    .withHost("localhost")
-                    .withBufferedIo(false)
-                    .withPort(port)
-                    .withReconnectDelayMillis(100)
+                    .setHost("localhost")
+                    .setBufferedIo(false)
+                    .setPort(port)
+                    .setReconnectDelayMillis(100)
                     .setName("test")
-                    .withImmediateFail(false)
+                    .setImmediateFail(false)
                     .setIgnoreExceptions(false)
                     .setLayout(layout)
                     .build();
diff --git a/log4j-layout-template-json/src/test/java/org/apache/logging/log4j/layout/template/json/LogstashIT.java b/log4j-layout-template-json/src/test/java/org/apache/logging/log4j/layout/template/json/LogstashIT.java
index 4b64bec..9e460f6 100644
--- a/log4j-layout-template-json/src/test/java/org/apache/logging/log4j/layout/template/json/LogstashIT.java
+++ b/log4j-layout-template-json/src/test/java/org/apache/logging/log4j/layout/template/json/LogstashIT.java
@@ -454,12 +454,12 @@ class LogstashIT {
         final SocketAppender appender = SocketAppender
                 .newBuilder()
                 .setConfiguration(CONFIGURATION)
-                .withHost(HOST_NAME)
-                .withPort(port)
-                .withReconnectDelayMillis(100)
+                .setHost(HOST_NAME)
+                .setPort(port)
+                .setReconnectDelayMillis(100)
                 .setName("LogstashItAppender")
-                .withBufferedIo(false)
-                .withImmediateFail(true)
+                .setBufferedIo(false)
+                .setImmediateFail(true)
                 .setIgnoreExceptions(false)
                 .setLayout(layout)
                 .build();