Modifier and Type	Class and Description
public static enum	PeriodicRotatingFileHandler.Period Possible period values.

Field Summary

Modifier and Type	Field and Description
private final AccessControlContext	acc References Deprecated `AccessControlContext` is deprecated or references (maybe indirectly) at least one deprecated element.
private DateTimeFormatter	format
private Instant	nextRollover
private String	nextSuffix
private PeriodicRotatingFileHandler.Period	period
private SuffixRotator	suffixRotator
private TimeZone	timeZone

Constructor Summary

Access	Constructor and Description
public	PeriodicRotatingFileHandler() Construct a new instance with no formatter and no output file.
public	PeriodicRotatingFileHandler(final String the file name fileName) Construct a new instance with the given output file.
public	PeriodicRotatingFileHandler(final String the file name fileName, final boolean `true` to append, `false` to overwrite append) Construct a new instance with the given output file and append setting.
public	PeriodicRotatingFileHandler(final File the file file, final String the format suffix to use suffix) Construct a new instance with the given output file.
public	PeriodicRotatingFileHandler(final File the file file, final String the format suffix to use suffix, final boolean `true` to append, `false` to overwrite append) Construct a new instance with the given output file and append setting.

Method Summary

Modifier and Type	Method and Description
private void	calcNextRollover(final Instant fromTime)
protected final String	Returns: the suffix to be used getNextSuffix() Returns the suffix to be used.
pack-priv SuffixRotator	Returns: the file rotator getSuffixRotator() Returns the file rotator for this handler.
public TimeZone	Returns: the configured time zone getTimeZone() Get the configured time zone for this handler.
private static <T extends Comparable<? super T>> T	min(T a, T b)
protected void	preWrite(final ExtLogRecord the record about to be logged record) Overrides org.jboss.logmanager.handlers.WriterHandler.preWrite. Execute any pre-write policy, such as file rotation.
private void	rollOver()
public void	setFile(final File the file file) Overrides org.jboss.logmanager.handlers.FileHandler.setFile. Set the output file.
private void	setFileInternal(final File file)
public void	setSuffix(String the suffix suffix) Set the suffix string.
public void	setTimeZone(final TimeZone the configured time zone timeZone) Set the configured time zone for this handler.

Inherited from org.jboss.logmanager.handlers.FileHandler:: getFile setAppend setFileName

Field Detail

acc	back to summary
private final AccessControlContext acc References Deprecated `AccessControlContext` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

format	back to summary
private DateTimeFormatter format

nextRollover	back to summary
private Instant nextRollover

nextSuffix	back to summary
private String nextSuffix

period	back to summary
private PeriodicRotatingFileHandler.Period period

suffixRotator	back to summary
private SuffixRotator suffixRotator

timeZone	back to summary
private TimeZone timeZone

Constructor Detail

PeriodicRotatingFileHandler	back to summary
public PeriodicRotatingFileHandler() Construct a new instance with no formatter and no output file.

PeriodicRotatingFileHandler	back to summary
public PeriodicRotatingFileHandler(final String fileName) throws FileNotFoundException Construct a new instance with the given output file. Parameters fileName:String the file name Exceptions FileNotFoundException: if the file could not be found on open

PeriodicRotatingFileHandler

back to summary

public PeriodicRotatingFileHandler(final String fileName) throws FileNotFoundException

Construct a new instance with the given output file.

Parameters

fileName:String: the file name

Exceptions

FileNotFoundException:: if the file could not be found on open

PeriodicRotatingFileHandler back to summary

PeriodicRotatingFileHandler	back to summary
public PeriodicRotatingFileHandler(final String fileName, final boolean append) throws FileNotFoundException Construct a new instance with the given output file and append setting. Parameters fileName:String the file name append:boolean `true` to append, `false` to overwrite Exceptions FileNotFoundException: if the file could not be found on open

public PeriodicRotatingFileHandler(final String fileName, final boolean append) throws FileNotFoundException

