Recycler API

log4j-1.2-api/src/main/java/org/apache/log4j/builders/appender/SyslogAppenderBuilder.java

@@ -142,6 +142,7 @@ private Appender createAppender(final String name, final Log4j1Configuration con
         resolveSyslogHost(syslogHost, host, port);
         final org.apache.logging.log4j.core.Layout messageLayout = LayoutAdapter.adapt(layout);
         final Log4j1SyslogLayout appenderLayout = Log4j1SyslogLayout.newBuilder()
+                .setConfiguration(configuration)
                 .setHeader(header)
                 .setFacility(Facility.toFacility(facility))
                 .setFacilityPrinting(facilityPrinting)

log4j-1.2-api/src/main/java/org/apache/log4j/builders/layout/HtmlLayoutBuilder.java

@@ -25,6 +25,7 @@
 import org.apache.log4j.builders.AbstractBuilder;
 import org.apache.log4j.config.PropertiesConfiguration;
 import org.apache.log4j.xml.XmlConfiguration;
+import org.apache.logging.log4j.core.config.DefaultConfiguration;
 import org.apache.logging.log4j.core.layout.HtmlLayout;
 import org.apache.logging.log4j.plugins.Namespace;
 import org.apache.logging.log4j.plugins.Plugin;
@@ -78,6 +79,7 @@ public Layout parse(final PropertiesConfiguration config) {
 
     private Layout createLayout(final String title, final boolean locationInfo) {
         return LayoutWrapper.adapt(HtmlLayout.newBuilder()
+                .setConfiguration(new DefaultConfiguration())
                 .setTitle(title)
                 .setLocationInfo(locationInfo)
                 .build());

log4j-1.2-api/src/main/java/org/apache/log4j/builders/layout/XmlLayoutBuilder.java

@@ -25,6 +25,7 @@
 import org.apache.log4j.config.PropertiesConfiguration;
 import org.apache.log4j.layout.Log4j1XmlLayout;
 import org.apache.log4j.xml.XmlConfiguration;
+import org.apache.logging.log4j.core.config.DefaultConfiguration;
 import org.apache.logging.log4j.plugins.Namespace;
 import org.apache.logging.log4j.plugins.Plugin;
 import org.w3c.dom.Element;
@@ -73,6 +74,6 @@ public Layout parse(final PropertiesConfiguration config) {
     }
 
     private Layout createLayout(final boolean properties, final boolean locationInfo) {
-        return LayoutWrapper.adapt(Log4j1XmlLayout.createLayout(locationInfo, properties));
+        return LayoutWrapper.adapt(Log4j1XmlLayout.createLayout(new DefaultConfiguration(), locationInfo, properties));
     }
 }

log4j-1.2-api/src/main/java/org/apache/log4j/layout/Log4j1SyslogLayout.java

@@ -24,6 +24,7 @@
 import org.apache.logging.log4j.core.Layout;
 import org.apache.logging.log4j.core.LogEvent;
 import org.apache.logging.log4j.core.StringLayout;
+import org.apache.logging.log4j.core.config.Configuration;
 import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
 import org.apache.logging.log4j.core.layout.AbstractStringLayout;
 import org.apache.logging.log4j.core.net.Facility;
@@ -85,7 +86,7 @@ public Log4j1SyslogLayout build() {
                 LOGGER.error("Log4j1SyslogLayout: the message layout must be a StringLayout.");
                 return null;
             }
-            return new Log4j1SyslogLayout(facility, facilityPrinting, header, (StringLayout) messageLayout, getCharset());
+            return new Log4j1SyslogLayout(getConfiguration(), facility, facilityPrinting, header, (StringLayout) messageLayout, getCharset());
         }
 
         public Facility getFacility() {
@@ -147,9 +148,14 @@ public static <B extends Builder<B>> B newBuilder() {
     private final LogEventPatternConverter dateConverter =  DatePatternConverter.newInstance(dateFormatOptions);
 
 
-    private Log4j1SyslogLayout(final Facility facility, final boolean facilityPrinting, final boolean header,
-            final StringLayout messageLayout, final Charset charset) {
-        super(charset);
+    private Log4j1SyslogLayout(
+            final Configuration config,
+            final Facility facility,
+            final boolean facilityPrinting,
+            final boolean header,
+            final StringLayout messageLayout,
+            final Charset charset) {
+        super(config, charset);
         this.facility = facility;
         this.facilityPrinting = facilityPrinting;
         this.header = header;
@@ -168,32 +174,36 @@ public String toSerializable(final LogEvent event) {
         // so we generate the message first
         final String message = messageLayout != null ? messageLayout.toSerializable(event)
                 : event.getMessage().getFormattedMessage();
-        final StringBuilder buf = getStringBuilder();
-
-        buf.append('<');
-        buf.append(Priority.getPriority(facility, event.getLevel()));
-        buf.append('>');
-
-        if (header) {
-            final int index = buf.length() + 4;
-            dateConverter.format(event, buf);
-            // RFC 3164 says leading space, not leading zero on days 1-9
-            if (buf.charAt(index) == '0') {
-                buf.setCharAt(index, Chars.SPACE);
+        final StringBuilder buf = stringBuilderRecycler.acquire();
+
+        try {
+            buf.append('<');
+            buf.append(Priority.getPriority(facility, event.getLevel()));
+            buf.append('>');
+
+            if (header) {
+                final int index = buf.length() + 4;
+                dateConverter.format(event, buf);
+                // RFC 3164 says leading space, not leading zero on days 1-9
+                if (buf.charAt(index) == '0') {
+                    buf.setCharAt(index, Chars.SPACE);
+                }
+
+                buf.append(Chars.SPACE);
+                buf.append(localHostname);
+                buf.append(Chars.SPACE);
             }
 
-            buf.append(Chars.SPACE);
-            buf.append(localHostname);
-            buf.append(Chars.SPACE);
-        }
-
         if (facilityPrinting) {
             buf.append(facility != null ? toRootLowerCase(facility.name()) : "user").append(':');
         }
 
-        buf.append(message);
-        // TODO: splitting message into 1024 byte chunks?
-        return buf.toString();
+            buf.append(message);
+            // TODO: splitting message into 1024 byte chunks?
+            return buf.toString();
+        } finally {
+            stringBuilderRecycler.release(buf);
+        }
     }
 
     /**

log4j-1.2-api/src/main/java/org/apache/log4j/layout/Log4j1XmlLayout.java

@@ -25,8 +25,11 @@
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import org.apache.logging.log4j.core.Layout;
 import org.apache.logging.log4j.core.LogEvent;
+import org.apache.logging.log4j.core.config.Configuration;
+import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
 import org.apache.logging.log4j.core.layout.AbstractStringLayout;
 import org.apache.logging.log4j.core.layout.ByteBufferDestination;
+import org.apache.logging.log4j.core.layout.Encoder;
 import org.apache.logging.log4j.core.util.Transform;
 import org.apache.logging.log4j.plugins.Configurable;
 import org.apache.logging.log4j.plugins.Plugin;
@@ -53,15 +56,16 @@ public final class Log4j1XmlLayout extends AbstractStringLayout {
     @PluginFactory
     public static Log4j1XmlLayout createLayout(
             // @formatter:off
+            @PluginConfiguration Configuration configuration,
             @PluginAttribute(value = "locationInfo") final boolean locationInfo,
             @PluginAttribute(value = "properties") final boolean properties
             // @formatter:on
     ) {
-        return new Log4j1XmlLayout(locationInfo, properties);
+        return new Log4j1XmlLayout(configuration, locationInfo, properties);
     }
 
-    private Log4j1XmlLayout(final boolean locationInfo, final boolean properties) {
-        super(StandardCharsets.UTF_8);
+    private Log4j1XmlLayout(final Configuration configuration, final boolean locationInfo, final boolean properties) {
+        super(configuration, StandardCharsets.UTF_8);
         this.locationInfo = locationInfo;
         this.properties = properties;
     }
@@ -76,16 +80,29 @@ public boolean isProperties() {
 
     @Override
     public void encode(final LogEvent event, final ByteBufferDestination destination) {
-        final StringBuilder text = getStringBuilder();
-        formatTo(event, text);
-        getStringBuilderEncoder().encode(text, destination);
+        final StringBuilder text = stringBuilderRecycler.acquire();
+        try {
+            formatTo(event, text);
+            final Encoder<StringBuilder> stringBuilderEncoder = stringBuilderEncoderRecycler.acquire();
+            try {
+                stringBuilderEncoder.encode(text, destination);
+            } finally {
+                stringBuilderEncoderRecycler.release(stringBuilderEncoder);
+            }
+        } finally {
+            stringBuilderRecycler.release(text);
+        }
     }
 
     @Override
     public String toSerializable(final LogEvent event) {
-        final StringBuilder text = getStringBuilder();
-        formatTo(event, text);
-        return text.toString();
+        final StringBuilder text = stringBuilderRecycler.acquire();
+        try {
+            formatTo(event, text);
+            return text.toString();
+        } finally {
+            stringBuilderRecycler.release(text);
+        }
     }
 
     @SuppressFBWarnings(

log4j-1.2-api/src/test/java/org/apache/log4j/layout/Log4j1SyslogLayoutTest.java

@@ -23,6 +23,7 @@
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.core.LogEvent;
 import org.apache.logging.log4j.core.StringLayout;
+import org.apache.logging.log4j.core.config.DefaultConfiguration;
 import org.apache.logging.log4j.core.layout.PatternLayout;
 import org.apache.logging.log4j.core.net.Facility;
 import org.apache.logging.log4j.core.time.MutableInstant;
@@ -71,15 +72,18 @@ static Stream<Arguments> configurations() {
     public void testSimpleLayout(final String expected, final Facility facility, final boolean header, final boolean facilityPrinting) {
         final LogEvent logEvent = createLogEvent();
         StringLayout appenderLayout = Log4j1SyslogLayout.newBuilder()
+                .setConfiguration(new DefaultConfiguration())
                 .setFacility(facility)
                 .setHeader(header)
                 .setFacilityPrinting(facilityPrinting)
                 .build();
         assertEquals(expected, appenderLayout.toSerializable(logEvent));
         final StringLayout messageLayout = PatternLayout.newBuilder()
+                .setConfiguration(new DefaultConfiguration())
                 .setPattern("%m")
                 .build();
         appenderLayout = Log4j1SyslogLayout.newBuilder()
+                .setConfiguration(new DefaultConfiguration())
                 .setFacility(facility)
                 .setHeader(header)
                 .setFacilityPrinting(facilityPrinting)

log4j-1.2-api/src/test/java/org/apache/log4j/layout/Log4j1XmlLayoutTest.java

@@ -17,6 +17,7 @@
 package org.apache.log4j.layout;
 
 import org.apache.logging.log4j.Level;
+import org.apache.logging.log4j.core.config.DefaultConfiguration;
 import org.apache.logging.log4j.core.impl.ContextDataFactory;
 import org.apache.logging.log4j.core.impl.Log4jLogEvent;
 import org.apache.logging.log4j.message.SimpleMessage;
@@ -34,7 +35,7 @@ public class Log4j1XmlLayoutTest {
 
     @Test
     public void testWithoutThrown() {
-        final Log4j1XmlLayout layout = Log4j1XmlLayout.createLayout(false, true);
+        final Log4j1XmlLayout layout = Log4j1XmlLayout.createLayout(new DefaultConfiguration(), false, true);
 
         final Log4jLogEvent event = Log4jLogEvent.newBuilder()
                 .setLoggerName("a.B")
@@ -55,7 +56,7 @@ public void testWithoutThrown() {
 
     @Test
     public void testWithPropertiesAndLocationInfo() {
-        final Log4j1XmlLayout layout = Log4j1XmlLayout.createLayout(true, true);
+        final Log4j1XmlLayout layout = Log4j1XmlLayout.createLayout(new DefaultConfiguration(), true, true);
 
         final StringMap contextMap = ContextDataFactory.createContextData(2);
         contextMap.putValue("key1", "value1");

log4j-api-test/src/test/java/org/apache/logging/log4j/message/ReusableMessageFactoryTest.java

@@ -16,6 +16,8 @@
  */
 package org.apache.logging.log4j.message;
 
+import org.apache.logging.log4j.spi.ThreadLocalRecyclerFactory;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -25,35 +27,39 @@
  */
 public class ReusableMessageFactoryTest {
 
+    private ReusableMessageFactory factory;
+
+    @BeforeEach
+    void setUp() {
+        factory = new ReusableMessageFactory(new ThreadLocalRecyclerFactory(8));
+    }
+
     @Test
     public void testCreateEventReturnsDifferentInstanceIfNotReleased() throws Exception {
-        final ReusableMessageFactory factory = new ReusableMessageFactory();
         final Message message1 = factory.newMessage("text, p0={} p1={} p2={} p3={}", 1, 2, 3, 4);
         final Message message2 = factory.newMessage("text, p0={} p1={} p2={} p3={}", 9, 8, 7, 6);
         assertNotSame(message1, message2);
-        ReusableMessageFactory.release(message1);
-        ReusableMessageFactory.release(message2);
+        factory.recycle(message1);
+        factory.recycle(message2);
     }
 
     @Test
     public void testCreateEventReturnsSameInstance() throws Exception {
-        final ReusableMessageFactory factory = new ReusableMessageFactory();
         final Message message1 = factory.newMessage("text, p0={} p1={} p2={} p3={}", 1, 2, 3, 4);
 
-        ReusableMessageFactory.release(message1);
+        factory.recycle(message1);
         final Message message2 = factory.newMessage("text, p0={} p1={} p2={} p3={}", 9, 8, 7, 6);
         assertSame(message1, message2);
 
-        ReusableMessageFactory.release(message2);
+        factory.recycle(message2);
         final Message message3 = factory.newMessage("text, AAA={} BBB={} p2={} p3={}", 9, 8, 7, 6);
         assertSame(message2, message3);
-        ReusableMessageFactory.release(message3);
+        factory.recycle(message3);
     }
 
     private void assertReusableParameterizeMessage(final Message message, final String txt, final Object[] params) {
         assertTrue(message instanceof ReusableParameterizedMessage);
         final ReusableParameterizedMessage msg = (ReusableParameterizedMessage) message;
-        assertTrue(msg.reserved, "reserved");
 
         assertEquals(txt, msg.getFormat());
         assertEquals(msg.getParameterCount(), params.length, "count");
@@ -65,7 +71,6 @@ private void assertReusableParameterizeMessage(final Message message, final Stri
 
     @Test
     public void testCreateEventOverwritesFields() throws Exception {
-        final ReusableMessageFactory factory = new ReusableMessageFactory();
         final Message message1 = factory.newMessage("text, p0={} p1={} p2={} p3={}", 1, 2, 3, 4);
         assertReusableParameterizeMessage(message1, "text, p0={} p1={} p2={} p3={}", new Object[]{
                 new Integer(1), //
@@ -74,7 +79,7 @@ public void testCreateEventOverwritesFields() throws Exception {
                 new Integer(4), //
         });
 
-        ReusableMessageFactory.release(message1);
+        factory.recycle(message1);
         final Message message2 = factory.newMessage("other, A={} B={} C={} D={}", 1, 2, 3, 4);
         assertReusableParameterizeMessage(message1, "other, A={} B={} C={} D={}", new Object[]{
                 new Integer(1), //
@@ -83,12 +88,11 @@ public void testCreateEventOverwritesFields() throws Exception {
                 new Integer(4), //
         });
         assertSame(message1, message2);
-        ReusableMessageFactory.release(message2);
+        factory.recycle(message2);
     }
 
     @Test
     public void testCreateEventReturnsThreadLocalInstance() throws Exception {
-        final ReusableMessageFactory factory = new ReusableMessageFactory();
         final Message[] message1 = new Message[1];
         final Message[] message2 = new Message[1];
         final Thread t1 = new Thread("THREAD 1") {
@@ -123,8 +127,8 @@ public void run() {
                 new Integer(3), //
                 new Integer(4), //
         });
-        ReusableMessageFactory.release(message1[0]);
-        ReusableMessageFactory.release(message2[0]);
+        factory.recycle(message1[0]);
+        factory.recycle(message2[0]);
     }
 
 }