Logback Core Module 1.5.1 · ch.qos.logback.core.ContextBase

Modifier and Type	Field and Description
private ExecutorService	alternateExecutorService
private long	birthTime
private final List<ConfigurationEventListener>	configurationEventListenerList
pack-priv LogbackLock	configurationLock
private LifeCycleManager	lifeCycleManager
private String	name
pack-priv Map<String, Object>	objectMap
pack-priv Map<String, String>	propertyMap
private ScheduledExecutorService	scheduledExecutorService
protected List<ScheduledFuture<?>>	scheduledFutures
private SequenceNumberGenerator	sequenceNumberGenerator
private StatusManager	sm
private boolean	started
private ThreadPoolExecutor	threadPoolExecutor

Access	Constructor and Description
public	ContextBase()

Method Summary

Modifier and Type	Method and Description
public void	addConfigurationEventListener(ConfigurationEventListener listener) Implements ch.qos.logback.core.Context.addConfigurationEventListener. Add a `ConfigurationEventListener` to this context.
public void	addScheduledFuture(ScheduledFuture<?> scheduledFuture) Implements ch.qos.logback.core.Context.addScheduledFuture. Add scheduledFuture parameter to the list of known futures.
public void	addSubstitutionProperty(String key, String value) Implements ch.qos.logback.core.spi.PropertyContainer.addSubstitutionProperty.
public void	fireConfigurationEvent(ConfigurationEvent configurationEvent) Implements ch.qos.logback.core.Context.fireConfigurationEvent. Fire `ConfigurationEvent` by invoking `registered listeners`.
public synchronized ExecutorService	getAlternateExecutorService() Overrides default ch.qos.logback.core.Context.getAlternateExecutorService. Return an alternate `ExecutorService` used for one task per thread execution.
public long	getBirthTime() Implements ch.qos.logback.core.Context.getBirthTime. The time at which this context was created, expressed in millisecond elapsed since the epoch (1.1.1970).
public Object	getConfigurationLock() Implements ch.qos.logback.core.Context.getConfigurationLock. Object used for synchronization purposes.
public Map<String, String>	getCopyOfPropertyMap() Implements ch.qos.logback.core.Context.getCopyOfPropertyMap. Get a copy of the property map
public List<ScheduledFuture<?>>	getCopyOfScheduledFutures()
public synchronized ExecutorService	getExecutorService() Implements ch.qos.logback.core.Context.getExecutorService. Every context has an ExecutorService which be invoked to execute certain tasks in a separate thread.
pack-priv synchronized LifeCycleManager	Returns: manager object getLifeCycleManager() Gets the life cycle manager for this context.
public String	getName() Implements ch.qos.logback.core.Context.getName. Contexts are named objects.
public Object	getObject(String key) Implements ch.qos.logback.core.Context.getObject. A Context can act as a store for various objects used by LOGBack components.
public String	getProperty(String key) Implements ch.qos.logback.core.Context.getProperty. Given a key, return the corresponding property value.
public synchronized ScheduledExecutorService	getScheduledExecutorService() Implements ch.qos.logback.core.Context.getScheduledExecutorService. Returns the ScheduledExecutorService for this context.
public List<ScheduledFuture<?>>	getScheduledFutures() Deprecated replaced by getCopyOfScheduledFutures
public SequenceNumberGenerator	getSequenceNumberGenerator() Implements ch.qos.logback.core.Context.getSequenceNumberGenerator.
public StatusManager	getStatusManager() Implements ch.qos.logback.core.Context.getStatusManager. Return the StatusManager instance in use.
protected void	initCollisionMaps()
public boolean	isStarted() Implements ch.qos.logback.core.spi.LifeCycle.isStarted.
private String	lazyGetHostname()
private void	putHostnameProperty(String hostname)
public void	putObject(String key, Object value) Implements ch.qos.logback.core.Context.putObject. Store an object under 'key'.
public void	putProperty(String key, String val) Implements ch.qos.logback.core.Context.putProperty. Set a property of this context.
public void	register(LifeCycle the subject component component) Implements ch.qos.logback.core.Context.register. Register a component that participates in the context's life cycle.
public void	removeObject(String key)
private void	removeShutdownHook()
public void	reset() Clear the internal objectMap and all properties.
public void	setName(String name) 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	setSequenceNumberGenerator(SequenceNumberGenerator sequenceNumberGenerator) Implements ch.qos.logback.core.Context.setSequenceNumberGenerator.
public void	setStatusManager(StatusManager the new status manager statusManager) Set the `StatusManager` for this context.
public void	start() Implements ch.qos.logback.core.spi.LifeCycle.start.
public void	stop() Implements ch.qos.logback.core.spi.LifeCycle.stop.
private synchronized void	stopExecutorServices()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

