Core :: Server 12.0.6 · org.eclipse.jetty.server.RequestLogWriter

Field Summary

Modifier and Type	Field and Description
private boolean	_append
private boolean	_closeOut
private String	_filename
private String	_filenameDateFormat
private transient OutputStream	_fileOut
private final AutoLock	_lock Hides org.eclipse.jetty.util.component.AbstractLifeCycle._lock.
private transient OutputStream	_out
private int	_retainDays
private String	_timeZone
private transient Writer	_writer
private static final Logger	LOG Hides org.eclipse.jetty.util.component.AbstractLifeCycle.LOG.

Inherited from org.eclipse.jetty.util.component.AbstractLifeCycle:: FAILED STARTED STARTING STOPPED STOPPING

Constructor Summary

Access	Constructor and Description
public	RequestLogWriter()
public	RequestLogWriter(String filename)

Method Summary

Modifier and Type	Method and Description
protected void	doStart() Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.doStart. Method to override to start the lifecycle
protected void	doStop() Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.doStop. Method to override to stop the lifecycle
public String	Returns: file name of the request log, or null if not applicable getDatedFilename() Retrieve the file name of the request log with the expanded date wildcard if the output is written to the disk using `RolloverFileOutputStream`.
public String	Returns: file name of the request log getFileName() Retrieve the output file name of the request log.
public String	Returns: the log File Date Format getFilenameDateFormat() Retrieve the file name date format string.
public int	Returns: number of days to keep a log file getRetainDays() Retrieve the number of days before rotated log files are deleted.
public String	getTimeZone()
public boolean	Returns: value of the flag isAppend() Retrieve append to log flag.
public void	setAppend(boolean true - request log file will be appended after restart, false - request log file will be overwritten after restart append) Set append to log flag.
public void	setFilename(String file name of the request log filename) Set the output file name of the request log.
public void	setFilenameDateFormat(String format string that is passed to `RolloverFileOutputStream` logFileDateFormat) Set the log file name date format.
public void	setRetainDays(int number of days to keep a log file retainDays) Set the number of days before rotated log files are deleted.
public void	setTimeZone(String timeZone)
public void	write(String requestEntry) Implements org.eclipse.jetty.server.RequestLog.Writer.write.

Inherited from org.eclipse.jetty.util.component.AbstractLifeCycle:: addEventListener getEventListeners getState getState isFailed isRunning isStarted isStarting isStopped isStopping removeEventListener setEventListeners start stop toString

Field Detail

_append	back to summary
private boolean _append

_closeOut	back to summary
private boolean _closeOut

_filename	back to summary
private String _filename

_filenameDateFormat	back to summary
private String _filenameDateFormat

_fileOut	back to summary
private transient OutputStream _fileOut

_lock	back to summary
private final AutoLock _lock Hides org.eclipse.jetty.util.component.AbstractLifeCycle._lock.

_out	back to summary
private transient OutputStream _out

_retainDays	back to summary
private int _retainDays

_timeZone	back to summary
private String _timeZone

_writer	back to summary
private transient Writer _writer

LOG	back to summary
private static final Logger LOG Hides org.eclipse.jetty.util.component.AbstractLifeCycle.LOG.

Constructor Detail

RequestLogWriter	back to summary
public RequestLogWriter()

RequestLogWriter	back to summary
public RequestLogWriter(String filename)

Method Detail

doStart	back to summary
protected void doStart() throws Exception Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.doStart. Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart. Method to override to start the lifecycle Annotations @Override Exceptions Exception: If there was a problem starting. Will cause a transition to FAILED state

doStart

back to summary

protected void doStart() throws Exception

Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.doStart.

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart.

Method to override to start the lifecycle

Annotations

@Override

Exceptions

Exception:: If there was a problem starting. Will cause a transition to FAILED state

doStop	back to summary
protected void doStop() throws Exception Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.doStop. Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop. Method to override to stop the lifecycle Annotations @Override Exceptions Exception: If there was a problem stopping. Will cause a transition to FAILED state

doStop

back to summary

protected void doStop() throws Exception

Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.doStop.

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop.

Method to override to stop the lifecycle

Annotations

@Override

Exceptions

Exception:: If there was a problem stopping. Will cause a transition to FAILED state

getDatedFilename back to summary

getDatedFilename	back to summary
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:String file name of the request log, or null if not applicable Annotations @ManagedAttribute:dated filename

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:String

file name of the request log, or null if not applicable

Annotations

@ManagedAttribute:dated filename

getFileName	back to summary
public String getFileName() Retrieve the output file name of the request log. Returns:String file name of the request log Annotations @ManagedAttribute:filename

getFileName

back to summary

public String getFileName()

Retrieve the output file name of the request log.

Returns:String

file name of the request log

Annotations

@ManagedAttribute:filename

getFilenameDateFormat	back to summary
public String getFilenameDateFormat() Retrieve the file name date format string. Returns:String the log File Date Format Annotations @ManagedAttribute:log file name date format

getFilenameDateFormat

back to summary

public String getFilenameDateFormat()

Retrieve the file name date format string.

Returns:String

the log File Date Format

Annotations

@ManagedAttribute:log file name date format

getRetainDays	back to summary
public int getRetainDays() Retrieve the number of days before rotated log files are deleted. Returns:int number of days to keep a log file Annotations @ManagedAttribute:number of days to keep a log file

getRetainDays

back to summary

public int getRetainDays()

Retrieve the number of days before rotated log files are deleted.

Returns:int

number of days to keep a log file

Annotations

@ManagedAttribute:number of days to keep a log file

getTimeZone	back to summary
public String getTimeZone() Annotations @ManagedAttribute:timezone of the log

isAppend	back to summary
public boolean isAppend() Retrieve append to log flag. Returns:boolean value of the flag Annotations @ManagedAttribute:if request log file will be appended after restart

isAppend

back to summary

public boolean isAppend()

Retrieve append to log flag.

Returns:boolean

value of the flag

Annotations

@ManagedAttribute:if request log file will be appended after restart

setAppend	back to summary
public void setAppend(boolean append) Set append to log flag. Parameters append:boolean true - request log file will be appended after restart, false - request log file will be overwritten after restart

setAppend

back to summary

public void setAppend(boolean append)

Set append to log flag.

Parameters

append:boolean: true - request log file will be appended after restart, false - request log file will be overwritten after restart

setFilename back to summary

setFilename	back to summary
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:String file name of the request log

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:String: file name of the request log

setFilenameDateFormat back to summary

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

public void setFilenameDateFormat(String logFileDateFormat)

Set the log file name date format.

Parameters

logFileDateFormat:String: format string that is passed to RolloverFileOutputStream

setRetainDays	back to summary
public void setRetainDays(int retainDays) Set the number of days before rotated log files are deleted. Parameters retainDays:int number of days to keep a log file

setRetainDays

back to summary

public void setRetainDays(int retainDays)

Set the number of days before rotated log files are deleted.

Parameters

retainDays:int: number of days to keep a log file

setTimeZone	back to summary
public void setTimeZone(String timeZone)

write	back to summary
public void write(String requestEntry) throws IOException Implements org.eclipse.jetty.server.RequestLog.Writer.write. Annotations @Override

write

back to summary

public void write(String requestEntry) throws IOException

Implements org.eclipse.jetty.server.RequestLog.Writer.write.

Annotations

@Override

public Class RequestLogWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail