Package org.apache.logging.log4j.spi

Interface LoggerContext

All Known Implementing Classes:

AsyncLoggerContext, LoggerContext, SimpleLoggerContext, SLF4JLoggerContext

public interface LoggerContext

Anchor point for logging implementations.

Method Summary

Modifier and Type	Method	Description
Object	getExternalContext()	An anchor for some other context, such as a ClassLoader or ServletContext.
ExtendedLogger	getLogger(String name)	Returns an ExtendedLogger.
ExtendedLogger	getLogger(String name, MessageFactory messageFactory)	Returns an ExtendedLogger.
boolean	hasLogger(String name)	Detects if a Logger with the specified name exists.
boolean	hasLogger(String name, Class<? extends MessageFactory> messageFactoryClass)	Detects if a Logger with the specified name and MessageFactory type exists.
boolean	hasLogger(String name, MessageFactory messageFactory)	Detects if a Logger with the specified name and MessageFactory exists.

Method Detail

getExternalContext

Object getExternalContext()

An anchor for some other context, such as a ClassLoader or ServletContext.

Returns:

The external context.

getLogger

ExtendedLogger getLogger(String name)

Returns an ExtendedLogger.

Parameters:

name - The name of the Logger to return.

Returns:

The logger with the specified name.

getLogger

ExtendedLogger getLogger(String name,
                         MessageFactory messageFactory)

Returns an ExtendedLogger.

Parameters:

name - The name of the Logger to return.

messageFactory - The message factory is used only when creating a logger, subsequent use does not change the logger but will log a warning if mismatched.

Returns:

The logger with the specified name.

hasLogger

boolean hasLogger(String name)

Detects if a Logger with the specified name exists.

Parameters:

name - The Logger name to search for.

Returns:

true if the Logger exists, false otherwise.

hasLogger

boolean hasLogger(String name,
                  MessageFactory messageFactory)

Detects if a Logger with the specified name and MessageFactory exists.

Parameters:

name - The Logger name to search for.

messageFactory - The message factory to search for.

Returns:

true if the Logger exists, false otherwise.

Since:

2.5

hasLogger

boolean hasLogger(String name,
                  Class<? extends MessageFactory> messageFactoryClass)

Detects if a Logger with the specified name and MessageFactory type exists.

Parameters:

name - The Logger name to search for.

messageFactoryClass - The message factory class to search for.

Returns:

true if the Logger exists, false otherwise.

Since:

2.5