Class RollingFileManager

java.lang.Object

org.apache.logging.log4j.core.appender.AbstractManager

org.apache.logging.log4j.core.appender.OutputStreamManager

org.apache.logging.log4j.core.appender.FileManager

org.apache.logging.log4j.core.appender.rolling.RollingFileManager

All Implemented Interfaces:

AutoCloseable, ByteBufferDestination

Direct Known Subclasses:

RollingRandomAccessFileManager

public class RollingFileManager
extends FileManager

The Rolling File Manager.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RollingFileManager.AsyncAction	Performs actions asynchronously.
private static class	RollingFileManager.EmptyQueue
private static class	RollingFileManager.FactoryData	Factory data.
private static class	RollingFileManager.RollingFileManagerFactory	Factory to create a RollingFileManager.

Nested classes/interfaces inherited from class AbstractManager

AbstractManager.AbstractFactoryData

Field Summary

Fields

Modifier and Type	Field	Description
private final ExecutorService	asyncExecutor
private final boolean	directWrite
private static final FileTime	EPOCH
private static RollingFileManager.RollingFileManagerFactory	factory
private String	fileName
private boolean	initialized
private long	initialTime
private static final int	MAX_TRIES
private static final int	MIN_DURATION
private PatternProcessor	patternProcessor
private static final AtomicReferenceFieldUpdater<RollingFileManager, PatternProcessor>	patternProcessorUpdater
private boolean	renameEmptyFiles
private final CopyOnWriteArrayList<RolloverListener>	rolloverListeners
private RolloverStrategy	rolloverStrategy
private static final AtomicReferenceFieldUpdater<RollingFileManager, RolloverStrategy>	rolloverStrategyUpdater
private final Semaphore	semaphore
protected long	size
private final Log4jThreadFactory	threadFactory
private TriggeringPolicy	triggeringPolicy
private static final AtomicReferenceFieldUpdater<RollingFileManager, TriggeringPolicy>	triggeringPolicyUpdater

Fields inherited from class OutputStreamManager

byteBuffer, layout

Fields inherited from class AbstractManager

count, LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RollingFileManager(String fileName, String pattern, OutputStream os, boolean append, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader, ByteBuffer buffer)	Deprecated.
protected	RollingFileManager(String fileName, String pattern, OutputStream os, boolean append, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, String advertiseURI, Layout<? extends Serializable> layout, int bufferSize, boolean writeHeader)	Deprecated.
protected	RollingFileManager(LoggerContext loggerContext, String fileName, String pattern, OutputStream os, boolean append, boolean createOnDemand, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, String advertiseURI, Layout<? extends Serializable> layout, boolean writeHeader, ByteBuffer buffer)	Deprecated.
protected	RollingFileManager(LoggerContext loggerContext, String fileName, String pattern, OutputStream os, boolean append, boolean createOnDemand, long size, long initialTime, TriggeringPolicy triggeringPolicy, RolloverStrategy rolloverStrategy, String advertiseURI, Layout<? extends Serializable> layout, String filePermissions, String fileOwner, String fileGroup, boolean writeHeader, ByteBuffer buffer)

Method Summary

Modifier and Type	Method	Description
void	addRolloverListener(RolloverListener listener)	Add a RolloverListener.
void	checkRollover(LogEvent event)	Determines if a rollover should occur.
protected void	createFileAfterRollover()
protected void	createParentDir(File file)
FileExtension	getFileExtension()
static RollingFileManager	getFileManager(String fileName, String pattern, boolean append, boolean bufferedIO, TriggeringPolicy policy, RolloverStrategy strategy, String advertiseURI, Layout<? extends Serializable> layout, int bufferSize, boolean immediateFlush, boolean createOnDemand, String filePermissions, String fileOwner, String fileGroup, Configuration configuration)	Returns a RollingFileManager.
String	getFileName()	Returns the name of the File being managed.
long	getFileSize()	Returns the current size of the file.
long	getFileTime()	Returns the time the file was created.
PatternProcessor	getPatternProcessor()	Returns the pattern processor.
RolloverStrategy	getRolloverStrategy()	Returns the rollover strategy.
(package private) Semaphore	getSemaphore()	Package-private access for tests only.
<T extends TriggeringPolicy> T	getTriggeringPolicy()	Returns the triggering policy.
private static long	initialFileTime(File file)
void	initialize()
boolean	isDirectWrite()
boolean	isRenameEmptyFiles()
boolean	releaseSub(long timeout, TimeUnit timeUnit)	Default hook to write footer during close.
void	removeRolloverListener(RolloverListener listener)	Remove a RolloverListener.
void	rollover()
void	rollover(Date prevFileTime, Date prevRollTime)
private boolean	rollover(RolloverStrategy strategy)
void	setPatternProcessor(PatternProcessor patternProcessor)
void	setRenameEmptyFiles(boolean renameEmptyFiles)
void	setRolloverStrategy(RolloverStrategy rolloverStrategy)
void	setTriggeringPolicy(TriggeringPolicy triggeringPolicy)
void	updateData(Object data)	Updates the RollingFileManager's data during a reconfiguration.
protected void	write(byte[] bytes, int offset, int length, boolean immediateFlush)	Some output streams synchronize writes while others do not.
protected void	writeToDestination(byte[] bytes, int offset, int length)	Overrides OutputStreamManager.writeToDestination(byte[], int, int) to add support for file locking.

Methods inherited from class FileManager

createOutputStream, defineAttributeView, getBufferSize, getContentFormat, getFileGroup, getFileManager, getFileOwner, getFilePermissions, isAppend, isAttributeViewEnabled, isCreateOnDemand, isLocking

Methods inherited from class OutputStreamManager

closeOutputStream, drain, flush, flushBuffer, flushDestination, getByteBuffer, getManager, getOutputStream, hasOutputStream, isOpen, setOutputStream, skipFooter, write, write, write, writeBytes, writeBytes, writeFooter, writeHeader

Methods inherited from class AbstractManager

close, getCount, getLoggerContext, getManager, getName, getStrSubstitutor, hasManager, log, logDebug, logError, logger, logWarn, narrow, release, stop

Methods inherited from class Object

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

Field Details

factory

private static RollingFileManager.RollingFileManagerFactory factory

MAX_TRIES

private static final int MAX_TRIES

See Also:

• Constant Field Values

MIN_DURATION

private static final int MIN_DURATION

See Also:

• Constant Field Values

EPOCH

private static final FileTime EPOCH

size

protected long size

initialTime

private long initialTime

patternProcessor

private volatile PatternProcessor patternProcessor

semaphore

private final Semaphore semaphore

threadFactory

private final Log4jThreadFactory threadFactory

triggeringPolicy

private volatile TriggeringPolicy triggeringPolicy

rolloverStrategy

private volatile RolloverStrategy rolloverStrategy

renameEmptyFiles

private volatile boolean renameEmptyFiles

initialized

private volatile boolean initialized

fileName

private volatile String fileName

directWrite

private final boolean directWrite

rolloverListeners

private final CopyOnWriteArrayList<RolloverListener> rolloverListeners

asyncExecutor

private final ExecutorService asyncExecutor

triggeringPolicyUpdater

private static final AtomicReferenceFieldUpdater<RollingFileManager, TriggeringPolicy> triggeringPolicyUpdater

rolloverStrategyUpdater

private static final AtomicReferenceFieldUpdater<RollingFileManager, RolloverStrategy> rolloverStrategyUpdater

patternProcessorUpdater

private static final AtomicReferenceFieldUpdater<RollingFileManager, PatternProcessor> patternProcessorUpdater

Constructor Details

RollingFileManager

@Deprecated
protected RollingFileManager(String fileName,
 String pattern,
 OutputStream os,
 boolean append,
 long size,
 long initialTime,
 TriggeringPolicy triggeringPolicy,
 RolloverStrategy rolloverStrategy,
 String advertiseURI,
 Layout<? extends Serializable> layout,
 int bufferSize,
 boolean writeHeader)

Deprecated.

RollingFileManager

@Deprecated
protected RollingFileManager(String fileName,
 String pattern,
 OutputStream os,
 boolean append,
 long size,
 long initialTime,
 TriggeringPolicy triggeringPolicy,
 RolloverStrategy rolloverStrategy,
 String advertiseURI,
 Layout<? extends Serializable> layout,
 boolean writeHeader,
 ByteBuffer buffer)

Deprecated.

RollingFileManager

@Deprecated
protected RollingFileManager(LoggerContext loggerContext,
 String fileName,
 String pattern,
 OutputStream os,
 boolean append,
 boolean createOnDemand,
 long size,
 long initialTime,
 TriggeringPolicy triggeringPolicy,
 RolloverStrategy rolloverStrategy,
 String advertiseURI,
 Layout<? extends Serializable> layout,
 boolean writeHeader,
 ByteBuffer buffer)

Deprecated.

RollingFileManager

protected RollingFileManager(LoggerContext loggerContext,
 String fileName,
 String pattern,
 OutputStream os,
 boolean append,
 boolean createOnDemand,
 long size,
 long initialTime,
 TriggeringPolicy triggeringPolicy,
 RolloverStrategy rolloverStrategy,
 String advertiseURI,
 Layout<? extends Serializable> layout,
 String filePermissions,
 String fileOwner,
 String fileGroup,
 boolean writeHeader,
 ByteBuffer buffer)

Since:

2.9

Method Details

initialize

public void initialize()

getFileManager

