Logback Classic Module 1.5.1 · ch.qos.logback.classic.LoggerContext

Modifier and Type	Field and Description
public static final boolean	DEFAULT_PACKAGING_DATA Default setting of packaging data in stack traces
private List<String>	frameworkPackages
private Map<String, Logger>	loggerCache
private final List<LoggerContextListener>	loggerContextListenerList
private LoggerContextVO	loggerContextRemoteView
private int	maxCallerDataDepth
pack-priv MDCAdapter	mdcAdapter
private int	noAppenderWarning
private boolean	packagingDataEnabled
pack-priv int	resetCount
pack-priv final Logger	root
pack-priv SequenceNumberGenerator	sequenceNumberGenerator Hides ch.qos.logback.core.ContextBase.sequenceNumberGenerator.
private int	size
private final TurboFilterList	turboFilterList

Access	Constructor and Description
public	LoggerContext()

Method Summary

Modifier and Type	Method and Description
public void	addListener(LoggerContextListener listener)
public void	addTurboFilter(TurboFilter newFilter)
private void	cancelScheduledTasks()
public Logger	exists(String the name of the logger to search for. name) Check if the named logger exists in the hierarchy.
pack-priv void	fireOnLevelChange(Logger logger, Level level)
private void	fireOnReset()
private void	fireOnStart()
private void	fireOnStop()
public List<LoggerContextListener>	getCopyOfListenerList()
public List<String>	Returns: list of framework packages getFrameworkPackages() List of packages considered part of the logging framework such that they are never considered as callers of the logging framework.
public final Logger	getLogger(final Class<?> clazz)
public Logger	getLogger(final String the name of the Logger to return name) Implements org.slf4j.ILoggerFactory.getLogger. Return an appropriate `Logger` instance as specified by the `name` parameter.
public LoggerContextVO	getLoggerContextRemoteView()
public List<Logger>	getLoggerList()
public int	getMaxCallerDataDepth()
public MDCAdapter	getMDCAdapter()
public SequenceNumberGenerator	getSequenceNumberGenerator() Overrides ch.qos.logback.core.ContextBase.getSequenceNumberGenerator. Implements ch.qos.logback.core.Context.getSequenceNumberGenerator.
pack-priv final FilterReply	getTurboFilterChainDecision_0_3OrMore(final Marker marker, final Logger logger, final Level level, final String format, final Object[] params, final Throwable t)
pack-priv final FilterReply	getTurboFilterChainDecision_1(final Marker marker, final Logger logger, final Level level, final String format, final Object param, final Throwable t)
pack-priv final FilterReply	getTurboFilterChainDecision_2(final Marker marker, final Logger logger, final Level level, final String format, final Object param1, final Object param2, final Throwable t)
public TurboFilterList	getTurboFilterList()
private void	incSize()
pack-priv void	initEvaluatorMap()
public boolean	isPackagingDataEnabled()
pack-priv final void	noAppenderDefinedWarning(final Logger logger)
public void	putProperty(String key, String val) Overrides ch.qos.logback.core.ContextBase.putProperty. Implements ch.qos.logback.core.Context.putProperty. Set a property of this context.
public void	removeListener(LoggerContextListener listener)
public void	reset() Overrides ch.qos.logback.core.ContextBase.reset. This method clears all internal properties, except internal status messages, closes all appenders, removes any turboFilters, fires an OnReset event, removes all status listeners, removes all context listeners (except those which are reset resistant).
private void	resetAllListeners()
private void	resetListenersExceptResetResistant()
private void	resetStatusListenersExceptResetResistant()
public void	resetTurboFilterList() First processPriorToRemoval all registered turbo filters and then clear the registration list.
public void	setMaxCallerDataDepth(int maxCallerDataDepth)
public void	setMDCAdapter(MDCAdapter anAdapter)
public void	setName(String name) Overrides ch.qos.logback.core.ContextBase.setName. Implements ch.qos.logback.core.Context.setName. The context name can be set only if it is not already set, or if the current name is the default context name, namely "default", or if the current name and the old name are the same.
public void	setPackagingDataEnabled(boolean packagingDataEnabled)
public void	setSequenceNumberGenerator(SequenceNumberGenerator sng) Overrides ch.qos.logback.core.ContextBase.setSequenceNumberGenerator. Implements ch.qos.logback.core.Context.setSequenceNumberGenerator.
pack-priv int	size()
public void	start() Overrides ch.qos.logback.core.ContextBase.start. Implements ch.qos.logback.core.spi.LifeCycle.start.
public void	stop() Overrides ch.qos.logback.core.ContextBase.stop. Implements ch.qos.logback.core.spi.LifeCycle.stop.
public String	toString() Overrides ch.qos.logback.core.ContextBase.toString. Returns a string representation of the object.
private void	updateLoggerContextVO() A new instance of LoggerContextRemoteView needs to be created each time the name or propertyMap (including keys or values) changes.

