Package org.codehaus.plexus.archiver

Class AbstractArchiver

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.plexus.archiver.AbstractArchiver

All Implemented Interfaces:

Archiver, FinalizerEnabled, org.codehaus.plexus.logging.LogEnabled, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Direct Known Subclasses:

AbstractZipArchiver, BZip2Archiver, DirectoryArchiver, GZipArchiver, TarArchiver, XZArchiver

public abstract class AbstractArchiver
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements Archiver, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable, FinalizerEnabled

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	AbstractArchiver.AddedResourceCollection

Field Summary

Fields

Modifier and Type	Field	Description
private ArchiverManager	archiverManager
private java.util.List<java.io.Closeable>	closeables
private int	defaultDirectoryMode
private int	defaultFileMode
private java.io.File	destFile
private java.io.File	dotFileDirectory
private java.lang.String	duplicateBehavior
private java.util.Comparator<java.lang.String>	filenameComparator
private java.util.List<ArchiveFinalizer>	finalizers
private boolean	forced
private int	forcedDirectoryMode
private int	forcedFileMode
private boolean	ignorePermissions
private boolean	includeEmptyDirs
private java.util.Date	lastModifiedDate
private org.codehaus.plexus.logging.Logger	logger
private int	overrideGid
private java.lang.String	overrideGroupName
private int	overrideUid
private java.lang.String	overrideUserName
private boolean	replacePathSlashesToJavaPaths
private java.util.List<java.lang.Object>	resources	A list of the following objects: Instances of ArchiveEntry, which are passed back by getResources() without modifications . Instances of PlexusIoResourceCollection, which are converted into an Iterator over instances of ArchiveEntry by getResources().
private boolean	useJvmChmod	since 2.2 is on by default

Fields inherited from interface org.codehaus.plexus.archiver.Archiver

DEFAULT_DIR_MODE, DEFAULT_FILE_MODE, DEFAULT_SYMLILNK_MODE, DUPLICATES_ADD, DUPLICATES_FAIL, DUPLICATES_PRESERVE, DUPLICATES_SKIP, DUPLICATES_VALID_BEHAVIORS, ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractArchiver()

Method Summary

Modifier and Type	Method	Description
void	addArchivedFileSet(java.io.File archiveFile)	Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addArchivedFileSet(java.io.File archiveFile, java.lang.String prefix)	Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addArchivedFileSet(java.io.File archiveFile, java.lang.String[] includes, java.lang.String[] excludes)	Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addArchivedFileSet(java.io.File archiveFile, java.lang.String prefix, java.lang.String[] includes, java.lang.String[] excludes)	Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addArchivedFileSet(ArchivedFileSet fileSet)	Adds the given archive file set to the archive.
void	addArchivedFileSet(ArchivedFileSet fileSet, java.nio.charset.Charset charset)	Adds the given archive file set to the archive.
void	addArchiveFinalizer(ArchiveFinalizer finalizer)
private void	addCloseable(java.lang.Object maybeCloseable)
void	addDirectory(java.io.File directory)	Obsolete, use Archiver.addFileSet(FileSet).
void	addDirectory(java.io.File directory, java.lang.String prefix)	Obsolete, use Archiver.addFileSet(FileSet).
void	addDirectory(java.io.File directory, java.lang.String[] includes, java.lang.String[] excludes)	Obsolete, use Archiver.addFileSet(FileSet).
void	addDirectory(java.io.File directory, java.lang.String prefix, java.lang.String[] includes, java.lang.String[] excludes)	Obsolete, use Archiver.addFileSet(FileSet).
void	addFile(java.io.File inputFile, java.lang.String destFileName)
void	addFile(java.io.File inputFile, java.lang.String destFileName, int permissions)
void	addFileSet(FileSet fileSet)	Adds the given file set to the archive.
void	addResource(org.codehaus.plexus.components.io.resources.PlexusIoResource resource, java.lang.String destFileName, int permissions)	Adds the given resource collection to the archive.
void	addResources(org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection collection)	Adds a resource collection to the archive.
void	addSymlink(java.lang.String symlinkName, int permissions, java.lang.String symlinkDestination)
void	addSymlink(java.lang.String symlinkName, java.lang.String symlinkDestination)
private ArchiveEntry	asArchiveEntry(AbstractArchiver.AddedResourceCollection collection, org.codehaus.plexus.components.io.resources.PlexusIoResource resource)
protected ArchiveEntry	asArchiveEntry(org.codehaus.plexus.components.io.resources.PlexusIoResource resource, java.lang.String destFileName, int permissions, org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection collection)
protected org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection	asResourceCollection(ArchivedFileSet fileSet, java.nio.charset.Charset charset)
protected boolean	checkForced()
protected void	cleanUp()
protected abstract void	close()
private static void	closeIfCloseable(java.lang.Object resource)
private void	closeIterators()
private static void	closeQuietlyIfCloseable(java.lang.Object resource)
void	configureReproducible(java.util.Date lastModifiedDate)	Configure the archiver to create archives in a reproducible way (see	void	contextualize(org.codehaus.plexus.context.Context context)	Allows us to pull the ArchiverManager instance out of the container without causing a chicken-and-egg instantiation/composition problem.
void	createArchive()
private void	doAddResource(java.lang.Object item)
protected abstract void	execute()
protected abstract java.lang.String	getArchiveType()
int	getDefaultDirectoryMode()
int	getDefaultFileMode()
java.io.File	getDestFile()
int	getDirectoryMode()	Gets the forced mode for directories, falling back to default if none is forced.
java.lang.String	getDuplicateBehavior()	Returns the behavior of this archiver when duplicate files are detected.
int	getFileMode()
java.util.Comparator<java.lang.String>	getFilenameComparator()
java.util.Map<java.lang.String,ArchiveEntry>	getFiles()
boolean	getIncludeEmptyDirs()
java.util.Date	getLastModifiedDate()
protected org.codehaus.plexus.logging.Logger	getLogger()
int	getOverrideDirectoryMode()
int	getOverrideFileMode()
int	getOverrideGid()
java.lang.String	getOverrideGroupName()
int	getOverrideUid()
java.lang.String	getOverrideUserName()
int	getRawDefaultFileMode()	Deprecated. Use Archiver.getDefaultFileMode().
ResourceIterator	getResources()	Returns an iterator over instances of ArchiveEntry, which have previously been added by calls to Archiver.addResources(PlexusIoResourceCollection), Archiver.addResource(PlexusIoResource, String, int), Archiver.addFileSet(FileSet), etc.
protected boolean	hasVirtualFiles()
boolean	isForced()	Returns, whether recreating the archive is forced (default).
boolean	isIgnorePermissions()
boolean	isSupportingForced()	Returns, whether the archive supports uptodate checks.
protected boolean	isUptodate()
boolean	isUseJvmChmod()
protected java.util.Date	normalizeLastModifiedDate(java.util.Date lastModifiedDate)	Normalize last modified time value to get reproducible archive entries, based on archive binary format (tar uses UTC timestamp but zip uses local time then requires tweaks to make the value reproducible whatever the current timezone is).
protected void	postCreateArchive()	This method is called after the archive creation completes successfully (no exceptions are thrown).
protected boolean	revert(java.lang.StringBuffer messageBuffer)
protected void	runArchiveFinalizers()
void	setArchiveFinalizers(java.util.List<ArchiveFinalizer> archiveFinalizers)
void	setDefaultDirectoryMode(int mode)	This is the "default" value we should use if no other value is specified
void	setDefaultFileMode(int mode)
void	setDestFile(java.io.File destFile)
void	setDirectoryMode(int mode)	This is the forced mode that should be used regardless if set, otherwise falls back to default.
void	setDotFileDirectory(java.io.File dotFileDirectory)
void	setDuplicateBehavior(java.lang.String duplicate)	Set the behavior of this archiver when duplicate files are detected.
void	setFileMode(int mode)
void	setFilenameComparator(java.util.Comparator<java.lang.String> filenameComparator)	Set filename comparator, used to sort file entries when scanning directories since File.list() does not guarantee any order.
void	setForced(boolean forced)	Sets, whether recreating the archive is forced (default).
void	setIgnorePermissions(boolean ignorePermissions)
void	setIncludeEmptyDirs(boolean includeEmptyDirs)
void	setLastModifiedDate(java.util.Date lastModifiedDate)	Define forced last modification date for entries (if non null).
void	setOverrideGid(int gid)
void	setOverrideGroupName(java.lang.String groupName)
void	setOverrideUid(int uid)
void	setOverrideUserName(java.lang.String userName)
void	setUseJvmChmod(boolean useJvmChmod)	to use or not the jvm method for file permissions: user all not active for group permissions
private ArchiveEntry	updateArchiveEntryAttributes(ArchiveEntry entry)
protected void	validate()

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

logger

private org.codehaus.plexus.logging.Logger logger

destFile

private java.io.File destFile

resources

private final java.util.List<java.lang.Object> resources

A list of the following objects:

• Instances of ArchiveEntry, which are passed back by getResources() without modifications .
• Instances of PlexusIoResourceCollection, which are converted into an Iterator over instances of ArchiveEntry by getResources().

includeEmptyDirs

private boolean includeEmptyDirs

forcedFileMode

private int forcedFileMode

forcedDirectoryMode

private int forcedDirectoryMode

defaultFileMode

private int defaultFileMode

defaultDirectoryMode

private int defaultDirectoryMode

forced

private boolean forced

finalizers

private java.util.List<ArchiveFinalizer> finalizers

dotFileDirectory

private java.io.File dotFileDirectory

duplicateBehavior

private java.lang.String duplicateBehavior

replacePathSlashesToJavaPaths

private final boolean replacePathSlashesToJavaPaths

closeables

private final java.util.List<java.io.Closeable> closeables

useJvmChmod

private boolean useJvmChmod

since 2.2 is on by default

Since:

1.1

lastModifiedDate

private java.util.Date lastModifiedDate

Since:

4.2.0

filenameComparator

private java.util.Comparator<java.lang.String> filenameComparator

overrideUid

private int overrideUid

overrideUserName

private java.lang.String overrideUserName

overrideGid

private int overrideGid

overrideGroupName

private java.lang.String overrideGroupName

archiverManager

private ArchiverManager archiverManager

ignorePermissions

private boolean ignorePermissions

Since:

1.1

Constructor Detail

AbstractArchiver

public AbstractArchiver()

Method Detail

getDuplicateBehavior

public java.lang.String getDuplicateBehavior()

Description copied from interface: Archiver

Returns the behavior of this archiver when duplicate files are detected.

Specified by:

getDuplicateBehavior in interface Archiver

setDuplicateBehavior

public void setDuplicateBehavior(java.lang.String duplicate)

Description copied from interface: Archiver

Set the behavior of this archiver when duplicate files are detected. One of:

• add - Add the duplicates to the archive as duplicate entries
• skip/preserve - Leave the first entry encountered in the archive, skip the new one
• fail - throw an ArchiverException

See Archiver.DUPLICATES_ADD, Archiver.DUPLICATES_SKIP, Archiver.DUPLICATES_PRESERVE, Archiver.DUPLICATES_FAIL.

Specified by:

setDuplicateBehavior in interface Archiver

setFileMode

public final void setFileMode(int mode)

Specified by:

setFileMode in interface Archiver

setDefaultFileMode

public final void setDefaultFileMode(int mode)

Specified by:

setDefaultFileMode in interface Archiver

getOverrideFileMode

public final int getOverrideFileMode()

Specified by:

getOverrideFileMode in interface Archiver

getFileMode

public final int getFileMode()

Specified by:

getFileMode in interface Archiver

getDefaultFileMode

public final int getDefaultFileMode()

Specified by:

getDefaultFileMode in interface Archiver

getRawDefaultFileMode

@Deprecated
public final int getRawDefaultFileMode()

Deprecated.

Use Archiver.getDefaultFileMode().

setDirectoryMode

public final void setDirectoryMode(int mode)

Description copied from interface: Archiver

This is the forced mode that should be used regardless if set, otherwise falls back to default.

Specified by:

setDirectoryMode in interface Archiver

setDefaultDirectoryMode

public final void setDefaultDirectoryMode(int mode)

Description copied from interface: Archiver

This is the "default" value we should use if no other value is specified

Specified by:

setDefaultDirectoryMode in interface Archiver

getOverrideDirectoryMode

public final int getOverrideDirectoryMode()

Specified by:

getOverrideDirectoryMode in interface Archiver

getDirectoryMode

public final int getDirectoryMode()

Description copied from interface: Archiver

Gets the forced mode for directories, falling back to default if none is forced.

Specified by:

getDirectoryMode in interface Archiver

Returns:

getDefaultDirectoryMode

public final int getDefaultDirectoryMode()

Specified by:

getDefaultDirectoryMode in interface Archiver

getIncludeEmptyDirs

public boolean getIncludeEmptyDirs()

Specified by:

getIncludeEmptyDirs in interface Archiver

setIncludeEmptyDirs

public void setIncludeEmptyDirs(boolean includeEmptyDirs)

Specified by:

setIncludeEmptyDirs in interface Archiver

addDirectory

public void addDirectory(@Nonnull
                         java.io.File directory)
                  throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addFileSet(FileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addDirectory in interface Archiver

Throws:

ArchiverException

addDirectory

public void addDirectory(@Nonnull
                         java.io.File directory,
                         java.lang.String prefix)
                  throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addFileSet(FileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addDirectory in interface Archiver

Throws:

ArchiverException

addDirectory

public void addDirectory(@Nonnull
                         java.io.File directory,
                         java.lang.String[] includes,
                         java.lang.String[] excludes)
                  throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addFileSet(FileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addDirectory in interface Archiver

Throws:

ArchiverException

addDirectory

public void addDirectory(@Nonnull
                         java.io.File directory,
                         java.lang.String prefix,
                         java.lang.String[] includes,
                         java.lang.String[] excludes)
                  throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addFileSet(FileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addDirectory in interface Archiver

Throws:

ArchiverException

addFileSet

public void addFileSet(@Nonnull
                       FileSet fileSet)
                throws ArchiverException

Description copied from interface: Archiver

Adds the given file set to the archive. This method is basically obsoleting Archiver.addDirectory(File), Archiver.addDirectory(File, String), Archiver.addDirectory(File, String[], String[]), and Archiver.addDirectory(File, String, String[], String[]). However, as these methods are in widespread use, they cannot easily be made deprecated.

Specified by:

addFileSet in interface Archiver

Throws:

ArchiverException - Adding the file set failed.

addFile

public void addFile(@Nonnull
                    java.io.File inputFile,
                    @Nonnull
                    java.lang.String destFileName)
             throws ArchiverException

Specified by:

addFile in interface Archiver

Throws:

ArchiverException

addSymlink

public void addSymlink(java.lang.String symlinkName,
                       java.lang.String symlinkDestination)
                throws ArchiverException

Specified by:

addSymlink in interface Archiver

Throws:

ArchiverException

addSymlink

public void addSymlink(java.lang.String symlinkName,
                       int permissions,
                       java.lang.String symlinkDestination)
                throws ArchiverException

Specified by:

addSymlink in interface Archiver

Throws:

ArchiverException

updateArchiveEntryAttributes

private ArchiveEntry updateArchiveEntryAttributes(ArchiveEntry entry)

asArchiveEntry

protected ArchiveEntry asArchiveEntry(@Nonnull
                                      org.codehaus.plexus.components.io.resources.PlexusIoResource resource,
                                      java.lang.String destFileName,
                                      int permissions,
                                      org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection collection)
                               throws ArchiverException

Throws:

ArchiverException

asArchiveEntry

private ArchiveEntry asArchiveEntry(AbstractArchiver.AddedResourceCollection collection,
                                    org.codehaus.plexus.components.io.resources.PlexusIoResource resource)
                             throws ArchiverException

Throws:

ArchiverException

addResource

public void addResource(org.codehaus.plexus.components.io.resources.PlexusIoResource resource,
                        java.lang.String destFileName,
                        int permissions)
                 throws ArchiverException

Description copied from interface: Archiver

Adds the given resource collection to the archive. Stream transformers are *not* supported on this method

Specified by:

addResource in interface Archiver

Throws:

ArchiverException

addFile

public void addFile(@Nonnull
                    java.io.File inputFile,
                    @Nonnull
                    java.lang.String destFileName,
                    int permissions)
             throws ArchiverException

Specified by:

addFile in interface Archiver

Throws:

ArchiverException

getResources

@Nonnull
public ResourceIterator getResources()
                              throws ArchiverException

Description copied from interface: Archiver

Returns an iterator over instances of ArchiveEntry, which have previously been added by calls to Archiver.addResources(PlexusIoResourceCollection), Archiver.addResource(PlexusIoResource, String, int), Archiver.addFileSet(FileSet), etc.

Specified by:

getResources in interface Archiver

Throws:

ArchiverException

closeIfCloseable

private static void closeIfCloseable(java.lang.Object resource)
                              throws java.io.IOException

Throws:

java.io.IOException

closeQuietlyIfCloseable

private static void closeQuietlyIfCloseable(java.lang.Object resource)

getFiles

public java.util.Map<java.lang.String,ArchiveEntry> getFiles()

Specified by:

getFiles in interface Archiver

getDestFile

public java.io.File getDestFile()

Specified by:

getDestFile in interface Archiver

setDestFile

public void setDestFile(java.io.File destFile)

Specified by:

setDestFile in interface Archiver

getLogger

protected org.codehaus.plexus.logging.Logger getLogger()

Overrides:

getLogger in class org.codehaus.plexus.logging.AbstractLogEnabled

asResourceCollection

protected org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection asResourceCollection(ArchivedFileSet fileSet,
                                                                                                      java.nio.charset.Charset charset)
                                                                                               throws ArchiverException

Throws:

ArchiverException

addResources

public void addResources(org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection collection)
                  throws ArchiverException

Adds a resource collection to the archive.

Specified by:

addResources in interface Archiver

Throws:

ArchiverException

doAddResource

private void doAddResource(java.lang.Object item)

addArchivedFileSet

public void addArchivedFileSet(ArchivedFileSet fileSet)
                        throws ArchiverException

Description copied from interface: Archiver

Adds the given archive file set to the archive. This method is basically obsoleting Archiver.addArchivedFileSet(File), Archiver.addArchivedFileSet(File, String[], String[]), and Archiver.addArchivedFileSet(File, String, String[], String[]). However, as these methods are in widespread use, they cannot easily be made deprecated. Stream transformers are supported on this method

Specified by:

addArchivedFileSet in interface Archiver

Throws:

ArchiverException

addArchivedFileSet

public void addArchivedFileSet(ArchivedFileSet fileSet,
                               java.nio.charset.Charset charset)
                        throws ArchiverException

Description copied from interface: Archiver

Adds the given archive file set to the archive. This method is basically obsoleting Archiver.addArchivedFileSet(File), Archiver.addArchivedFileSet(File, String[], String[]), and Archiver.addArchivedFileSet(File, String, String[], String[]). However, as these methods are in widespread use, they cannot easily be made deprecated.

Specified by:

addArchivedFileSet in interface Archiver

Parameters:

fileSet - the fileSet to add

charset - the encoding to use, particularly useful to specific non-standard filename encodings for some kinds of archives (for instance zip files) Stream transformers are supported on this method

Throws:

ArchiverException

addArchivedFileSet

public void addArchivedFileSet(@Nonnull
                               java.io.File archiveFile,
                               java.lang.String prefix,
                               java.lang.String[] includes,
                               java.lang.String[] excludes)
                        throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addArchivedFileSet in interface Archiver

Throws:

ArchiverException

Since:

1.0-alpha-7

addArchivedFileSet

public void addArchivedFileSet(@Nonnull
                               java.io.File archiveFile,
                               java.lang.String prefix)
                        throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addArchivedFileSet in interface Archiver

Throws:

ArchiverException

Since:

1.0-alpha-7

addArchivedFileSet

public void addArchivedFileSet(@Nonnull
                               java.io.File archiveFile,
                               java.lang.String[] includes,
                               java.lang.String[] excludes)
                        throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addArchivedFileSet in interface Archiver

Throws:

ArchiverException

Since:

1.0-alpha-7

addArchivedFileSet

public void addArchivedFileSet(@Nonnull
                               java.io.File archiveFile)
                        throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet). You can use "inline" of this method in your IDE to get the proper implementation for this release.

Specified by:

addArchivedFileSet in interface Archiver

Throws:

ArchiverException

Since:

1.0-alpha-7

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Allows us to pull the ArchiverManager instance out of the container without causing a chicken-and-egg instantiation/composition problem.

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException

isForced

public boolean isForced()

Description copied from interface: Archiver

Returns, whether recreating the archive is forced (default). Setting this option to false means, that the archiver should compare the timestamps of included files with the timestamp of the target archive and rebuild the archive only, if the latter timestamp precedes the former timestamps. Checking for timestamps will typically offer a performance gain (in particular, if the following steps in a build can be suppressed, if an archive isn't recreated) on the cost that you get inaccurate results from time to time. In particular, removal of source files won't be detected.

An archiver doesn't necessarily support checks for uptodate. If so, setting this option to true will simply be ignored. The method Archiver.isSupportingForced() may be called to check whether an archiver does support uptodate checks.

Specified by:

isForced in interface Archiver

Returns:

True, if the target archive should always be created; false otherwise

See Also:

Archiver.setForced(boolean), Archiver.isSupportingForced()

setForced

public void setForced(boolean forced)

Description copied from interface: Archiver

Sets, whether recreating the archive is forced (default). Setting this option to false means, that the archiver should compare the timestamps of included files with the timestamp of the target archive and rebuild the archive only, if the latter timestamp precedes the former timestamps. Checking for timestamps will typically offer a performance gain (in particular, if the following steps in a build can be suppressed, if an archive isn't recreated) on the cost that you get inaccurate results from time to time. In particular, removal of source files won't be detected.

An archiver doesn't necessarily support checks for uptodate. If so, setting this option to true will simply be ignored. The method Archiver.isSupportingForced() may be called to check whether an archiver does support uptodate checks.

Specified by:

setForced in interface Archiver

Parameters:

forced - True, if the target archive should always be created; false otherwise

See Also:

Archiver.isForced(), Archiver.isSupportingForced()

addArchiveFinalizer

public void addArchiveFinalizer(ArchiveFinalizer finalizer)

Specified by:

addArchiveFinalizer in interface FinalizerEnabled

setArchiveFinalizers

public void setArchiveFinalizers(java.util.List<ArchiveFinalizer> archiveFinalizers)

Specified by:

setArchiveFinalizers in interface FinalizerEnabled

setDotFileDirectory

public void setDotFileDirectory(java.io.File dotFileDirectory)

Specified by:

setDotFileDirectory in interface Archiver

isUptodate

protected boolean isUptodate()
                      throws ArchiverException

Throws:

ArchiverException

checkForced

protected boolean checkForced()
                       throws ArchiverException

Throws:

ArchiverException

isSupportingForced

public boolean isSupportingForced()

Description copied from interface: Archiver

Returns, whether the archive supports uptodate checks. If so, you may set Archiver.setForced(boolean) to true.

Specified by:

isSupportingForced in interface Archiver

Returns:

True, if the archiver does support uptodate checks, false otherwise

See Also:

Archiver.setForced(boolean), Archiver.isForced()

runArchiveFinalizers

protected void runArchiveFinalizers()
                             throws ArchiverException

Throws:

ArchiverException

createArchive

public final void createArchive()
                         throws ArchiverException,
                                java.io.IOException

Specified by:

createArchive in interface Archiver

Throws:

ArchiverException

java.io.IOException

hasVirtualFiles

protected boolean hasVirtualFiles()

revert

protected boolean revert(java.lang.StringBuffer messageBuffer)

validate

protected void validate()
                 throws ArchiverException,
                        java.io.IOException

Throws:

ArchiverException

java.io.IOException

postCreateArchive

protected void postCreateArchive()
                          throws ArchiverException,
                                 java.io.IOException

This method is called after the archive creation completes successfully (no exceptions are thrown). Subclasses may override this method in order to augment or validate the archive after it is created.

Throws:

ArchiverException

java.io.IOException

Since:

3.6

getArchiveType

protected abstract java.lang.String getArchiveType()

addCloseable

private void addCloseable(java.lang.Object maybeCloseable)

closeIterators

private void closeIterators()

close

protected abstract void close()
                       throws java.io.IOException

Throws:

java.io.IOException

cleanUp

protected void cleanUp()
                throws java.io.IOException

Throws:

java.io.IOException

execute

protected abstract void execute()
                         throws ArchiverException,
                                java.io.IOException

Throws:

ArchiverException

java.io.IOException

isUseJvmChmod

public boolean isUseJvmChmod()

Specified by:

isUseJvmChmod in interface Archiver

Returns:

Since:

1.1

setUseJvmChmod

public void setUseJvmChmod(boolean useJvmChmod)

Description copied from interface: Archiver

to use or not the jvm method for file permissions: user all not active for group permissions

Specified by:

setUseJvmChmod in interface Archiver

Since:

1.1

isIgnorePermissions

public boolean isIgnorePermissions()

Specified by:

isIgnorePermissions in interface Archiver

Since:

1.1

setIgnorePermissions

public void setIgnorePermissions(boolean ignorePermissions)

Specified by:

setIgnorePermissions in interface Archiver

Since:

1.1

setLastModifiedDate

public void setLastModifiedDate(java.util.Date lastModifiedDate)

Description copied from interface: Archiver

Define forced last modification date for entries (if non null).

Specified by:

setLastModifiedDate in interface Archiver

getLastModifiedDate

public java.util.Date getLastModifiedDate()

Specified by:

getLastModifiedDate in interface Archiver

setFilenameComparator

public void setFilenameComparator(java.util.Comparator<java.lang.String> filenameComparator)

Description copied from interface: Archiver

Set filename comparator, used to sort file entries when scanning directories since File.list() does not guarantee any order.

Specified by:

setFilenameComparator in interface Archiver

getFilenameComparator

public java.util.Comparator<java.lang.String> getFilenameComparator()

setOverrideUid

public void setOverrideUid(int uid)

Specified by:

setOverrideUid in interface Archiver

setOverrideUserName

public void setOverrideUserName(java.lang.String userName)

Specified by:

setOverrideUserName in interface Archiver

getOverrideUid

public int getOverrideUid()

Specified by:

getOverrideUid in interface Archiver

getOverrideUserName

public java.lang.String getOverrideUserName()

Specified by:

getOverrideUserName in interface Archiver

setOverrideGid

public void setOverrideGid(int gid)

Specified by:

setOverrideGid in interface Archiver

setOverrideGroupName

public void setOverrideGroupName(java.lang.String groupName)

Specified by:

setOverrideGroupName in interface Archiver

getOverrideGid

public int getOverrideGid()

Specified by:

getOverrideGid in interface Archiver

getOverrideGroupName

public java.lang.String getOverrideGroupName()

Specified by:

getOverrideGroupName in interface Archiver

configureReproducible

public void configureReproducible(java.util.Date lastModifiedDate)

Description copied from interface: Archiver

Configure the archiver to create archives in a reproducible way (see Specified by:

configureReproducible in interface Archiver

Parameters:

lastModifiedDate - the date to use for archive entries last modified time

normalizeLastModifiedDate

protected java.util.Date normalizeLastModifiedDate(java.util.Date lastModifiedDate)

Normalize last modified time value to get reproducible archive entries, based on archive binary format (tar uses UTC timestamp but zip uses local time then requires tweaks to make the value reproducible whatever the current timezone is).

Parameters:

lastModifiedDate -

Returns: