Revert changes to methods used by Spring Boot

ppkarwasz · ppkarwasz · commit 0c3b74b9c11c · 2024-03-14T21:00:15.000+01:00
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationFactory.java b/log4j-1.2-api/src/main/java/org/apache/log4j/config/Log4j1ConfigurationFactory.java
@@ -51,7 +51,7 @@ public Configuration getConfiguration(final LoggerContext loggerContext, final C
     }
 
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         return SUFFIXES;
     }
 }
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/config/PropertiesConfigurationFactory.java b/log4j-1.2-api/src/main/java/org/apache/log4j/config/PropertiesConfigurationFactory.java
@@ -46,7 +46,7 @@ public class PropertiesConfigurationFactory extends ConfigurationFactory {
     protected static final String DEFAULT_PREFIX = "log4j";
 
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         if (!PropertiesUtil.getProperties()
                 .getBooleanProperty(ConfigurationFactory.LOG4J1_EXPERIMENTAL, Boolean.FALSE)) {
             return null;
diff --git a/log4j-1.2-api/src/main/java/org/apache/log4j/xml/XmlConfigurationFactory.java b/log4j-1.2-api/src/main/java/org/apache/log4j/xml/XmlConfigurationFactory.java
@@ -47,7 +47,7 @@ public class XmlConfigurationFactory extends ConfigurationFactory {
     protected static final String DEFAULT_PREFIX = "log4j";
 
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         if (!PropertiesUtil.getProperties()
                 .getBooleanProperty(ConfigurationFactory.LOG4J1_EXPERIMENTAL, Boolean.FALSE)) {
             return null;
diff --git a/log4j-1.2-api/src/test/java/org/apache/log4j/BasicConfigurationFactory.java b/log4j-1.2-api/src/test/java/org/apache/log4j/BasicConfigurationFactory.java
@@ -31,7 +31,7 @@
 public class BasicConfigurationFactory extends ConfigurationFactory {
 
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         return new String[] {"*"};
     }
 
diff --git a/log4j-config-properties/src/main/java/org/apache/logging/log4j/config/properties/JavaPropsConfigurationFactory.java b/log4j-config-properties/src/main/java/org/apache/logging/log4j/config/properties/JavaPropsConfigurationFactory.java
@@ -40,7 +40,7 @@ public Configuration getConfiguration(final LoggerContext loggerContext, final C
     }
 
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         return SUFFIXES;
     }
 }
diff --git a/log4j-config-yaml/src/main/java/org/apache/logging/log4j/config/yaml/YamlConfigurationFactory.java b/log4j-config-yaml/src/main/java/org/apache/logging/log4j/config/yaml/YamlConfigurationFactory.java
@@ -40,7 +40,7 @@ public Configuration getConfiguration(final LoggerContext loggerContext, final C
     }
 
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         return SUFFIXES;
     }
 }
diff --git a/log4j-core-test/src/main/java/org/apache/logging/log4j/core/test/BasicConfigurationFactory.java b/log4j-core-test/src/main/java/org/apache/logging/log4j/core/test/BasicConfigurationFactory.java
@@ -40,7 +40,7 @@ public Configuration getConfiguration(
     }
 
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         return null;
     }
 
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ConfigurationFactory.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/ConfigurationFactory.java
@@ -29,7 +29,6 @@
 import org.apache.logging.log4j.status.StatusLogger;
 import org.apache.logging.log4j.util.LoaderUtil;
 import org.apache.logging.log4j.util.PropertiesUtil;
-import org.apache.logging.log4j.util.PropertyEnvironment;
 import org.apache.logging.log4j.util.PropertyKey;
 
 /**
@@ -66,6 +65,8 @@ public abstract class ConfigurationFactory extends ConfigurationBuilderFactory i
      */
     public static final String NAMESPACE = "ConfigurationFactory";
 
+    public static final Key<ConfigurationFactory> KEY = new Key<>() {};
+
     public static final Key<PluginNamespace> PLUGIN_NAMESPACE_KEY = new @Namespace(NAMESPACE) Key<>() {};
 
     /**
@@ -95,8 +96,15 @@ public abstract class ConfigurationFactory extends ConfigurationBuilderFactory i
      */
     private static final String CLASS_PATH_SCHEME = "classpath";
 
+    protected abstract String[] getSupportedTypes();
+
+    @Override
+    public String[] getSupportedExtensions() {
+        return getSupportedTypes();
+    }
+
     @Deprecated(since = "3.0.0", forRemoval = true)
