org.apache.archiva.repository.storage

Class FilesystemStorage

java.lang.Object

org.apache.archiva.repository.storage.FilesystemStorage

All Implemented Interfaces:

RepositoryStorage

public class FilesystemStorage
extends Object
implements RepositoryStorage

Implementation of RepositoryStorage where data is stored in the filesystem. All files are relative to a given base path. Path values are separated by '/', '..' is allowed to navigate to a parent directory, but navigation out of the base path will lead to a exception.

Constructor Summary

Constructors

Constructor and Description
FilesystemStorage(Path basePath, FileLockManager fileLockManager)

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.
FileLockManager	getFileLockManager()
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 location and releases all locks.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilesystemStorage

public FilesystemStorage(Path basePath,
                         FileLockManager fileLockManager)
                  throws IOException

Throws:

IOException

Method Detail

consumeData

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

Description copied from interface: RepositoryStorage

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

Specified by:

consumeData in interface RepositoryStorage

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

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

Description copied from interface: RepositoryStorage

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

Specified by:

consumeDataFromChannel in interface RepositoryStorage

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

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

Description copied from interface: RepositoryStorage

Writes data to the asset using a write lock.

Specified by:

writeData in interface RepositoryStorage

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

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

Description copied from interface: RepositoryStorage

Writes data and sets a lock during the operation.

Specified by:

writeDataToChannel in interface RepositoryStorage

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

getLocation

public URI getLocation()

Description copied from interface: RepositoryStorage

Returns a URI representation of the storage location.

Specified by:

getLocation in interface RepositoryStorage

Returns:

The URI that is pointing to the storage.

updateLocation

public void updateLocation(URI newLocation)
                    throws IOException

Updates the location and releases all locks.

Specified by:

updateLocation in interface RepositoryStorage

Parameters:

newLocation - The URI to the new location

Throws:

IOException - If the directory cannot be created.

getAsset

public StorageAsset getAsset(String path)

Description copied from interface: RepositoryStorage

Returns information about a specific storage asset.

Specified by:

getAsset in interface RepositoryStorage

Returns:

addAsset

public StorageAsset addAsset(String path,
                             boolean container)

Description copied from interface: RepositoryStorage

Adds a new asset to the underlying storage.

Specified by:

addAsset in interface RepositoryStorage

Parameters:

path - The path to the asset.

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

Returns:

removeAsset

public void removeAsset(StorageAsset asset)
                 throws IOException

Description copied from interface: RepositoryStorage

Removes the given asset from the storage.

Specified by:

removeAsset in interface RepositoryStorage

Throws:

IOException

moveAsset

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

Description copied from interface: RepositoryStorage

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.

Specified by:

moveAsset in interface RepositoryStorage

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

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

Description copied from interface: RepositoryStorage

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

Specified by:

moveAsset in interface RepositoryStorage

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

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

Description copied from interface: RepositoryStorage

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.

Specified by:

copyAsset in interface RepositoryStorage

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

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

Description copied from interface: RepositoryStorage

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.

Specified by:

copyAsset in interface RepositoryStorage

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

getFileLockManager

public FileLockManager getFileLockManager()