Construct a new instance with the given output file and append setting.

Parameters

fileName:String: the file name
append:boolean: true to append, false to overwrite

Exceptions

FileNotFoundException:: if the file could not be found on open

PeriodicRotatingFileHandler	back to summary
public PeriodicRotatingFileHandler(final File file, final String suffix) throws FileNotFoundException Construct a new instance with the given output file. Parameters file:File the file suffix:String the format suffix to use Exceptions FileNotFoundException: if the file could not be found on open

PeriodicRotatingFileHandler

back to summary

public PeriodicRotatingFileHandler(final File file, final String suffix) throws FileNotFoundException

Construct a new instance with the given output file.

Parameters

file:File: the file
suffix:String: the format suffix to use

Exceptions

FileNotFoundException:: if the file could not be found on open

PeriodicRotatingFileHandler back to summary

PeriodicRotatingFileHandler	back to summary
public PeriodicRotatingFileHandler(final File file, final String suffix, final boolean append) throws FileNotFoundException Construct a new instance with the given output file and append setting. Parameters file:File the file suffix:String the format suffix to use append:boolean `true` to append, `false` to overwrite Exceptions FileNotFoundException: if the file could not be found on open

public PeriodicRotatingFileHandler(final File file, final String suffix, final boolean append) throws FileNotFoundException

Construct a new instance with the given output file and append setting.

Parameters

file:File: the file
suffix:String: the format suffix to use
append:boolean: true to append, false to overwrite

Exceptions

FileNotFoundException:: if the file could not be found on open

Method Detail

calcNextRollover	back to summary
private void calcNextRollover(final Instant fromTime)

getNextSuffix	back to summary
protected final String getNextSuffix() Returns the suffix to be used. Returns:String the suffix to be used

getNextSuffix

back to summary

protected final String getNextSuffix()

Returns the suffix to be used.

Returns:String: the suffix to be used

getSuffixRotator	back to summary
pack-priv SuffixRotator getSuffixRotator() Returns the file rotator for this handler. Returns:SuffixRotator the file rotator

getSuffixRotator

back to summary

pack-priv SuffixRotator getSuffixRotator()

Returns the file rotator for this handler.

Returns:SuffixRotator: the file rotator

getTimeZone	back to summary
public TimeZone getTimeZone() Get the configured time zone for this handler. Returns:TimeZone the configured time zone

getTimeZone

back to summary

public TimeZone getTimeZone()

Get the configured time zone for this handler.

Returns:TimeZone: the configured time zone

min	back to summary
private static <T extends Comparable<? super T>> T min(T a, T b)

preWrite	back to summary
protected void preWrite(final ExtLogRecord record) Overrides org.jboss.logmanager.handlers.WriterHandler.preWrite. Doc from org.jboss.logmanager.handlers.WriterHandler.preWrite. Execute any pre-write policy, such as file rotation. The write lock is held during this method, so make it quick. The default implementation does nothing. This implementation checks to see if the scheduled rollover time has yet occurred. Parameters record:ExtLogRecord the record about to be logged

preWrite

back to summary

protected void preWrite(final ExtLogRecord record)

Overrides org.jboss.logmanager.handlers.WriterHandler.preWrite.

Doc from org.jboss.logmanager.handlers.WriterHandler.preWrite.

Execute any pre-write policy, such as file rotation. The write lock is held during this method, so make it quick. The default implementation does nothing. This implementation checks to see if the scheduled rollover time has yet occurred.

Parameters

record:ExtLogRecord: the record about to be logged

rollOver	back to summary
private void rollOver()

setFile	back to summary
public void setFile(final File file) throws FileNotFoundException Overrides org.jboss.logmanager.handlers.FileHandler.setFile. Doc from org.jboss.logmanager.handlers.FileHandler.setFile. Set the output file. Parameters file:File the file Annotations @Override Exceptions FileNotFoundException: if an error occurs opening the file

