Package org.codehaus.plexus.archiver

Class AbstractUnArchiver

java.lang.Object
org.codehaus.plexus.archiver.AbstractUnArchiver
All Implemented Interfaces:
FinalizerEnabled, UnArchiver
Direct Known Subclasses:
AbstractZipUnArchiver, BZip2UnArchiver, GZipUnArchiver, SnappyUnArchiver, TarUnArchiver, XZUnArchiver, ZstdUnArchiver
public abstract class AbstractUnArchiver extends Object implements UnArchiver, FinalizerEnabled
Author:
Emmanuel Venisse

  • Constructor Details

    • AbstractUnArchiver

      public AbstractUnArchiver()

    • AbstractUnArchiver

      public AbstractUnArchiver(File sourceFile)

  • Method Details

    • getLogger

      protected org.slf4j.Logger getLogger()

    • getDestDirectory

      public File getDestDirectory()
      Specified by:
      getDestDirectory in interface UnArchiver

    • setDestDirectory

      public void setDestDirectory(File destDirectory)
      Specified by:
      setDestDirectory in interface UnArchiver

    • getDestFile

      public File getDestFile()
      Specified by:
      getDestFile in interface UnArchiver

    • setDestFile

      public void setDestFile(File destFile)
      Specified by:
      setDestFile in interface UnArchiver

    • getSourceFile

      public File getSourceFile()
      Specified by:
      getSourceFile in interface UnArchiver

    • setSourceFile

      public void setSourceFile(File sourceFile)
      Specified by:
      setSourceFile in interface UnArchiver

    • isOverwrite

      public boolean isOverwrite()
      Description copied from interface: UnArchiver
      Gets a flag indicating destination files are always overwritten.
      Specified by:
      isOverwrite in interface UnArchiver
      Returns:
      true, if destination files are overwritten, even if they are newer than the corresponding entry in the archive.

    • setOverwrite

      public void setOverwrite(boolean b)
      Description copied from interface: UnArchiver
      Should we overwrite files in dest, even if they are newer than the corresponding entries in the archive?
      Specified by:
      setOverwrite in interface UnArchiver

    • getFileMappers

      public org.codehaus.plexus.components.io.filemappers.FileMapper[] getFileMappers()
      Description copied from interface: UnArchiver
      Get chain of components which rewrite the target path of each unpacked file.
      Specified by:
      getFileMappers in interface UnArchiver
      Returns:
      FileMappers to be used for rewriting each target path, or null if no rewriting shall happen.

    • setFileMappers

      public void setFileMappers(org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers)
      Description copied from interface: UnArchiver
      Sets chain of components to be used for rewriting target path of each unpacked file.
      Specified by:
      setFileMappers in interface UnArchiver
      Parameters:
      fileMappers - FileMapper to be used for rewriting each target path, or null if no rewriting shall happen.

    • extract

      public final void extract() throws ArchiverException
      Description copied from interface: UnArchiver
      Extract the archive.
      Specified by:
      extract in interface UnArchiver
      Throws:
      ArchiverException

    • extract

      public final void extract(String path, File outputDirectory) throws ArchiverException
      Description copied from interface: UnArchiver
      Take a path into the archive and extract it to the specified directory.
      Specified by:
      extract in interface UnArchiver
      Parameters:
      path - Path inside the archive to be extracted.
      outputDirectory - Directory to extract to.
      Throws:
      ArchiverException

    • addArchiveFinalizer

      public void addArchiveFinalizer(ArchiveFinalizer finalizer)
      Specified by:
      addArchiveFinalizer in interface FinalizerEnabled

    • setArchiveFinalizers

      public void setArchiveFinalizers(List<ArchiveFinalizer> archiveFinalizers)
      Specified by:
      setArchiveFinalizers in interface FinalizerEnabled

    • validate

      protected void validate(String path, File outputDirectory)

    • validate

      protected void validate() throws ArchiverException
      Throws:
      ArchiverException

    • setFileSelectors

      public void setFileSelectors(org.codehaus.plexus.components.io.fileselectors.FileSelector[] fileSelectors)
      Description copied from interface: UnArchiver
      Sets a set of FileSelector instances, which may be used to select the files to extract from the archive. If file selectors are present, then a file is only extracted, if it is confirmed by all file selectors.
      Specified by:
      setFileSelectors in interface UnArchiver

    • getFileSelectors

      public org.codehaus.plexus.components.io.fileselectors.FileSelector[] getFileSelectors()
      Description copied from interface: UnArchiver
      Returns a set of FileSelector instances, which may be used to select the files to extract from the archive. If file selectors are present, then a file is only extracted, if it is confirmed by all file selectors.
      Specified by:
      getFileSelectors in interface UnArchiver

    • isSelected

      protected boolean isSelected(String fileName, org.codehaus.plexus.components.io.resources.PlexusIoResource fileInfo) throws ArchiverException
      Throws:
      ArchiverException

    • execute

      protected abstract void execute() throws ArchiverException
      Throws:
      ArchiverException

    • execute

      protected abstract void execute(String path, File outputDirectory) throws ArchiverException
      Throws:
      ArchiverException

    • isUseJvmChmod

      @Deprecated public boolean isUseJvmChmod()
      Deprecated.
      Specified by:
      isUseJvmChmod in interface UnArchiver
      Returns:
      Since:
      1.1

    • setUseJvmChmod

      @Deprecated public void setUseJvmChmod(boolean useJvmChmod)
      Deprecated.
      jvm chmod won't set group level permissions !
      Specified by:
      setUseJvmChmod in interface UnArchiver
      Parameters:
      useJvmChmod -
      Since:
      1.1

    • isIgnorePermissions

      public boolean isIgnorePermissions()
      Specified by:
      isIgnorePermissions in interface UnArchiver
      Since:
      1.1

    • setIgnorePermissions

      public void setIgnorePermissions(boolean ignorePermissions)
      Specified by:
      setIgnorePermissions in interface UnArchiver
      Since:
      1.1

    • extractFile

      protected void extractFile(File srcF, File dir, InputStream compressedInputStream, String entryName, Date entryDate, boolean isDirectory, Integer mode, String symlinkDestination, org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers) throws IOException, ArchiverException
      Throws:
      IOException
      ArchiverException

    • shouldExtractEntry

      protected boolean shouldExtractEntry(File targetDirectory, File targetFileName, String entryName, Date entryDate) throws IOException
      Throws:
      IOException