AbstractAccessLogValve (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- org.apache.catalina.util.LifecycleBase
- - org.apache.catalina.util.LifecycleMBeanBase
  - - org.apache.catalina.valves.ValveBase
    - - org.apache.catalina.valves.AbstractAccessLogValve

All Implemented Interfaces:

MBeanRegistration, AccessLog, Contained, JmxEnabled, Lifecycle, Valve

Direct Known Subclasses:

AccessLogValve
```
public abstract class AbstractAccessLogValve
extends ValveBase
implements AccessLog
```
Abstract 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 HTTP Server mod_log_config module.

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 (or IP address if enableLookups for the connector is false)
- %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
- %t{format} - Date and time, in any format supported by SimpleDateFormat
- %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
- %I - current Request thread name (can compare later with stacktraces)
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 HTTP Server log configuration syntax:
- %{xxx}i for incoming headers
- %{xxx}o for outgoing response 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
- %{xxx}t xxx is an enhanced SimpleDateFormat pattern (see Configuration Reference document for details on supported time patterns)
Conditional logging is also supported. This can be done with the conditionUnless and conditionIf properties. If the value returned from ServletRequest.getAttribute(conditionUnless) yields a non-null value, the logging will be skipped. If the value returned from ServletRequest.getAttribute(conditionIf) yields the null value, the logging will be skipped. The condition attribute is synonym for conditionUnless and is provided for backwards compatibility.

For extended attributes coming from a getAttribute() call, it is you responsibility to ensure there are no newline or control characters.
Author:

Craig R. McClanahan, Jason Brittain, Remy Maucherat, Takayuki Kaneko, Peter Rossbach

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`AbstractAccessLogValve.AccessLogElement` AccessLogElement writes the partial message into the buffer.
`protected static class`	`AbstractAccessLogValve.ByteSentElement` write bytes sent, excluding HTTP headers - %b, %B
`protected static class`	`AbstractAccessLogValve.CookieElement` write a specific cookie - %{xxx}c
`protected class`	`AbstractAccessLogValve.DateAndTimeElement` write date and time, in configurable format (default CLF) - %t or %t{format}
`protected static class`	`AbstractAccessLogValve.DateFormatCache` Cache structure for formatted timestamps based on seconds.
`protected static class`	`AbstractAccessLogValve.ElapsedTimeElement` write time taken to process the request - %D, %T
`protected static class`	`AbstractAccessLogValve.FirstByteTimeElement` write time until first byte is written (commit time) in millis - %F
`protected static class`	`AbstractAccessLogValve.HeaderElement` write incoming headers - %{xxx}i
`protected class`	`AbstractAccessLogValve.HostElement` write remote host name - %h
`protected static class`	`AbstractAccessLogValve.HttpStatusCodeElement` write HTTP status code of the response - %s
`protected static class`	`AbstractAccessLogValve.LocalAddrElement` write local IP address - %A
`protected class`	`AbstractAccessLogValve.LocalPortElement` write local port on which this request was received - %p
`protected static class`	`AbstractAccessLogValve.LocalServerNameElement` write local server name - %v
`protected static class`	`AbstractAccessLogValve.LogicalUserNameElement` write remote logical username from identd (always returns '-') - %l
`protected static class`	`AbstractAccessLogValve.MethodElement` write request method (GET, POST, etc.) - %m
`protected class`	`AbstractAccessLogValve.ProtocolElement` write request protocol - %H
`protected static class`	`AbstractAccessLogValve.QueryElement` write Query string (prepended with a '?'
`protected class`	`AbstractAccessLogValve.RemoteAddrElement` write remote IP address - %a
`protected static class`	`AbstractAccessLogValve.RequestAttributeElement` write an attribute in the ServletRequest - %{xxx}r
`protected static class`	`AbstractAccessLogValve.RequestElement` write first line of the request (method and request URI) - %r
`protected static class`	`AbstractAccessLogValve.RequestURIElement` write requested URL path - %U
`protected static class`	`AbstractAccessLogValve.ResponseHeaderElement` write a specific response header - %{xxx}o
`protected static class`	`AbstractAccessLogValve.SessionAttributeElement` write an attribute in the HttpSession - %{xxx}s
`protected static class`	`AbstractAccessLogValve.SessionIdElement` write user session ID - %S
`protected static class`	`AbstractAccessLogValve.StringElement` write any string
`protected static class`	`AbstractAccessLogValve.ThreadNameElement` write thread name - %I
`protected static class`	`AbstractAccessLogValve.UserElement` write remote user that was authenticated (if any), else '-' - %u

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`condition` Are we doing conditional logging. default null.
`protected String`	`conditionIf` Are we doing conditional logging. default null.
`protected boolean`	`enabled` enabled this component
`protected Locale`	`locale` Locale used to format timestamps in log entries and in log file name suffix.
`protected String`	`localeName` Name of locale used to format timestamps in log entries and in log file name suffix.
`protected AbstractAccessLogValve.AccessLogElement[]`	`logElements` Array of AccessLogElement, they will be used to make log message.
`protected String`	`pattern` The pattern used to format our access log lines.
`protected boolean`	`requestAttributesEnabled`

Fields inherited from class org.apache.catalina.valves.ValveBase
asyncSupported, container, containerLog, next, sm

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase
mserver

Fields inherited from interface org.apache.catalina.AccessLog
PROTOCOL_ATTRIBUTE, REMOTE_ADDR_ATTRIBUTE, REMOTE_HOST_ATTRIBUTE, SERVER_PORT_ATTRIBUTE

Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors
Constructor and Description

AbstractAccessLogValve()

Constructors
Constructor and Description
`AbstractAccessLogValve()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected AbstractAccessLogValve.AccessLogElement`	`createAccessLogElement(char pattern)` create an AccessLogElement implementation
`protected AbstractAccessLogValve.AccessLogElement`	`createAccessLogElement(String header, char pattern)` create an AccessLogElement implementation which needs header string
`protected AbstractAccessLogValve.AccessLogElement[]`	`createLogElements()` parse pattern string and create the array of AccessLogElement
`protected static Locale`	`findLocale(String name, Locale fallback)` Find a locale by name
`String`	`getCondition()` Return whether the attribute name to look for when performing conditional logging.
`String`	`getConditionIf()` Return whether the attribute name to look for when performing conditional logging.
`String`	`getConditionUnless()` Return whether the attribute name to look for when performing conditional logging.
`boolean`	`getEnabled()`
`String`	`getLocale()` Return the locale used to format timestamps in log entries and in log file name suffix.
`String`	`getPattern()` Return the format pattern.
`boolean`	`getRequestAttributesEnabled()`
`void`	`invoke(Request request, Response response)` Log a message summarizing the specified request and response, according to the format specified by the `pattern` property.
`protected abstract void`	`log(CharArrayWriter message)` Log the specified message.
`void`	`log(Request request, Response response, long time)` Add the request/response to the access log using the specified processing time.
`void`	`setCondition(String condition)` Set the ServletRequest.attribute to look for to perform conditional logging.
`void`	`setConditionIf(String condition)` Set the ServletRequest.attribute to look for to perform conditional logging.
`void`	`setConditionUnless(String condition)` Set the ServletRequest.attribute to look for to perform conditional logging.
`void`	`setEnabled(boolean enabled)`
`void`	`setLocale(String localeName)` Set the locale used to format timestamps in log entries and in log file name suffix.
`void`	`setPattern(String pattern)` Set the format pattern, first translating any recognized alias.
`void`	`setRequestAttributesEnabled(boolean requestAttributesEnabled)` Should this valve set request attributes for IP address, Hostname, protocol and port used for the request?
`protected void`	`startInternal()` Start this component and implement the requirements of `LifecycleBase.startInternal()`.
`protected void`	`stopInternal()` Stop this component and implement the requirements of `LifecycleBase.stopInternal()`.

Methods inherited from class org.apache.catalina.valves.ValveBase
backgroundProcess, event, getContainer, getDomainInternal, getNext, getObjectNameKeyProperties, initInternal, isAsyncSupported, setAsyncSupported, setContainer, setNext, toString

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase
destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - enabled
```
protected boolean enabled
```
    enabled this component
  - pattern
```
protected String pattern
```
    The pattern used to format our access log lines.
  - condition
```
protected String condition
```
    Are we doing conditional logging. default null. It is the value of conditionUnless property.
  - conditionIf
```
protected String conditionIf
```
    Are we doing conditional logging. default null. It is the value of conditionIf property.
  - localeName
```
protected String localeName
```
    Name of locale used to format timestamps in log entries and in log file name suffix.
  - locale
```
protected Locale locale
```
    Locale used to format timestamps in log entries and in log file name suffix.
  - logElements
```
protected AbstractAccessLogValve.AccessLogElement[] logElements
```
    Array of AccessLogElement, they will be used to make log message.
  - requestAttributesEnabled
```
protected boolean requestAttributesEnabled
```
    See Also:
    setRequestAttributesEnabled(boolean)
- Constructor Detail
  - AbstractAccessLogValve
```
public AbstractAccessLogValve()
```
- Method Detail
  - setRequestAttributesEnabled
```
public void setRequestAttributesEnabled(boolean requestAttributesEnabled)
```
    Should this valve set request attributes for IP address, Hostname, protocol and port used for the request? This are typically used in conjunction with the AccessLogValve which will otherwise log the original values. Default is true. The attributes set are:
    - org.apache.catalina.RemoteAddr
    - org.apache.catalina.RemoteHost
    - org.apache.catalina.Protocol
    - org.apache.catalina.ServerPost
    Specified by:
    
    setRequestAttributesEnabled in interface AccessLog
    
    Parameters:
    requestAttributesEnabled - true causes the attributes to be set, false disables the setting of the attributes.
  - getRequestAttributesEnabled
```
public boolean getRequestAttributesEnabled()
```
    Specified by:
    
    getRequestAttributesEnabled in interface AccessLog
    
    Returns:
    true if the attributes will be logged, otherwise false
    See Also:
    AccessLog.setRequestAttributesEnabled(boolean)
  - getEnabled
```
public boolean getEnabled()
```
    Returns:
    Returns the enabled.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Parameters:
    enabled - The enabled to set.
  - 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
  - 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
  - getConditionUnless
```
public String getConditionUnless()
```
    Return whether the attribute name to look for when performing conditional logging. If null, every request is logged.
  - setConditionUnless
```
public void setConditionUnless(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
  - getConditionIf
```
public String getConditionIf()
```
    Return whether the attribute name to look for when performing conditional logging. If null, every request is logged.
  - setConditionIf
```
public void setConditionIf(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
  - getLocale
```
public String getLocale()
```
    Return the locale used to format timestamps in log entries and in log file name suffix.
  - setLocale
```
public void setLocale(String localeName)
```
    Set the locale used to format timestamps in log entries and in log file name suffix. Changing the locale is only supported as long as the AccessLogValve has not logged anything. Changing the locale later can lead to inconsistent formatting.
    
    Parameters:
    localeName - The locale to use.
  - invoke
```
public void invoke(Request request,
          Response response)
            throws IOException,
                   ServletException
```
    Log a message summarizing the specified request and response, according to the format specified by the pattern property.
    
    Specified by:
    
    invoke in interface Valve
    
    Specified by:
    
    invoke in class ValveBase
    
    Parameters:
    request - Request being processed
    response - Response being processed
    
    Throws:
    
    IOException - if an input/output error has occurred
    
    ServletException - if a servlet error has occurred
  - log
```
public void log(Request request,
       Response response,
       long time)
```
    Description copied from interface: AccessLog
    
    Add the request/response to the access log using the specified processing time.
    
    Specified by:
    
    log in interface AccessLog
    
    Parameters:
    request - Request (associated with the response) to log
    response - Response (associated with the request) to log
    time - Time taken to process the request/response in milliseconds (use 0 if not known)
  - log
```
protected abstract void log(CharArrayWriter message)
```
    Log the specified message.
    
    Parameters:
    message - Message to be logged. This object will be recycled by the calling method.
  - findLocale
```
protected static Locale findLocale(String name,
                Locale fallback)
```
    Find a locale by name
  - startInternal
```
protected void startInternal()
                      throws LifecycleException
```
    Start this component and implement the requirements of LifecycleBase.startInternal().
    
    Overrides:
    
    startInternal in class ValveBase
    
    Throws:
    
    LifecycleException - if this component detects a fatal error that prevents this component from being used
  - stopInternal
```
protected void stopInternal()
                     throws LifecycleException
```
    Stop this component and implement the requirements of LifecycleBase.stopInternal().
    
    Overrides:
    
    stopInternal in class ValveBase
    
    Throws:
    
    LifecycleException - if this component detects a fatal error that prevents this component from being used
  - createLogElements
```
protected AbstractAccessLogValve.AccessLogElement[] createLogElements()
```
    parse pattern string and create the array of AccessLogElement
  - createAccessLogElement
```
protected AbstractAccessLogValve.AccessLogElement createAccessLogElement(String header,
                                                             char pattern)
```
    create an AccessLogElement implementation which needs header string
  - createAccessLogElement
```
protected AbstractAccessLogValve.AccessLogElement createAccessLogElement(char pattern)
```
    create an AccessLogElement implementation

Class AbstractAccessLogValve

Nested Class Summary

Field Summary

Fields inherited from class org.apache.catalina.valves.ValveBase

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

Fields inherited from interface org.apache.catalina.AccessLog

Fields inherited from interface org.apache.catalina.Lifecycle

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

enabled

pattern

condition

conditionIf

localeName

locale

logElements

requestAttributesEnabled

Constructor Detail

AbstractAccessLogValve

Method Detail

setRequestAttributesEnabled

getRequestAttributesEnabled

getEnabled

setEnabled

getPattern

setPattern

getCondition

setCondition

getConditionUnless

setConditionUnless

getConditionIf

setConditionIf

getLocale

setLocale

invoke

log

log

findLocale

startInternal

stopInternal

createLogElements

createAccessLogElement

createAccessLogElement