Package org.apache.catalina.valves

Class AccessLogValve

  • All Implemented Interfaces:
    Contained, Lifecycle, Valve, GlassFishValve
    public final class AccessLogValve
extends ValveBase

    Implementation of the Valve interface that generates a web server access log with the detailed line contents matching a configurable pattern. The syntax of the available patterns is similar to that supported by the Apache mod_log_config module. As an additional feature, automatic rollover of log files when the date changes is also supported.

    Patterns for the logged message may include constant text or any of the following replacement strings, for which the corresponding information from the specified Response is substituted:

    • %a - Remote IP address
    • %A - Local IP address
    • %b - Bytes sent, excluding HTTP headers, or '-' if no bytes were sent
    • %B - Bytes sent, excluding HTTP headers
    • %h - Remote host name
    • %H - Request protocol
    • %l - Remote logical username from identd (always returns '-')
    • %m - Request method
    • %p - Local port
    • %q - Query string (prepended with a '?' if it exists, otherwise an empty string
    • %r - First line of the request
    • %s - HTTP status code of the response
    • %S - User session ID
    • %t - Date and time, in Common Log Format format
    • %u - Remote user that was authenticated
    • %U - Requested URL path
    • %v - Local server name
    • %D - Time taken to process the request, in millis
    • %T - Time taken to process the request, in seconds

    In addition, the caller can specify one of the following aliases for commonly utilized patterns:

    • common - %h %l %u %t "%r" %s %b
    • combined - %h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i"

    There is also support to write information from the cookie, incoming header, the Session or something else in the ServletRequest.
    It is modeled after the apache syntax:

    • %{xxx}i for incoming headers
    • %{xxx}c for a specific cookie
    • %{xxx}r xxx is an attribute in the ServletRequest
    • %{xxx}s xxx is an attribute in the HttpSession

    Conditional logging is also supported. This can be done with the condition property. If the value returned from ServletRequest.getAttribute(condition) yields a non-null value. The logging will be skipped.

    Version:
    $Revision: 1.4 $ $Date: 2006/10/23 23:18:02 $
    Author:
    Craig R. McClanahan, Jason Brittain

    • Constructor Detail

      • AccessLogValve

        public AccessLogValve()
        Construct a new instance of this class with default property values.

    • Method Detail

      • getDirectory

        public String getDirectory()
        Return the directory in which we create log files.

      • setDirectory

        public void setDirectory​(String directory)
        Set the directory in which we create log files.
        Parameters:
        directory - The new log file directory

      • getPattern

        public String getPattern()
        Return the format pattern.

      • setPattern

        public void setPattern​(String pattern)
        Set the format pattern, first translating any recognized alias.
        Parameters:
        pattern - The new pattern

      • getPrefix

        public String getPrefix()
        Return the log file prefix.

      • setPrefix

        public void setPrefix​(String prefix)
        Set the log file prefix.
        Parameters:
        prefix - The new log file prefix

      • isRotatable

        public boolean isRotatable()
        Should we rotate the logs

      • setRotatable

        public void setRotatable​(boolean rotatable)
        Set the value is we should we rotate the logs
        Parameters:
        rotatable - true is we should rotate.

      • getSuffix

        public String getSuffix()
        Return the log file suffix.

      • setSuffix

        public void setSuffix​(String suffix)
        Set the log file suffix.
        Parameters:
        suffix - The new log file suffix

      • setResolveHosts

        public void setResolveHosts​(boolean resolveHosts)
        Set the resolve hosts flag.
        Parameters:
        resolveHosts - The new resolve hosts value

      • isResolveHosts

        public boolean isResolveHosts()
        Get the value of the resolve hosts flag.

      • getCondition

        public String getCondition()
        Return whether the attribute name to look for when performing conditional logging. If null, every request is logged.

      • setCondition

        public void setCondition​(String condition)
        Set the ServletRequest.attribute to look for to perform conditional logging. Set to null to log everything.
        Parameters:
        condition - Set to null to log everything

      • getFileDateFormat

        public String getFileDateFormat()
        Return the date format date based log rotation.

      • setFileDateFormat

        public void setFileDateFormat​(String fileDateFormat)
        Set the date format date based log rotation.

      • invoke

        public int invoke​(Request request,
                  Response response)
           throws IOException,
                  jakarta.servlet.ServletException
        Log a message summarizing the specified request and response, according to the format specified by the pattern property.
        Specified by:
        invoke in interface GlassFishValve
        Specified by:
        invoke in class ValveBase
        Parameters:
        request - Request being processed
        response - Response being processed
        Returns:
        INVOKE_NEXT or END_PIPELINE
        Throws:
        IOException - if an input/output error has occurred
        jakarta.servlet.ServletException - if a servlet error has occurred

      • postInvoke

        public void postInvoke​(Request request,
                       Response response)
        Description copied from class: ValveBase
        A post-request processing implementation that does nothing. Very few Valves override this behaviour as most Valve logic is used for request processing.
        Specified by:
        postInvoke in interface GlassFishValve
        Overrides:
        postInvoke in class ValveBase
        Parameters:
        request - The servlet request to be processed
        response - The servlet response to be created

      • log

        public void log​(String message,
                Date date)
        Log the specified message to the log file, switching files if the date has changed since the previous log call.
        Parameters:
        message - Message to be logged
        date - the current Date object (so this method doesn't need to create a new one)

      • start

        public void start()
           throws LifecycleException
        Prepare for the beginning of active use of the public methods of this component. This method should be called after configure(), and before any of the public methods of the component are utilized.
        Specified by:
        start in interface Lifecycle
        Overrides:
        start in class ValveBase
        Throws:
        LifecycleException - if this component detects a fatal error that prevents this component from being used

      • stop

        public void stop()
          throws LifecycleException
        Gracefully terminate the active use of the public methods of this component. This method should be the last one called on a given instance of this component.
        Specified by:
        stop in interface Lifecycle
        Overrides:
        stop in class ValveBase
        Throws:
        LifecycleException - if this component detects a fatal error that needs to be reported