public class NCSARequestLog extends Object implements RequestLog
Constructor and Description |
---|
NCSARequestLog()
Constructor.
|
NCSARequestLog(String filename)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
getDatedFilename()
Get the dated log filename.
|
String |
getFilename()
Get the log filename.
|
String[] |
getIgnorePaths() |
boolean |
getLogCookies() |
String |
getLogDateFormat() |
boolean |
getLogLatency() |
String |
getLogTimeZone() |
int |
getRetainDays() |
boolean |
isAppend() |
boolean |
isExtended() |
boolean |
isStarted() |
void |
log(HttpRequest request,
HttpResponse response,
int responseLength)
Log a request.
|
protected void |
logExtended(HttpRequest request,
HttpResponse response,
Writer log)
Log Extended fields.
|
void |
setAppend(boolean a) |
void |
setBuffered(boolean b)
Deprecated.
ignored
|
void |
setExtended(boolean e) |
void |
setFilename(String filename)
Set the log filename.
|
void |
setIgnorePaths(String[] ignorePaths)
Set which paths to ignore.
|
void |
setLogCookies(boolean logCookies) |
void |
setLogDateFormat(String format) |
void |
setLogLatency(boolean logLatency) |
void |
setLogTimeZone(String tz) |
void |
setPreferProxiedForAddress(boolean value)
Prefer to log the proxied-for IP address (if present in
the request header) over the native requester IP address.
|
void |
setRetainDays(int retainDays) |
void |
start()
Start the LifeCycle.
|
void |
stop()
Stop the LifeCycle.
|
public NCSARequestLog()
public NCSARequestLog(String filename) throws IOException
filename
- Filename, which can be in
rolloverFileOutputStream formatIOException
RolloverFileOutputStream
public void setFilename(String filename)
filename
- The filename to use. If the filename contains the
string "yyyy_mm_dd", then a RolloverFileOutputStream is used and the
log is rolled over nightly and aged according setRetainDays. If no
filename is set or a null filename
passed, then requests are logged to System.err.setRetainDays(int)
public String getFilename()
getDatedFilename()
public String getDatedFilename()
getFilename()
public void setLogDateFormat(String format)
format
- The date format to use within the log file.public String getLogDateFormat()
public void setLogTimeZone(String tz)
tz
- The date format timezone to use within the log file.public String getLogTimeZone()
public int getRetainDays()
public void setRetainDays(int retainDays)
retainDays
- The number of days to retain rollovered log files.public boolean isExtended()
public void setExtended(boolean e)
e
- True if NCSA extended format is to be used.public boolean isAppend()
public void setAppend(boolean a)
a
- True if logs are appended to existing log files.public void setBuffered(boolean b)
public void setIgnorePaths(String[] ignorePaths)
ignorePaths
- Array of path specifications to ignorepublic String[] getIgnorePaths()
public boolean getLogCookies()
public void setLogCookies(boolean logCookies)
logCookies
- The logCookies to set.public boolean getLogLatency()
public void setLogLatency(boolean logLatency)
logLatency
- If true, latency is logged at the end of the log linepublic void setPreferProxiedForAddress(boolean value)
public void start() throws Exception
LifeCycle
public boolean isStarted()
public void stop()
LifeCycle
public void log(HttpRequest request, HttpResponse response, int responseLength)
log
in interface RequestLog
request
- The requestresponse
- The response to this request.responseLength
- The bytes written to the response.protected void logExtended(HttpRequest request, HttpResponse response, Writer log) throws IOException
request
- The request to log.response
- The response to log.log
- The writer to write the extra fields to.IOException
- Problem writing logCopyright © 2013. All Rights Reserved.