| java.lang.Object
 org.apache.catalina.valves.ValveBase
org.apache.catalina.valves.AccessLogValve
| AccessLogValve | | final public class AccessLogValve extends ValveBase implements Lifecycle(Code) | | 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.
author:
Craig R. McClanahan
author:
Jason Brittain
version:
$Revision: 1.10 $ $Date: 2004/02/27 14:58:52 $ |
| Field Summary | |
| final protected static String | info
The descriptive information about this implementation. | | protected LifecycleSupport | lifecycle
The lifecycle event support for this component. | | final protected static String | months
The set of month abbreviations for log messages. |
| Constructor Summary | |
| public | AccessLogValve()
Construct a new instance of this class with default property values. |
| info | | final protected static String info(Code) | | The descriptive information about this implementation.
|
| months | | final protected static String months(Code) | | The set of month abbreviations for log messages.
|
| AccessLogValve | | public AccessLogValve()(Code) | | Construct a new instance of this class with default property values.
|
| addLifecycleListener | | public void addLifecycleListener(LifecycleListener listener)(Code) | | Add a lifecycle event listener to this component.
Parameters:
listener - The listener to add |
| findLifecycleListeners | | public LifecycleListener[] findLifecycleListeners()(Code) | | Get the lifecycle listeners associated with this lifecycle. If this
Lifecycle has no listeners registered, a zero-length array is returned.
|
| getCondition | | public String getCondition()(Code) | | Return whether the attribute name to look for when
performing conditional loggging. If null, every
request is logged.
|
| getDirectory | | public String getDirectory()(Code) | | Return the directory in which we create log files.
|
| getFileDateFormat | | public String getFileDateFormat()(Code) | | Return the date format date based log rotation.
|
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this implementation.
|
| getPattern | | public String getPattern()(Code) | | Return the format pattern.
|
| getPrefix | | public String getPrefix()(Code) | | Return the log file prefix.
|
| getSuffix | | public String getSuffix()(Code) | | Return the log file suffix.
|
| invoke | | public void invoke(Request request, Response response, ValveContext context) throws IOException, ServletException(Code) | | Log a message summarizing the specified request and response, according
to the format specified by the pattern property.
Parameters:
request - Request being processed
Parameters:
response - Response being processed
Parameters:
context - The valve context used to invoke the next valvein the current processing pipeline
exception:
IOException - if an input/output error has occurred
exception:
ServletException - if a servlet error has occurred |
| isResolveHosts | | public boolean isResolveHosts()(Code) | | Get the value of the resolve hosts flag.
|
| isRotatable | | public boolean isRotatable()(Code) | | Should we rotate the logs
|
| log | | public void log(String message, Date date)(Code) | | 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
Parameters:
date - the current Date object (so this method doesn't need tocreate a new one) |
| removeLifecycleListener | | public void removeLifecycleListener(LifecycleListener listener)(Code) | | Remove a lifecycle event listener from this component.
Parameters:
listener - The listener to add |
| setCondition | | public void setCondition(String condition)(Code) | | 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 |
| setDirectory | | public void setDirectory(String directory)(Code) | | Set the directory in which we create log files.
Parameters:
directory - The new log file directory |
| setFileDateFormat | | public void setFileDateFormat(String fileDateFormat)(Code) | | Set the date format date based log rotation.
|
| setPattern | | public void setPattern(String pattern)(Code) | | Set the format pattern, first translating any recognized alias.
Parameters:
pattern - The new pattern |
| setPrefix | | public void setPrefix(String prefix)(Code) | | Set the log file prefix.
Parameters:
prefix - The new log file prefix |
| setResolveHosts | | public void setResolveHosts(boolean resolveHosts)(Code) | | Set the resolve hosts flag.
Parameters:
resolveHosts - The new resolve hosts value |
| setRotatable | | public void setRotatable(boolean rotatable)(Code) | | Set the value is we should we rotate the logs
Parameters:
rotatable - true is we should rotate. |
| setSuffix | | public void setSuffix(String suffix)(Code) | | Set the log file suffix.
Parameters:
suffix - The new log file suffix |
| start | | public void start() throws LifecycleException(Code) | | 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.
exception:
LifecycleException - if this component detects a fatal errorthat prevents this component from being used |
| stop | | public void stop() throws LifecycleException(Code) | | 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.
exception:
LifecycleException - if this component detects a fatal errorthat needs to be reported |
|
|