org.codehaus.plexus.archiver.diags

Class TrackingArchiver

java.lang.Object

org.codehaus.plexus.archiver.diags.TrackingArchiver

All Implemented Interfaces:

Archiver

public class TrackingArchiver
extends Object
implements Archiver

A diagnostic archiver that keeps track of stuff that has been added.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TrackingArchiver.Addition

Field Summary

Fields

Modifier and Type	Field and Description
List<TrackingArchiver.Addition>	added

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 and Description
TrackingArchiver()

Method Summary

Modifier and Type	Method and Description
void	addArchivedFileSet(ArchivedFileSet fileSet) Adds the given archive file set to the archive.
void	addArchivedFileSet(ArchivedFileSet fileSet, Charset charset) Adds the given archive file set to the archive.
void	addArchivedFileSet(File archiveFile) Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addArchivedFileSet(File archiveFile, String prefix) Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addArchivedFileSet(File archiveFile, String[] includes, String[] excludes) Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addArchivedFileSet(File archiveFile, String prefix, String[] includes, String[] excludes) Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).
void	addDirectory(File directory) Obsolete, use Archiver.addFileSet(FileSet).
void	addDirectory(File directory, String prefix) Obsolete, use Archiver.addFileSet(FileSet).
void	addDirectory(File directory, String[] includes, String[] excludes) Obsolete, use Archiver.addFileSet(FileSet).
void	addDirectory(File directory, String prefix, String[] includes, String[] excludes) Obsolete, use Archiver.addFileSet(FileSet).
void	addFile(File inputFile, String destFileName)
void	addFile(File inputFile, 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, String destFileName, int permissions) Adds the given resource collection to the archive.
void	addResources(org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection resources) Adds the given resource collection to the archive.
void	addSymlink(String s, int i, String s2)
void	addSymlink(String s, String s2)
void	configureReproducible(Date lastModifiedDate) Configure the archiver to create archives in a reproducible way (see Reproducible Builds).
void	createArchive()
int	getDefaultDirectoryMode()
int	getDefaultFileMode()
File	getDestFile()
int	getDirectoryMode() Gets the forced mode for directories, falling back to default if none is forced.
String	getDuplicateBehavior() Returns the behavior of this archiver when duplicate files are detected.
int	getFileMode()
Map<String,ArchiveEntry>	getFiles()
boolean	getIncludeEmptyDirs()
Date	getLastModifiedDate()
int	getOverrideDirectoryMode()
int	getOverrideFileMode()
int	getOverrideGid()
String	getOverrideGroupName()
int	getOverrideUid()
String	getOverrideUserName()
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.
boolean	isForced() Returns, whether recreating the archive is forced (default).
boolean	isIgnorePermissions()
boolean	isSupportingForced() Returns, whether the archive supports uptodate checks.
boolean	isUseJvmChmod()
void	setDefaultDirectoryMode(int mode) This is the "default" value we should use if no other value is specified
void	setDefaultFileMode(int mode)
void	setDestFile(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(File dotFileDirectory)
void	setDuplicateBehavior(String duplicate) Set the behavior of this archiver when duplicate files are detected.
void	setFileMode(int mode)
void	setFilenameComparator(Comparator<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(Date lastModifiedDate) Define forced last modification date for entries (if non null).
void	setOverrideGid(int gid)
void	setOverrideGroupName(String groupName)
void	setOverrideUid(int uid)
void	setOverrideUserName(String userName)
void	setUseJvmChmod(boolean useJvmChmod) to use or not the jvm method for file permissions: user all not active for group permissions

Methods inherited from class java.lang.Object

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

Field Detail

added

public final List<TrackingArchiver.Addition> added

Constructor Detail

TrackingArchiver

public TrackingArchiver()

Method Detail

createArchive

public void createArchive()
                   throws ArchiverException,
                          IOException

Specified by:

createArchive in interface Archiver

Throws:

ArchiverException

IOException

addDirectory

public void addDirectory(@Nonnull
                         File directory)
                  throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addFileSet(FileSet).

Specified by:

addDirectory in interface Archiver

Throws:

ArchiverException

addDirectory

public void addDirectory(@Nonnull
                         File directory,
                         String prefix)
                  throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addFileSet(FileSet).

Specified by:

addDirectory in interface Archiver

Throws:

ArchiverException

addDirectory

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

Description copied from interface: Archiver

Obsolete, use Archiver.addFileSet(FileSet).

Specified by:

addDirectory in interface Archiver

Throws:

ArchiverException

addDirectory

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

Description copied from interface: Archiver

Obsolete, use Archiver.addFileSet(FileSet).

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 deprecated.

Specified by:

addFileSet in interface Archiver

Throws:

ArchiverException - Adding the file set failed.

addFile

public void addFile(@Nonnull
                    File inputFile,
                    @Nonnull
                    String destFileName)
             throws ArchiverException

Specified by:

addFile in interface Archiver

Throws:

ArchiverException

addFile

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

Specified by:

addFile in interface Archiver

Throws:

ArchiverException

addArchivedFileSet

public void addArchivedFileSet(@Nonnull
                               File archiveFile)
                        throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).

Specified by:

addArchivedFileSet in interface Archiver

Throws:

ArchiverException

addArchivedFileSet

public void addArchivedFileSet(@Nonnull
                               File archiveFile,
                               String prefix)
                        throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).

Specified by:

addArchivedFileSet in interface Archiver

Throws:

ArchiverException

addSymlink

public void addSymlink(String s,
                       String s2)
                throws ArchiverException

Specified by:

addSymlink in interface Archiver

Throws:

ArchiverException

addSymlink

public void addSymlink(String s,
                       int i,
                       String s2)
                throws ArchiverException

Specified by:

addSymlink in interface Archiver

Throws:

ArchiverException

addArchivedFileSet

public void addArchivedFileSet(File archiveFile,
                               String[] includes,
                               String[] excludes)
                        throws ArchiverException

Description copied from interface: Archiver

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).

Specified by:

addArchivedFileSet in interface Archiver

Throws:

ArchiverException

addArchivedFileSet

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

Description copied from interface: Archiver

Obsolete, use Archiver.addArchivedFileSet(ArchivedFileSet).

Specified by:

addArchivedFileSet in interface Archiver

Throws:

ArchiverException

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 deprecated. Stream transformers are supported on this method

Specified by:

addArchivedFileSet in interface Archiver

Throws:

ArchiverException

addArchivedFileSet

public void addArchivedFileSet(ArchivedFileSet fileSet,
                               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 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

addResource

public void addResource(org.codehaus.plexus.components.io.resources.PlexusIoResource resource,
                        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

addResources

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

Description copied from interface: Archiver

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

Specified by:

addResources in interface Archiver

Throws:

ArchiverException

getDestFile

public File getDestFile()

Specified by:

getDestFile in interface Archiver

setDestFile

public void setDestFile(File destFile)

Specified by:

setDestFile in interface Archiver

setFileMode

public void setFileMode(int mode)

Specified by:

setFileMode in interface Archiver

getFileMode

public int getFileMode()

Specified by:

getFileMode in interface Archiver

getOverrideFileMode

public int getOverrideFileMode()

Specified by:

getOverrideFileMode in interface Archiver

setDefaultFileMode

public void setDefaultFileMode(int mode)

Specified by:

setDefaultFileMode in interface Archiver

getDefaultFileMode

public int getDefaultFileMode()

Specified by:

getDefaultFileMode in interface Archiver

setDirectoryMode

public 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

getDirectoryMode

public 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:

getOverrideDirectoryMode

public int getOverrideDirectoryMode()

Specified by:

getOverrideDirectoryMode in interface Archiver

setDefaultDirectoryMode

public 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

getDefaultDirectoryMode

public 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

setDotFileDirectory

public void setDotFileDirectory(File dotFileDirectory)

Specified by:

setDotFileDirectory in interface Archiver

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

getFiles

public Map<String,ArchiveEntry> getFiles()

Specified by:

getFiles in interface Archiver

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()

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()

getDuplicateBehavior

public 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(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

isUseJvmChmod

public boolean isUseJvmChmod()

Specified by:

isUseJvmChmod in interface Archiver

Returns:

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

isIgnorePermissions

public boolean isIgnorePermissions()

Specified by:

isIgnorePermissions in interface Archiver

setIgnorePermissions

public void setIgnorePermissions(boolean ignorePermissions)

Specified by:

setIgnorePermissions in interface Archiver

setLastModifiedDate

public void setLastModifiedDate(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 Date getLastModifiedDate()

Specified by:

getLastModifiedDate in interface Archiver

setFilenameComparator

public void setFilenameComparator(Comparator<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

setOverrideUid

public void setOverrideUid(int uid)

Specified by:

setOverrideUid in interface Archiver

setOverrideUserName

public void setOverrideUserName(String userName)

Specified by:

setOverrideUserName in interface Archiver

getOverrideUid

public int getOverrideUid()

Specified by:

getOverrideUid in interface Archiver

getOverrideUserName

public String getOverrideUserName()

Specified by:

getOverrideUserName in interface Archiver

setOverrideGid

public void setOverrideGid(int gid)

Specified by:

setOverrideGid in interface Archiver

setOverrideGroupName

public void setOverrideGroupName(String groupName)

Specified by:

setOverrideGroupName in interface Archiver

getOverrideGid

public int getOverrideGid()

Specified by:

getOverrideGid in interface Archiver

getOverrideGroupName

public String getOverrideGroupName()

Specified by:

getOverrideGroupName in interface Archiver

configureReproducible

public void configureReproducible(Date lastModifiedDate)

Description copied from interface: Archiver

Configure the archiver to create archives in a reproducible way (see Reproducible Builds).

This will configure:

• reproducible archive entries order,
• defined entries timestamp
• and reproducible entries Unix mode.

Specified by:

configureReproducible in interface Archiver

Parameters:

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