org.mortbay.jetty
Class NCSARequestLog

java.lang.Object
  extended by org.mortbay.component.AbstractLifeCycle
      extended by org.mortbay.jetty.NCSARequestLog
All Implemented Interfaces:
LifeCycle, RequestLog

public class NCSARequestLog
extends AbstractLifeCycle
implements RequestLog

This RequestLog implementation outputs logs in the pseudo-standard NCSA common log format. Configuration options allow a choice between the standard Common Log Format (as used in the 3 log format) and the Combined Log Format (single log format). This log format can be output by most web servers, and almost all web log analysis software can understand these formats.

Author:
Greg Wilkins, Nigel Canonizado

Constructor Summary
NCSARequestLog()
           
NCSARequestLog(String filename)
           
 
Method Summary
protected  void doStart()
           
protected  void doStop()
           
 String getDatedFilename()
           
 String getFilename()
           
 String getFilenameDateFormat()
           
 String[] getIgnorePaths()
           
 boolean getLogCookies()
           
 String getLogDateFormat()
           
 boolean getLogLatency()
           
 boolean getLogServer()
           
 String getLogTimeZone()
           
 int getRetainDays()
           
 boolean isAppend()
           
 boolean isExtended()
           
 void log(Request request, Response response)
           
protected  void logExtended(Request request, Response response, Writer writer)
           
 void setAppend(boolean append)
           
 void setExtended(boolean extended)
           
 void setFilename(String filename)
           
 void setFilenameDateFormat(String logFileDateFormat)
          Set the log file date format.
 void setIgnorePaths(String[] ignorePaths)
           
 void setLogCookies(boolean logCookies)
           
 void setLogDateFormat(String format)
           
 void setLogLatency(boolean logLatency)
           
 void setLogServer(boolean logServer)
           
 void setLogTimeZone(String tz)
           
 void setPreferProxiedForAddress(boolean preferProxiedForAddress)
           
 void setRetainDays(int retainDays)
           
 
Methods inherited from class org.mortbay.component.AbstractLifeCycle
isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, start, stop
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.mortbay.component.LifeCycle
isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, start, stop
 

Constructor Detail

NCSARequestLog

public NCSARequestLog()

NCSARequestLog

public NCSARequestLog(String filename)
Parameters:
filename - The filename for the request log. This may be in the format expected by RolloverFileOutputStream
Method Detail

setFilename

public void setFilename(String filename)
Parameters:
filename - The filename for the request log. This may be in the format expected by RolloverFileOutputStream

getFilename

public String getFilename()

getDatedFilename

public String getDatedFilename()

setLogDateFormat

public void setLogDateFormat(String format)
Parameters:
format - Format for the timestamps in the log file. If not set, the pre-formated request timestamp is used.

getLogDateFormat

public String getLogDateFormat()

setLogTimeZone

public void setLogTimeZone(String tz)

getLogTimeZone

public String getLogTimeZone()

setRetainDays

public void setRetainDays(int retainDays)

getRetainDays

public int getRetainDays()

setExtended

public void setExtended(boolean extended)

isExtended

public boolean isExtended()

setAppend

public void setAppend(boolean append)

isAppend

public boolean isAppend()

setIgnorePaths

public void setIgnorePaths(String[] ignorePaths)

getIgnorePaths

public String[] getIgnorePaths()

setLogCookies

public void setLogCookies(boolean logCookies)

getLogCookies

public boolean getLogCookies()

getLogServer

public boolean getLogServer()

setLogServer

public void setLogServer(boolean logServer)

setLogLatency

public void setLogLatency(boolean logLatency)

getLogLatency

public boolean getLogLatency()

setPreferProxiedForAddress

public void setPreferProxiedForAddress(boolean preferProxiedForAddress)

log

public void log(Request request,
                Response response)
Specified by:
log in interface RequestLog

logExtended

protected void logExtended(Request request,
                           Response response,
                           Writer writer)
                    throws IOException
Throws:
IOException

doStart

protected void doStart()
                throws Exception
Overrides:
doStart in class AbstractLifeCycle
Throws:
Exception

doStop

protected void doStop()
               throws Exception
Overrides:
doStop in class AbstractLifeCycle
Throws:
Exception

getFilenameDateFormat

public String getFilenameDateFormat()
Returns:
the log File Date Format

setFilenameDateFormat

public void setFilenameDateFormat(String logFileDateFormat)
Set the log file date format.

Parameters:
logFileDateFormat - the logFileDateFormat to pass to RolloverFileOutputStream
See Also:
RolloverFileOutputStream#RolloverFileOutputStream(String, boolean, int, TimeZone, String, String)}