Package org.apache.logging.log4j.core.config.status

Class StatusConfiguration

java.lang.Object

org.apache.logging.log4j.core.config.status.StatusConfiguration

public class StatusConfiguration
extends java.lang.Object

Configuration for setting up the StatusLogger fallback listener.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StatusConfiguration.Verbosity	Deprecated. This class is not used anymore and only kept for binary backward compatibility.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	initialized
private @Nullable Level	level
private java.util.concurrent.locks.Lock	lock
private static StatusLogger	LOGGER
private @Nullable java.io.PrintStream	output

Constructor Summary

Constructors

Constructor	Description
StatusConfiguration()

Method Summary

Modifier and Type	Method	Description
void	error(java.lang.String message)	Deprecated. Use StatusLogger.getLogger() and then AbstractLogger.error(String) instead.
void	initialize()	Configures and initializes the StatusLogger using the configured options in this instance.
private static @Nullable java.io.PrintStream	parseStreamName(@Nullable java.lang.String name)
StatusConfiguration	withDestination(@Nullable java.lang.String destination)	Sets the output of the StatusLogger fallback listener.
StatusConfiguration	withStatus(@Nullable java.lang.String level)	Sets the level of the StatusLogger fallback listener.
StatusConfiguration	withStatus(@Nullable Level level)	Sets the level of the StatusLogger fallback listener.
StatusConfiguration	withVerboseClasses(java.lang.String... verboseClasses)	Deprecated. This method is ineffective and only kept for binary backward compatibility.
StatusConfiguration	withVerbosity(java.lang.String verbosity)	Deprecated. This method is ineffective and only kept for binary backward compatibility.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

private static final StatusLogger LOGGER

lock

private final java.util.concurrent.locks.Lock lock

initialized

private volatile boolean initialized

output

private @Nullable java.io.PrintStream output

level

private @Nullable Level level

Constructor Detail

StatusConfiguration

public StatusConfiguration()

Method Detail

error

@Deprecated
public void error(java.lang.String message)

Deprecated.

Use StatusLogger.getLogger() and then AbstractLogger.error(String) instead.

Logs an error message to the StatusLogger.

Parameters:

message - error message to log

withDestination

public StatusConfiguration withDestination(@Nullable java.lang.String destination)

Sets the output of the StatusLogger fallback listener.

Accepted values are as follows:

• out (i.e., System.out)
• err (i.e., System.err)
• a URI (e.g., file:///path/to/log4j-status-logs.txt)

Invalid values will be ignored.

Parameters:

destination - destination where StatusLogger messages should be output

Returns:

this

parseStreamName

private static @Nullable java.io.PrintStream parseStreamName(@Nullable java.lang.String name)
                                                      throws java.net.URISyntaxException,
                                                             java.io.FileNotFoundException

Throws:

java.net.URISyntaxException

java.io.FileNotFoundException

withStatus

public StatusConfiguration withStatus(@Nullable java.lang.String level)

Sets the level of the StatusLogger fallback listener.

Parameters:

level - a level name

Returns:

this

withStatus

public StatusConfiguration withStatus(@Nullable Level level)

Sets the level of the StatusLogger fallback listener.

Parameters:

level - a level

Returns:

this

withVerbosity

@Deprecated
public StatusConfiguration withVerbosity(java.lang.String verbosity)

Deprecated.

This method is ineffective and only kept for binary backward compatibility.

Specifies the verbosity level to log at. This only applies to classes configured by verboseClasses.

Parameters:

verbosity - basic filter for status logger messages.

Returns:

this

withVerboseClasses

@Deprecated
public StatusConfiguration withVerboseClasses(java.lang.String... verboseClasses)

Deprecated.

This method is ineffective and only kept for binary backward compatibility.

Specifies which class names to filter if the configured verbosity level is QUIET.

Parameters:

verboseClasses - names of classes to filter if not using VERBOSE.

Returns:

this

initialize

public void initialize()

Configures and initializes the StatusLogger using the configured options in this instance.