org.apache.archiva.repository.storage

Class StorageUtil

java.lang.Object

org.apache.archiva.repository.storage.StorageUtil

public class StorageUtil
extends Object

Utility class for assets. Allows to copy, move between different storage instances and recursively consume the tree.

Author:

Martin Stockhammer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorageUtil.PathInformation

Constructor Summary

Constructors

Constructor and Description
StorageUtil()

Method Summary

Modifier and Type	Method and Description
static void	copyAsset(StorageAsset source, StorageAsset target, boolean locked, CopyOption... copyOptions) Copies the source asset to the target.
static void	copyToLocalFile(StorageAsset asset, Path destination, CopyOption... copyOptions)
static void	deleteRecursively(StorageAsset baseDir) Deletes the given asset and all child assets recursively.
static StorageUtil.PathInformation	getAssetDataAsPath(StorageAsset asset)
static String	getExtension(StorageAsset asset) Returns the extension of the name of a given asset.
static void	moveAsset(StorageAsset source, StorageAsset target, boolean locked, CopyOption... copyOptions) Moves a asset between different storage instances.
static void	recurse(StorageAsset baseAsset, Consumer<StorageAsset> consumer) Runs the consumer function recursively on each asset found starting at the base path.
static void	recurse(StorageAsset baseAsset, Consumer<StorageAsset> consumer, boolean depthFirst) Runs the consumer function recursively on each asset found starting at the base path.
static void	recurse(StorageAsset baseAsset, Consumer<StorageAsset> consumer, boolean depthFirst, int maxDepth) Runs the consumer function recursively on each asset found starting at the base path

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageUtil

public StorageUtil()

Method Detail

copyAsset

public static final void copyAsset(StorageAsset source,
                                   StorageAsset target,
                                   boolean locked,
                                   CopyOption... copyOptions)
                            throws IOException

Copies the source asset to the target. The assets may be from different RepositoryStorage instances. If you know that source and asset are from the same storage instance, the copy method of the storage instance may be faster.

Parameters:

source - The source asset

target - The target asset

locked - If true, a readlock is set on the source and a write lock is set on the target.

copyOptions - Copy options

Throws:

IOException

moveAsset

public static final void moveAsset(StorageAsset source,
                                   StorageAsset target,
                                   boolean locked,
                                   CopyOption... copyOptions)
                            throws IOException

Moves a asset between different storage instances. If you know that source and asset are from the same storage instance, the move method of the storage instance may be faster.

Parameters:

source - The source asset

target - The target asset

locked - If true, a lock is used for the move operation.

copyOptions - Options for copying

Throws:

IOException - If the move fails

recurse

public static final void recurse(StorageAsset baseAsset,
                                 Consumer<StorageAsset> consumer,
                                 boolean depthFirst,
                                 int maxDepth)
                          throws IOException

Runs the consumer function recursively on each asset found starting at the base path

Parameters:

baseAsset - The base path where to start search

consumer - The consumer function applied to each found asset

depthFirst - If true, the deepest elements are consumed first.

maxDepth - The maximum depth to recurse into. 0 means, only the baseAsset is consumed, 1 the base asset and its children and so forth.

Throws:

IOException

recurse

public static final void recurse(StorageAsset baseAsset,
                                 Consumer<StorageAsset> consumer,
                                 boolean depthFirst)
                          throws IOException

Runs the consumer function recursively on each asset found starting at the base path. The function descends into maximum depth.

Parameters:

baseAsset - The base path where to start search

consumer - The consumer function applied to each found asset

depthFirst - If true, the deepest elements are consumed first.

Throws:

IOException

recurse

public static final void recurse(StorageAsset baseAsset,
                                 Consumer<StorageAsset> consumer)
                          throws IOException

Runs the consumer function recursively on each asset found starting at the base path. It does not recurse with depth first and stops only if there are no more children available.

Parameters:

baseAsset - The base path where to start search

consumer - The consumer function applied to each found asset

Throws:

IOException

deleteRecursively

public static final void deleteRecursively(StorageAsset baseDir)
                                    throws IOException

Deletes the given asset and all child assets recursively.

Parameters:

baseDir - The base asset to remove.

Throws:

IOException

getExtension

public static final String getExtension(StorageAsset asset)

Returns the extension of the name of a given asset. Extension is the substring after the last occurence of '.' in the string. If no '.' is found, the empty string is returned.

Parameters:

asset - The asset from which to return the extension string.

Returns:

The extension.

copyToLocalFile

public static final void copyToLocalFile(StorageAsset asset,
                                         Path destination,
                                         CopyOption... copyOptions)
                                  throws IOException

Throws:

IOException

getAssetDataAsPath

public static final StorageUtil.PathInformation getAssetDataAsPath(StorageAsset asset)
                                                            throws IOException

Throws:

IOException