ch.qos.logback.core

Class ContextBase

java.lang.Object

ch.qos.logback.core.ContextBase

All Implemented Interfaces:

Context, LifeCycle, PropertyContainer

Direct Known Subclasses:

AccessContext, LoggerContext, RequestLogImpl

public class ContextBase
extends java.lang.Object
implements Context, LifeCycle

Field Summary

Fields

Modifier and Type	Field and Description
private long	birthTime
(package private) LogbackLock	configurationLock
private java.util.concurrent.ExecutorService	executorService
private LifeCycleManager	lifeCycleManager
private java.lang.String	name
(package private) java.util.Map<java.lang.String,java.lang.Object>	objectMap
(package private) java.util.Map<java.lang.String,java.lang.String>	propertyMap
private java.util.concurrent.ScheduledExecutorService	scheduledExecutorService
protected java.util.List<java.util.concurrent.ScheduledFuture<?>>	scheduledFutures
private StatusManager	sm
private boolean	started

Constructor Summary

Constructors

Constructor and Description
ContextBase()

Method Summary

Modifier and Type	Method and Description
void	addScheduledFuture(java.util.concurrent.ScheduledFuture<?> scheduledFuture)
long	getBirthTime() The time at which this context was created, expressed in millisecond elapsed since the epoch (1.1.1970).
java.lang.Object	getConfigurationLock() Object used for synchronization purposes.
java.util.Map<java.lang.String,java.lang.String>	getCopyOfPropertyMap() Get a copy of the property map
java.util.concurrent.ExecutorService	getExecutorService() Every context has an ExecutorService which be invoked to execute certain tasks in a separate thread.
(package private) LifeCycleManager	getLifeCycleManager() Gets the life cycle manager for this context.
java.lang.String	getName() Contexts are named objects.
java.lang.Object	getObject(java.lang.String key) A Context can act as a store for various objects used by LOGBack components.
java.lang.String	getProperty(java.lang.String key) Given a key, return the corresponding property value.
java.util.concurrent.ScheduledExecutorService	getScheduledExecutorService() Returns the ScheduledExecutorService for this context.
java.util.List<java.util.concurrent.ScheduledFuture<?>>	getScheduledFutures()
StatusManager	getStatusManager() Return the StatusManager instance in use.
protected void	initCollisionMaps()
boolean	isStarted()
void	putObject(java.lang.String key, java.lang.Object value) Store an object under 'key'.
void	putProperty(java.lang.String key, java.lang.String val) Set a property of this context.
void	register(LifeCycle component) Register a component that participates in the context's life cycle.
void	removeObject(java.lang.String key)
private void	removeShutdownHook()
void	reset() Clear the internal objectMap and all properties.
void	setName(java.lang.String name) 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.
void	setStatusManager(StatusManager statusManager) Set the StatusManager for this context.
void	start()
void	stop()
private void	stopExecutorServices()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

birthTime

private long birthTime

name

private java.lang.String name

sm

private StatusManager sm

propertyMap

java.util.Map<java.lang.String,java.lang.String> propertyMap

objectMap

java.util.Map<java.lang.String,java.lang.Object> objectMap

configurationLock

LogbackLock configurationLock

executorService

private java.util.concurrent.ExecutorService executorService

scheduledExecutorService

private java.util.concurrent.ScheduledExecutorService scheduledExecutorService

scheduledFutures

protected java.util.List<java.util.concurrent.ScheduledFuture<?>> scheduledFutures

lifeCycleManager

private LifeCycleManager lifeCycleManager

started

private boolean started

Constructor Detail

ContextBase

public ContextBase()

Method Detail

getStatusManager

public StatusManager getStatusManager()

Description copied from interface: Context

Return the StatusManager instance in use.

Specified by:

getStatusManager in interface Context

Returns:

the StatusManager instance in use.

setStatusManager

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 - the new status manager

getCopyOfPropertyMap

public java.util.Map<java.lang.String,java.lang.String> getCopyOfPropertyMap()

Description copied from interface: Context

Get a copy of the property map

Specified by:

getCopyOfPropertyMap in interface Context

Specified by:

getCopyOfPropertyMap in interface PropertyContainer

putProperty

public void putProperty(java.lang.String key,
                        java.lang.String val)

Description copied from interface: Context

Set a property of this context.

Specified by:

putProperty in interface Context

initCollisionMaps

protected void initCollisionMaps()

getProperty

public java.lang.String getProperty(java.lang.String key)

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

Specified by:

getProperty in interface Context

Specified by:

getProperty in interface PropertyContainer

Parameters:

key -

Returns:

getObject

public java.lang.Object getObject(java.lang.String key)

Description copied from interface: Context

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

Specified by:

getObject in interface Context

Returns:

The object stored under 'key'.

putObject

public void putObject(java.lang.String key,
                      java.lang.Object value)

Description copied from interface: Context

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

Specified by:

putObject in interface Context

removeObject

public void removeObject(java.lang.String key)

getName

public java.lang.String getName()

Description copied from interface: Context

Contexts are named objects.

Specified by:

getName in interface Context

Returns:

the name for this context

start

public void start()

Specified by:

start in interface LifeCycle

stop

public void stop()

Specified by:

stop in interface LifeCycle

isStarted

public boolean isStarted()

Specified by:

isStarted in interface LifeCycle

reset

public void reset()

Clear the internal objectMap and all properties. Removes registered shutdown hook

setName

public void setName(java.lang.String name)
             throws java.lang.IllegalStateException

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.

Specified by:

setName in interface Context

Throws:

java.lang.IllegalStateException - if the context already has a name, other than "default".

getBirthTime

public long getBirthTime()

Description copied from interface: Context

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

Specified by:

getBirthTime in interface Context

Returns:

The time as measured when this class was created.

getConfigurationLock

public java.lang.Object getConfigurationLock()

Description copied from interface: Context

Object used for synchronization purposes. INTENDED FOR INTERNAL USAGE.

Specified by:

getConfigurationLock in interface Context

getExecutorService

public java.util.concurrent.ExecutorService getExecutorService()

Description copied from interface: Context

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

Specified by:

getExecutorService in interface Context

Returns:

the executor for this context.

getScheduledExecutorService

public java.util.concurrent.ScheduledExecutorService getScheduledExecutorService()

Description copied from interface: Context

Returns the ScheduledExecutorService for this context.

Specified by:

getScheduledExecutorService in interface Context

Returns:

stopExecutorServices

private void stopExecutorServices()

removeShutdownHook

private void removeShutdownHook()

register

public void register(LifeCycle component)

Description copied from interface: Context

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.

Specified by:

register in interface Context

Parameters:

component - the subject component

getLifeCycleManager

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:

manager object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addScheduledFuture

public void addScheduledFuture(java.util.concurrent.ScheduledFuture<?> scheduledFuture)

Specified by:

addScheduledFuture in interface Context

getScheduledFutures

public java.util.List<java.util.concurrent.ScheduledFuture<?>> getScheduledFutures()