Class RotatingFileTarget

java.lang.Object

org.apache.log.output.AbstractTarget

org.apache.log.output.AbstractOutputTarget

org.apache.log.output.io.StreamTarget

org.apache.log.output.io.FileTarget

org.apache.log.output.io.rotate.RotatingFileTarget

All Implemented Interfaces:

ErrorAware, LogTarget, Closeable

public class RotatingFileTarget
extends FileTarget

This is a basic Output log target that writes to rotating files.

Author:

Peter Donald, Stephen McConnell, Bernhard Huber

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	m_append	Flag indicating whether or not file should be appended to
private FileStrategy	m_fileStrategy	The file strategy to be used.
private RotateStrategy	m_rotateStrategy	The rotation strategy to be used.

Constructor Summary

Constructors

Constructor	Description
RotatingFileTarget(boolean append, Formatter formatter, RotateStrategy rotateStrategy, FileStrategy fileStrategy)	Construct RotatingFileTarget object.
RotatingFileTarget(Formatter formatter, RotateStrategy rotateStrategy, FileStrategy fileStrategy)	Construct RotatingFileTarget object.

Method Summary

Modifier and Type	Method	Description
protected void	rotate()	Rotates the file.
protected void	write(String data)	Output the log message, and check if rotation is needed.

Methods inherited from class FileTarget

getFile, openFile, setFile

Methods inherited from class StreamTarget

close, setOutputStream, shutdownStream

Methods inherited from class AbstractOutputTarget

doProcessEvent, getFormatter, open

Methods inherited from class AbstractTarget

getErrorHandler, isOpen, processEvent, setErrorHandler

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

m_append

private boolean m_append

Flag indicating whether or not file should be appended to

m_rotateStrategy

private RotateStrategy m_rotateStrategy

The rotation strategy to be used.

m_fileStrategy

private FileStrategy m_fileStrategy

The file strategy to be used.

Constructor Details

RotatingFileTarget

public RotatingFileTarget(Formatter formatter,
 RotateStrategy rotateStrategy,
 FileStrategy fileStrategy)
                   throws IOException

Construct RotatingFileTarget object.

Parameters:

formatter - Formatter to be used

rotateStrategy - RotateStrategy to be used

fileStrategy - FileStrategy to be used

Throws:

IOException - if a file access or write related error occurs

RotatingFileTarget

public RotatingFileTarget(boolean append,
 Formatter formatter,
 RotateStrategy rotateStrategy,
 FileStrategy fileStrategy)
                   throws IOException

Construct RotatingFileTarget object.

Parameters:

append - true if file is to be appended to, false otherwise

formatter - Formatter to be used

rotateStrategy - RotateStrategy to be used

fileStrategy - FileStrategy to be used

Throws:

IOException - if a file access or write related error occurs

Method Details

rotate

protected void rotate()
               throws IOException

Rotates the file.

Throws:

IOException - if a file access or write related error occurs

write

protected void write(String data)

Output the log message, and check if rotation is needed.

Overrides:

write in class StreamTarget

Parameters:

data - the date to write to the target