DEFAULT_PACKAGING_DATA	back to summary
public static final boolean DEFAULT_PACKAGING_DATA Default setting of packaging data in stack traces

frameworkPackages	back to summary
private List<String> frameworkPackages

loggerCache	back to summary
private Map<String, Logger> loggerCache

loggerContextListenerList	back to summary
private final List<LoggerContextListener> loggerContextListenerList

loggerContextRemoteView	back to summary
private LoggerContextVO loggerContextRemoteView

maxCallerDataDepth	back to summary
private int maxCallerDataDepth

mdcAdapter	back to summary
pack-priv MDCAdapter mdcAdapter

noAppenderWarning	back to summary
private int noAppenderWarning

packagingDataEnabled	back to summary
private boolean packagingDataEnabled

resetCount	back to summary
pack-priv int resetCount

root	back to summary
pack-priv final Logger root

sequenceNumberGenerator	back to summary
pack-priv SequenceNumberGenerator sequenceNumberGenerator Hides ch.qos.logback.core.ContextBase.sequenceNumberGenerator.

size	back to summary
private int size

turboFilterList	back to summary
private final TurboFilterList turboFilterList

LoggerContext	back to summary
public LoggerContext()

Method Detail

addListener	back to summary
public void addListener(LoggerContextListener listener)

addTurboFilter	back to summary
public void addTurboFilter(TurboFilter newFilter)

cancelScheduledTasks	back to summary
private void cancelScheduledTasks()

exists back to summary

exists	back to summary
public Logger exists(String name) Check if the named logger exists in the hierarchy. If so return its reference, otherwise returns `null`. Parameters name:String the name of the logger to search for.

public Logger exists(String name)

Check if the named logger exists in the hierarchy. If so return its reference, otherwise returns null.

Parameters

name:String: the name of the logger to search for.

fireOnLevelChange	back to summary
pack-priv void fireOnLevelChange(Logger logger, Level level)

fireOnReset	back to summary
private void fireOnReset()

fireOnStart	back to summary
private void fireOnStart()

fireOnStop	back to summary
private void fireOnStop()

getCopyOfListenerList	back to summary
public List<LoggerContextListener> getCopyOfListenerList()

getFrameworkPackages	back to summary
public List<String> getFrameworkPackages() List of packages considered part of the logging framework such that they are never considered as callers of the logging framework. This list used to compute the caller for logging events. To designate package "com.foo" as well as all its subpackages as being part of the logging framework, simply add "com.foo" to this list. Returns:List<String> list of framework packages

getFrameworkPackages

back to summary

public List<String> getFrameworkPackages()

List of packages considered part of the logging framework such that they are never considered as callers of the logging framework. This list used to compute the caller for logging events.

To designate package "com.foo" as well as all its subpackages as being part of the logging framework, simply add "com.foo" to this list.

Returns:List<String>: list of framework packages

getLogger	back to summary
public final Logger getLogger(final Class<?> clazz)

getLogger back to summary

getLogger	back to summary
public Logger getLogger(final String name) Implements org.slf4j.ILoggerFactory.getLogger. Doc from org.slf4j.ILoggerFactory.getLogger. Return an appropriate `Logger` instance as specified by the `name` parameter. If the name parameter is equal to `Logger#ROOT_LOGGER_NAME`, that is the string value "ROOT" (case insensitive), then the root logger of the underlying logging system is returned. Null-valued name arguments are considered invalid. Certain extremely simple logging systems, e.g. NOP, may always return the same logger instance regardless of the requested name. Parameters name:String the name of the Logger to return Returns:Logger a Logger instance Annotations @Override

public Logger getLogger(final String name)

Implements org.slf4j.ILoggerFactory.getLogger.

Doc from org.slf4j.ILoggerFactory.getLogger.

Return an appropriate Logger instance as specified by the name parameter.

If the name parameter is equal to Logger#ROOT_LOGGER_NAME, that is the string value "ROOT" (case insensitive), then the root logger of the underlying logging system is returned.

Null-valued name arguments are considered invalid.

Certain extremely simple logging systems, e.g. NOP, may always return the same logger instance regardless of the requested name.

Parameters

name:String: the name of the Logger to return

Returns:Logger

a Logger instance

Annotations

@Override

getLoggerContextRemoteView	back to summary
public LoggerContextVO getLoggerContextRemoteView()

getLoggerList	back to summary
public List<Logger> getLoggerList()

getMaxCallerDataDepth	back to summary
public int getMaxCallerDataDepth()

getMDCAdapter	back to summary
public MDCAdapter getMDCAdapter()

getSequenceNumberGenerator	back to summary
public SequenceNumberGenerator getSequenceNumberGenerator() Overrides ch.qos.logback.core.ContextBase.getSequenceNumberGenerator. Implements ch.qos.logback.core.Context.getSequenceNumberGenerator. Annotations @Override

