Package ch.qos.logback.core

Interface Context

All Superinterfaces:
PropertyContainer
All Known Implementing Classes:
ContextBase
public interface Context extends PropertyContainer
A context is the main anchorage point of all logback components.
Author:
Ceki Gulcu

  • Method Details

    • getStatusManager

      StatusManager getStatusManager()
      Return the StatusManager instance in use.
      Returns:
      the StatusManager instance in use.

    • getObject

      Object getObject(String key)
      A Context can act as a store for various objects used by LOGBack components.
      Returns:
      The object stored under 'key'.

    • putObject

      void putObject(String key, Object value)
      Store an object under 'key'. If no object can be found, null is returned.
      Parameters:
      key -
      value -

    • getProperty

      String getProperty(String key)
      Get the property of this context.
      Specified by:
      getProperty in interface PropertyContainer

    • putProperty

      void putProperty(String key, String value)
      Set a property of this context.

    • getCopyOfPropertyMap

      Map<String,String> getCopyOfPropertyMap()
      Get a copy of the property map
      Specified by:
      getCopyOfPropertyMap in interface PropertyContainer
      Returns:
      Since:
      0.9.20

    • getName

      String getName()
      Contexts are named objects.
      Returns:
      the name for this context

    • setName

      void setName(String name)
      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 getConfigurationLock()
      Object used for synchronization purposes. INTENDED FOR INTERNAL USAGE.

    • getScheduledExecutorService

      ScheduledExecutorService getScheduledExecutorService()
      Returns the ScheduledExecutorService for this context.
      Returns:
      ScheduledExecutorService
      Since:
      1.1.7

    • getExecutorService

      ExecutorService 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)

    • register

      void register(LifeCycle component)
      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

      void addScheduledFuture(ScheduledFuture<?> scheduledFuture)
      Add scheduledFuture parameter to the list of known futures.
      Parameters:
      scheduledFuture -

    • getSequenceNumberGenerator

      SequenceNumberGenerator getSequenceNumberGenerator()

    • setSequenceNumberGenerator

      void setSequenceNumberGenerator(SequenceNumberGenerator sequenceNumberGenerator)

    • addConfigurationEventListener

      void addConfigurationEventListener(ConfigurationEventListener listener)
      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.

      Parameters:
      listener -
      Since:
      1.3.6/1.4.6

    • fireConfigurationEvent

      void fireConfigurationEvent(ConfigurationEvent configurationEvent)
      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.

      Parameters:
      configurationEvent -
      Since:
      1.3.6/1.4.6