public static RollingFileManager getFileManager(String fileName,
 String pattern,
 boolean append,
 boolean bufferedIO,
 TriggeringPolicy policy,
 RolloverStrategy strategy,
 String advertiseURI,
 Layout<? extends Serializable> layout,
 int bufferSize,
 boolean immediateFlush,
 boolean createOnDemand,
 String filePermissions,
 String fileOwner,
 String fileGroup,
 Configuration configuration)

Returns a RollingFileManager.

Parameters:

fileName - The file name.

pattern - The pattern for rolling file.

append - true if the file should be appended to.

bufferedIO - true if data should be buffered.

policy - The TriggeringPolicy.

strategy - The RolloverStrategy.

advertiseURI - the URI to use when advertising the file

layout - The Layout.

bufferSize - buffer size to use if bufferedIO is true

immediateFlush - flush on every write or not

createOnDemand - true if you want to lazy-create the file (a.k.a. on-demand.)

filePermissions - File permissions

fileOwner - File owner

fileGroup - File group

configuration - The configuration.

Returns:

A RollingFileManager.

addRolloverListener

public void addRolloverListener(RolloverListener listener)

Add a RolloverListener.

Parameters:

listener - The RolloverListener.

removeRolloverListener

public void removeRolloverListener(RolloverListener listener)

Remove a RolloverListener.

Parameters:

listener - The RolloverListener.

getFileName

public String getFileName()

Returns the name of the File being managed.

Overrides:

getFileName in class FileManager

Returns:

The name of the File being managed.

createParentDir

protected void createParentDir(File file)

Overrides:

createParentDir in class FileManager

isDirectWrite

public boolean isDirectWrite()

getFileExtension

public FileExtension getFileExtension()

write

protected void write(byte[] bytes,
 int offset,
 int length,
 boolean immediateFlush)

Description copied from class: OutputStreamManager

Some output streams synchronize writes while others do not. Synchronizing here insures that log events won't be intertwined.

Overrides:

write in class FileManager

Parameters:

bytes - The serialized Log event.

offset - The offset into the byte array.

length - The number of bytes to write.

immediateFlush - flushes immediately after writing.

writeToDestination

protected void writeToDestination(byte[] bytes,
 int offset,
 int length)

Description copied from class: FileManager

Overrides OutputStreamManager.writeToDestination(byte[], int, int) to add support for file locking.

Overrides:

writeToDestination in class FileManager

Parameters:

bytes - the array containing data

offset - from where to write

length - how many bytes to write

isRenameEmptyFiles

public boolean isRenameEmptyFiles()

setRenameEmptyFiles

public void setRenameEmptyFiles(boolean renameEmptyFiles)

getFileSize

public long getFileSize()

Returns the current size of the file.

Returns:

The size of the file in bytes.

getFileTime

public long getFileTime()

Returns the time the file was created.

Returns:

The time the file was created.

checkRollover

public void checkRollover(LogEvent event)

Determines if a rollover should occur.

Parameters:

event - The LogEvent.

releaseSub

public boolean releaseSub(long timeout,
 TimeUnit timeUnit)

Description copied from class: OutputStreamManager

Default hook to write footer during close.

Overrides:

releaseSub in class OutputStreamManager

Parameters:

timeout - timeout

timeUnit - timeout time unit

Returns:

true if all resources were closed normally, false otherwise.

rollover

public void rollover(Date prevFileTime,
 Date prevRollTime)

rollover

public void rollover()

createFileAfterRollover

protected void createFileAfterRollover()
                                throws IOException

Throws:

IOException

getPatternProcessor

public PatternProcessor getPatternProcessor()

Returns the pattern processor.

Returns:

The PatternProcessor.

setTriggeringPolicy

public void setTriggeringPolicy(TriggeringPolicy triggeringPolicy)

setRolloverStrategy

public void setRolloverStrategy(RolloverStrategy rolloverStrategy)

setPatternProcessor

public void setPatternProcessor(PatternProcessor patternProcessor)

getTriggeringPolicy

public <T extends TriggeringPolicy> T getTriggeringPolicy()

Returns the triggering policy.

Type Parameters:

T - TriggeringPolicy type

Returns:

The TriggeringPolicy

getSemaphore

Semaphore getSemaphore()

Package-private access for tests only.

Returns:

The semaphore that controls access to the rollover operation.

getRolloverStrategy

public RolloverStrategy getRolloverStrategy()

Returns the rollover strategy.

Returns:

The RolloverStrategy

rollover

private boolean rollover(RolloverStrategy strategy)

updateData

public void updateData(Object data)

Updates the RollingFileManager's data during a reconfiguration. This method should be considered private. It is not thread safe and calling it outside of a reconfiguration may lead to errors. This method may be made protected in a future release.

Overrides:

updateData in class AbstractManager

Parameters:

data - The data to update.

initialFileTime

private static long initialFileTime(File file)