getSequenceNumberGenerator

back to summary

public SequenceNumberGenerator getSequenceNumberGenerator()

Overrides ch.qos.logback.core.ContextBase.getSequenceNumberGenerator.

Implements ch.qos.logback.core.Context.getSequenceNumberGenerator.

Annotations

@Override

getTurboFilterChainDecision_0_3OrMore	back to summary
pack-priv final FilterReply getTurboFilterChainDecision_0_3OrMore(final Marker marker, final Logger logger, final Level level, final String format, final Object[] params, final Throwable t)

getTurboFilterChainDecision_1	back to summary
pack-priv final FilterReply getTurboFilterChainDecision_1(final Marker marker, final Logger logger, final Level level, final String format, final Object param, final Throwable t)

getTurboFilterChainDecision_2	back to summary
pack-priv final FilterReply getTurboFilterChainDecision_2(final Marker marker, final Logger logger, final Level level, final String format, final Object param1, final Object param2, final Throwable t)

getTurboFilterList	back to summary
public TurboFilterList getTurboFilterList()

incSize	back to summary
private void incSize()

initEvaluatorMap	back to summary
pack-priv void initEvaluatorMap()

isPackagingDataEnabled	back to summary
public boolean isPackagingDataEnabled()

noAppenderDefinedWarning	back to summary
pack-priv final void noAppenderDefinedWarning(final Logger logger)

putProperty	back to summary
public void putProperty(String key, String val) Overrides ch.qos.logback.core.ContextBase.putProperty. Implements ch.qos.logback.core.Context.putProperty. Doc from ch.qos.logback.core.Context.putProperty. Set a property of this context. Annotations @Override

putProperty

back to summary

public void putProperty(String key, String val)

Overrides ch.qos.logback.core.ContextBase.putProperty.

Implements ch.qos.logback.core.Context.putProperty.

Doc from ch.qos.logback.core.Context.putProperty.

Set a property of this context.

Annotations

@Override

removeListener	back to summary
public void removeListener(LoggerContextListener listener)

reset	back to summary
public void reset() Overrides ch.qos.logback.core.ContextBase.reset. This method clears all internal properties, except internal status messages, closes all appenders, removes any turboFilters, fires an OnReset event, removes all status listeners, removes all context listeners (except those which are reset resistant). As mentioned above, internal status messages survive resets. Annotations @Override

reset

back to summary

public void reset()

Overrides ch.qos.logback.core.ContextBase.reset.

This method clears all internal properties, except internal status messages, closes all appenders, removes any turboFilters, fires an OnReset event, removes all status listeners, removes all context listeners (except those which are reset resistant).

As mentioned above, internal status messages survive resets.

Annotations

@Override

resetAllListeners	back to summary
private void resetAllListeners()

resetListenersExceptResetResistant	back to summary
private void resetListenersExceptResetResistant()

resetStatusListenersExceptResetResistant	back to summary
private void resetStatusListenersExceptResetResistant()

resetTurboFilterList	back to summary
public void resetTurboFilterList() First processPriorToRemoval all registered turbo filters and then clear the registration list.

setMaxCallerDataDepth	back to summary
public void setMaxCallerDataDepth(int maxCallerDataDepth)

setMDCAdapter	back to summary
public void setMDCAdapter(MDCAdapter anAdapter)

setName

back to summary

public void setName(String name)

Overrides ch.qos.logback.core.ContextBase.setName.

Implements ch.qos.logback.core.Context.setName.

Doc from ch.qos.logback.core.ContextBase.setName.

The context name can be set only if it is not already set, or if the current name is the default context name, namely "default", or if the current name and the old name are the same.

Annotations

@Override

setPackagingDataEnabled	back to summary
public void setPackagingDataEnabled(boolean packagingDataEnabled)

setSequenceNumberGenerator

back to summary

public void setSequenceNumberGenerator(SequenceNumberGenerator sng)

Overrides ch.qos.logback.core.ContextBase.setSequenceNumberGenerator.

Implements ch.qos.logback.core.Context.setSequenceNumberGenerator.

Annotations

@Override

size	back to summary
pack-priv int size()

start

back to summary

public void start()

Overrides ch.qos.logback.core.ContextBase.start.

Implements ch.qos.logback.core.spi.LifeCycle.start.

Annotations

@Override

stop

back to summary

public void stop()

Overrides ch.qos.logback.core.ContextBase.stop.

Implements ch.qos.logback.core.spi.LifeCycle.stop.

toString

back to summary

public String toString()

Overrides ch.qos.logback.core.ContextBase.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

updateLoggerContextVO	back to summary
private void updateLoggerContextVO() A new instance of LoggerContextRemoteView needs to be created each time the name or propertyMap (including keys or values) changes.

public Class LoggerContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail