Java Doc for ExtendedAccessLogValve.java in » Sevlet-Container » tomcat-catalina » org » apache » catalina » valves » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Sevlet Container » tomcat catalina » org.apache.catalina.valves

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.catalina.valves .ValveBase

org.apache.catalina.valves .ExtendedAccessLogValve

ExtendedAccessLogValve

final public class ExtendedAccessLogValve extends ValveBase implements Lifecycle(Code)

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:

c-dns: Client hostname
c-ip: Client ip address
bytes: bytes served
cs-method: request method
cs-uri: The full uri requested
cs-uri-query: The query string
cs-uri-stem: The uri without query string
date: The date in yyyy-mm-dd format for GMT
s-dns: The server dns entry
s-ip: The server ip address
cs(XXX): The value of header XXX from client to server
sc(XXX): The value of header XXX from server to client
sc-status: The status code
time: Time the request was served
time-taken: Time (in seconds) taken to serve the request
x-A(XXX): Pull XXX attribute from the servlet context
x-C(XXX): Pull the first cookie of the name XXX
x-R(XXX): Pull XXX attribute from the servlet request
x-S(XXX): Pull XXX attribute from the session
x-P(...): Call request.getParameter(...) and URLencode it. Helpful to capture certain POST parameters.
For any of the x-H(...) the following method will be called from the HttpServletRequestObject
x-H(authType): getAuthType
x-H(characterEncoding): getCharacterEncoding
x-H(contentLength): getContentLength
x-H(locale): getLocale
x-H(protocol): getProtocol
x-H(remoteUser): getRemoteUser
x-H(requestedSessionId): getGequestedSessionId
x-H(requestedSessionIdFromCookie): isRequestedSessionIdFromCookie
x-H(requestedSessionIdValid): isRequestedSessionIdValid
x-H(scheme): getScheme
x-H(secure): isSecure

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.

author:
Tim Funk
version:
$Revision: 1.8.2.1 $ $Date: 2004/08/21 15:49:56 $

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

Constructor Summary
public	ExtendedAccessLogValve() Construct a new instance of this class with default property values.

Method Summary
public void	addLifecycleListener(LifecycleListener listener) Add a lifecycle event listener to this component.
public FieldInfo[]	decodePattern(String fields) Decode the given pattern.
public LifecycleListener[]	findLifecycleListeners() Get the lifecycle listeners associated with this lifecycle.
public String	getCondition() Return whether the attribute name to look for when performing conditional loggging.
public String	getDirectory() Return the directory in which we create log files.
public String	getFileDateFormat() Return the date format date based log rotation.
public String	getInfo() Return descriptive information about this implementation.
public String	getPattern() Return the format pattern.
public String	getPrefix() Return the log file prefix.
public String	getSuffix() Return the log file suffix.
public 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.
public boolean	isCheckExists() Check for file existence before logging.
public boolean	isRotatable() Return true if logs are automatically rotated.
public void	removeLifecycleListener(LifecycleListener listener) Remove a lifecycle event listener from this component.
public synchronized boolean	rotate(String newFileName) Rename the existing log file to something else.
public void	setCheckExists(boolean checkExists) Set whether to check for log file existence before logging.
public void	setCondition(String condition) Set the ServletRequest.attribute to look for to perform conditional logging.
public void	setDirectory(String directory) Set the directory in which we create log files.
public void	setFileDateFormat(String fileDateFormat) Set the date format date based log rotation.
public void	setPattern(String pattern) Set the format pattern, first translating any recognized alias.
public void	setPrefix(String prefix) Set the log file prefix.
public void	setRotatable(boolean rotatable)
public void	setSuffix(String suffix) Set the log file suffix.
public void	start() Prepare for the beginning of active use of the public methods of this component.
public void	stop() Gracefully terminate the active use of the public methods of this component.

Field Detail

info
final protected static String info(Code)
	The descriptive information about this implementation.

lifecycle
protected LifecycleSupport lifecycle(Code)
	The lifecycle event support for this component.

Constructor Detail

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

Method Detail

addLifecycleListener
public void addLifecycleListener(LifecycleListener listener)(Code)
	Add a lifecycle event listener to this component. Parameters: listener - The listener to add

decodePattern
public FieldInfo[] decodePattern(String fields)(Code)
	Decode the given pattern. Is public so a pattern may allows to be validated. Parameters: fields - The pattern to decode null on error. Otherwise array of decoded fields

findLifecycleListeners
public LifecycleListener[] findLifecycleListeners()(Code)
	Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.

getCondition
public String getCondition()(Code)
	Return whether the attribute name to look for when performing conditional loggging. If null, every request is logged.

getDirectory
public String getDirectory()(Code)
	Return the directory in which we create log files.

getFileDateFormat
public String getFileDateFormat()(Code)
	Return the date format date based log rotation.

getInfo
public String getInfo()(Code)
	Return descriptive information about this implementation.

getPattern
public String getPattern()(Code)
	Return the format pattern.

getPrefix
public String getPrefix()(Code)
	Return the log file prefix.

getSuffix
public String getSuffix()(Code)
	Return the log file suffix.

invoke
public void invoke(Request request, Response response, ValveContext context) throws IOException, ServletException(Code)
	Log a message summarizing the specified request and response, according to the format specified by the `pattern` property. Parameters: request - Request being processed Parameters: response - Response being processed Parameters: context - The valve context used to invoke the next valvein the current processing pipeline exception: IOException - if an input/output error has occurred exception: ServletException - if a servlet error has occurred

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

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

removeLifecycleListener
public void removeLifecycleListener(LifecycleListener listener)(Code)
	Remove a lifecycle event listener from this component. Parameters: listener - The listener to add

rotate
public synchronized boolean rotate(String newFileName)(Code)
	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 true if a file was rotated with no error

setCheckExists
public void setCheckExists(boolean checkExists)(Code)
	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)(Code)
	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)(Code)
	Set the directory in which we create log files. Parameters: directory - The new log file directory

setFileDateFormat
public void setFileDateFormat(String fileDateFormat)(Code)
	Set the date format date based log rotation.

setPattern
public void setPattern(String pattern)(Code)
	Set the format pattern, first translating any recognized alias. Parameters: pattern - The new pattern pattern

setPrefix
public void setPrefix(String prefix)(Code)
	Set the log file prefix. Parameters: prefix - The new log file prefix

setRotatable
public void setRotatable(boolean rotatable)(Code)
	Set the value is we should we rotate the logs Parameters: rotatable - true is we should rotate.

setSuffix
public void setSuffix(String suffix)(Code)
	Set the log file suffix. Parameters: suffix - The new log file suffix

start
public void start() throws LifecycleException(Code)
	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. exception: LifecycleException - if this component detects a fatal errorthat prevents this component from being used

stop
public void stop() throws LifecycleException(Code)
	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. exception: LifecycleException - if this component detects a fatal errorthat needs to be reported

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

protected Container container(Code)(Java Doc)
protected ObjectName controller(Code)(Java Doc)
protected int debug(Code)(Java Doc)
protected String domain(Code)(Java Doc)
protected static String info(Code)(Java Doc)
protected MBeanServer mserver(Code)(Java Doc)
protected ObjectName oname(Code)(Java Doc)
final protected static StringManager sm(Code)(Java Doc)

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

public ObjectName createObjectName(String domain, ObjectName parent) throws MalformedObjectNameException(Code)(Java Doc)
public Container getContainer()(Code)(Java Doc)
public ObjectName getContainerName()(Code)(Java Doc)
public ObjectName getController()(Code)(Java Doc)
public int getDebug()(Code)(Java Doc)
public String getDomain()(Code)(Java Doc)
public String getInfo()(Code)(Java Doc)
public ObjectName getObjectName()(Code)(Java Doc)
public ObjectName getParentName(ObjectName valveName)(Code)(Java Doc)
abstract public void invoke(Request request, Response response, ValveContext context) throws IOException, ServletException(Code)(Java Doc)
public void postDeregister()(Code)(Java Doc)
public void postRegister(Boolean registrationDone)(Code)(Java Doc)
public void preDeregister() throws Exception(Code)(Java Doc)
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception(Code)(Java Doc)
public void setContainer(Container container)(Code)(Java Doc)
public void setController(ObjectName controller)(Code)(Java Doc)
public void setDebug(int debug)(Code)(Java Doc)
public void setObjectName(ObjectName oname)(Code)(Java Doc)

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.