alternateExecutorService	back to summary
private ExecutorService alternateExecutorService

birthTime	back to summary
private long birthTime

configurationEventListenerList	back to summary
private final List<ConfigurationEventListener> configurationEventListenerList

configurationLock	back to summary
pack-priv LogbackLock configurationLock

lifeCycleManager	back to summary
private LifeCycleManager lifeCycleManager

name	back to summary
private String name

objectMap	back to summary
pack-priv Map<String, Object> objectMap

propertyMap	back to summary
pack-priv Map<String, String> propertyMap

scheduledExecutorService	back to summary
private ScheduledExecutorService scheduledExecutorService

scheduledFutures	back to summary
protected List<ScheduledFuture<?>> scheduledFutures

sequenceNumberGenerator	back to summary
private SequenceNumberGenerator sequenceNumberGenerator

sm	back to summary
private StatusManager sm

started	back to summary
private boolean started

threadPoolExecutor	back to summary
private ThreadPoolExecutor threadPoolExecutor

ContextBase	back to summary
public ContextBase()

Method Detail

addConfigurationEventListener back to summary

addConfigurationEventListener	back to summary
public void addConfigurationEventListener(ConfigurationEventListener listener) Implements ch.qos.logback.core.Context.addConfigurationEventListener. Doc from ch.qos.logback.core.Context.addConfigurationEventListener. Add a `ConfigurationEventListener` to this context. Configuration events are supposed to be rare and listeners to such events rarer still. The propagation of `configuration events` is intended for internal testing as well as some coordination between configurators. Annotations @Override

public void addConfigurationEventListener(ConfigurationEventListener listener)

Implements ch.qos.logback.core.Context.addConfigurationEventListener.

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

Add a ConfigurationEventListener to this context.

Configuration events are supposed to be rare and listeners to such events rarer still.

The propagation of configuration events is intended for internal testing as well as some coordination between configurators.

Annotations

@Override

addScheduledFuture	back to summary
public void addScheduledFuture(ScheduledFuture<?> scheduledFuture) Implements ch.qos.logback.core.Context.addScheduledFuture. Doc from ch.qos.logback.core.Context.addScheduledFuture. Add scheduledFuture parameter to the list of known futures. Annotations @Override

addScheduledFuture

back to summary

public void addScheduledFuture(ScheduledFuture<?> scheduledFuture)

Implements ch.qos.logback.core.Context.addScheduledFuture.

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

Add scheduledFuture parameter to the list of known futures.

Annotations

@Override

addSubstitutionProperty	back to summary
public void addSubstitutionProperty(String key, String value) Implements ch.qos.logback.core.spi.PropertyContainer.addSubstitutionProperty. Annotations @Override

addSubstitutionProperty

back to summary

public void addSubstitutionProperty(String key, String value)

Implements ch.qos.logback.core.spi.PropertyContainer.addSubstitutionProperty.

Annotations

@Override

fireConfigurationEvent back to summary

fireConfigurationEvent	back to summary
public void fireConfigurationEvent(ConfigurationEvent configurationEvent) Implements ch.qos.logback.core.Context.fireConfigurationEvent. Doc from ch.qos.logback.core.Context.fireConfigurationEvent. Fire `ConfigurationEvent` by invoking `registered listeners`. Note that it is the role of configurators to invoke this method as a context does not necessarily know when it is being configured. Annotations @Override

public void fireConfigurationEvent(ConfigurationEvent configurationEvent)

Implements ch.qos.logback.core.Context.fireConfigurationEvent.

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

Fire ConfigurationEvent by invoking registered listeners.

Note that it is the role of configurators to invoke this method as a context does not necessarily know when it is being configured.

Annotations

@Override

getAlternateExecutorService back to summary

getAlternateExecutorService	back to summary
public synchronized ExecutorService getAlternateExecutorService() Overrides default ch.qos.logback.core.Context.getAlternateExecutorService. Doc from ch.qos.logback.core.Context.getAlternateExecutorService. Return an alternate `ExecutorService` used for one task per thread execution. Returns:ExecutorService ExecutorService Annotations @Override

