Package org.apache.logging.log4j.core.async

Class AsyncLoggerContext

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.LoggerContext

org.apache.logging.log4j.core.async.AsyncLoggerContext

All Implemented Interfaces:

AutoCloseable, ConfigurationListener, LifeCycle, LifeCycle2, LoggerContext, LoggerContextShutdownEnabled, Terminable

public class AsyncLoggerContext
extends LoggerContext

LoggerContext that creates AsyncLogger objects.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields inherited from class org.apache.logging.log4j.core.LoggerContext

PROPERTY_CONFIG

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface org.apache.logging.log4j.spi.LoggerContext

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
AsyncLoggerContext(String name)
AsyncLoggerContext(String name, Object externalContext)
AsyncLoggerContext(String name, Object externalContext, String configLocn)
AsyncLoggerContext(String name, Object externalContext, URI configLocn)

Method Summary

Modifier and Type	Method	Description
RingBufferAdmin	createRingBufferAdmin()	Creates and returns a new RingBufferAdmin that instruments the ringbuffer of the AsyncLogger objects in this LoggerContext.
protected Logger	newInstance(LoggerContext ctx, String name, MessageFactory messageFactory)	Callback to create a new logger.
void	setName(String name)	Sets the name.
void	setUseThreadLocals(boolean useThreadLocals)	Signals this context whether it is allowed to use ThreadLocal objects for efficiency.
void	start()	Starts the context using the configuration specified by LoggerContext.getConfigLocation().
void	start(Configuration config)	Starts the context using a specific configuration.
boolean	stop(long timeout, TimeUnit timeUnit)	Blocks until all Log4j tasks have completed execution after a shutdown request and all appenders have shut down, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Methods inherited from class org.apache.logging.log4j.core.LoggerContext

addFilter, addPropertyChangeListener, addShutdownListener, close, getConfigLocation, getConfiguration, getContext, getContext, getContext, getExternalContext, getListeners, getLogger, getLogger, getLoggerRegistry, getLoggers, getName, getObject, getRootLogger, hasLogger, hasLogger, hasLogger, onChange, putObject, putObjectIfAbsent, reconfigure, reconfigure, removeFilter, removeObject, removeObject, removePropertyChangeListener, setConfigLocation, setConfiguration, setExternalContext, terminate, updateLoggers, updateLoggers

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.spi.LoggerContext

getLogger, getLogger

Constructor Details

AsyncLoggerContext

public AsyncLoggerContext(String name)

AsyncLoggerContext

public AsyncLoggerContext(String name,
 Object externalContext)

AsyncLoggerContext

public AsyncLoggerContext(String name,
 Object externalContext,
 URI configLocn)

AsyncLoggerContext

public AsyncLoggerContext(String name,
 Object externalContext,
 String configLocn)

Method Details

newInstance

protected Logger newInstance(LoggerContext ctx,
 String name,
 MessageFactory messageFactory)

Description copied from class: LoggerContext

Callback to create a new logger.

Overrides:

newInstance in class LoggerContext

Parameters:

ctx - The LoggerContext this logger is associated with, never null.

name - The logger name, never null.

messageFactory - The message factory to be used, never null.

Returns:

A new logger instance.

setName

public void setName(String name)

Description copied from class: LoggerContext

Sets the name.

Overrides:

setName in class LoggerContext

Parameters:

name - the new LoggerContext name

start

public void start()

Description copied from class: LoggerContext

Starts the context using the configuration specified by LoggerContext.getConfigLocation().

If the configuration location is null, Log4j will search for a configuration file using the default classpath resources. For details on the search order and supported formats, see the Log4j 2 Configuration File Location documentation.

Specified by:

start in interface LifeCycle

Overrides:

start in class LoggerContext

start

public void start(Configuration config)

Description copied from class: LoggerContext

Starts the context using a specific configuration.

Warning: For backward compatibility, especially with Spring Boot, if the context is already started, this method will fall back to LoggerContext.reconfigure(Configuration). This behavior is maintained for legacy integrations and may change in future major versions. New code should not rely on this fallback.

Overrides:

start in class LoggerContext

Parameters:

config - The new Configuration to use for this context

stop

public boolean stop(long timeout,
 TimeUnit timeUnit)

Description copied from class: LoggerContext

Blocks until all Log4j tasks have completed execution after a shutdown request and all appenders have shut down, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Not all appenders will honor this, it is a hint and not an absolute guarantee that the this method not block longer. Setting timeout too low increase the risk of losing outstanding log events not yet written to the final destination.

Log4j can start threads to perform certain actions like file rollovers, calling this method with a positive timeout will block until the rollover thread is done.

Specified by:

stop in interface LifeCycle2

Overrides:

stop in class LoggerContext

Parameters:

timeout - the maximum time to wait, or 0 which mean that each apppender uses its default timeout, and don't wait for background tasks

timeUnit - the time unit of the timeout argument

Returns:

true if the logger context terminated and false if the timeout elapsed before termination.

createRingBufferAdmin

public RingBufferAdmin createRingBufferAdmin()

Creates and returns a new RingBufferAdmin that instruments the ringbuffer of the AsyncLogger objects in this LoggerContext.

Returns:

a new RingBufferAdmin that instruments the ringbuffer

setUseThreadLocals

public void setUseThreadLocals(boolean useThreadLocals)

Signals this context whether it is allowed to use ThreadLocal objects for efficiency.

Parameters:

useThreadLocals - whether this context is allowed to use ThreadLocal objects