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

Class DirectWriteRolloverStrategy

java.lang.Object

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

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

All Implemented Interfaces:

DirectFileRolloverStrategy, RolloverStrategy

@Plugin(name="DirectWriteRolloverStrategy",
        category="Core",
        printObject=true)
public class DirectWriteRolloverStrategy
extends AbstractRolloverStrategy
implements DirectFileRolloverStrategy

When rolling over, DirectWriteRolloverStrategy writes directly to the file as resolved by the file pattern. Files will be renamed files according to an algorithm as described below.

The DirectWriteRolloverStrategy uses similar logic as DefaultRolloverStrategy to determine the file name based on the file pattern, however the DirectWriteRolloverStrategy writes directly to a file and does not rename it during rollover, except if it is compressed, in which case it will add the appropriate file extension.

Since:

2.8

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirectWriteRolloverStrategy.Builder Builds DirectWriteRolloverStrategy instances.

Field Summary

Fields inherited from class org.apache.logging.log4j.core.appender.rolling.AbstractRolloverStrategy

LOGGER, PATTERN_COUNTER, strSubstitutor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DirectWriteRolloverStrategy(int maxFiles, int compressionLevel, StrSubstitutor strSubstitutor, Action[] customActions, boolean stopCustomActionsOnError) Deprecated. Since 2.9 Added tempCompressedFilePatternString parameter
protected	DirectWriteRolloverStrategy(int maxFiles, int compressionLevel, StrSubstitutor strSubstitutor, Action[] customActions, boolean stopCustomActionsOnError, String tempCompressedFilePatternString) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
void	clearCurrentFileName()
static DirectWriteRolloverStrategy	createStrategy(String maxFiles, String compressionLevelStr, Action[] customActions, boolean stopCustomActionsOnError, Configuration config) Deprecated. Since 2.9 Usage of Builder API is preferable
int	getCompressionLevel()
String	getCurrentFileName(RollingFileManager manager)
List<Action>	getCustomActions()
int	getMaxFiles()
PatternProcessor	getTempCompressedFilePattern()
boolean	isStopCustomActionsOnError()
static DirectWriteRolloverStrategy.Builder	newBuilder()
RolloverDescription	rollover(RollingFileManager manager) Performs the rollover.
String	toString()

Methods inherited from class org.apache.logging.log4j.core.appender.rolling.AbstractRolloverStrategy

getEligibleFiles, getEligibleFiles, getEligibleFiles, getEligibleFiles, getEligibleFiles, getStrSubstitutor, merge, suffixLength

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectWriteRolloverStrategy

@Deprecated
protected DirectWriteRolloverStrategy(int maxFiles,
                                                  int compressionLevel,
                                                  StrSubstitutor strSubstitutor,
                                                  Action[] customActions,
                                                  boolean stopCustomActionsOnError)

Deprecated. Since 2.9 Added tempCompressedFilePatternString parameter

Constructs a new instance.

Parameters:

maxFiles - The maximum number of files that match the date portion of the pattern to keep.

customActions - custom actions to perform asynchronously after rollover

stopCustomActionsOnError - whether to stop executing asynchronous actions if an error occurs

DirectWriteRolloverStrategy

protected DirectWriteRolloverStrategy(int maxFiles,
                                      int compressionLevel,
                                      StrSubstitutor strSubstitutor,
                                      Action[] customActions,
                                      boolean stopCustomActionsOnError,
                                      String tempCompressedFilePatternString)

Constructs a new instance.

Parameters:

maxFiles - The maximum number of files that match the date portion of the pattern to keep.

customActions - custom actions to perform asynchronously after rollover

stopCustomActionsOnError - whether to stop executing asynchronous actions if an error occurs

tempCompressedFilePatternString - File pattern of the working file used during compression, if null no temporary file are used

Method Detail

newBuilder

@PluginBuilderFactory
public static DirectWriteRolloverStrategy.Builder newBuilder()

createStrategy

@Deprecated
 @PluginFactory
public static DirectWriteRolloverStrategy createStrategy(@PluginAttribute(value="maxFiles")
                                                                                     String maxFiles,
                                                                                     @PluginAttribute(value="compressionLevel")
                                                                                     String compressionLevelStr,
                                                                                     @PluginElement(value="Actions")
                                                                                     Action[] customActions,
                                                                                     @PluginAttribute(value="stopCustomActionsOnError",defaultBoolean=true)
                                                                                     boolean stopCustomActionsOnError,
                                                                                     @PluginConfiguration
                                                                                     Configuration config)

Deprecated. Since 2.9 Usage of Builder API is preferable

Creates the DirectWriteRolloverStrategy.

Parameters:

maxFiles - The maximum number of files that match the date portion of the pattern to keep.

compressionLevelStr - The compression level, 0 (less) through 9 (more); applies only to ZIP files.

customActions - custom actions to perform asynchronously after rollover

stopCustomActionsOnError - whether to stop executing asynchronous actions if an error occurs

config - The Configuration.

Returns:

A DirectWriteRolloverStrategy.

getCompressionLevel

public int getCompressionLevel()

getCustomActions

public List<Action> getCustomActions()

getMaxFiles

public int getMaxFiles()

isStopCustomActionsOnError

public boolean isStopCustomActionsOnError()

getTempCompressedFilePattern

public PatternProcessor getTempCompressedFilePattern()

getCurrentFileName

public String getCurrentFileName(RollingFileManager manager)

Specified by:

getCurrentFileName in interface DirectFileRolloverStrategy

clearCurrentFileName

public void clearCurrentFileName()

Specified by:

clearCurrentFileName in interface DirectFileRolloverStrategy

rollover

public RolloverDescription rollover(RollingFileManager manager)
                             throws SecurityException

Performs the rollover.

Specified by:

rollover in interface RolloverStrategy

Parameters:

manager - The RollingFileManager name for current active log file.

Returns:

A RolloverDescription.

Throws:

SecurityException - if an error occurs.

toString

public String toString()

Overrides:

toString in class Object