Merge branch '2.x' into dependabot/maven/log4j-parent/2.x/xmlunit.version-2.10.2

Author: ppkarwasz

log4j-api/src/main/java/org/apache/logging/log4j/util/Base64Util.java

@@ -16,11 +16,8 @@
  */
 package org.apache.logging.log4j.util;
 
-import java.lang.reflect.Method;
 import java.nio.charset.Charset;
-import org.apache.logging.log4j.Logger;
-import org.apache.logging.log4j.LoggingException;
-import org.apache.logging.log4j.status.StatusLogger;
+import java.util.Base64;
 
 /**
  * Base64 encodes Strings. This utility is only necessary because the mechanism to do this changed in Java 8 and
@@ -30,27 +27,7 @@
  */
 public final class Base64Util {
 
-    private static final Logger LOGGER = StatusLogger.getLogger();
-
-    private static Method encodeMethod = null;
-    private static Object encoder = null;
-
-    static {
-        try {
-            final Class<?> clazz = LoaderUtil.loadClass("java.util.Base64");
-            final Class<?> encoderClazz = LoaderUtil.loadClass("java.util.Base64$Encoder");
-            final Method method = clazz.getMethod("getEncoder");
-            encoder = method.invoke(null);
-            encodeMethod = encoderClazz.getMethod("encodeToString", byte[].class);
-        } catch (Exception ex) {
-            try {
-                final Class<?> clazz = LoaderUtil.loadClass("javax.xml.bind.DataTypeConverter");
-                encodeMethod = clazz.getMethod("printBase64Binary");
-            } catch (Exception ex2) {
-                LOGGER.error("Unable to create a Base64 Encoder", ex2);
-            }
-        }
-    }
+    private static final Base64.Encoder ENCODER = Base64.getEncoder();
 
     private Base64Util() {}
 
@@ -60,17 +37,6 @@ private Base64Util() {}
      */
     @Deprecated
     public static String encode(final String str) {
-        if (str == null) {
-            return null;
-        }
-        final byte[] data = str.getBytes(Charset.defaultCharset());
-        if (encodeMethod != null) {
-            try {
-                return (String) encodeMethod.invoke(encoder, data);
-            } catch (Exception ex) {
-                throw new LoggingException("Unable to encode String", ex);
-            }
-        }
-        throw new LoggingException("No Encoder, unable to encode string");
+        return str != null ? ENCODER.encodeToString(str.getBytes(Charset.defaultCharset())) : null;
     }
 }

log4j-core-test/src/test/java/org/apache/logging/log4j/core/async/AsyncLoggerConfigTest.java

@@ -100,7 +100,7 @@ void testSingleFilterInvocation() {
                 .withLoggerName(FQCN)
                 .withConfig(configuration)
                 .withLevel(Level.INFO)
-                .withFilter(filter)
+                .setFilter(filter)
                 .build();
         final Appender appender = mock(Appender.class);
         when(appender.isStarted()).thenReturn(true);

log4j-core-test/src/test/java/org/apache/logging/log4j/core/config/CustomConfigurationTest.java

@@ -63,20 +63,26 @@ void testConfig(final LoggerContext ctx) {
                 .withConfiguration(config)
                 .build();
         final FileAppender appender = FileAppender.newBuilder()
-                .withFileName(logFile.toString())
-                .withAppend(false)
-                .setName("File")
+                .setBufferedIo(false)
                 .setIgnoreExceptions(false)
-                .withBufferedIo(false)
+                .setName("File")
                 .setLayout(layout)
+                .withAppend(false)
+                .withFileName(logFile.toString())
                 .build();
         appender.start();
         config.addAppender(appender);
         final AppenderRef ref = AppenderRef.createAppenderRef("File", null, null);
         final AppenderRef[] refs = new AppenderRef[] {ref};
 
-        final LoggerConfig loggerConfig = LoggerConfig.createLogger(
-                false, Level.INFO, "org.apache.logging.log4j", "true", refs, null, config, null);
+        final LoggerConfig loggerConfig = LoggerConfig.newBuilder()
+                .withConfig(config)
+                .withAdditivity(false)
+                .withIncludeLocation("true")
+                .withLevel(Level.INFO)
+                .withLoggerName("org.apache.logging.log4j")
+                .withRefs(refs)
+                .build();
         loggerConfig.addAppender(appender, null, null);
         config.addLogger("org.apache.logging.log4j", loggerConfig);
         ctx.updateLoggers();

log4j-core-test/src/test/java/org/apache/logging/log4j/core/config/LoggerConfigTest.java

@@ -47,11 +47,16 @@ class LoggerConfigTest {
     private static final String FQCN = LoggerConfigTest.class.getName();
 
     private static LoggerConfig createForProperties(final Property[] properties) {
-        return LoggerConfig.createLogger(
-                true, Level.INFO, "name", "false", new AppenderRef[0], properties, new NullConfiguration(), null);
+        return LoggerConfig.newBuilder()
+                .withConfig(new NullConfiguration())
+                .withAdditivity(true)
+                .withLevel(Level.INFO)
+                .withLoggerName("name")
+                .withIncludeLocation("false")
+                .withProperties(properties)
+                .build();
     }
 
-    @SuppressWarnings({"deprecation"})
     @Test
     void testPropertiesWithoutSubstitution() {
         assertNull(createForProperties(null).getPropertyList(), "null propertiesList");
@@ -129,7 +134,7 @@ void testSingleFilterInvocation() {
                 .withLoggerName(FQCN)
                 .withConfig(configuration)
                 .withLevel(Level.INFO)
-                .withFilter(filter)
+                .setFilter(filter)
                 .build();
         final Appender appender = mock(Appender.class);
         when(appender.isStarted()).thenReturn(true);

log4j-core/src/main/java/org/apache/logging/log4j/core/async/package-info.java

@@ -18,7 +18,7 @@
  * Provides Asynchronous Logger classes and interfaces for low-latency logging.
  */
 @Export
-@Version("2.24.1")
+@Version("2.25.0")
 package org.apache.logging.log4j.core.async;
 
 import org.osgi.annotation.bundle.Export;

log4j-core/src/main/java/org/apache/logging/log4j/core/config/LoggerConfig.java

@@ -213,15 +213,21 @@ public Filter getFilter() {
         }
 
         /**
-         * @deprecated Use {@link #withFilter(Filter)} instead
+         * @deprecated Use {@link #setFilter(Filter)} instead
          */
         @Deprecated
         public B withtFilter(final Filter filter) {
-            this.filter = filter;
-            return asBuilder();
+            return setFilter(filter);
         }
 
+        /** @deprecated since 2.25.0. Use {@link #setFilter(Filter)} instead. */
+        @Deprecated
         public B withFilter(final Filter filter) {
+            return setFilter(filter);
+        }
+
+        /** @since 2.25.0 */
+        public B setFilter(final Filter filter) {
             this.filter = filter;
             return asBuilder();
         }
@@ -936,7 +942,16 @@ public Filter getFilter() {
                 return filter;
             }
 
+            /**
+             * @deprecated since 2.25.0. Use {@link #setFilter(Filter)} instead.
+             */
+            @Deprecated
             public B withtFilter(final Filter filter) {
+                return setFilter(filter);
+            }
+
+            /** @since 2.25.0 */
+            public B setFilter(final Filter filter) {
                 this.filter = filter;
                 return asBuilder();
             }

log4j-core/src/main/java/org/apache/logging/log4j/core/config/package-info.java

@@ -18,7 +18,7 @@
  * Configuration of Log4j 2.
  */
 @Export
-@Version("2.24.1")
+@Version("2.25.0")
 package org.apache.logging.log4j.core.config;
 
 import org.osgi.annotation.bundle.Export;

log4j-core/src/main/java/org/apache/logging/log4j/core/pattern/RegexReplacement.java

@@ -65,7 +65,7 @@ public String toString() {
      * Create a RegexReplacement.
      * @param regex The regular expression to locate.
      * @param replacement The replacement value.
-     * @return A RegexReplacement.
+     * @return the new RegexReplacement instance or {@code null} if an input parameter was invalid
      */
     @PluginFactory
     public static RegexReplacement createRegexReplacement(
@@ -76,6 +76,7 @@ public static RegexReplacement createRegexReplacement(
         }
         if (replacement == null) {
             LOGGER.error("A replacement string is required to perform replacement");
+            return null;
         }
         // FIXME: should we use Matcher.quoteReplacement() here?
         return new RegexReplacement(regex, replacement);

src/changelog/.2.x.x/3215_fix-RegexReplacement.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns="https://logging.apache.org/xml/ns"
+       xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+       type="fixed">
+  <issue id="3215" link="https://github.com/apache/logging-log4j2/issues/3215"/>
+  <description format="asciidoc">
+    Properly handle null 'replacement' parameter in RegexReplacement#createRegexReplacement.
+  </description>
+</entry>

src/changelog/.2.x.x/3369_fix_typo_in_RootLogger_Builder_method.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns="https://logging.apache.org/xml/ns"
+       xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
+       type="added">
+  <issue id="3369" link="https://github.com/apache/logging-log4j2/issues/3369"/>
+  <description format="asciidoc">
+    Fixed typo in "LoggerConfig.RootLogger.Builder#withtFilter(...)" method.
+    Created new corrected 'withFilter()' method and deprecated old method.
+  </description>
+</entry>