Class RolloverFileOutputStream

java.lang.Object

java.io.OutputStream

org.eclipse.jetty.util.RolloverFileOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class RolloverFileOutputStream
extends OutputStream

RolloverFileOutputStream.

This output stream puts content in a file that is rolled over every 24 hours. The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file.

Old files are retained for a number of days before being deleted.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	RolloverFileOutputStream.RollTask

Field Summary

Fields

Modifier and Type	Field	Description
private static Timer	__rollover
private boolean	_append
private File	_file
private SimpleDateFormat	_fileBackupFormat
private SimpleDateFormat	_fileDateFormat
private String	_filename
private OutputStream	_out
private int	_retainDays
private RolloverFileOutputStream.RollTask	_rollTask
(package private) static final String	ROLLOVER_FILE_BACKUP_FORMAT
(package private) static final String	ROLLOVER_FILE_DATE_FORMAT
(package private) static final int	ROLLOVER_FILE_RETAIN_DAYS
(package private) static final String	YYYY_MM_DD

Constructor Summary

Constructors

Constructor	Description
RolloverFileOutputStream(String filename)
RolloverFileOutputStream(String filename, boolean append)
RolloverFileOutputStream(String filename, boolean append, int retainDays)
RolloverFileOutputStream(String filename, boolean append, int retainDays, TimeZone zone)
RolloverFileOutputStream(String filename, boolean append, int retainDays, TimeZone zone, String dateFormat, String backupFormat)
RolloverFileOutputStream(String filename, boolean append, int retainDays, TimeZone zone, String dateFormat, String backupFormat, ZonedDateTime now)

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
String	getDatedFilename()
String	getFilename()
int	getRetainDays()
(package private) void	removeOldFiles(ZonedDateTime now)
private void	renameFile(File src, File dest)
protected void	rollover(File oldFile, File backupFile, File newFile)	This method is called whenever a log file is rolled over
private void	scheduleNextRollover(ZonedDateTime now)
(package private) void	setFile(ZonedDateTime now)
static ZonedDateTime	toMidnight(ZonedDateTime now)	Get the "start of day" for the provided DateTime at the zone specified.
void	write(byte[] buf)
void	write(byte[] buf, int off, int len)
void	write(int b)

Methods inherited from class Object

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

Field Details

__rollover

private static Timer __rollover

YYYY_MM_DD

static final String YYYY_MM_DD

See Also:

• Constant Field Values

ROLLOVER_FILE_DATE_FORMAT

static final String ROLLOVER_FILE_DATE_FORMAT

See Also:

• Constant Field Values

ROLLOVER_FILE_BACKUP_FORMAT

static final String ROLLOVER_FILE_BACKUP_FORMAT

See Also:

• Constant Field Values

ROLLOVER_FILE_RETAIN_DAYS

static final int ROLLOVER_FILE_RETAIN_DAYS

See Also:

• Constant Field Values

_out

private OutputStream _out

_rollTask

private RolloverFileOutputStream.RollTask _rollTask

_fileBackupFormat

private SimpleDateFormat _fileBackupFormat

_fileDateFormat

private SimpleDateFormat _fileDateFormat

_filename

private String _filename

_file

private File _file

_append

private boolean _append

_retainDays

private int _retainDays

Constructor Details

RolloverFileOutputStream

public RolloverFileOutputStream(String filename)
                         throws IOException

Parameters:

filename - The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file.

Throws:

IOException - if unable to create output

RolloverFileOutputStream

public RolloverFileOutputStream(String filename,
 boolean append)
                         throws IOException

Parameters:

filename - The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file.

append - If true, existing files will be appended to.

Throws:

IOException - if unable to create output

RolloverFileOutputStream

public RolloverFileOutputStream(String filename,
 boolean append,
 int retainDays)
                         throws IOException

Parameters:

filename - The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file.

append - If true, existing files will be appended to.

retainDays - The number of days to retain files before deleting them. 0 to retain forever.

Throws:

IOException - if unable to create output

RolloverFileOutputStream

public RolloverFileOutputStream(String filename,
 boolean append,
 int retainDays,
 TimeZone zone)
                         throws IOException

Parameters:

filename - The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file.

append - If true, existing files will be appended to.

retainDays - The number of days to retain files before deleting them. 0 to retain forever.

zone - the timezone for the output

Throws:

IOException - if unable to create output

RolloverFileOutputStream

public RolloverFileOutputStream(String filename,
 boolean append,
 int retainDays,
 TimeZone zone,
 String dateFormat,
 String backupFormat)
                         throws IOException

Parameters:

filename - The filename must include the string "yyyy_mm_dd", which is replaced with the actual date when creating and rolling over the file.

append - If true, existing files will be appended to.

retainDays - The number of days to retain files before deleting them. 0 to retain forever.

zone - the timezone for the output

dateFormat - The format for the date file substitution. The default is "yyyy_MM_dd". If set to the empty string, the file is rolledover to the same filename, with the current file being renamed to the backup filename.

backupFormat - The format for the file extension of backup files. The default is "HHmmssSSS".

Throws:

IOException - if unable to create output

RolloverFileOutputStream

RolloverFileOutputStream(String filename,
 boolean append,
 int retainDays,
 TimeZone zone,
 String dateFormat,
 String backupFormat,
 ZonedDateTime now)
                  throws IOException

Throws:

IOException

Method Details

toMidnight

public static ZonedDateTime toMidnight(ZonedDateTime now)

Get the "start of day" for the provided DateTime at the zone specified.

Parameters:

now - the date time to calculate from

Returns:

start of the day of the date provided

scheduleNextRollover

private void scheduleNextRollover(ZonedDateTime now)

getFilename

public String getFilename()

getDatedFilename

public String getDatedFilename()

getRetainDays

public int getRetainDays()

setFile

void setFile(ZonedDateTime now)
      throws IOException

Throws:

IOException

renameFile

private void renameFile(File src,
 File dest)
                 throws IOException

Throws:

IOException

rollover

protected void rollover(File oldFile,
 File backupFile,
 File newFile)

This method is called whenever a log file is rolled over

Parameters:

oldFile - The original filename or null if this is the first creation

backupFile - The backup filename or null if the filename is dated.

newFile - The new filename that is now being used for logging

removeOldFiles

void removeOldFiles(ZonedDateTime now)

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] buf)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] buf,
 int off,
 int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException