Interface Context

  • All Superinterfaces:
    PropertyContainer
    All Known Implementing Classes:
    ContextBase, LoggerContext

    @Deprecated(since="2022-01-27")
    public interface Context
    extends PropertyContainer
    Deprecated.
    This internal logback API is not supported by AEM as a Cloud Service.
    A context is the main anchorage point of all logback components.
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void addScheduledFuture​(java.util.concurrent.ScheduledFuture<?> scheduledFuture)
      Deprecated.
       
      long getBirthTime()
      Deprecated.
      The time at which this context was created, expressed in millisecond elapsed since the epoch (1.1.1970).
      java.lang.Object getConfigurationLock()
      Deprecated.
      Object used for synchronization purposes.
      java.util.Map<java.lang.String,​java.lang.String> getCopyOfPropertyMap()
      Deprecated.
      Get a copy of the property map
      java.util.concurrent.ExecutorService getExecutorService()
      Deprecated.
      java.lang.String getName()
      Deprecated.
      Contexts are named objects.
      java.lang.Object getObject​(java.lang.String key)
      Deprecated.
      A Context can act as a store for various objects used by LOGBack components.
      java.lang.String getProperty​(java.lang.String key)
      Deprecated.
      Get the property of this context.
      java.util.concurrent.ScheduledExecutorService getScheduledExecutorService()
      Deprecated.
      Returns the ScheduledExecutorService for this context.
      StatusManager getStatusManager()
      Deprecated.
      Return the StatusManager instance in use.
      void putObject​(java.lang.String key, java.lang.Object value)
      Deprecated.
      Store an object under 'key'.
      void putProperty​(java.lang.String key, java.lang.String value)
      Deprecated.
      Set a property of this context.
      void register​(LifeCycle component)
      Deprecated.
      Register a component that participates in the context's life cycle.
      void setName​(java.lang.String name)
      Deprecated.
      The name of the context can be set only once.
    • Method Detail

      • getStatusManager

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

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

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

        java.lang.String getProperty​(java.lang.String key)
        Deprecated.
        Get the property of this context.
        Specified by:
        getProperty in interface PropertyContainer
      • putProperty

        void putProperty​(java.lang.String key,
                         java.lang.String value)
        Deprecated.
        Set a property of this context.
      • getCopyOfPropertyMap

        java.util.Map<java.lang.String,​java.lang.String> getCopyOfPropertyMap()
        Deprecated.
        Get a copy of the property map
        Specified by:
        getCopyOfPropertyMap in interface PropertyContainer
        Returns:
        Since:
        0.9.20
      • getName

        java.lang.String getName()
        Deprecated.
        Contexts are named objects.
        Returns:
        the name for this context
      • setName

        void setName​(java.lang.String name)
        Deprecated.
        The name of the context can be set only once.
        Parameters:
        name -
      • getBirthTime

        long getBirthTime()
        Deprecated.
        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

        java.lang.Object getConfigurationLock()
        Deprecated.
        Object used for synchronization purposes. INTENDED FOR INTERNAL USAGE.
      • getScheduledExecutorService

        java.util.concurrent.ScheduledExecutorService getScheduledExecutorService()
        Deprecated.
        Returns the ScheduledExecutorService for this context.
        Returns:
        Since:
        1.1.7
      • getExecutorService

        java.util.concurrent.ExecutorService getExecutorService()
        Deprecated.
        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.0
      • register

        void register​(LifeCycle component)
        Deprecated.
        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​(java.util.concurrent.ScheduledFuture<?> scheduledFuture)
        Deprecated.