public synchronized ExecutorService getAlternateExecutorService()

Overrides default ch.qos.logback.core.Context.getAlternateExecutorService.

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

Return an alternate ExecutorService used for one task per thread execution.

Returns:ExecutorService

ExecutorService

Annotations

@Override

getBirthTime	back to summary
public long getBirthTime() Implements ch.qos.logback.core.Context.getBirthTime. Doc from ch.qos.logback.core.Context.getBirthTime. The time at which this context was created, expressed in millisecond elapsed since the epoch (1.1.1970). Returns:long The time as measured when this class was created.

getBirthTime

back to summary

public long getBirthTime()

Implements ch.qos.logback.core.Context.getBirthTime.

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

The time at which this context was created, expressed in millisecond elapsed since the epoch (1.1.1970).

Returns:long: The time as measured when this class was created.

getConfigurationLock	back to summary
public Object getConfigurationLock() Implements ch.qos.logback.core.Context.getConfigurationLock. Doc from ch.qos.logback.core.Context.getConfigurationLock. Object used for synchronization purposes. INTENDED FOR INTERNAL USAGE.

getConfigurationLock

back to summary

public Object getConfigurationLock()

Implements ch.qos.logback.core.Context.getConfigurationLock.

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

Object used for synchronization purposes. INTENDED FOR INTERNAL USAGE.

getCopyOfPropertyMap	back to summary
public Map<String, String> getCopyOfPropertyMap() Implements ch.qos.logback.core.Context.getCopyOfPropertyMap. Doc from ch.qos.logback.core.Context.getCopyOfPropertyMap. Get a copy of the property map

getCopyOfPropertyMap

back to summary

public Map<String, String> getCopyOfPropertyMap()

Implements ch.qos.logback.core.Context.getCopyOfPropertyMap.

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

Get a copy of the property map

getCopyOfScheduledFutures	back to summary
public List<ScheduledFuture<?>> getCopyOfScheduledFutures()

getExecutorService	back to summary
public synchronized ExecutorService getExecutorService() Implements ch.qos.logback.core.Context.getExecutorService. Doc from ch.qos.logback.core.Context.getExecutorService. Every context has an ExecutorService which be invoked to execute certain tasks in a separate thread. Returns:ExecutorService the executor for this context. Annotations @Override

getExecutorService

back to summary

public synchronized ExecutorService getExecutorService()

Implements ch.qos.logback.core.Context.getExecutorService.

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

Every context has an ExecutorService which be invoked to execute certain tasks in a separate thread.

Returns:ExecutorService

the executor for this context.

Annotations

@Override

getLifeCycleManager back to summary

getLifeCycleManager	back to summary
pack-priv synchronized LifeCycleManager getLifeCycleManager() Gets the life cycle manager for this context. The default implementation lazily initializes an instance of `LifeCycleManager`. Subclasses may override to provide a custom manager implementation, but must take care to return the same manager object for each call to this method. This is exposed primarily to support instrumentation for unit testing. Returns:LifeCycleManager manager object

pack-priv synchronized LifeCycleManager getLifeCycleManager()

Gets the life cycle manager for this context.

The default implementation lazily initializes an instance of LifeCycleManager. Subclasses may override to provide a custom manager implementation, but must take care to return the same manager object for each call to this method.

This is exposed primarily to support instrumentation for unit testing.

Returns:LifeCycleManager: manager object

getName	back to summary
public String getName() Implements ch.qos.logback.core.Context.getName. Doc from ch.qos.logback.core.Context.getName. Contexts are named objects. Returns:String the name for this context

getName

back to summary

public String getName()

Implements ch.qos.logback.core.Context.getName.

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

Contexts are named objects.

Returns:String: the name for this context

getObject	back to summary
public Object getObject(String key) Implements ch.qos.logback.core.Context.getObject. Doc from ch.qos.logback.core.Context.getObject. A Context can act as a store for various objects used by LOGBack components. Returns:Object The object stored under 'key'.

getObject

back to summary

public Object getObject(String key)

Implements ch.qos.logback.core.Context.getObject.

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

A Context can act as a store for various objects used by LOGBack components.

Returns:Object: The object stored under 'key'.

getProperty	back to summary
public String getProperty(String key) Implements ch.qos.logback.core.Context.getProperty. Given a key, return the corresponding property value. If invoked with the special key "CONTEXT_NAME", the name of the context is returned.

getProperty

back to summary

public String getProperty(String key)

