org.apache.archiva.repository.storage

Class FilesystemAsset

java.lang.Object

org.apache.archiva.repository.storage.FilesystemAsset

All Implemented Interfaces:

Comparable, StorageAsset

public class FilesystemAsset
extends Object
implements StorageAsset, Comparable

Implementation of an asset that is stored on the filesystem.

The implementation does not check the given paths. Caller should normalize the asset path and check, if the base path is a parent of the resulting path.

The file must not exist for all operations.

Author:

Martin Stockhammer

Field Summary

Fields

Modifier and Type	Field and Description
static AclEntryPermission[]	DEFAULT_ACL_DIR_PERMISSIONS
static AclEntryPermission[]	DEFAULT_ACL_FILE_PERMISSIONS
static Set<PosixFilePermission>	DEFAULT_POSIX_DIR_PERMISSIONS
static String	DEFAULT_POSIX_DIR_PERMS
static Set<PosixFilePermission>	DEFAULT_POSIX_FILE_PERMISSIONS
static String	DEFAULT_POSIX_FILE_PERMS

Constructor Summary

Constructors

Constructor and Description
FilesystemAsset(RepositoryStorage storage, String path, Path assetPath) Creates an asset for the given path.
FilesystemAsset(RepositoryStorage storage, String path, Path assetPath, Path basePath, boolean directory) Creates an asset for the given path.
FilesystemAsset(RepositoryStorage storage, String path, Path assetPath, Path basePath, boolean directory, boolean setPermissionsForNew) Creates an asset for the given path.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object o)
void	create() Creates the asset in the underlying storage, if it does not exist.
boolean	exists() Returns true, if the asset exists.
List<AclEntry>	getDefaultDirectoryAcls()
List<AclEntry>	getDefaultFileAcls()
Set<PosixFilePermission>	getDefaultPosixDirectoryPermissions()
Set<PosixFilePermission>	getDefaultPosixFilePermissions()
Path	getFilePath() Returns the real path to the asset, if it exist.
Instant	getModificationTime() Returns the time of the last modification.
String	getName() Returns the name of the asset.
StorageAsset	getParent() Returns the parent of this asset.
String	getPath() Returns the complete path relative to the repository to the given asset.
ReadableByteChannel	getReadChannel() Returns a NIO representation of the data.
InputStream	getReadStream() Returns a input stream to the underlying file, if it exists.
long	getSize() Returns the size of the represented file.
RepositoryStorage	getStorage() Returns the storage this asset belongs to.
WritableByteChannel	getWriteChannel(boolean replace) Returns a NIO representation of the asset where you can write the data.
OutputStream	getWriteStream(boolean replace) Returns an output stream where you can write data to the asset.
boolean	hasParent() Returns true, if there is a parent to this asset.
boolean	isContainer() Returns true, if the path of this asset points to a directory
boolean	isFileBased() Returns true, if the asset can return a file path for the given asset.
List<StorageAsset>	list() Returns the list of directory entries, if this asset represents a directory.
boolean	replaceDataFromFile(Path newData) Replaces the content.
StorageAsset	resolve(String toPath) Returns the asset relative to the given path
void	setDefaultDirectoryAcls(List<AclEntry> acl)
void	setDefaultFileAcls(List<AclEntry> acl)
void	setDefaultPosixDirectoryPermissions(Set<PosixFilePermission> perms)
void	setDefaultPosixFilePermissions(Set<PosixFilePermission> perms)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POSIX_FILE_PERMS

public static final String DEFAULT_POSIX_FILE_PERMS

See Also:

Constant Field Values

DEFAULT_POSIX_DIR_PERMS

public static final String DEFAULT_POSIX_DIR_PERMS

See Also:

Constant Field Values

DEFAULT_POSIX_FILE_PERMISSIONS

public static final Set<PosixFilePermission> DEFAULT_POSIX_FILE_PERMISSIONS

DEFAULT_POSIX_DIR_PERMISSIONS

public static final Set<PosixFilePermission> DEFAULT_POSIX_DIR_PERMISSIONS

DEFAULT_ACL_FILE_PERMISSIONS

public static final AclEntryPermission[] DEFAULT_ACL_FILE_PERMISSIONS

DEFAULT_ACL_DIR_PERMISSIONS

public static final AclEntryPermission[] DEFAULT_ACL_DIR_PERMISSIONS

Constructor Detail

FilesystemAsset

public FilesystemAsset(RepositoryStorage storage,
                       String path,
                       Path assetPath)

Creates an asset for the given path. The given paths are not checked. The base path should be an absolute path.

Parameters:

path - The logical path for the asset relative to the repository.

assetPath - The asset path.

FilesystemAsset

public FilesystemAsset(RepositoryStorage storage,
                       String path,
                       Path assetPath,
                       Path basePath,
                       boolean directory)

Creates an asset for the given path. The given paths are not checked. The base path should be an absolute path.

Parameters:

path - The logical path for the asset relative to the repository

assetPath - The asset path.

directory - This is only relevant, if the represented file or directory does not exist yet and is a hint.

FilesystemAsset

public FilesystemAsset(RepositoryStorage storage,
                       String path,
                       Path assetPath,
                       Path basePath,
                       boolean directory,
                       boolean setPermissionsForNew)

Creates an asset for the given path. The given paths are not checked. The base path should be an absolute path.

Parameters:

path - The logical path for the asset relative to the repository

assetPath - The asset path.

directory - This is only relevant, if the represented file or directory does not exist yet and is a hint.

Method Detail

getStorage

public RepositoryStorage getStorage()

Description copied from interface: StorageAsset

Returns the storage this asset belongs to.

Specified by:

getStorage in interface StorageAsset

Returns:

getPath

public String getPath()

Description copied from interface: StorageAsset

Returns the complete path relative to the repository to the given asset.

Specified by:

getPath in interface StorageAsset

Returns:

A path starting with '/' that uniquely identifies the asset in the repository.

getName

public String getName()

Description copied from interface: StorageAsset

Returns the name of the asset. It may be just the filename.

Specified by:

getName in interface StorageAsset

Returns:

getModificationTime

public Instant getModificationTime()

Description copied from interface: StorageAsset

Returns the time of the last modification.

Specified by:

getModificationTime in interface StorageAsset

Returns:

isContainer

public boolean isContainer()

Returns true, if the path of this asset points to a directory

Specified by:

isContainer in interface StorageAsset

Returns:

list

public List<StorageAsset> list()

Returns the list of directory entries, if this asset represents a directory. Otherwise a empty list will be returned.

Specified by:

list in interface StorageAsset

Returns:

The list of entries in the directory, if it exists.

getSize

public long getSize()

Returns the size of the represented file. If it cannot be determined, -1 is returned.

Specified by:

getSize in interface StorageAsset

Returns:

getReadStream

public InputStream getReadStream()
                          throws IOException

Returns a input stream to the underlying file, if it exists. The caller has to make sure, that the stream is closed after it was used.

Specified by:

getReadStream in interface StorageAsset

Returns:

Throws:

IOException

getReadChannel

public ReadableByteChannel getReadChannel()
                                   throws IOException

Description copied from interface: StorageAsset

Returns a NIO representation of the data.

Specified by:

getReadChannel in interface StorageAsset

Returns:

A channel to the asset data.

Throws:

IOException

getWriteStream

public OutputStream getWriteStream(boolean replace)
                            throws IOException

Description copied from interface: StorageAsset

Returns an output stream where you can write data to the asset. The operation is not locked or synchronized. User of this method have to make sure, that the stream is proper closed after usage.

Specified by:

getWriteStream in interface StorageAsset

Parameters:

replace - If true, the original data will be replaced, otherwise the data will be appended.

Returns:

The OutputStream where the data can be written.

Throws:

IOException

getWriteChannel

public WritableByteChannel getWriteChannel(boolean replace)
                                    throws IOException

Description copied from interface: StorageAsset

Returns a NIO representation of the asset where you can write the data.

Specified by:

getWriteChannel in interface StorageAsset

Parameters:

replace - True, if the content should be replaced by the data written to the stream.

Returns:

The Channel for writing the data.

Throws:

IOException

replaceDataFromFile

public boolean replaceDataFromFile(Path newData)
                            throws IOException

Description copied from interface: StorageAsset

Replaces the content. The implementation may do an atomic move operation, or keep a backup. If the operation fails, the implementation should try to restore the old data, if possible. The original file may be deleted, if the storage was successful.

Specified by:

replaceDataFromFile in interface StorageAsset

Parameters:

newData - Replaces the data by the content of the given file.

Throws:

IOException

exists

public boolean exists()

Description copied from interface: StorageAsset

Returns true, if the asset exists.

Specified by:

exists in interface StorageAsset

Returns:

True, if the asset exists, otherwise false.

getFilePath

public Path getFilePath()
                 throws UnsupportedOperationException

Description copied from interface: StorageAsset

Returns the real path to the asset, if it exist. Not all implementations may implement this method. The method throws UnsupportedOperationException, if and only if StorageAsset.isFileBased() returns false.

Specified by:

getFilePath in interface StorageAsset

Returns:

The filesystem path to the asset.

Throws:

UnsupportedOperationException - If the underlying storage is not file based.

isFileBased

public boolean isFileBased()

Description copied from interface: StorageAsset

Returns true, if the asset can return a file path for the given asset. If this is true, the StorageAsset.getFilePath() will not throw a UnsupportedOperationException

Specified by:

isFileBased in interface StorageAsset

Returns:

hasParent

public boolean hasParent()

Description copied from interface: StorageAsset

Returns true, if there is a parent to this asset.

Specified by:

hasParent in interface StorageAsset

Returns:

getParent

public StorageAsset getParent()

Description copied from interface: StorageAsset

Returns the parent of this asset.

Specified by:

getParent in interface StorageAsset

Returns:

The asset, or null, if it does not exist.

resolve

public StorageAsset resolve(String toPath)

Description copied from interface: StorageAsset

Returns the asset relative to the given path

Specified by:

resolve in interface StorageAsset

Returns:

setDefaultFileAcls

public void setDefaultFileAcls(List<AclEntry> acl)

getDefaultFileAcls

public List<AclEntry> getDefaultFileAcls()

setDefaultPosixFilePermissions

public void setDefaultPosixFilePermissions(Set<PosixFilePermission> perms)

getDefaultPosixFilePermissions

public Set<PosixFilePermission> getDefaultPosixFilePermissions()

setDefaultDirectoryAcls

public void setDefaultDirectoryAcls(List<AclEntry> acl)

getDefaultDirectoryAcls

public List<AclEntry> getDefaultDirectoryAcls()

setDefaultPosixDirectoryPermissions

public void setDefaultPosixDirectoryPermissions(Set<PosixFilePermission> perms)

getDefaultPosixDirectoryPermissions

public Set<PosixFilePermission> getDefaultPosixDirectoryPermissions()

create

public void create()
            throws IOException

Description copied from interface: StorageAsset

Creates the asset in the underlying storage, if it does not exist.

Specified by:

create in interface StorageAsset

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable