org.apache.catalina.valves
Class AccessLogValve
- Contained, Lifecycle, MBeanRegistration, Valve
public final class AccessLogValve
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:
- Craig R. McClanahan
- Jason Brittain
protected static String | info - The descriptive information about this implementation.
|
protected LifecycleSupport | lifecycle - The lifecycle event support for this component.
|
protected static String[] | months - The set of month abbreviations for log messages.
|
AccessLogValve() - Construct a new instance of this class with default property values.
|
void | addLifecycleListener(LifecycleListener listener) - Add a lifecycle event listener to this component.
|
LifecycleListener[] | findLifecycleListeners() - Get the lifecycle listeners associated with this lifecycle.
|
String | getCondition() - Return whether the attribute name to look for when
performing conditional loggging.
|
String | getDirectory() - Return the directory in which we create log files.
|
String | getFileDateFormat() - Return the date format date based log rotation.
|
String | getInfo() - Return descriptive information about this implementation.
|
String | getPattern() - Return the format pattern.
|
String | getPrefix() - Return the log file prefix.
|
String | getSuffix() - Return the log file suffix.
|
void | invoke(Request request, Response response, ValveContext context) - Log a message summarizing the specified request and response, according
to the format specified by the
pattern property.
|
boolean | isResolveHosts() - Get the value of the resolve hosts flag.
|
boolean | isRotatable() - Should we rotate the logs
|
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.
|
void | removeLifecycleListener(LifecycleListener listener) - Remove a lifecycle event listener from this component.
|
void | setCondition(String condition) - Set the ServletRequest.attribute to look for to perform
conditional logging.
|
void | setDirectory(String directory) - Set the directory in which we create log files.
|
void | setFileDateFormat(String fileDateFormat) - Set the date format date based log rotation.
|
void | setPattern(String pattern) - Set the format pattern, first translating any recognized alias.
|
void | setPrefix(String prefix) - Set the log file prefix.
|
void | setResolveHosts(boolean resolveHosts) - Set the resolve hosts flag.
|
void | setRotatable(boolean rotatable) - Set the value is we should we rotate the logs
|
void | setSuffix(String suffix) - Set the log file suffix.
|
void | start() - Prepare for the beginning of active use of the public methods of this
component.
|
void | stop() - Gracefully terminate the active use of the public methods of this
component.
|
createObjectName , getContainer , getContainerName , getController , getDebug , getDomain , getInfo , getObjectName , getParentName , invoke , postDeregister , postRegister , preDeregister , preRegister , setContainer , setController , setDebug , setObjectName |
info
protected static final String info
The descriptive information about this implementation.
lifecycle
protected LifecycleSupport lifecycle
The lifecycle event support for this component.
months
protected static final String[] months
The set of month abbreviations for log messages.
AccessLogValve
public AccessLogValve()
Construct a new instance of this class with default property values.
findLifecycleListeners
public LifecycleListener[] findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. If this
Lifecycle has no listeners registered, a zero-length array is returned.
- findLifecycleListeners in interface Lifecycle
getCondition
public String getCondition()
Return whether the attribute name to look for when
performing conditional loggging. If null, every
request is logged.
getDirectory
public String getDirectory()
Return the directory in which we create log files.
getFileDateFormat
public String getFileDateFormat()
Return the date format date based log rotation.
getInfo
public String getInfo()
Return descriptive information about this implementation.
- getInfo in interface Valve
- getInfo in interface ValveBase
getPattern
public String getPattern()
Return the format pattern.
getPrefix
public String getPrefix()
Return the log file prefix.
getSuffix
public String getSuffix()
Return the log file suffix.
invoke
public void invoke(Request request,
Response response,
ValveContext context)
throws IOException,
ServletException
Log a message summarizing the specified request and response, according
to the format specified by the pattern
property.
- invoke in interface Valve
- invoke in interface ValveBase
request
- Request being processedresponse
- Response being processedcontext
- The valve context used to invoke the next valve
in the current processing pipeline
isResolveHosts
public boolean isResolveHosts()
Get the value of the resolve hosts flag.
isRotatable
public boolean isRotatable()
Should we rotate the logs
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.
message
- Message to be loggeddate
- the current Date object (so this method doesn't need to
create a new one)
setCondition
public void setCondition(String condition)
Set the ServletRequest.attribute to look for to perform
conditional logging. Set to null to log everything.
condition
- Set to null to log everything
setDirectory
public void setDirectory(String directory)
Set the directory in which we create log files.
directory
- The new log file directory
setFileDateFormat
public void setFileDateFormat(String fileDateFormat)
Set the date format date based log rotation.
setPattern
public void setPattern(String pattern)
Set the format pattern, first translating any recognized alias.
pattern
- The new pattern
setPrefix
public void setPrefix(String prefix)
Set the log file prefix.
prefix
- The new log file prefix
setResolveHosts
public void setResolveHosts(boolean resolveHosts)
Set the resolve hosts flag.
resolveHosts
- The new resolve hosts value
setRotatable
public void setRotatable(boolean rotatable)
Set the value is we should we rotate the logs
rotatable
- true is we should rotate.
setSuffix
public void setSuffix(String suffix)
Set the log file suffix.
suffix
- The new log file suffix
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.
- start in interface Lifecycle
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.
- stop in interface Lifecycle
LifecycleException
- if this component detects a fatal error
that needs to be reported
Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.