Interface ContextSelector

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      LoggerContext getContext​(java.lang.String fqcn, java.lang.ClassLoader loader, boolean currentContext)
      Returns the LoggerContext.
      LoggerContext getContext​(java.lang.String fqcn, java.lang.ClassLoader loader, boolean currentContext, java.net.URI configLocation)
      Returns the LoggerContext.
      default LoggerContext getContext​(java.lang.String fqcn, java.lang.ClassLoader loader, java.util.Map.Entry<java.lang.String,​java.lang.Object> entry, boolean currentContext)
      Returns the LoggerContext.
      default LoggerContext getContext​(java.lang.String fqcn, java.lang.ClassLoader loader, java.util.Map.Entry<java.lang.String,​java.lang.Object> entry, boolean currentContext, java.net.URI configLocation)
      Returns the LoggerContext.
      java.util.List<LoggerContext> getLoggerContexts()
      Returns a List of all the available LoggerContexts.
      default boolean hasContext​(java.lang.String fqcn, java.lang.ClassLoader loader, boolean currentContext)
      Checks to see if a LoggerContext is installed.
      default boolean isClassLoaderDependent()
      Determines whether or not this ContextSelector depends on the callers classloader.
      void removeContext​(LoggerContext context)
      Remove any references to the LoggerContext.
      default void shutdown​(java.lang.String fqcn, java.lang.ClassLoader loader, boolean currentContext, boolean allContexts)
      Shuts down the LoggerContext.
    • Method Detail

      • shutdown

        default void shutdown​(java.lang.String fqcn,
                              java.lang.ClassLoader loader,
                              boolean currentContext,
                              boolean allContexts)
        Shuts down the LoggerContext.
        Parameters:
        fqcn - The fully qualified class name of the caller.
        loader - The ClassLoader to use or null.
        currentContext - If true returns the current Context, if false returns the Context appropriate
        allContexts - if true all LoggerContexts that can be located will be shutdown.
        Since:
        2.13.0
      • hasContext

        default boolean hasContext​(java.lang.String fqcn,
                                   java.lang.ClassLoader loader,
                                   boolean currentContext)
        Checks to see if a LoggerContext is installed. The default implementation returns false.
        Parameters:
        fqcn - The fully qualified class name of the caller.
        loader - The ClassLoader to use or null.
        currentContext - If true returns the current Context, if false returns the Context appropriate for the caller if a more appropriate Context can be determined.
        Returns:
        true if a LoggerContext has been installed, false otherwise.
        Since:
        2.13.0
      • getContext

        LoggerContext getContext​(java.lang.String fqcn,
                                 java.lang.ClassLoader loader,
                                 boolean currentContext)
        Returns the LoggerContext.
        Parameters:
        fqcn - The fully qualified class name of the caller.
        loader - ClassLoader to use or null.
        currentContext - If true returns the current Context, if false returns the Context appropriate for the caller if a more appropriate Context can be determined.
        Returns:
        The LoggerContext.
      • getContext

        default LoggerContext getContext​(java.lang.String fqcn,
                                         java.lang.ClassLoader loader,
                                         java.util.Map.Entry<java.lang.String,​java.lang.Object> entry,
                                         boolean currentContext)
        Returns the LoggerContext.
        Parameters:
        fqcn - The fully qualified class name of the caller.
        loader - ClassLoader to use or null.
        entry - An entry for the external Context map.
        currentContext - If true returns the current Context, if false returns the Context appropriate for the caller if a more appropriate Context can be determined.
        Returns:
        The LoggerContext.
      • getContext

        LoggerContext getContext​(java.lang.String fqcn,
                                 java.lang.ClassLoader loader,
                                 boolean currentContext,
                                 java.net.URI configLocation)
        Returns the LoggerContext.
        Parameters:
        fqcn - The fully qualified class name of the caller.
        loader - ClassLoader to use or null.
        currentContext - If true returns the current Context, if false returns the Context appropriate for the caller if a more appropriate Context can be determined.
        configLocation - The location of the configuration for the LoggerContext.
        Returns:
        The LoggerContext.
      • getContext

        default LoggerContext getContext​(java.lang.String fqcn,
                                         java.lang.ClassLoader loader,
                                         java.util.Map.Entry<java.lang.String,​java.lang.Object> entry,
                                         boolean currentContext,
                                         java.net.URI configLocation)
        Returns the LoggerContext.
        Parameters:
        fqcn - The fully qualified class name of the caller.
        loader - ClassLoader to use or null.
        currentContext - If true returns the current Context, if false returns the Context appropriate for the caller if a more appropriate Context can be determined.
        configLocation - The location of the configuration for the LoggerContext.
        Returns:
        The LoggerContext.
      • getLoggerContexts

        java.util.List<LoggerContext> getLoggerContexts()
        Returns a List of all the available LoggerContexts.
        Returns:
        The List of LoggerContexts.
      • removeContext

        void removeContext​(LoggerContext context)
        Remove any references to the LoggerContext.
        Parameters:
        context - The context to remove.
      • isClassLoaderDependent

        default boolean isClassLoaderDependent()
        Determines whether or not this ContextSelector depends on the callers classloader. This method should be overridden by implementations, however a default method is provided which always returns true to preserve the old behavior.
        Returns:
        true if the class loader is required.
        Since:
        2.15.0