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.
use CustomRequestLog given format string CustomRequestLog.EXTENDED_NCSA_FORMAT with a RequestLogWriter
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.

  • Constructor Details

    • NCSARequestLog

      public NCSARequestLog()
      Deprecated.
      Create request log object with default settings.

    • NCSARequestLog

      public NCSARequestLog(String filename)
      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 by RolloverFileOutputStream

    • NCSARequestLog

      public NCSARequestLog(RequestLogWriter writer)
      Deprecated.
      Create request log object given a RequestLogWriter file name.
      Parameters:
      writer - the writer which manages the output of the formatted string produced by the RequestLog

  • Method Details

    • setFilename

      public void setFilename(String filename)
      Deprecated.
      Set the output file name of the request log. The file name may be in the format expected by RolloverFileOutputStream.
      Parameters:
      filename - file name of the request log

    • setLogTimeZone

      public void setLogTimeZone(String tz)
      Deprecated.
      Description copied from class: AbstractNCSARequestLog
      Set the timezone of the request log.
      Overrides:
      setLogTimeZone in class AbstractNCSARequestLog
      Parameters:
      tz - timezone string

    • getFilename

      @ManagedAttribute("file of log") public String getFilename()
      Deprecated.
      Retrieve the output file name of the request log.
      Returns:
      file name of the request log

    • getDatedFilename

      public String getDatedFilename()
      Deprecated.
      Retrieve the file name of the request log with the expanded date wildcard if the output is written to the disk using RolloverFileOutputStream.
      Returns:
      file name of the request log, or null if not applicable

    • 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

      @ManagedAttribute("number of days that log files are kept") public int 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

      @ManagedAttribute("existing log files are appends to the new one") public boolean isAppend()
      Deprecated.
      Retrieve append to log flag.
      Returns:
      value of the flag

    • setFilenameDateFormat

      public void setFilenameDateFormat(String logFileDateFormat)
      Deprecated.
      Set the log file name date format.
      Parameters:
      logFileDateFormat - format string that is passed to RolloverFileOutputStream
      See Also:

    • getFilenameDateFormat

      public String getFilenameDateFormat()
      Deprecated.
      Retrieve the file name date format string.
      Returns:
      the log File Date Format

    • write

      public void write(String requestEntry) throws IOException
      Deprecated.
      Description copied from class: AbstractNCSARequestLog
      Write requestEntry out. (to disk or slf4j log)
      Overrides:
      write in class AbstractNCSARequestLog
      Parameters:
      requestEntry - the request entry
      Throws:
      IOException - if unable to write the entry