- All Superinterfaces:
PropertyContainer
- All Known Implementing Classes:
ContextBase
,LoggerContext
A context is the main anchorage point of all logback components.
- Author:
- Ceki Gulcu
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add aConfigurationEventListener
to this context.void
addScheduledFuture
(ScheduledFuture<?> scheduledFuture) Add scheduledFuture parameter to the list of known futures.void
fireConfigurationEvent
(ConfigurationEvent configurationEvent) FireConfigurationEvent
by invokingregistered listeners
.default ExecutorService
Return an alternateExecutorService
used for one task per thread execution.long
The time at which this context was created, expressed in millisecond elapsed since the epoch (1.1.1970).Object used for synchronization purposes.Get a copy of the property mapEvery context has an ExecutorService which be invoked to execute certain tasks in a separate thread.getName()
Contexts are named objects.A Context can act as a store for various objects used by LOGBack components.getProperty
(String key) Get the property of this context.Returns the ScheduledExecutorService for this context.Return the StatusManager instance in use.void
Store an object under 'key'.void
putProperty
(String key, String value) Set a property of this context.void
Register a component that participates in the context's life cycle.void
The name of the context can be set only once.void
setSequenceNumberGenerator
(SequenceNumberGenerator sequenceNumberGenerator) Methods inherited from interface ch.qos.logback.core.spi.PropertyContainer
addSubstitutionProperties, addSubstitutionProperty
-
Method Details
-
getStatusManager
Return the StatusManager instance in use.- Returns:
- the
StatusManager
instance in use.
-
getObject
A Context can act as a store for various objects used by LOGBack components.- Returns:
- The object stored under 'key'.
-
putObject
Store an object under 'key'. If no object can be found, null is returned.- Parameters:
key
-value
-
-
getProperty
Get the property of this context.- Specified by:
getProperty
in interfacePropertyContainer
-
putProperty
Set a property of this context. -
getCopyOfPropertyMap
Get a copy of the property map- Specified by:
getCopyOfPropertyMap
in interfacePropertyContainer
- Returns:
- Since:
- 0.9.20
-
getName
Contexts are named objects.- Returns:
- the name for this context
-
setName
The name of the context can be set only once.- Parameters:
name
-
-
getBirthTime
long getBirthTime()The time at which this context was created, expressed in millisecond elapsed since the epoch (1.1.1970).- Returns:
- The time as measured when this class was created.
-
getConfigurationLock
Object used for synchronization purposes. INTENDED FOR INTERNAL USAGE. -
getScheduledExecutorService
Returns the ScheduledExecutorService for this context.- Returns:
- ScheduledExecutorService
- Since:
- 1.1.7
-
getExecutorService
Every context has an ExecutorService which be invoked to execute certain tasks in a separate thread.- Returns:
- the executor for this context.
- Since:
- 1.0.00 (undeprecated in 1.4.7)
-
getAlternateExecutorService
Return an alternateExecutorService
used for one task per thread execution.- Returns:
- ExecutorService
-
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
- the subject component
-
addScheduledFuture
Add scheduledFuture parameter to the list of known futures.- Parameters:
scheduledFuture
-
-
getSequenceNumberGenerator
-
setSequenceNumberGenerator
-
addConfigurationEventListener
Add aConfigurationEventListener
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.- Parameters:
listener
-- Since:
- 1.3.6/1.4.6
-
fireConfigurationEvent
FireConfigurationEvent
by invokingregistered 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.
- Parameters:
configurationEvent
-- Since:
- 1.3.6/1.4.6
-