Implements ch.qos.logback.core.Context.getProperty.

Given a key, return the corresponding property value. If invoked with the special key "CONTEXT_NAME", the name of the context is returned.

getScheduledExecutorService	back to summary
public synchronized ScheduledExecutorService getScheduledExecutorService() Implements ch.qos.logback.core.Context.getScheduledExecutorService. Doc from ch.qos.logback.core.Context.getScheduledExecutorService. Returns the ScheduledExecutorService for this context. Returns:ScheduledExecutorService ScheduledExecutorService Annotations @Override

getScheduledExecutorService

back to summary

public synchronized ScheduledExecutorService getScheduledExecutorService()

Implements ch.qos.logback.core.Context.getScheduledExecutorService.

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

Returns the ScheduledExecutorService for this context.

Returns:ScheduledExecutorService

ScheduledExecutorService

Annotations

@Override

getScheduledFutures	back to summary
public List<ScheduledFuture<?>> getScheduledFutures() Deprecated replaced by getCopyOfScheduledFutures Annotations @Deprecated

getSequenceNumberGenerator	back to summary
public SequenceNumberGenerator getSequenceNumberGenerator() Implements ch.qos.logback.core.Context.getSequenceNumberGenerator.

getStatusManager back to summary

getStatusManager	back to summary
public StatusManager getStatusManager() Implements ch.qos.logback.core.Context.getStatusManager. Doc from ch.qos.logback.core.Context.getStatusManager. Return the StatusManager instance in use. Returns:StatusManager the `StatusManager` instance in use.

public StatusManager getStatusManager()

Implements ch.qos.logback.core.Context.getStatusManager.

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

Return the StatusManager instance in use.

Returns:StatusManager: the StatusManager instance in use.

initCollisionMaps	back to summary
protected void initCollisionMaps()

isStarted	back to summary
public boolean isStarted() Implements ch.qos.logback.core.spi.LifeCycle.isStarted.

lazyGetHostname	back to summary
private String lazyGetHostname()

putHostnameProperty	back to summary
private void putHostnameProperty(String hostname)

putObject	back to summary
public void putObject(String key, Object value) Implements ch.qos.logback.core.Context.putObject. Doc from ch.qos.logback.core.Context.putObject. Store an object under 'key'. If no object can be found, null is returned.

putObject

back to summary

public void putObject(String key, Object value)

Implements ch.qos.logback.core.Context.putObject.

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

Store an object under 'key'. If no object can be found, null is returned.

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

putProperty

back to summary

public void putProperty(String key, String val)

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

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

Set a property of this context.

register	back to summary
public void register(LifeCycle component) Implements ch.qos.logback.core.Context.register. Doc from ch.qos.logback.core.Context.register. Register a component that participates in the context's life cycle. All components registered via this method will be stopped and removed from the context when the context is reset. Parameters component:LifeCycle the subject component

back to summary

public void register(LifeCycle component)

Implements ch.qos.logback.core.Context.register.

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

All components registered via this method will be stopped and removed from the context when the context is reset.

Parameters

component:LifeCycle: the subject component

removeObject	back to summary
public void removeObject(String key)

removeShutdownHook	back to summary
private void removeShutdownHook()

reset	back to summary
public void reset() Clear the internal objectMap and all properties. Removes any registered shutdown hook.

setName	back to summary
public void setName(String name) throws IllegalStateException 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. Exceptions IllegalStateException: if the context already has a name, other than "default".

setName

back to summary

public void setName(String name) throws IllegalStateException

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.

Exceptions

IllegalStateException:: if the context already has a name, other than "default".

setSequenceNumberGenerator	back to summary
public void setSequenceNumberGenerator(SequenceNumberGenerator sequenceNumberGenerator) Implements ch.qos.logback.core.Context.setSequenceNumberGenerator.

setStatusManager back to summary

setStatusManager	back to summary
public void setStatusManager(StatusManager statusManager) Set the `StatusManager` for this context. Note that by default this context is initialized with a `BasicStatusManager`. A null value for the 'statusManager' argument is not allowed. A malicious attacker can set the status manager to a dummy instance, disabling internal error reporting. Parameters statusManager:StatusManager the new status manager

public void setStatusManager(StatusManager statusManager)

Set the StatusManager for this context. Note that by default this context is initialized with a BasicStatusManager. A null value for the 'statusManager' argument is not allowed.

A malicious attacker can set the status manager to a dummy instance, disabling internal error reporting.

Parameters