-    public static URIConfigurationFactory getInstance() {
+    public static ConfigurationFactory getInstance() {
         return LoggerContext.getContext(false).getInstanceFactory().getInstance(KEY);
     }
 
@@ -106,7 +114,7 @@ public static URIConfigurationFactory getInstance() {
      * @return the AuthorizationProvider, if any.
      */
     public static AuthorizationProvider authorizationProvider(final PropertiesUtil props) {
-        return AuthorizationProvider.getAuthorizationProvider((PropertyEnvironment) props);
+        return AuthorizationProvider.getAuthorizationProvider(props);
     }
 
     @Override
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultConfigurationFactory.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/DefaultConfigurationFactory.java
@@ -100,7 +100,7 @@ public Configuration getConfiguration(
                 }
             }
             for (final URIConfigurationFactory factory : configurationFactories) {
-                final String[] types = factory.getSupportedTypes();
+                final String[] types = factory.getSupportedExtensions();
                 if (types != null) {
                     for (final String type : types) {
                         if (type.equals(ALL_TYPES)) {
@@ -131,7 +131,7 @@ public Configuration getConfiguration(
             }
             final String configLocationStr = configLocation.toString();
             for (final URIConfigurationFactory factory : configurationFactories) {
-                final String[] types = factory.getSupportedTypes();
+                final String[] types = factory.getSupportedExtensions();
                 if (types != null) {
                     for (final String type : types) {
                         if (type.equals(ALL_TYPES) || configLocationStr.endsWith(type)) {
@@ -186,7 +186,7 @@ private Configuration getConfiguration(
                 if (requiredVersion != null && !factory.getVersion().equals(requiredVersion)) {
                     continue;
                 }
-                final String[] types = factory.getSupportedTypes();
+                final String[] types = factory.getSupportedExtensions();
                 if (types != null) {
                     for (final String type : types) {
                         if (type.equals(ALL_TYPES) || configLocation.endsWith(type)) {
@@ -212,7 +212,7 @@ private Configuration getConfiguration(
         for (final URIConfigurationFactory factory : configurationFactories) {
             String configName;
             final String prefix = isTest ? factory.getTestPrefix() : factory.getDefaultPrefix();
-            final String[] types = factory.getSupportedTypes();
+            final String[] types = factory.getSupportedExtensions();
             if (types == null) {
                 continue;
             }
@@ -241,7 +241,7 @@ private Configuration getConfiguration(
     }
 
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         return null;
     }
 
@@ -252,7 +252,7 @@ public Configuration getConfiguration(final LoggerContext loggerContext, final C
                     loadConfigurationFactories(loggerContext.getInstanceFactory());
             final String config = source.getLocation();
             for (final URIConfigurationFactory factory : configurationFactories) {
-                final String[] types = factory.getSupportedTypes();
+                final String[] types = factory.getSupportedExtensions();
                 if (types != null) {
                     for (final String type : types) {
                         if (type.equals(ALL_TYPES) || config != null && config.endsWith(type)) {
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/URIConfigurationFactory.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/URIConfigurationFactory.java
@@ -46,7 +46,7 @@ public interface URIConfigurationFactory {
      *     Can contain {@code *}, if an attempt should be made to parse files with any file extension.
      * </p>
      */
-    String[] getSupportedTypes();
+    String[] getSupportedExtensions();
 
     /**
      * The version of the configuration format.
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/json/JsonConfigurationFactory.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/json/JsonConfigurationFactory.java
@@ -35,7 +35,7 @@ public class JsonConfigurationFactory extends ConfigurationFactory {
     private static final String[] SUFFIXES = new String[] {".json", ".jsn"};
 
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         return SUFFIXES;
     }
 
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/config/xml/XmlConfigurationFactory.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/config/xml/XmlConfigurationFactory.java
@@ -53,7 +53,7 @@ public Configuration getConfiguration(final LoggerContext loggerContext, final C
      * @return An array of File extensions.
      */
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         return SUFFIXES;
     }
 }
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/DefaultBundle.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/impl/DefaultBundle.java
@@ -160,12 +160,21 @@ public RuntimeStrSubstitutor runtimeStrSubstitutor(final InterpolatorFactory fac
         return new RuntimeStrSubstitutor(factory.newInterpolator(null));
     }
 
+    /**
+     * Spring Boot needs a ConfigurationFactory for compatibility.
+     */
     @SingletonFactory
     @ConditionalOnMissingBinding
-    public URIConfigurationFactory configurationFactory() {
+    public ConfigurationFactory configurationFactory() {
         return new DefaultConfigurationFactory();
     }
 
+    @SingletonFactory
+    @ConditionalOnMissingBinding
+    public URIConfigurationFactory configurationFactory(final ConfigurationFactory factory) {
+        return factory;
+    }
+
     @SingletonFactory
     @ConditionalOnMissingBinding
     public MergeStrategy defaultMergeStrategy() {
diff --git a/log4j-osgi-test/src/test/java/org/apache/logging/log4j/osgi/tests/CustomConfigurationFactory.java b/log4j-osgi-test/src/test/java/org/apache/logging/log4j/osgi/tests/CustomConfigurationFactory.java
@@ -59,7 +59,7 @@ public Configuration getConfiguration(
      * @return An array of File extensions.
      */
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         return SUFFIXES;
     }
 }
diff --git a/log4j-script/src/test/java/org/apache/logging/log4j/script/config/builder/CustomConfigurationFactory.java b/log4j-script/src/test/java/org/apache/logging/log4j/script/config/builder/CustomConfigurationFactory.java
@@ -77,7 +77,7 @@ public Configuration getConfiguration(
     }
 
     @Override
-    public String[] getSupportedTypes() {
+    protected String[] getSupportedTypes() {
         return new String[] {"*"};
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public Configuration getConfiguration(final LoggerContext loggerContext, final C`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`@Override`
`54`		`- public String[] getSupportedTypes() {`
	`54`	`+ protected String[] getSupportedTypes() {`
`55`	`55`	`return SUFFIXES;`
`56`	`56`	`}`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`public class BasicConfigurationFactory extends ConfigurationFactory {`
`32`	`32`
`33`	`33`	`@Override`
`34`		`- public String[] getSupportedTypes() {`
	`34`	`+ protected String[] getSupportedTypes() {`
`35`	`35`	`return new String[] {"*"};`
`36`	`36`	`}`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public Configuration getConfiguration(final LoggerContext loggerContext, final C`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`@Override`
`43`		`- public String[] getSupportedTypes() {`
	`43`	`+ protected String[] getSupportedTypes() {`
`44`	`44`	`return SUFFIXES;`
`45`	`45`	`}`
`46`	`46`	`}`