org.apache.catalina.valves
public class AccessLogValve extends ValveBase implements Lifecycle
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:
In addition, the caller can specify one of the following aliases for commonly utilized patterns:
%h %l %u %t "%r" %s %b
%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}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
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: 832123 $ $Date: 2009-11-02 22:57:21 +0100 (Mon, 02 Nov 2009) $
Nested Class Summary | |
---|---|
protected interface | AccessLogValve.AccessLogElement
AccessLogElement writes the partial message into the buffer. |
protected class | AccessLogValve.ByteSentElement
write bytes sent, excluding HTTP headers - %b, %B |
protected class | AccessLogValve.CookieElement
write a specific cookie - %{xxx}c |
protected class | AccessLogValve.DateAndTimeElement
write date and time, in Common Log Format - %t |
protected class | AccessLogValve.ElapsedTimeElement
write time taken to process the request - %D, %T |
protected class | AccessLogValve.HeaderElement
write incoming headers - %{xxx}i |
protected class | AccessLogValve.HostElement
write remote host name - %h |
protected class | AccessLogValve.HttpStatusCodeElement
write HTTP status code of the response - %s |
protected static class | AccessLogValve.LocalAddrElement
write local IP address - %A |
protected class | AccessLogValve.LocalPortElement
write local port on which this request was received - %p |
protected class | AccessLogValve.LocalServerNameElement
write local server name - %v |
protected class | AccessLogValve.LogicalUserNameElement
write remote logical username from identd (always returns '-') - %l |
protected class | AccessLogValve.MethodElement
write request method (GET, POST, etc.) |
protected class | AccessLogValve.ProtocolElement
write request protocol - %H |
protected class | AccessLogValve.QueryElement
write Query string (prepended with a '? |
protected class | AccessLogValve.RemoteAddrElement
write remote IP address - %a |
protected class | AccessLogValve.RequestAttributeElement
write an attribute in the ServletRequest - %{xxx}r |
protected class | AccessLogValve.RequestElement
write first line of the request (method and request URI) - %r |
protected class | AccessLogValve.RequestURIElement
write requested URL path - %U |
protected class | AccessLogValve.ResponseHeaderElement
write a specific response header - %{xxx}o |
protected class | AccessLogValve.SessionAttributeElement
write an attribute in the HttpSession - %{xxx}s |
protected class | AccessLogValve.SessionIdElement
write user session ID - %S |
protected class | AccessLogValve.StringElement
write any string |
protected class | AccessLogValve.ThreadNameElement
write thread name - %I |
protected class | AccessLogValve.UserElement
write remote user that was authenticated (if any), else '-' - %u |
Field Summary | |
---|---|
protected String | condition
Are we doing conditional logging. default false. |
protected File | currentLogFile
The current log file we are writing to. |
protected boolean | enabled
enabled this component |
protected String | fileDateFormat
Date format to place in log file name. |
protected SimpleDateFormat | fileDateFormatter
A date formatter to format a Date into a date in the format
"yyyy-MM-dd". |
protected static String | info
The descriptive information about this implementation. |
protected LifecycleSupport | lifecycle
The lifecycle event support for this component. |
protected AccessLogValve.AccessLogElement[] | logElements
Array of AccessLogElement, they will be used to make log message. |
protected static String[] | months
The set of month abbreviations for log messages. |
protected String | pattern
The pattern used to format our access log lines. |
protected String | prefix
The prefix that is added to log file filenames. |
protected boolean | rotatable
Should we rotate our log file? |
protected StringManager | sm
The string manager for this package. |
protected boolean | started
Has this component been started yet? |
protected String | suffix
The suffix that is added to log file filenames. |
protected PrintWriter | writer
The PrintWriter to which we are currently logging, if any. |
Method Summary | |
---|---|
void | addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component.
|
void | backgroundProcess()
Execute a periodic task, such as reloading, etc. |
protected AccessLogValve.AccessLogElement[] | createLogElements()
parse pattern string and create the array of AccessLogElement |
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. |
boolean | getEnabled() |
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)
Log a message summarizing the specified request and response, according
to the format specified by the pattern property.
|
boolean | isBuffered()
Is the logging buffered |
boolean | isCheckExists()
Check for file existence before logging. |
boolean | isResolveHosts()
Get the value of the resolve hosts flag. |
boolean | isRotatable()
Should we rotate the logs |
void | log(String message)
Log the specified message to the log file, switching files if the date
has changed since the previous log call.
|
protected void | open()
Open the new log file for the date specified by dateStamp . |
void | removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component.
|
boolean | rotate(String newFileName)
Rename the existing log file to something else. |
void | setBuffered(boolean buffered)
Set the value if the logging should be buffered
|
void | setCheckExists(boolean checkExists)
Set whether to check for log file existence before logging.
|
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 | setEnabled(boolean enabled) |
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. |
Parameters: listener The listener to add
Returns: Returns the enabled.
pattern
property.
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
Parameters: message Message to be logged
dateStamp
.Parameters: listener The listener to add
Parameters: newFileName The file name to move the log file entry to
Returns: true if a file was rotated with no error
Parameters: buffered true if buffered.
Parameters: checkExists true meaning to check for file existence.
Parameters: condition Set to null to log everything
Parameters: directory The new log file directory
Parameters: enabled The enabled to set.
Parameters: pattern The new pattern
Parameters: prefix The new log file prefix
Parameters: resolveHosts The new resolve hosts value
Parameters: rotatable true is we should rotate.
Parameters: suffix The new log file suffix
configure()
,
and before any of the public methods of the component are utilized.
Throws: LifecycleException if this component detects a fatal error that prevents this component from being used
Throws: LifecycleException if this component detects a fatal error that needs to be reported