setFile

back to summary

public void setFile(final File file) throws FileNotFoundException

Overrides org.jboss.logmanager.handlers.FileHandler.setFile.

Doc from org.jboss.logmanager.handlers.FileHandler.setFile.

Set the output file.

Parameters

file:File: the file

Annotations

@Override

Exceptions

FileNotFoundException:: if an error occurs opening the file

setFileInternal	back to summary
private void setFileInternal(final File file) throws FileNotFoundException

setSuffix back to summary

setSuffix	back to summary
public void setSuffix(String suffix) throws IllegalArgumentException Set the suffix string. The string is in a format which can be understood by `DateTimeFormatter`. The period of the rotation is automatically calculated based on the suffix. If the suffix ends with `.gz` or `.zip` the file will be compressed on rotation. Parameters suffix:String the suffix Exceptions IllegalArgumentException: if the suffix is not valid

public void setSuffix(String suffix) throws IllegalArgumentException

Set the suffix string. The string is in a format which can be understood by DateTimeFormatter. The period of the rotation is automatically calculated based on the suffix.

If the suffix ends with .gz or .zip the file will be compressed on rotation.

Parameters

suffix:String: the suffix

Exceptions

IllegalArgumentException:: if the suffix is not valid

setTimeZone	back to summary
public void setTimeZone(final TimeZone timeZone) Set the configured time zone for this handler. Parameters timeZone:TimeZone the configured time zone

setTimeZone

back to summary

public void setTimeZone(final TimeZone timeZone)

Set the configured time zone for this handler.

Parameters

timeZone:TimeZone: the configured time zone

org.jboss.logmanager.handlers back to summary

public final Enum PeriodicRotatingFileHandler.Period

Class Inheritance

extends Enum<PeriodicRotatingFileHandler.Period>

java.lang.Object
java.lang.Enum
org.jboss.logmanager.handlers.PeriodicRotatingFileHandler.Period

Possible period values. Keep in strictly ascending order of magnitude.

Field Summary

Modifier and Type	Field and Description
public static final PeriodicRotatingFileHandler.Period	DAY
public static final PeriodicRotatingFileHandler.Period	HALF_DAY
public static final PeriodicRotatingFileHandler.Period	HOUR
public static final PeriodicRotatingFileHandler.Period	MINUTE
public static final PeriodicRotatingFileHandler.Period	MONTH
public static final PeriodicRotatingFileHandler.Period	NEVER
public static final PeriodicRotatingFileHandler.Period	WEEK
public static final PeriodicRotatingFileHandler.Period	YEAR

Constructor Summary

Access	Constructor and Description
private	Period()

Method Summary

Modifier and Type	Method and Description
public static PeriodicRotatingFileHandler.Period	valueOf(String name)
public static PeriodicRotatingFileHandler.Period[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DAY	back to summary
public static final PeriodicRotatingFileHandler.Period DAY

HALF_DAY	back to summary
public static final PeriodicRotatingFileHandler.Period HALF_DAY

HOUR	back to summary
public static final PeriodicRotatingFileHandler.Period HOUR

MINUTE	back to summary
public static final PeriodicRotatingFileHandler.Period MINUTE

MONTH	back to summary
public static final PeriodicRotatingFileHandler.Period MONTH

NEVER	back to summary
public static final PeriodicRotatingFileHandler.Period NEVER

WEEK	back to summary
public static final PeriodicRotatingFileHandler.Period WEEK

YEAR	back to summary
public static final PeriodicRotatingFileHandler.Period YEAR

Constructor Detail

Period	back to summary
private Period()

Method Detail

valueOf	back to summary
public static PeriodicRotatingFileHandler.Period valueOf(String name)

values	back to summary
public static PeriodicRotatingFileHandler.Period[] values()

public Class PeriodicRotatingFileHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PeriodicRotatingFileHandler.Period

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail