java.lang.Object
org.apache.logging.log4j.core.appender.rolling.action.AbstractAction
org.apache.logging.log4j.core.appender.rolling.action.GzCompressAction
All Implemented Interfaces:
Runnable, Action

public final class GzCompressAction extends AbstractAction
Compresses a file using GZ compression.
  • Constructor Details

    • 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)
      Prefer the constructor with compression level.
  • Method Details

    • execute

      public boolean execute() throws IOException
      Compress.
      Specified by:
      execute in interface Action
      Specified by:
      execute in class AbstractAction
      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.
      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 class AbstractAction
      Parameters:
      ex - exception.
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getSource

      public File getSource()
    • getDestination

      public File getDestination()
    • isDeleteSource

      public boolean isDeleteSource()