Package org.eclipse.jetty.server
Class NCSARequestLog
java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.server.AbstractNCSARequestLog
org.eclipse.jetty.server.NCSARequestLog
- All Implemented Interfaces:
RequestLog
,Container
,Destroyable
,Dumpable
,Dumpable.DumpableContainer
,LifeCycle
- Direct Known Subclasses:
AsyncNCSARequestLog
@Deprecated
@ManagedObject("NCSA standard format request log")
public class NCSARequestLog
extends AbstractNCSARequestLog
Deprecated.
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.-
Nested Class Summary
Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
AbstractLifeCycle.AbstractLifeCycleListener
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container
Container.InheritedListener, Container.Listener
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
Dumpable.DumpableContainer
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
LifeCycle.Listener
Nested classes/interfaces inherited from interface org.eclipse.jetty.server.RequestLog
RequestLog.Collection, RequestLog.Writer
-
Field Summary
FieldsFields inherited from class org.eclipse.jetty.server.AbstractNCSARequestLog
LOG
-
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Create request log object with default settings.NCSARequestLog
(String filename) Deprecated.Create request log object with specified output file name.NCSARequestLog
(RequestLogWriter writer) Deprecated.Create request log object given a RequestLogWriter file name. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
doStart()
Deprecated.Set up request logging and open log file.protected void
doStop()
Deprecated.Close the log file and perform cleanup.Deprecated.Retrieve the file name of the request log with the expanded date wildcard if the output is written to the disk usingRolloverFileOutputStream
.Deprecated.Retrieve the output file name of the request log.Deprecated.Retrieve the file name date format string.int
Deprecated.Retrieve the number of days before rotated log files are deleted.boolean
isAppend()
Deprecated.Retrieve append to log flag.protected boolean
Deprecated.Is logging enabledvoid
setAppend
(boolean append) Deprecated.Set append to log flag.void
setFilename
(String filename) Deprecated.Set the output file name of the request log.void
setFilenameDateFormat
(String logFileDateFormat) Deprecated.Set the log file name date format.void
setLogTimeZone
(String tz) Deprecated.Set the timezone of the request log.void
setRetainDays
(int retainDays) Deprecated.Set the number of days before rotated log files are deleted.void
Deprecated.Write requestEntry out.Methods inherited from class org.eclipse.jetty.server.AbstractNCSARequestLog
getAuthentication, getIgnorePaths, getLogCookies, getLogDateFormat, getLogLatency, getLogLocale, getLogServer, getLogTimeZone, getPreferProxiedForAddress, isExtended, isLogDispatch, log, logExtended, setExtended, setIgnorePaths, setLogCookies, setLogDateFormat, setLogDispatch, setLogLatency, setLogLocale, setLogServer, setPreferProxiedForAddress
Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle
addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer
isDumpable
-
Field Details
-
_requestLogWriter
Deprecated.
-
-
Constructor Details
-
NCSARequestLog
public NCSARequestLog()Deprecated.Create request log object with default settings. -
NCSARequestLog
Deprecated.Create request log object with specified output file name.- Parameters:
filename
- the file name for the request log. This may be in the format expected byRolloverFileOutputStream
-
NCSARequestLog
Deprecated.Create request log object given a RequestLogWriter file name.- Parameters:
writer
- the writer which manages the output of the formatted string produced by theRequestLog
-
-
Method Details
-
setFilename
Deprecated.Set the output file name of the request log. The file name may be in the format expected byRolloverFileOutputStream
.- Parameters:
filename
- file name of the request log
-
setLogTimeZone
Deprecated.Description copied from class:AbstractNCSARequestLog
Set the timezone of the request log.- Overrides:
setLogTimeZone
in classAbstractNCSARequestLog
- Parameters:
tz
- timezone string
-
getFilename
Deprecated.Retrieve the output file name of the request log.- Returns:
- file name of the request log
-
getDatedFilename
Deprecated.Retrieve the file name of the request log with the expanded date wildcard if the output is written to the disk usingRolloverFileOutputStream
.- Returns:
- file name of the request log, or null if not applicable
-
isEnabled
protected boolean isEnabled()Deprecated.Description copied from class:AbstractNCSARequestLog
Is logging enabled- Overrides:
isEnabled
in classAbstractNCSARequestLog
- Returns:
- true if logging is enabled
-
setRetainDays
public void setRetainDays(int retainDays) Deprecated.Set the number of days before rotated log files are deleted.- Parameters:
retainDays
- number of days to keep a log file
-
getRetainDays
Deprecated.Retrieve the number of days before rotated log files are deleted.- Returns:
- number of days to keep a log file
-
setAppend
public void setAppend(boolean append) Deprecated.Set append to log flag.- Parameters:
append
- true - request log file will be appended after restart, false - request log file will be overwritten after restart
-
isAppend
Deprecated.Retrieve append to log flag.- Returns:
- value of the flag
-
setFilenameDateFormat
Deprecated.Set the log file name date format.- Parameters:
logFileDateFormat
- format string that is passed toRolloverFileOutputStream
- See Also:
-
getFilenameDateFormat
Deprecated.Retrieve the file name date format string.- Returns:
- the log File Date Format
-
write
Deprecated.Description copied from class:AbstractNCSARequestLog
Write requestEntry out. (to disk or slf4j log)- Overrides:
write
in classAbstractNCSARequestLog
- Parameters:
requestEntry
- the request entry- Throws:
IOException
- if unable to write the entry
-
doStart
Deprecated.Set up request logging and open log file.- Overrides:
doStart
in classAbstractNCSARequestLog
- Throws:
Exception
- See Also:
-
doStop
Deprecated.Close the log file and perform cleanup.- Overrides:
doStop
in classAbstractNCSARequestLog
- Throws:
Exception
- See Also:
-
CustomRequestLog
given format stringCustomRequestLog.EXTENDED_NCSA_FORMAT
with aRequestLogWriter