Package org.codehaus.plexus.archiver.dir

Class DirectoryArchiver

java.lang.Object

org.codehaus.plexus.archiver.AbstractArchiver

org.codehaus.plexus.archiver.dir.DirectoryArchiver

All Implemented Interfaces:

Archiver, FinalizerEnabled

@Named("dir")
public class DirectoryArchiver
extends AbstractArchiver

A plexus archiver implementation that stores the files to archive in a directory.

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
DirectoryArchiver()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected void	cleanUp()
protected void	close()
protected void	copyFile(ArchiveEntry entry, java.lang.String vPath)	Copies the specified file to the specified path, creating any ancestor directory structure as necessary.
protected void	createSymbolicLink(java.io.File link, java.io.File target)	Creates a symbolic link.
void	execute()
protected java.lang.String	getArchiveType()
SymlinkFailureMode	getSymlinkFailureMode()	Returns what happens to a symbolic link that the file system refuses to create.
boolean	isSupportingForced()	Returns, whether the archive supports uptodate checks.
void	resetArchiver()
void	setSymlinkFailureMode(SymlinkFailureMode symlinkFailureMode)	Sets what happens to a symbolic link that the file system refuses to create, for example on Windows without the "Create symbolic links" right or Developer Mode.

Methods inherited from class org.codehaus.plexus.archiver.AbstractArchiver

addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchiveFinalizer, addDirectory, addDirectory, addDirectory, addDirectory, addFile, addFile, addFileSet, addResource, addResources, addSymlink, addSymlink, asArchiveEntry, asResourceCollection, checkForced, configureReproducible, configureReproducibleBuild, createArchive, getDefaultDirectoryMode, getDefaultFileMode, getDestFile, getDirectoryMode, getDuplicateBehavior, getFileMode, getFilenameComparator, getFiles, getIncludeEmptyDirs, getLastModifiedDate, getLastModifiedTime, getLogger, getOverrideDirectoryMode, getOverrideFileMode, getOverrideGid, getOverrideGroupName, getOverrideUid, getOverrideUserName, getRawDefaultFileMode, getResources, getUmask, hasVirtualFiles, isForced, isIgnorePermissions, isUptodate, isUseJvmChmod, normalizeLastModifiedTime, postCreateArchive, revert, runArchiveFinalizers, setArchiveFinalizers, setDefaultDirectoryMode, setDefaultFileMode, setDestFile, setDirectoryMode, setDotFileDirectory, setDuplicateBehavior, setFileMode, setFilenameComparator, setForced, setIgnorePermissions, setIncludeEmptyDirs, setLastModifiedDate, setLastModifiedTime, setOverrideGid, setOverrideGroupName, setOverrideUid, setOverrideUserName, setUmask, setUseJvmChmod, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryArchiver

public DirectoryArchiver()

Default constructor.

Method Detail

getSymlinkFailureMode

public SymlinkFailureMode getSymlinkFailureMode()

Returns what happens to a symbolic link that the file system refuses to create.

Returns:

the failure mode, SymlinkFailureMode.COPY_TARGET by default

Since:

4.15.0

setSymlinkFailureMode

public void setSymlinkFailureMode(SymlinkFailureMode symlinkFailureMode)

Sets what happens to a symbolic link that the file system refuses to create, for example on Windows without the "Create symbolic links" right or Developer Mode.

Parameters:

symlinkFailureMode - the failure mode

Since:

4.15.0

createSymbolicLink

protected void createSymbolicLink(java.io.File link,
                                  java.io.File target)
                           throws java.io.IOException

Creates a symbolic link. Visible for testing, so a test can simulate a file system that refuses links.

Parameters:

link - the link to create

target - the link target

Throws:

java.io.IOException - if the link cannot be created

Since:

4.15.0

resetArchiver

public void resetArchiver()
                   throws java.io.IOException

Throws:

java.io.IOException

execute

public void execute()
             throws ArchiverException,
                    java.io.IOException

Specified by:

execute in class AbstractArchiver

Throws:

ArchiverException

java.io.IOException

copyFile

protected void copyFile(ArchiveEntry entry,
                        java.lang.String vPath)
                 throws ArchiverException,
                        java.io.IOException

Copies the specified file to the specified path, creating any ancestor directory structure as necessary.

Parameters:

entry - The file to copy (IOException will be thrown if this does not exist)

vPath - The fully qualified path to copy the file to.

Throws:

ArchiverException - If there is a problem creating the directory structure

java.io.IOException - If there is a problem copying the file

cleanUp

protected void cleanUp()
                throws java.io.IOException

Overrides:

cleanUp in class AbstractArchiver

Throws:

java.io.IOException

close

protected void close()
              throws java.io.IOException

Specified by:

close in class AbstractArchiver

Throws:

java.io.IOException

getArchiveType

protected java.lang.String getArchiveType()

Specified by:

getArchiveType in class AbstractArchiver

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

Overrides:

isSupportingForced in class AbstractArchiver

Returns:

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

See Also:

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