public final class AccessLogValve extends ValveBase
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}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.
container, controller, debug, domain, lifecycle, log, next, oname, rb, startedAFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, INIT_EVENT, START_EVENT, STOP_EVENTEND_PIPELINE, INVOKE_NEXT| Constructor and Description |
|---|
AccessLogValve()
Construct a new instance of this class with default property values.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
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.
|
int |
invoke(Request request,
Response response)
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 |
postInvoke(Request request,
Response response)
A post-request processing implementation that does nothing.
|
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.
|
addLifecycleListener, backgroundProcess, createObjectName, event, findLifecycleListeners, getContainer, getController, getDebug, getDomain, getNext, getObjectName, getParentName, invoke, isStarted, removeLifecycleListener, setContainer, setController, setDebug, setNext, setObjectNamepublic AccessLogValve()
public String getDirectory()
public void setDirectory(String directory)
directory - The new log file directorypublic String getInfo()
public String getPattern()
public void setPattern(String pattern)
pattern - The new patternpublic 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 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 int invoke(Request request, Response response) throws IOException, javax.servlet.ServletException
pattern property.invoke in interface GlassFishValveinvoke in class ValveBaserequest - Request being processedresponse - Response being processedINVOKE_NEXT or END_PIPELINEIOException - if an input/output error has occurredjavax.servlet.ServletException - if a servlet error has occurredpublic void postInvoke(Request request, Response response)
ValveBasepostInvoke in interface GlassFishValvepostInvoke in class ValveBaserequest - The servlet request to be processedresponse - The servlet response to be createdpublic void log(String message, Date date)
message - Message to be loggeddate - the current Date object (so this method doesn't need to
create a new one)public void start()
throws LifecycleException
configure(),
and before any of the public methods of the component are utilized.start in interface Lifecyclestart in class ValveBaseLifecycleException - if this component detects a fatal error
that prevents this component from being usedpublic void stop()
throws LifecycleException
stop in interface Lifecyclestop in class ValveBaseLifecycleException - if this component detects a fatal error
that needs to be reportedCopyright © 2018. All rights reserved.