Skip to content

Commit

Permalink
Formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@ppkarwasz
ppkarwasz committed Jan 24, 2025
1 parent af0cb3a commit dffa4b8
Showing 1 changed file with 52 additions and 100 deletions.
152 changes: 52 additions & 100 deletions log4j-core/src/main/java/org/apache/logging/log4j/core/config/AbstractConfiguration.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,7 @@
import org.apache.logging.log4j.util.PropertiesUtil;

/**
* The base Configuration. Many configuration implementations will extend this
* class.
* The base Configuration. Many configuration implementations will extend this class.
*/
public abstract class AbstractConfiguration extends AbstractFilterable implements Configuration {

Expand Down Expand Up @@ -154,8 +153,7 @@ protected AbstractConfiguration(final LoggerContext loggerContext, final Configu
this.loggerContext = new WeakReference<>(loggerContext);
tempLookup.setLoggerContext(loggerContext);
// The loggerContext is null for the NullConfiguration class.
// this.loggerContext = new WeakReference(Objects.requireNonNull(loggerContext,
// "loggerContext is null"));
// this.loggerContext = new WeakReference(Objects.requireNonNull(loggerContext, "loggerContext is null"));
this.configurationSource = Objects.requireNonNull(configurationSource, "configurationSource is null");
componentMap.put(CONTEXT_PROPERTIES, propertyMap);
pluginManager = new PluginManager(Node.CATEGORY);
Expand Down Expand Up @@ -284,8 +282,8 @@ protected void initializeWatchers(
if (file != null) {
final Source cfgSource = new Source(file);
final long lastModified = file.lastModified();
final ConfigurationFileWatcher watcher = new ConfigurationFileWatcher(this, reconfigurable,
listeners, lastModified);
final ConfigurationFileWatcher watcher =
new ConfigurationFileWatcher(this, reconfigurable, listeners, lastModified);
watchManager.watch(cfgSource, watcher);
} else if (configSource.getURL() != null) {
monitorSource(reconfigurable, configSource);
Expand Down Expand Up @@ -371,20 +369,15 @@ public boolean stop(final long timeout, final TimeUnit timeUnit) {
super.stop(timeout, timeUnit, false);

// Stop the components that are closest to the application first:
// 1. Notify all LoggerConfigs' ReliabilityStrategy that the configuration will
// be stopped.
// 1. Notify all LoggerConfigs' ReliabilityStrategy that the configuration will be stopped.
// 2. Stop the LoggerConfig objects (this may stop nested Filters)
// 3. Stop the AsyncLoggerConfigDelegate. This shuts down the AsyncLoggerConfig
// Disruptor
// and waits until all events in the RingBuffer have been processed.
// 3. Stop the AsyncLoggerConfigDelegate. This shuts down the AsyncLoggerConfig Disruptor
// and waits until all events in the RingBuffer have been processed.
// 4. Stop all AsyncAppenders. This shuts down the associated thread and
// waits until all events in the queue have been processed. (With optional
// timeout.)
// 5. Notify all LoggerConfigs' ReliabilityStrategy that appenders will be
// stopped.
// This guarantees that any event received by a LoggerConfig before
// reconfiguration
// are passed on to the Appenders before the Appenders are stopped.
// waits until all events in the queue have been processed. (With optional timeout.)
// 5. Notify all LoggerConfigs' ReliabilityStrategy that appenders will be stopped.
// This guarantees that any event received by a LoggerConfig before reconfiguration
// are passed on to the Appenders before the Appenders are stopped.
// 6. Stop the remaining running Appenders. (It should now be safe to do so.)
// 7. Notify all LoggerConfigs that their Appenders can be cleaned up.

Expand Down Expand Up @@ -579,10 +572,8 @@ protected void preConfigure(final Node node) {
}

/**
* Process conditions by evaluating them and including the children of
* conditions that are true
* Process conditions by evaluating them and including the children of conditions that are true
* and discarding those that are not.
*
* @param node The node to evaluate.
*/
protected void processConditionals(final Node node) {
Expand Down Expand Up @@ -632,12 +623,10 @@ protected void processConditionals(final Node node) {
}

/**
* Handle Select nodes. This finds the first child condition that returns true
* and attaches its children
* Handle Select nodes. This finds the first child condition that returns true and attaches its children
* to the parent of the Select Node. Other Nodes are discarded.
*
* @param selectNode The Select Node.
* @param type The PluginType of the Select Node.
* @param type The PluginType of the Select Node.
* @return The list of Nodes to be added to the parent.
*/
protected List<Node> processSelect(final Node selectNode, final PluginType<?> type) {
Expand Down Expand Up @@ -674,7 +663,7 @@ protected void doConfigure() {
processConditionals(rootNode);
preConfigure(rootNode);
configurationScheduler.start();

// Find the "Properties" node first
boolean hasProperties = false;
for (final Node node : rootNode.getChildren()) {
if ("Properties".equalsIgnoreCase(node.getName())) {
Expand Down Expand Up @@ -768,6 +757,7 @@ protected void doConfigure() {
LOGGER.warn(
"No Root logger was configured, creating default ERROR-level Root logger with Console appender");
setToDefault();
// return; // LOG4J2-219: creating default root=ok, but don't exclude configured Loggers
}

for (final Map.Entry<String, LoggerConfig> entry : loggerConfigs.entrySet()) {
Expand Down Expand Up @@ -847,8 +837,7 @@ public void removeListener(final ConfigurationListener listener) {
* Returns the Appender with the specified name.
*
* @param appenderName The name of the Appender.
* @return the Appender with the specified name or null if the Appender cannot
* be located.
* @return the Appender with the specified name or null if the Appender cannot be located.
*/
@Override
@SuppressWarnings("unchecked")
Expand Down Expand Up @@ -901,8 +890,7 @@ public Advertiser getAdvertiser() {
/*
* (non-Javadoc)
*
* @see org.apache.logging.log4j.core.config.ReliabilityStrategyFactory#
* getReliabilityStrategy(org.apache.logging.log4j
* @see org.apache.logging.log4j.core.config.ReliabilityStrategyFactory#getReliabilityStrategy(org.apache.logging.log4j
* .core.config.LoggerConfig)
*/
@Override
Expand All @@ -911,15 +899,12 @@ public ReliabilityStrategy getReliabilityStrategy(final LoggerConfig loggerConfi
}

/**
* Associates an Appender with a LoggerConfig. This method is synchronized in
* case a Logger with the same name is
* Associates an Appender with a LoggerConfig. This method is synchronized in case a Logger with the same name is
* being updated at the same time.
* <p>
* Note: This method is not used when configuring via configuration. It is
* primarily used by unit tests.
* Note: This method is not used when configuring via configuration. It is primarily used by unit tests.
* </p>
*
* @param logger The Logger the Appender will be associated with.
* @param logger The Logger the Appender will be associated with.
* @param appender The Appender.
*/
@Override
Expand All @@ -944,14 +929,11 @@ public synchronized void addLoggerAppender(
}

/**
* Associates a Filter with a LoggerConfig. This method is synchronized in case
* a Logger with the same name is being
* Associates a Filter with a LoggerConfig. This method is synchronized in case a Logger with the same name is being
* updated at the same time.
* <p>
* Note: This method is not used when configuring via configuration. It is
* primarily used by unit tests.
* Note: This method is not used when configuring via configuration. It is primarily used by unit tests.
* </p>
*
* @param logger The Logger the Footer will be associated with.
* @param filter The Filter.
*/
Expand All @@ -972,15 +954,12 @@ public synchronized void addLoggerFilter(final org.apache.logging.log4j.core.Log
}

/**
* Marks a LoggerConfig as additive. This method is synchronized in case a
* Logger with the same name is being
* Marks a LoggerConfig as additive. This method is synchronized in case a Logger with the same name is being
* updated at the same time.
* <p>
* Note: This method is not used when configuring via configuration. It is
* primarily used by unit tests.
* Note: This method is not used when configuring via configuration. It is primarily used by unit tests.
* </p>
*
* @param logger The Logger the Appender will be associated with.
* @param logger The Logger the Appender will be associated with.
* @param additive True if the LoggerConfig should be additive, false otherwise.
*/
@Override
Expand All @@ -1000,10 +979,8 @@ public synchronized void setLoggerAdditive(
}

/**
* Remove an Appender. First removes any associations between LoggerConfigs and
* the Appender, removes the Appender
* from this appender list and then stops the appender. This method is
* synchronized in case an Appender with the
* Remove an Appender. First removes any associations between LoggerConfigs and the Appender, removes the Appender
* from this appender list and then stops the appender. This method is synchronized in case an Appender with the
* same name is being added during the removal.
*
* @param appenderName the name of the appender to remove.
Expand All @@ -1030,8 +1007,7 @@ public List<CustomLevelConfig> getCustomLevels() {
}

/**
* Locates the appropriate LoggerConfig for a Logger name. This will remove
* tokens from the package name as
* Locates the appropriate LoggerConfig for a Logger name. This will remove tokens from the package name as
* necessary or return the root LoggerConfig if no other matches were found.
*
* @param loggerName The Logger name.
Expand Down Expand Up @@ -1071,8 +1047,7 @@ public LoggerConfig getRootLogger() {
/**
* Returns a Map of all the LoggerConfigs.
*
* @return a Map with each entry containing the name of the Logger and the
* LoggerConfig.
* @return a Map with each entry containing the name of the Logger and the LoggerConfig.
*/
@Override
public Map<String, LoggerConfig> getLoggers() {
Expand All @@ -1090,11 +1065,10 @@ public LoggerConfig getLogger(final String loggerName) {
}

/**
* Add a loggerConfig. The LoggerConfig must already be configured with
* Appenders, Filters, etc. After addLogger is
* Add a loggerConfig. The LoggerConfig must already be configured with Appenders, Filters, etc. After addLogger is
* called LoggerContext.updateLoggers must be called.
*
* @param loggerName The name of the Logger.
* @param loggerName The name of the Logger.
* @param loggerConfig The LoggerConfig.
*/
@Override
Expand Down Expand Up @@ -1136,7 +1110,6 @@ public void createConfiguration(final Node node, final LogEvent event) {

/**
* This method is used by Arbiters to create specific children.
*
* @param type The PluginType.
* @param node The Node.
* @return The created object or null;
Expand All @@ -1151,58 +1124,39 @@ public Object createPluginObject(final PluginType<?> type, final Node node) {
}

/**
* Invokes a static factory method to either create the desired object or to
* create a builder object that creates
* the desired object. In the case of a factory method, it should be annotated
* with
* {@link org.apache.logging.log4j.core.config.plugins.PluginFactory}, and each
* parameter should be annotated with
* an appropriate plugin annotation depending on what that parameter describes.
* Parameters annotated with
* {@link org.apache.logging.log4j.core.config.plugins.PluginAttribute} must be
* a type that can be converted from a
* string using one of the
* {@link org.apache.logging.log4j.core.config.plugins.convert.TypeConverter
* TypeConverters}
* . Parameters with
* {@link org.apache.logging.log4j.core.config.plugins.PluginElement} may be any
* plugin class or
* an array of a plugin class. Collections and Maps are currently not supported,
* although the factory method that is
* Invokes a static factory method to either create the desired object or to create a builder object that creates
* the desired object. In the case of a factory method, it should be annotated with
* {@link org.apache.logging.log4j.core.config.plugins.PluginFactory}, and each parameter should be annotated with
* an appropriate plugin annotation depending on what that parameter describes. Parameters annotated with
* {@link org.apache.logging.log4j.core.config.plugins.PluginAttribute} must be a type that can be converted from a
* string using one of the {@link org.apache.logging.log4j.core.config.plugins.convert.TypeConverter TypeConverters}
* . Parameters with {@link org.apache.logging.log4j.core.config.plugins.PluginElement} may be any plugin class or
* an array of a plugin class. Collections and Maps are currently not supported, although the factory method that is
* called can create these from an array.
* <p>
* Plugins can also be created using a builder class that implements
* {@link org.apache.logging.log4j.core.util.Builder}. In that case, a static
* method annotated with
* {@link org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute}
* should create the builder class, and
* the various fields in the builder class should be annotated similarly to the
* method parameters. However, instead
* {@link org.apache.logging.log4j.core.util.Builder}. In that case, a static method annotated with
* {@link org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute} should create the builder class, and
* the various fields in the builder class should be annotated similarly to the method parameters. However, instead
* of using PluginAttribute, one should use
* {@link org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute}
* where the default value can be
* specified as the default field value instead of as an additional annotation
* parameter.
* {@link org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute} where the default value can be
* specified as the default field value instead of as an additional annotation parameter.
* </p>
* <p>
* In either case, there are also annotations for specifying a
* {@link org.apache.logging.log4j.core.config.Configuration} (
* {@link org.apache.logging.log4j.core.config.plugins.PluginConfiguration}) or
* a
* {@link org.apache.logging.log4j.core.config.plugins.PluginConfiguration}) or a
* {@link org.apache.logging.log4j.core.config.Node} (
* {@link org.apache.logging.log4j.core.config.plugins.PluginNode}).
* </p>
* <p>
* Although the happy path works, more work still needs to be done to log
* incorrect parameters. These will generally
* Although the happy path works, more work still needs to be done to log incorrect parameters. These will generally
* result in unhelpful InvocationTargetExceptions.
* </p>
*
* @param type the type of plugin to create.
* @param node the corresponding configuration node for this plugin to create.
* @param type the type of plugin to create.
* @param node the corresponding configuration node for this plugin to create.
* @param event the LogEvent that spurred the creation of this plugin
* @return the created plugin object or {@code null} if there was an error
* setting it up.
* @return the created plugin object or {@code null} if there was an error setting it up.
* @see org.apache.logging.log4j.core.config.plugins.util.PluginBuilder
* @see org.apache.logging.log4j.core.config.plugins.visitors.PluginVisitor
* @see org.apache.logging.log4j.core.config.plugins.convert.TypeConverter
Expand Down Expand Up @@ -1273,14 +1227,12 @@ private void setParents() {
}

/**
* Reads an InputStream using buffered reads into a byte array buffer. The given
* InputStream will remain open after
* Reads an InputStream using buffered reads into a byte array buffer. The given InputStream will remain open after
* invocation of this method.
*
* @param is the InputStream to read into a byte array buffer.
* @return a byte array of the InputStream contents.
* @throws IOException if the {@code read} method of the provided InputStream
* throws this exception.
* @throws IOException if the {@code read} method of the provided InputStream throws this exception.
*/
protected static byte[] toByteArray(final InputStream is) throws IOException {
final ByteArrayOutputStream buffer = new ByteArrayOutputStream();
Expand Down

0 comments on commit dffa4b8

Please sign in to comment.