| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.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 HTTP Server
 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 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
 
 Log rotation can be on or off. This is dictated by the
 rotatable property.
 
 For UNIX users, another field called checkExists is also
 available. If set to true, the log file's existence will be checked before
 each logging. This way an external log rotator can move the file
 somewhere and Tomcat will start with a new file.
 
 For JMX junkies, a public method called rotate has
 been made available to allow you to tell this instance to move
 the existing log file to somewhere else and start writing a new log file.
 
 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.
 
For extended attributes coming from a getAttribute() call, it is you responsibility to ensure there are no newline or control characters.
| Nested Class Summary | |
|---|---|
| protected static interface | AccessLogValve.AccessLogElementAccessLogElement writes the partial message into the buffer. | 
| protected  class | AccessLogValve.ByteSentElementwrite bytes sent, excluding HTTP headers - %b, %B | 
| protected  class | AccessLogValve.CookieElementwrite a specific cookie - %{xxx}c | 
| protected  class | AccessLogValve.DateAndTimeElementwrite date and time, in Common Log Format - %t | 
| protected  class | AccessLogValve.ElapsedTimeElementwrite time taken to process the request - %D, %T | 
| protected  class | AccessLogValve.HeaderElementwrite incoming headers - %{xxx}i | 
| protected  class | AccessLogValve.HostElementwrite remote host name - %h | 
| protected  class | AccessLogValve.HttpStatusCodeElementwrite HTTP status code of the response - %s | 
| protected static class | AccessLogValve.LocalAddrElementwrite local IP address - %A | 
| protected  class | AccessLogValve.LocalPortElementwrite local port on which this request was received - %p | 
| protected  class | AccessLogValve.LocalServerNameElementwrite local server name - %v | 
| protected  class | AccessLogValve.LogicalUserNameElementwrite remote logical username from identd (always returns '-') - %l | 
| protected  class | AccessLogValve.MethodElementwrite request method (GET, POST, etc.) - %m | 
| protected  class | AccessLogValve.ProtocolElementwrite request protocol - %H | 
| protected  class | AccessLogValve.QueryElementwrite Query string (prepended with a '?' | 
| protected  class | AccessLogValve.RemoteAddrElementwrite remote IP address - %a | 
| protected  class | AccessLogValve.RequestAttributeElementwrite an attribute in the ServletRequest - %{xxx}r | 
| protected  class | AccessLogValve.RequestElementwrite first line of the request (method and request URI) - %r | 
| protected  class | AccessLogValve.RequestURIElementwrite requested URL path - %U | 
| protected  class | AccessLogValve.ResponseHeaderElementwrite a specific response header - %{xxx}o | 
| protected  class | AccessLogValve.SessionAttributeElementwrite an attribute in the HttpSession - %{xxx}s | 
| protected  class | AccessLogValve.SessionIdElementwrite user session ID - %S | 
| protected  class | AccessLogValve.StringElementwrite any string | 
| protected  class | AccessLogValve.ThreadNameElementwrite thread name - %I | 
| protected  class | AccessLogValve.UserElementwrite remote user that was authenticated (if any), else '-' - %u | 
| Field Summary | |
|---|---|
| protected  java.lang.String | conditionAre we doing conditional logging. default false. | 
| protected  java.io.File | currentLogFileThe current log file we are writing to. | 
| protected  boolean | enabledenabled this component | 
| protected  java.lang.String | encodingCharacter set used by the log file. | 
| protected  java.lang.String | fileDateFormatDate format to place in log file name. | 
| protected  java.text.SimpleDateFormat | fileDateFormatterA date formatter to format a Date into a date in the format "yyyy-MM-dd". | 
| protected static java.lang.String | infoThe descriptive information about this implementation. | 
| protected  LifecycleSupport | lifecycleThe lifecycle event support for this component. | 
| protected  AccessLogValve.AccessLogElement[] | logElementsArray of AccessLogElement, they will be used to make log message. | 
| protected static java.lang.String[] | monthsThe set of month abbreviations for log messages. | 
| protected  java.lang.String | patternThe pattern used to format our access log lines. | 
| protected  java.lang.String | prefixThe prefix that is added to log file filenames. | 
| protected  boolean | rotatableShould we rotate our log file? | 
| protected  StringManager | smThe string manager for this package. | 
| protected  boolean | startedHas this component been started yet? | 
| protected  java.lang.String | suffixThe suffix that is added to log file filenames. | 
| protected  java.io.PrintWriter | writerThe PrintWriter to which we are currently logging, if any. | 
| Fields inherited from class org.apache.catalina.valves.ValveBase | 
|---|
| container, containerLog, controller, domain, mserver, next, oname | 
| Fields inherited from interface org.apache.catalina.Lifecycle | 
|---|
| AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT | 
| Constructor Summary | |
|---|---|
| AccessLogValve() | |
| 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 | createAccessLogElement(char pattern)create an AccessLogElement implementation | 
| protected  AccessLogValve.AccessLogElement | createAccessLogElement(java.lang.String header,
                       char pattern)create an AccessLogElement implementation which needs header string | 
| protected  AccessLogValve.AccessLogElement[] | createLogElements()parse pattern string and create the array of AccessLogElement | 
|  LifecycleListener[] | findLifecycleListeners()Get the lifecycle listeners associated with this lifecycle. | 
|  java.lang.String | getCondition()Return whether the attribute name to look for when performing conditional loggging. | 
|  java.lang.String | getDirectory()Return the directory in which we create log files. | 
|  boolean | getEnabled() | 
|  java.lang.String | getEncoding()Return the character set name that is used to write the log file. | 
|  java.lang.String | getFileDateFormat()Return the date format date based log rotation. | 
|  java.lang.String | getInfo()Return descriptive information about this implementation. | 
|  java.lang.String | getPattern()Return the format pattern. | 
|  java.lang.String | getPrefix()Return the log file prefix. | 
|  java.lang.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 patternproperty. | 
|  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 access log. | 
|  void | log(Request request,
    Response response,
    long time)Add the request/response to the access log using the specified processing time. | 
|  void | log(java.lang.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(java.lang.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(java.lang.String condition)Set the ServletRequest.attribute to look for to perform conditional logging. | 
|  void | setDirectory(java.lang.String directory)Set the directory in which we create log files. | 
|  void | setEnabled(boolean enabled) | 
|  void | setEncoding(java.lang.String encoding)Set the character set that is used to write the log file. | 
|  void | setFileDateFormat(java.lang.String fileDateFormat)Set the date format date based log rotation. | 
|  void | setPattern(java.lang.String pattern)Set the format pattern, first translating any recognized alias. | 
|  void | setPrefix(java.lang.String prefix)Set the log file prefix. | 
|  void | setResolveHosts(boolean resolveHosts)Set the resolve hosts flag. | 
|  void | setRotatable(boolean rotatable)Configure whether the access log should be rotated. | 
|  void | setSuffix(java.lang.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. | 
| Methods inherited from class org.apache.catalina.valves.ValveBase | 
|---|
| createObjectName, event, getContainer, getContainerName, getController, getDomain, getNext, getObjectName, getParentName, postDeregister, postRegister, preDeregister, preRegister, setContainer, setController, setNext, setObjectName, toString | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Field Detail | 
|---|
protected static final java.lang.String info
protected LifecycleSupport lifecycle
protected static final java.lang.String[] months
protected boolean enabled
protected java.lang.String pattern
protected java.lang.String prefix
protected boolean rotatable
protected StringManager sm
protected boolean started
protected java.lang.String suffix
protected java.io.PrintWriter writer
protected java.text.SimpleDateFormat fileDateFormatter
protected java.io.File currentLogFile
protected java.lang.String condition
protected java.lang.String fileDateFormat
protected java.lang.String encoding
null, the
 system default character set will be used. An empty string will be
 treated as null when this property is assigned.
protected AccessLogValve.AccessLogElement[] logElements
| Constructor Detail | 
|---|
public AccessLogValve()
| Method Detail | 
|---|
public boolean getEnabled()
public void setEnabled(boolean enabled)
enabled - The enabled to set.public java.lang.String getDirectory()
public void setDirectory(java.lang.String directory)
directory - The new log file directorypublic java.lang.String getInfo()
getInfo in interface ValvegetInfo in class ValveBasepublic java.lang.String getPattern()
public void setPattern(java.lang.String pattern)
pattern - The new patternpublic boolean isCheckExists()
public void setCheckExists(boolean checkExists)
checkExists - true meaning to check for file existence.public java.lang.String getPrefix()
public void setPrefix(java.lang.String prefix)
prefix - The new log file prefixpublic boolean isRotatable()
true if the access log should be rotatedpublic void setRotatable(boolean rotatable)
rotatable - true if the log should be rotatedpublic boolean isBuffered()
public void setBuffered(boolean buffered)
buffered - true if buffered.public java.lang.String getSuffix()
public void setSuffix(java.lang.String suffix)
suffix - The new log file suffixpublic void setResolveHosts(boolean resolveHosts)
resolveHosts - The new resolve hosts valuepublic boolean isResolveHosts()
public java.lang.String getCondition()
public void setCondition(java.lang.String condition)
condition - Set to null to log everythingpublic java.lang.String getFileDateFormat()
public void setFileDateFormat(java.lang.String fileDateFormat)
public java.lang.String getEncoding()
null if the system default
  character set is used.public void setEncoding(java.lang.String encoding)
encoding - The name of the character set.public void backgroundProcess()
backgroundProcess in interface ValvebackgroundProcess in class ValveBase
public void invoke(Request request,
                   Response response)
            throws java.io.IOException,
                   javax.servlet.ServletException
pattern property.
invoke in interface Valveinvoke in class ValveBaserequest - Request being processedresponse - Response being processed
java.io.IOException - if an input/output error has occurred
javax.servlet.ServletException - if a servlet error has occurred
public void log(Request request,
                Response response,
                long time)
AccessLog
log in interface AccessLogrequest - 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(java.lang.String newFileName)
newFileName - The file name to move the log file entry to
public void log(java.lang.String message)
message - Message to be loggedprotected void open()
dateStamp.
public void addLifecycleListener(LifecycleListener listener)
addLifecycleListener in interface Lifecyclelistener - The listener to addpublic LifecycleListener[] findLifecycleListeners()
findLifecycleListeners in interface Lifecyclepublic void removeLifecycleListener(LifecycleListener listener)
removeLifecycleListener in interface Lifecyclelistener - The listener to add
public void start()
           throws LifecycleException
configure(),
 and before any of the public methods of the component are utilized.
start in interface LifecycleLifecycleException - if this component detects a fatal error
  that prevents this component from being used
public void stop()
          throws LifecycleException
stop in interface LifecycleLifecycleException - if this component detects a fatal error
  that needs to be reportedprotected AccessLogValve.AccessLogElement[] createLogElements()
protected AccessLogValve.AccessLogElement createAccessLogElement(java.lang.String header,
                                                                 char pattern)
protected AccessLogValve.AccessLogElement createAccessLogElement(char pattern)
| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||