org.apache.archiva.repository.storage

Interface RepositoryStorage

All Known Subinterfaces:

EditableManagedRepository, EditableRemoteRepository, EditableRepository, EditableRepositoryGroup, ManagedRepository, RemoteRepository, Repository, RepositoryGroup

All Known Implementing Classes:

AbstractManagedRepository, AbstractRemoteRepository, AbstractRepository, AbstractRepositoryGroup, BasicManagedRepository, BasicRemoteRepository, FilesystemStorage, MavenManagedRepository, MavenRemoteRepository, MavenRepositoryGroup

public interface RepositoryStorage

This is the low level API to access artifacts in a repository. Each artifact is represented by one storage asset. Each asset can be accessed by a path that is independent on the underlying storage implementation. Paths always use '/' as path separator. The path is local to the repository and is unique for each asset. The storage API knows nothing about the repository layout or repository specific metadata. If you use this API you must either have knowledge about the specific repository layout or use the structure as it is, e.g. for browsing. The base implementation for the storage uses a directory structure on the local filesystem. It is the decision of the repository type specific implementation, if this API provides access to all elements, that is really stored or just a selected view. Checking access is not part of this API.

Method Summary

Modifier and Type	Method and Description
StorageAsset	addAsset(String path, boolean container) Adds a new asset to the underlying storage.
void	consumeData(StorageAsset asset, Consumer<InputStream> consumerFunction, boolean readLock) Consumes the data and sets a lock for the file during the operation.
void	consumeDataFromChannel(StorageAsset asset, Consumer<ReadableByteChannel> consumerFunction, boolean readLock) Consumes the data and sets a lock for the file during the operation.
void	copyAsset(StorageAsset origin, StorageAsset destination, CopyOption... copyOptions) Copies the given asset to the new destination.
StorageAsset	copyAsset(StorageAsset origin, String destination, CopyOption... copyOptions) Copies the given asset to the new destination.
StorageAsset	getAsset(String path) Returns information about a specific storage asset.
URI	getLocation() Returns a URI representation of the storage location.
void	moveAsset(StorageAsset origin, StorageAsset destination, CopyOption... copyOptions) Moves the asset to the given location and returns the asset object for the destination.
StorageAsset	moveAsset(StorageAsset origin, String destination, CopyOption... copyOptions) Moves the asset to the given location and returns the asset object for the destination.
void	removeAsset(StorageAsset asset) Removes the given asset from the storage.
void	updateLocation(URI newLocation) Updates the base location of the repository storage.
void	writeData(StorageAsset asset, Consumer<OutputStream> consumerFunction, boolean writeLock) Writes data to the asset using a write lock.
void	writeDataToChannel(StorageAsset asset, Consumer<WritableByteChannel> consumerFunction, boolean writeLock) Writes data and sets a lock during the operation.

Method Detail

getLocation

URI getLocation()

Returns a URI representation of the storage location.

Returns:

The URI that is pointing to the storage.

updateLocation

void updateLocation(URI newLocation)
             throws IOException

Updates the base location of the repository storage. The method does not move any data. It just points to the new location. Artifacts may not be accessible anymore if the data has not been moved or copied. Assets retrieved before the relocation may still be pointing to the old location.

Parameters:

newLocation - The URI to the new location

Throws:

IOException - If the repository cannot be relocated

getAsset

StorageAsset getAsset(String path)

Returns information about a specific storage asset.

Parameters:

path -

Returns:

consumeData

void consumeData(StorageAsset asset,
                 Consumer<InputStream> consumerFunction,
                 boolean readLock)
          throws IOException

Consumes the data and sets a lock for the file during the operation.

Parameters:

asset - The asset from which the data is consumed.

consumerFunction - The consumer that reads the data

readLock - If true, a read lock is acquired on the asset.

Throws:

IOException

consumeDataFromChannel

void consumeDataFromChannel(StorageAsset asset,
                            Consumer<ReadableByteChannel> consumerFunction,
                            boolean readLock)
                     throws IOException

Consumes the data and sets a lock for the file during the operation.

Parameters:

asset - The asset from which the data is consumed.

consumerFunction - The consumer that reads the data

readLock - If true, a read lock is acquired on the asset.

Throws:

IOException

writeData

void writeData(StorageAsset asset,
               Consumer<OutputStream> consumerFunction,
               boolean writeLock)
        throws IOException

Writes data to the asset using a write lock.

Parameters:

asset - The asset to which the data is written.

consumerFunction - The function that provides the data.

writeLock - If true, a write lock is acquired on the destination.

Throws:

IOException

writeDataToChannel

void writeDataToChannel(StorageAsset asset,
                        Consumer<WritableByteChannel> consumerFunction,
                        boolean writeLock)
                 throws IOException

Writes data and sets a lock during the operation.

Parameters:

asset - The asset to which the data is written.

consumerFunction - The function that provides the data.

writeLock - If true, a write lock is acquired on the destination.

Throws:

IOException

addAsset

StorageAsset addAsset(String path,
                      boolean container)

Adds a new asset to the underlying storage.

Parameters:

path - The path to the asset.

container - True, if the asset should be a container, false, if it is a file.

Returns:

removeAsset

void removeAsset(StorageAsset asset)
          throws IOException

Removes the given asset from the storage.

Parameters:

asset -

Throws:

IOException

moveAsset

StorageAsset moveAsset(StorageAsset origin,
                       String destination,
                       CopyOption... copyOptions)
                throws IOException

Moves the asset to the given location and returns the asset object for the destination. Moves only assets that belong to the same storage instance. It will throw a IOException if the assets are from differents storage instances.

Parameters:

origin - The original asset

destination - The destination path pointing to the new asset.

copyOptions - The copy options.

Returns:

The asset representation of the moved object.

Throws:

IOException

moveAsset

void moveAsset(StorageAsset origin,
               StorageAsset destination,
               CopyOption... copyOptions)
        throws IOException

Moves the asset to the given location and returns the asset object for the destination. Moves only assets that belong to the same storage instance. It will throw a IOException if the assets are from differents storage instances. *

Parameters:

origin - The original asset

destination - The destination path.

copyOptions - The copy options (e.g. StandardCopyOption.REPLACE_EXISTING

Throws:

IOException - If it was not possible to copy the asset.

copyAsset

StorageAsset copyAsset(StorageAsset origin,
                       String destination,
                       CopyOption... copyOptions)
                throws IOException

Copies the given asset to the new destination. Copies only assets that belong to the same storage instance. It will throw a IOException if the assets are from differents storage instances.

Parameters:

origin - The original asset

destination - The path to the new asset

copyOptions - The copy options, e.g. (e.g. StandardCopyOption.REPLACE_EXISTING

Returns:

The asset representation of the copied object

Throws:

IOException - If it was not possible to copy the asset

copyAsset

void copyAsset(StorageAsset origin,
               StorageAsset destination,
               CopyOption... copyOptions)
        throws IOException

Copies the given asset to the new destination. Copies only assets that belong to the same storage instance. It will throw a IOException if the assets are from differents storage instances.

Parameters:

origin - The original asset

destination - The path to the new asset

copyOptions - The copy options, e.g. (e.g. StandardCopyOption.REPLACE_EXISTING

Throws:

IOException - If it was not possible to copy the asset