You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by rg...@apache.org on 2019/12/07 04:58:51 UTC

[logging-log4j2] branch release-2.x updated: LOG4J2-2674 - Change the name of the ConfigurationSource

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

rgoers 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 c541dab  LOG4J2-2674 - Change the name of the ConfigurationSource
c541dab is described below

commit c541dab32fc3fbec510f4d1bfced8e2d9a097989
Author: Ralph Goers <rg...@apache.org>
AuthorDate: Fri Dec 6 21:56:56 2019 -0700

    LOG4J2-2674 - Change the name of the ConfigurationSource
---
 .../apache/logging/log4j/core/config/Configuration.java    | 14 ++++++++------
 .../logging/log4j/core/config/ConfigurationSource.java     |  4 ++++
 .../core/config/composite/CompositeConfiguration.java      |  2 +-
 .../log4j/core/config/CompositeConfigurationTest.java      |  3 +++
 src/changes/changes.xml                                    |  3 +++
 5 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/Configuration.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/Configuration.java
index 9d7632f..b607571 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/Configuration.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/Configuration.java
@@ -132,12 +132,14 @@ public interface Configuration extends Filterable {
 
     ConfigurationScheduler getScheduler();
 
-	/**
-	 * Returns the source of this configuration.
-	 *
-	 * @return the source of this configuration, never {@code null}, but may be
-	 * {@link org.apache.logging.log4j.core.config.ConfigurationSource#NULL_SOURCE}.
-	 */
+    /**
+     * Returns the source of this configuration.
+     *
+     * @return the source of this configuration, never {@code null}, but may be
+     * {@link org.apache.logging.log4j.core.config.ConfigurationSource#NULL_SOURCE}
+     * or
+     * {@link org.apache.logging.log4j.core.config.ConfigurationSource#COMPOSITE_SOURCE}
+     */
     ConfigurationSource getConfigurationSource();
 
     /**
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ConfigurationSource.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ConfigurationSource.java
index e3d70b3..3630c41 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ConfigurationSource.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ConfigurationSource.java
@@ -47,6 +47,10 @@ public class ConfigurationSource {
      * ConfigurationSource to use with Configurations that do not require a "real" configuration source.
      */
     public static final ConfigurationSource NULL_SOURCE = new ConfigurationSource(new byte[0], null, 0);
+    /**
+     * ConfigurationSource to use with {@link org.apache.logging.log4j.core.config.composite.CompositeConfiguration}.
+     */
+    public static final ConfigurationSource COMPOSITE_SOURCE = new ConfigurationSource(new byte[0], null, 0);
     private static final String HTTPS = "https";
     private static final String HTTP = "http";
 
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/composite/CompositeConfiguration.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/composite/CompositeConfiguration.java
index 75f471d..2be2a9f 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/composite/CompositeConfiguration.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/composite/CompositeConfiguration.java
@@ -61,7 +61,7 @@ public class CompositeConfiguration extends AbstractConfiguration implements Rec
      * @param configurations The List of Configurations to merge.
      */
     public CompositeConfiguration(final List<? extends AbstractConfiguration> configurations) {
-        super(configurations.get(0).getLoggerContext(), ConfigurationSource.NULL_SOURCE);
+        super(configurations.get(0).getLoggerContext(), ConfigurationSource.COMPOSITE_SOURCE);
         rootNode = configurations.get(0).getRootNode();
         this.configurations = configurations;
         final String mergeStrategyClassName = PropertiesUtil.getProperties().getStringProperty(MERGE_STRATEGY_PROPERTY,
diff --git a/log4j-core/src/test/java/org/apache/logging/log4j/core/config/CompositeConfigurationTest.java b/log4j-core/src/test/java/org/apache/logging/log4j/core/config/CompositeConfigurationTest.java
index 965e568..4d16533 100644
--- a/log4j-core/src/test/java/org/apache/logging/log4j/core/config/CompositeConfigurationTest.java
+++ b/log4j-core/src/test/java/org/apache/logging/log4j/core/config/CompositeConfigurationTest.java
@@ -115,6 +115,9 @@ public class CompositeConfigurationTest {
                         appendersMap.size());
                 assertTrue(appendersMap.get("File") instanceof FileAppender);
                 assertTrue(appendersMap.get("STDOUT") instanceof ConsoleAppender);
+
+                assertEquals("Expected COMPOSITE_SOURCE for composite configuration but got " + config.getConfigurationSource(),
+                        config.getConfigurationSource(), ConfigurationSource.COMPOSITE_SOURCE);
             }
         };
         runTest(lcr, test);
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index f29a418..6f5dc26 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -30,6 +30,9 @@
          - "remove" - Removed
     -->
     <release version="2.13.0" date="2019-MM-DD" description="GA Release 2.13.0">
+      <action issue="LOG4J2-2674" dev="rgoers" type="fix" due-to="Anton Korenkov">
+        Use a less confusing name for the CompositeConfiguration source.
+      </action>
       <action issue="LOG4J2-2732" dev="rgoers" type="add" due-to="Matt Pavlovich">
         Add ThreadContext.putIfNotNull method.
       </action>