Package ch.qos.logback.access.tomcat

Class LogbackValve

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle

        org.apache.catalina.Lifecycle.SingleUse

    • Constructor Summary

      Constructors 
      Constructor Description
      LogbackValve()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAppender​(Appender<IAccessEvent> newAppender)
      Add an appender.
      void addError​(java.lang.String msg, java.lang.Throwable t)  
      void addFilter​(Filter<IAccessEvent> newFilter)
      Add a filter.
      void addInfo​(java.lang.String msg)  
      void addLifecycleListener​(org.apache.catalina.LifecycleListener arg0)  
      void addScheduledFuture​(java.util.concurrent.ScheduledFuture<?> scheduledFuture)  
      void addStatus​(Status status)  
      private void addThreadName​(IAccessEvent accessEvent)  
      void addWarn​(java.lang.String msg)  
      void clearAllFilters()  
      private void configureAsResource​(java.net.URL resourceURL)  
      void detachAndStopAllAppenders()
      Detach and processPriorToRemoval all previously added appenders.
      boolean detachAppender​(Appender<IAccessEvent> appender)
      Detach the appender passed as parameter from the list of appenders.
      boolean detachAppender​(java.lang.String name)
      Detach the appender with the name passed as parameter from the list of appenders.
      private java.net.URL fileToUrl​(java.io.File configFile)  
      org.apache.catalina.LifecycleListener[] findLifecycleListeners()  
      Appender<IAccessEvent> getAppender​(java.lang.String name)
      Get an appender by name.
      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.List<Filter<IAccessEvent>> getCopyOfAttachedFiltersList()
      Get a copy of all the filters contained within this FilterAttachable object.
      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.
      java.lang.String getFilename()  
      FilterReply getFilterChainDecision​(IAccessEvent event)
      Loop through the filters in the chain.
      java.lang.String getInfo()  
      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)
      Get the property of this context.
      java.util.Map<java.lang.String,​java.lang.String> getPropertyMap()  
      java.util.concurrent.ScheduledExecutorService getScheduledExecutorService()
      Returns the ScheduledExecutorService for this context.
      StatusManager getStatusManager()
      Return the StatusManager instance in use.
      void invoke​(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response)  
      boolean isAttached​(Appender<IAccessEvent> appender)
      Returns true if the specified appender is in list of attached attached, false otherwise.
      boolean isQuiet()  
      boolean isStarted()  
      java.util.Iterator<Appender<IAccessEvent>> iteratorForAppenders()
      Get an iterator for appenders contained in the parent object.
      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 removeLifecycleListener​(org.apache.catalina.LifecycleListener arg0)  
      private java.net.URL searchAsResource​(java.lang.String filename)  
      private java.io.File searchForConfigFileTomcatProperty​(java.lang.String filename, java.lang.String propertyKey)  
      void setFilename​(java.lang.String filename)  
      void setName​(java.lang.String name)
      The name of the context can be set only once.
      void setQuiet​(boolean quiet)  
      void startInternal()  
      protected void stopInternal()  
      java.lang.String toString()  

      • Methods inherited from class org.apache.catalina.valves.ValveBase

        backgroundProcess, getContainer, getDomainInternal, getNext, getObjectNameKeyProperties, initInternal, isAsyncSupported, setAsyncSupported, setContainer, setNext

      • Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

        destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregister

      • Methods inherited from class org.apache.catalina.util.LifecycleBase

        destroy, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, setState, setState, setThrowOnFailure, start, stop

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.apache.catalina.Lifecycle

        destroy, getState, getStateName, init, start, stop

    • Field Detail

      • DEFAULT_FILENAME

        public static final java.lang.String DEFAULT_FILENAME
        See Also:
        Constant Field Values

      • DEFAULT_CONFIG_FILE

        public static final java.lang.String DEFAULT_CONFIG_FILE

      • birthTime

        private long birthTime

      • name

        private java.lang.String name

      • propertyMap

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

      • objectMap

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

      • filenameOption

        java.lang.String filenameOption

      • quiet

        boolean quiet

      • started

        boolean started

      • alreadySetLogbackStatusManager

        boolean alreadySetLogbackStatusManager

      • scheduledExecutorService

        private java.util.concurrent.ScheduledExecutorService scheduledExecutorService

    • Constructor Detail

      • LogbackValve

        public LogbackValve()

    • Method Detail

      • isStarted

        public boolean isStarted()

      • startInternal

        public void startInternal()
                   throws org.apache.catalina.LifecycleException
        Overrides:
        startInternal in class org.apache.catalina.valves.ValveBase
        Throws:
        org.apache.catalina.LifecycleException

      • fileToUrl

        private java.net.URL fileToUrl​(java.io.File configFile)

      • searchAsResource

        private java.net.URL searchAsResource​(java.lang.String filename)

      • searchForConfigFileTomcatProperty

        private java.io.File searchForConfigFileTomcatProperty​(java.lang.String filename,
                                                       java.lang.String propertyKey)

      • addStatus

        public void addStatus​(Status status)

      • addInfo

        public void addInfo​(java.lang.String msg)

      • addWarn

        public void addWarn​(java.lang.String msg)

      • addError

        public void addError​(java.lang.String msg,
                     java.lang.Throwable t)

      • configureAsResource

        private void configureAsResource​(java.net.URL resourceURL)

      • getFilename

        public java.lang.String getFilename()

      • setFilename

        public void setFilename​(java.lang.String filename)

      • isQuiet

        public boolean isQuiet()

      • setQuiet

        public void setQuiet​(boolean quiet)

      • invoke

        public void invoke​(org.apache.catalina.connector.Request request,
                   org.apache.catalina.connector.Response response)
            throws java.io.IOException,
                   javax.servlet.ServletException
        Specified by:
        invoke in interface org.apache.catalina.Valve
        Throws:
        java.io.IOException
        javax.servlet.ServletException

      • addThreadName

        private void addThreadName​(IAccessEvent accessEvent)

      • stopInternal

        protected void stopInternal()
                     throws org.apache.catalina.LifecycleException
        Overrides:
        stopInternal in class org.apache.catalina.valves.ValveBase
        Throws:
        org.apache.catalina.LifecycleException

      • getInfo

        public java.lang.String getInfo()

      • getPropertyMap

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

      • 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

      • 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

      • 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.

      • 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

      • setName

        public void setName​(java.lang.String name)
        Description copied from interface: Context
        The name of the context can be set only once.
        Specified by:
        setName in interface Context

      • 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

      • 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

      • addLifecycleListener

        public void addLifecycleListener​(org.apache.catalina.LifecycleListener arg0)
        Specified by:
        addLifecycleListener in interface org.apache.catalina.Lifecycle
        Overrides:
        addLifecycleListener in class org.apache.catalina.util.LifecycleBase

      • findLifecycleListeners

        public org.apache.catalina.LifecycleListener[] findLifecycleListeners()
        Specified by:
        findLifecycleListeners in interface org.apache.catalina.Lifecycle
        Overrides:
        findLifecycleListeners in class org.apache.catalina.util.LifecycleBase

      • removeLifecycleListener

        public void removeLifecycleListener​(org.apache.catalina.LifecycleListener arg0)
        Specified by:
        removeLifecycleListener in interface org.apache.catalina.Lifecycle
        Overrides:
        removeLifecycleListener in class org.apache.catalina.util.LifecycleBase

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class org.apache.catalina.valves.ValveBase

      • 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:

      • addScheduledFuture

        public void addScheduledFuture​(java.util.concurrent.ScheduledFuture<?> scheduledFuture)
        Specified by:
        addScheduledFuture in interface Context