Class GzCompressAction
- java.lang.Object
-
- org.apache.logging.log4j.core.appender.rolling.action.AbstractAction
-
- org.apache.logging.log4j.core.appender.rolling.action.GzCompressAction
-
public final class GzCompressAction extends AbstractAction
Compresses a file using GZ compression.
-
-
Field Summary
-
Fields inherited from class org.apache.logging.log4j.core.appender.rolling.action.AbstractAction
LOGGER
-
-
Constructor Summary
Constructors Constructor Description GzCompressAction(File source, File destination, boolean deleteSource)
Deprecated.GzCompressAction(File source, File destination, boolean deleteSource, int compressionLevel)
Create new instance of GzCompressAction.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
execute()
Compress.static boolean
execute(File source, File destination, boolean deleteSource)
Deprecated.In favor ofexecute(File, File, boolean, int)
.static boolean
execute(File source, File destination, boolean deleteSource, int compressionLevel)
Compress a file.File
getDestination()
File
getSource()
boolean
isDeleteSource()
protected void
reportException(Exception ex)
Capture exception.String
toString()
-
Methods inherited from class org.apache.logging.log4j.core.appender.rolling.action.AbstractAction
close, isComplete, isInterrupted, run
-
-
-
-
Constructor Detail
-
GzCompressAction
public GzCompressAction(File source, File destination, boolean deleteSource, int compressionLevel)
Create new instance of GzCompressAction.- Parameters:
source
- file to compress, may not be null.destination
- compressed file, may not be null.deleteSource
- if true, attempt to delete file on completion. Failure to delete does not cause an exception to be thrown or affect return value.compressionLevel
- Gzip deflater compression level.
-
GzCompressAction
@Deprecated public GzCompressAction(File source, File destination, boolean deleteSource)
Deprecated.Prefer the constructor with compression level.
-
-
Method Detail
-
execute
public boolean execute() throws IOException
Compress.- Specified by:
execute
in interfaceAction
- Specified by:
execute
in classAbstractAction
- Returns:
- true if successfully compressed.
- Throws:
IOException
- on IO exception.
-
execute
@Deprecated public static boolean execute(File source, File destination, boolean deleteSource) throws IOException
Deprecated.In favor ofexecute(File, File, boolean, int)
.Compress a file.- Parameters:
source
- file to compress, may not be null.destination
- compressed file, may not be null.deleteSource
- if true, attempt to delete file on completion. Failure to delete does not cause an exception to be thrown or affect return value.- Returns:
- true if source file compressed.
- Throws:
IOException
- on IO exception.
-
execute
public static boolean execute(File source, File destination, boolean deleteSource, int compressionLevel) throws IOException
Compress a file.- Parameters:
source
- file to compress, may not be null.destination
- compressed file, may not be null.deleteSource
- if true, attempt to delete file on completion. Failure to delete does not cause an exception to be thrown or affect return value.compressionLevel
- Gzip deflater compression level.- Returns:
- true if source file compressed.
- Throws:
IOException
- on IO exception.
-
reportException
protected void reportException(Exception ex)
Capture exception.- Overrides:
reportException
in classAbstractAction
- Parameters:
ex
- exception.
-
getSource
public File getSource()
-
getDestination
public File getDestination()
-
isDeleteSource
public boolean isDeleteSource()
-
-