I2PRequestLog (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- org.eclipse.jetty.util.component.AbstractLifeCycle
- - net.i2p.jetty.I2PRequestLog

All Implemented Interfaces:
RequestLog, LifeCycle
```
public class I2PRequestLog
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. ** I2P Mods ** For Jetty 5, this extended NCSARequestLog to override log() to put in the requestor's destination hash, instead of 127.0.0.1, which is placed in the X-I2P-DestHash field in the request headers by I2PTunnelHTTPServer. But we also had to modify NCSARequestLog to do so, to change private fields to protected. So that we will work with system Jetty 6 packages, we just copy the whole thing and modify log() as required.

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.LifeCycle
  LifeCycle.Listener

Field Summary
- Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
  FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary
Constructors
Constructor and Description
I2PRequestLog()
I2PRequestLog.
I2PRequestLog(String filename)

Constructors
Constructor and Description
`I2PRequestLog()` I2PRequestLog.
`I2PRequestLog(String filename)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`doStart()` doStart.
`protected void`	`doStop()` doStop.
`String`	`getDatedFilename()`
`String`	`getFilename()`
`String`	`getFilenameDateFormat()`
`String[]`	`getIgnorePaths()`
`boolean`	`getLogCookies()`
`String`	`getLogDateFormat()`
`boolean`	`getLogLatency()`
`Locale`	`getLogLocale()`
`boolean`	`getLogServer()`
`String`	`getLogTimeZone()`
`int`	`getRetainDays()`
`boolean`	`isAppend()`
`boolean`	`isExtended()`
`void`	`log(Request request, Response response)` log.
`protected void`	`logExtended(Request request, Writer writer)` Log extended (referrer and user-agent)
`void`	`setAppend(boolean append)` setAppend.
`void`	`setB64(boolean b64)`
`void`	`setExtended(boolean extended)` setExtended.
`void`	`setFilename(String filename)`
`void`	`setFilenameDateFormat(String logFileDateFormat)` Set the log file date format.
`void`	`setIgnorePaths(String[] ignorePaths)` setIgnorePaths.
`void`	`setLogCookies(boolean logCookies)` setLogCookies.
`void`	`setLogDateFormat(String format)`
`void`	`setLogLatency(boolean logLatency)` setLogLatency.
`void`	`setLogLocale(Locale logLocale)` setLogLocale.
`void`	`setLogServer(boolean logServer)` setLogServer.
`void`	`setLogTimeZone(String tz)` setLogTimeZone.
`void`	`setPreferProxiedForAddress(boolean preferProxiedForAddress)` setPreferProxiedForAddress.
`void`	`setRetainDays(int retainDays)` setRetainDays.

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - I2PRequestLog
```
public I2PRequestLog()
```
    I2PRequestLog.
  - I2PRequestLog
```
public I2PRequestLog(String filename)
```
    Parameters:
    filename - The filename for the request log. This may be in the format expected by RolloverFileOutputStream
- Method Detail
  - doStart
```
protected void doStart()
                throws Exception
```
    doStart.
    Overrides:
    doStart in class AbstractLifeCycle
    Throws:
    Exception
  - doStop
```
protected void doStop()
               throws Exception
```
    doStop.
    Overrides:
    doStop in class AbstractLifeCycle
    Throws:
    Exception
  - getDatedFilename
```
public String getDatedFilename()
```
    Returns:
    the dated filename
  - getFilename
```
public String getFilename()
```
    Returns:
    the filename
  - getFilenameDateFormat
```
public String getFilenameDateFormat()
```
    Returns:
    the log File Date Format
  - getIgnorePaths
```
public String[] getIgnorePaths()
```
    Returns:
    the ignore paths
  - getLogCookies
```
public boolean getLogCookies()
```
    Returns:
    the log cookies
  - getLogDateFormat
```
public String getLogDateFormat()
```
    Returns:
    the log date format
  - getLogLatency
```
public boolean getLogLatency()
```
    Returns:
    the log latency
  - getLogLocale
```
public Locale getLogLocale()
```
    Returns:
    the log locale
  - getLogServer
```
public boolean getLogServer()
```
    Returns:
    the log server
  - getLogTimeZone
```
public String getLogTimeZone()
```
    Returns:
    the log time zone
  - getRetainDays
```
public int getRetainDays()
```
    Returns:
    the retain days
  - isAppend
```
public boolean isAppend()
```
    Returns:
    whether append
  - isExtended
```
public boolean isExtended()
```
    Returns:
    whether extended
  - log
```
public void log(Request request,
                Response response)
```
    log.
    Specified by:
    log in interface RequestLog
  - logExtended
```
protected void logExtended(Request request,
                           Writer writer)
                    throws IOException
```
    Log extended (referrer and user-agent)
    Throws:
    IOException
  - setAppend
```
public void setAppend(boolean append)
```
    setAppend.
  - setB64
```
public void setB64(boolean b64)
```
    Parameters:
    b64 - true to enable base 64 logging. False for base 32 logging. Default false.
  - setExtended
```
public void setExtended(boolean extended)
```
    setExtended.
  - setFilename
```
public void setFilename(String filename)
```
    Parameters:
    filename - The filename for the request log. This may be in the format expected by RolloverFileOutputStream
  - setFilenameDateFormat
```
public void setFilenameDateFormat(String logFileDateFormat)
```
    Set the log file date format. See RolloverFileOutputStream(String, boolean, int, TimeZone, String, String)
    Parameters:
    logFileDateFormat - the logFileDateFormat to pass to RolloverFileOutputStream
  - setIgnorePaths
```
public void setIgnorePaths(String[] ignorePaths)
```
    setIgnorePaths.
  - setLogCookies
```
public void setLogCookies(boolean logCookies)
```
    setLogCookies.
  - 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.
  - setLogLatency
```
public void setLogLatency(boolean logLatency)
```
    setLogLatency.
  - setLogLocale
```
public void setLogLocale(Locale logLocale)
```
    setLogLocale.
  - setLogServer
```
public void setLogServer(boolean logServer)
```
    setLogServer.
  - setLogTimeZone
```
public void setLogTimeZone(String tz)
```
    setLogTimeZone.
  - setPreferProxiedForAddress
```
public void setPreferProxiedForAddress(boolean preferProxiedForAddress)
```
    setPreferProxiedForAddress.
  - setRetainDays
```
public void setRetainDays(int retainDays)
```
    setRetainDays.

Class I2PRequestLog

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

Methods inherited from class java.lang.Object

Constructor Detail

I2PRequestLog

I2PRequestLog

Method Detail

doStart

doStop

getDatedFilename

getFilename

getFilenameDateFormat

getIgnorePaths

getLogCookies

getLogDateFormat

getLogLatency

getLogLocale

getLogServer

getLogTimeZone

getRetainDays

isAppend

isExtended

log

logExtended

setAppend

setB64

setExtended

setFilename

setFilenameDateFormat

setIgnorePaths

setLogCookies

setLogDateFormat

setLogLatency

setLogLocale

setLogServer

setLogTimeZone

setPreferProxiedForAddress

setRetainDays