org.apache.catalina.valves

Class ExtendedAccessLogValve

Implemented Interfaces:
Contained, Lifecycle, MBeanRegistration, Valve

public final class ExtendedAccessLogValve
extends ValveBase
implements Lifecycle

An implementation of the W3c Extended Log File Format. See http://www.w3.org/TR/WD-logfile.html for more information about the format. The following fields are supported:

Log rotation can be on or off. This is dictated by the rotatable property.

For UNIX users, another field called checkExistsis 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 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.

Version:
$Revision: 1.8.2.1 $ $Date: 2004/08/21 15:49:56 $

Author:
Tim Funk

Field Summary

protected static String
info
The descriptive information about this implementation.
protected LifecycleSupport
lifecycle
The lifecycle event support for this component.

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

ExtendedAccessLogValve()
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.
org.apache.catalina.valves.FieldInfo[]
decodePattern(String fields)
Decode the given pattern.
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
isCheckExists()
Check for file existence before logging.
boolean
isRotatable()
Return true if logs are automatically rotated.
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
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
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
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.

Constructor Details

ExtendedAccessLogValve

public ExtendedAccessLogValve()
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


decodePattern

public org.apache.catalina.valves.FieldInfo[] decodePattern(String fields)
Decode the given pattern. Is public so a pattern may allows to be validated.

Parameters:
fields - The pattern to decode

Returns:
null on error. Otherwise array of decoded fields


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


isCheckExists

public boolean isCheckExists()
Check for file existence before logging.


isRotatable

public boolean isRotatable()
Return true if logs are automatically rotated.


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


rotate

public boolean rotate(String newFileName)
Rename the existing log file to something else. Then open the old log file name up once again. Intended to be called by a JMX agent.

Parameters:
newFileName - The file name to move the log file entry to

Returns:
true if a file was rotated with no error


setCheckExists

public void setCheckExists(boolean checkExists)
Set whether to check for log file existence before logging.

Parameters:
checkExists - true meaning to check for file existence.


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 pattern


setPrefix

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

Parameters:
prefix - The new log file prefix


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.