Package org.eclipse.jetty.server

Class NCSARequestLog

  • All Implemented Interfaces:
    RequestLog, org.eclipse.jetty.util.component.LifeCycle
    Direct Known Subclasses:
    AsyncNCSARequestLog
    @ManagedObject("NCSA standard format request log")
public class NCSARequestLog
extends AbstractNCSARequestLog
    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 Detail

      • NCSARequestLog

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

      • NCSARequestLog

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

    • Method Detail

      • setFilename

        public void setFilename​(String filename)
        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

      • getFilename

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

      • getDatedFilename

        public String getDatedFilename()
        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)
        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()
        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)
        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()
        Retrieve append to log flag.
        Returns:
        value of the flag

      • setFilenameDateFormat

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

      • getFilenameDateFormat

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