org.apache.catalina.valves

Class AccessLogValve

Implemented Interfaces:
Contained, Lifecycle, MBeanRegistration, Valve

public final 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:

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:

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: 1.10 $ $Date: 2004/02/27 14:58:52 $

Authors:
Craig R. McClanahan
Jason Brittain

Field Summary

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.

Fields inherited from class org.apache.catalina.valves.ValveBase

container, controller, debug, domain, info, mserver, oname, sm

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

AccessLogValve()
Construct a new instance of this class with default property values.

Method Summary

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.

Methods inherited from class org.apache.catalina.valves.ValveBase

createObjectName, getContainer, getContainerName, getController, getDebug, getDomain, getInfo, getObjectName, getParentName, invoke, postDeregister, postRegister, preDeregister, preRegister, setContainer, setController, setDebug, setObjectName

Field Details

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.

Constructor Details

AccessLogValve

public AccessLogValve()
Construct a new instance of this class with default property values.

Method Details

addLifecycleListener

public void addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component.
Specified by:
addLifecycleListener in interface Lifecycle

Parameters:
listener - The listener to add


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.
Specified by:
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.
Specified by:
getInfo in interface Valve
Overrides:
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.
Specified by:
invoke in interface Valve
Overrides:
invoke in interface ValveBase

Parameters:
request - Request being processed
response - Response being processed
context - 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.

Parameters:
message - Message to be logged
date - the current Date object (so this method doesn't need to create a new one)


removeLifecycleListener

public void removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component.
Specified by:
removeLifecycleListener in interface Lifecycle

Parameters:
listener - The listener to add


setCondition

public void setCondition(String condition)
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)
Set the directory in which we create log files.

Parameters:
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.

Parameters:
pattern - The new pattern


setPrefix

public void setPrefix(String prefix)
Set the log file prefix.

Parameters:
prefix - The new log file prefix


setResolveHosts

public void setResolveHosts(boolean resolveHosts)
Set the resolve hosts flag.

Parameters:
resolveHosts - The new resolve hosts value


setRotatable

public void setRotatable(boolean rotatable)
Set the value is we should we rotate the logs

Parameters:
rotatable - true is we should rotate.


setSuffix

public void setSuffix(String suffix)
Set the log file suffix.

Parameters:
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.
Specified by:
start in interface Lifecycle

Throws:
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.
Specified by:
stop in interface Lifecycle

Throws:
LifecycleException - if this component detects a fatal error that needs to be reported


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.