|
Apache Tomcat 7.0.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.catalina.util.LifecycleBase
org.apache.catalina.util.LifecycleMBeanBase
org.apache.catalina.valves.ValveBase
org.apache.catalina.valves.AccessLogValve
public 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:
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.
Nested Class Summary | |
---|---|
protected static 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.) - %m |
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 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 static StringManager |
sm
The string manager for this package. |
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. |
Fields inherited from class org.apache.catalina.valves.ValveBase |
---|
asyncSupported, container, containerLog, next |
Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase |
---|
mserver |
Fields inherited from interface org.apache.catalina.Lifecycle |
---|
AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, DESTROY_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT |
Constructor Summary | |
---|---|
AccessLogValve()
|
Method Summary | |
---|---|
void |
backgroundProcess()
Execute a periodic task, such as reloading, etc. |
protected AccessLogValve.AccessLogElement[] |
createLogElements()
parse pattern string and create the array of AccessLogElement |
String |
getCondition()
Return whether the attribute name to look for when performing conditional logging. |
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(Request request,
Response response,
long time)
Add the request/response to the access log using the specified processing time. |
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 . |
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. |
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 |
---|
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 |
---|
protected static final String info
protected static final String[] months
protected boolean enabled
protected String pattern
protected String prefix
protected boolean rotatable
protected static final StringManager sm
protected String suffix
protected PrintWriter writer
protected SimpleDateFormat fileDateFormatter
protected File currentLogFile
protected String condition
protected String fileDateFormat
protected AccessLogValve.AccessLogElement[] logElements
Constructor Detail |
---|
public AccessLogValve()
Method Detail |
---|
public boolean getEnabled()
public void setEnabled(boolean enabled)
enabled
- The enabled to set.public String getDirectory()
public void setDirectory(String directory)
directory
- The new log file directorypublic String getInfo()
getInfo
in interface Valve
getInfo
in class ValveBase
public String getPattern()
public void setPattern(String pattern)
pattern
- The new patternpublic boolean isCheckExists()
public void setCheckExists(boolean checkExists)
checkExists
- true meaning to check for file existence.public String getPrefix()
public void setPrefix(String prefix)
prefix
- The new log file prefixpublic boolean isRotatable()
public void setRotatable(boolean rotatable)
rotatable
- true is we should rotate.public boolean isBuffered()
public void setBuffered(boolean buffered)
buffered
- true if buffered.public String getSuffix()
public void setSuffix(String suffix)
suffix
- The new log file suffixpublic void setResolveHosts(boolean resolveHosts)
resolveHosts
- The new resolve hosts valuepublic boolean isResolveHosts()
public String getCondition()
public void setCondition(String condition)
condition
- Set to null to log everythingpublic String getFileDateFormat()
public void setFileDateFormat(String fileDateFormat)
public void backgroundProcess()
backgroundProcess
in interface Valve
backgroundProcess
in class ValveBase
public void invoke(Request request, Response response) throws IOException, ServletException
pattern
property.
invoke
in interface Valve
invoke
in class ValveBase
request
- Request being processedresponse
- Response being processed
IOException
- if an input/output error has occurred
ServletException
- if a servlet error has occurredpublic void log(Request request, Response response, long time)
AccessLog
log
in interface AccessLog
request
- Request (associated with the response) to logresponse
- Response (associated with the request) to logtime
- Time taken to process the request/response in
milliseconds (use 0 if not known)public boolean rotate(String newFileName)
newFileName
- The file name to move the log file entry to
public void log(String message)
message
- Message to be loggedprotected void open()
dateStamp
.
protected void startInternal() throws LifecycleException
LifecycleBase.startInternal()
.
startInternal
in class ValveBase
LifecycleException
- if this component detects a fatal error
that prevents this component from being usedprotected void stopInternal() throws LifecycleException
LifecycleBase.stopInternal()
.
stopInternal
in class ValveBase
LifecycleException
- if this component detects a fatal error
that prevents this component from being usedprotected AccessLogValve.AccessLogElement[] createLogElements()
|
Apache Tomcat 7.0.4 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |