org.apache.archiva.repository.storage

Interface StorageAsset

All Known Implementing Classes:

FilesystemAsset

public interface StorageAsset

A instance of this interface represents information about a specific asset in a repository. The asset may be an real artifact, a directory, or a virtual asset. Each asset has a unique path relative to the repository. The implementation may read the data directly from the filesystem or underlying storage implementation.

Author:

Martin Stockhammer

Method Summary

Modifier and Type	Method and Description
void	create() Creates the asset in the underlying storage, if it does not exist.
boolean	exists() Returns true, if the asset exists.
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 the input stream of the artifact content.
long	getSize() The size in bytes of the asset.
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 this asset is a container type and contains further child assets.
boolean	isFileBased() Returns true, if the asset can return a file path for the given asset.
List<StorageAsset>	list() List the child assets.
boolean	replaceDataFromFile(Path newData) Replaces the content.
StorageAsset	resolve(String toPath) Returns the asset relative to the given path

Method Detail

getStorage

RepositoryStorage getStorage()

Returns the storage this asset belongs to.

Returns:

getPath

String getPath()

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

Returns:

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

getName

String getName()

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

Returns:

getModificationTime

Instant getModificationTime()

Returns the time of the last modification.

Returns:

isContainer

boolean isContainer()

Returns true, if this asset is a container type and contains further child assets.

Returns:

list

List<StorageAsset> list()

List the child assets.

Returns:

The list of children. If there are no children and if the asset is not a container, a empty list will be returned.

getSize

long getSize()

The size in bytes of the asset. If the asset does not have a size, -1 should be returned.

Returns:

The size if the asset has a size, otherwise -1

getReadStream

InputStream getReadStream()
                   throws IOException

Returns the input stream of the artifact content. It will throw a IOException, if the stream could not be created. Implementations should create a new stream instance for each invocation and make sure that the stream is proper closed after usage.

Returns:

The InputStream representing the content of the artifact.

Throws:

IOException

getReadChannel

ReadableByteChannel getReadChannel()
                            throws IOException

Returns a NIO representation of the data.

Returns:

A channel to the asset data.

Throws:

IOException

getWriteStream

OutputStream getWriteStream(boolean replace)
                     throws IOException

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.

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

WritableByteChannel getWriteChannel(boolean replace)
                             throws IOException

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

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

boolean replaceDataFromFile(Path newData)
                     throws IOException

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.

Parameters:

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

Throws:

IOException

exists

boolean exists()

Returns true, if the asset exists.

Returns:

True, if the asset exists, otherwise false.

create

void create()
     throws IOException

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

Throws:

IOException

getFilePath

Path getFilePath()
          throws UnsupportedOperationException

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 isFileBased() returns false.

Returns:

The filesystem path to the asset.

Throws:

UnsupportedOperationException - If the underlying storage is not file based.

isFileBased

boolean isFileBased()

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

Returns:

hasParent

boolean hasParent()

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

Returns:

getParent

StorageAsset getParent()

Returns the parent of this asset.

Returns:

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

resolve

StorageAsset resolve(String toPath)

Returns the asset relative to the given path

Parameters:

toPath -

Returns: