org.apache.archiva.repository.base

Class AbstractRepository

java.lang.Object

org.apache.archiva.repository.base.AbstractRepository

All Implemented Interfaces:

EventListener, EventHandler<RepositoryEvent>, EventSource, EditableRepository, Repository, RepositoryStorage

Direct Known Subclasses:

AbstractManagedRepository, AbstractRemoteRepository, AbstractRepositoryGroup

public abstract class AbstractRepository
extends Object
implements EditableRepository, EventHandler<RepositoryEvent>

Implementation of a repository with the necessary fields for a bare repository. No features are provided. Capabilities and features must be implemented by concrete classes.

Field Summary

Fields

Modifier and Type	Field and Description
static com.cronutils.model.definition.CronDefinition	CRON_DEFINITION
protected URI	location

Constructor Summary

Constructors

Constructor and Description
AbstractRepository(Locale primaryLocale, RepositoryType type, String id, String name, RepositoryStorage repositoryStorage)
AbstractRepository(RepositoryType type, String id, String name, RepositoryStorage repositoryStorage)

Method Summary

Modifier and Type	Method and Description
StorageAsset	addAsset(String path, boolean container) Adds a new asset to the underlying storage.
void	addFailoverLocation(URI location) Adds a failover location for the repository.
protected <T extends RepositoryFeature<T>> void	addFeature(RepositoryFeature<T> feature)
void	clearFailoverLocations() Clears the failover location set.
void	close() Closes all resources that are opened by this repository.
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.
abstract RepositoryCapabilities	getCapabilities() Returns the capabilities of the repository implementation.
String	getDescription() Returns a description of this repository.
String	getDescription(Locale locale) Returns the description for the given locale.
Set<URI>	getFailoverLocations() A repository may allow additional locations that can be used, if the primary location is not available.
<T extends RepositoryFeature<T>> RepositoryFeature<T>	getFeature(Class<T> clazz) Extension method that allows to provide different features that are not supported by all repository types.
String	getId() Return the identifier of the repository.
ArchivaIndexingContext	getIndexingContext() Returns a indexing context.
String	getLayout() Returns a layout definition.
StorageAsset	getLocalPath() Returns a storage representation to the local data stored for this repository.
URI	getLocation() Returns the location of this repository.
String	getName() This is the display name of the repository.
String	getName(Locale locale) Returns the name in the given locale.
Locale	getPrimaryLocale() Returns the primary locale used for setting the default values for name and description.
String	getSchedulingDefinition() Returns the definition, when the repository jobs are executed.
protected RepositoryStorage	getStorage()
RepositoryType	getType() This identifies the type of repository.
void	handle(RepositoryEvent event)
abstract boolean	hasIndex() Returns true, if this repository has a index available
boolean	isOpen() Returns the current status of this repository.
boolean	isScanned() True, if this repository is scanned regularly.
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.
<T extends Event> void	registerEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)
void	removeAsset(StorageAsset asset) Removes the given asset from the storage.
void	removeFailoverLocation(URI location) Removes a failover location from the set.
void	setBaseUri(URI baseUri) Sets the base uri for relative location uris.
void	setDescription(Locale locale, String description) Sets the description for the given locale
void	setIndexingContext(ArchivaIndexingContext context) Sets the indexing context reference.
void	setLayout(String layout) Sets the layout string.
void	setLocation(URI location) Sets the location of the repository.
void	setName(Locale locale, String name) Sets the name for the given locale
protected void	setPrimaryLocale(Locale locale)
void	setScanned(boolean scanned) Sets the flag for scanning the repository.
void	setSchedulingDefinition(String cronExpression) Sets the scheduling definition, that defines the times, when the regular repository jobs are started.
protected void	setStorage(RepositoryStorage storage)
<T extends RepositoryFeature<T>> boolean	supportsFeature(Class<T> clazz) Returns true, if the requested feature is supported by this repository.
<T extends Event> void	unregisterEventHandler(EventType<T> type, EventHandler<? super T> eventHandler)
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.

Methods inherited from class java.lang.Object

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

Field Detail

location

protected URI location

CRON_DEFINITION

public static final com.cronutils.model.definition.CronDefinition CRON_DEFINITION

Constructor Detail

AbstractRepository

public AbstractRepository(RepositoryType type,
                          String id,
                          String name,
                          RepositoryStorage repositoryStorage)

AbstractRepository

public AbstractRepository(Locale primaryLocale,
                          RepositoryType type,
                          String id,
                          String name,
                          RepositoryStorage repositoryStorage)

Method Detail

setPrimaryLocale

protected void setPrimaryLocale(Locale locale)

getId

public String getId()

Description copied from interface: Repository

Return the identifier of the repository. Repository identifier should be unique at least for the same type.

Specified by:

getId in interface Repository

Returns:

The identifier.

getName

public String getName()

Description copied from interface: Repository

This is the display name of the repository. This string is presented in the user interface.

Specified by:

getName in interface Repository

Returns:

The display name of the repository

getName

public String getName(Locale locale)

Description copied from interface: Repository

Returns the name in the given locale.

Specified by:

getName in interface Repository

Returns:

getDescription

public String getDescription()

Description copied from interface: Repository

Returns a description of this repository.

Specified by:

getDescription in interface Repository

Returns:

The description.

getDescription

public String getDescription(Locale locale)

Description copied from interface: Repository

Returns the description for the given locale.

Specified by:

getDescription in interface Repository

Returns:

getType

public RepositoryType getType()

Description copied from interface: Repository

This identifies the type of repository. Archiva does only support certain types of repositories.

Specified by:

getType in interface Repository

Returns:

A unique identifier for the repository type.

getLocation

public URI getLocation()

Description copied from interface: Repository

Returns the location of this repository. For local repositories this might be a file URI, for remote repositories a http URL or some very repository specific schemes. Each repository has only one unique location.

Specified by:

getLocation in interface Repository

Specified by:

getLocation in interface RepositoryStorage

Returns:

The repository location.

getLocalPath

public StorageAsset getLocalPath()

Description copied from interface: Repository

Returns a storage representation to the local data stored for this repository. The repository implementation may not store the real artifacts in this path. The directory structure is completely implementation dependant.

Specified by:

getLocalPath in interface Repository

getFailoverLocations

public Set<URI> getFailoverLocations()

Description copied from interface: Repository

A repository may allow additional locations that can be used, if the primary location is not available.

Specified by:

getFailoverLocations in interface Repository

Returns:

isScanned

public boolean isScanned()

Description copied from interface: Repository

True, if this repository is scanned regularly.

Specified by:

isScanned in interface Repository

getSchedulingDefinition

public String getSchedulingDefinition()

Description copied from interface: Repository

Returns the definition, when the repository jobs are executed. This must return a valid a cron string.

Specified by:

getSchedulingDefinition in interface Repository

Returns:

hasIndex

public abstract boolean hasIndex()

Description copied from interface: Repository

Returns true, if this repository has a index available

Specified by:

hasIndex in interface Repository

Returns:

getLayout

public String getLayout()

Description copied from interface: Repository

Returns a layout definition. The returned string may be implementation specific and is not standardized.

Specified by:

getLayout in interface Repository

Returns:

getCapabilities

public abstract RepositoryCapabilities getCapabilities()

Description copied from interface: Repository

Returns the capabilities of the repository implementation.

Specified by:

getCapabilities in interface Repository

Returns:

getFeature

public <T extends RepositoryFeature<T>> RepositoryFeature<T> getFeature(Class<T> clazz)
                                                                 throws UnsupportedFeatureException

Description copied from interface: Repository

Extension method that allows to provide different features that are not supported by all repository types.

Specified by:

getFeature in interface Repository

Type Parameters:

T - This is the class of the feature

Parameters:

clazz - The feature class that is requested

Returns:

The feature implementation for this repository instance, if it is supported

Throws:

UnsupportedFeatureException - if the feature is not supported by this repository type

supportsFeature

public <T extends RepositoryFeature<T>> boolean supportsFeature(Class<T> clazz)

Description copied from interface: Repository

Returns true, if the requested feature is supported by this repository.

Specified by:

supportsFeature in interface Repository

Type Parameters:

T - The requested feature class

Parameters:

clazz - The requested feature class

Returns:

True, if the feature is supported, otherwise false.

getPrimaryLocale

public Locale getPrimaryLocale()

Description copied from interface: EditableRepository

Returns the primary locale used for setting the default values for name and description.

Specified by:

getPrimaryLocale in interface EditableRepository

Returns:

The locale used for name and description when they are not set

setName

public void setName(Locale locale,
                    String name)

Description copied from interface: EditableRepository

Sets the name for the given locale

Specified by:

setName in interface EditableRepository

Parameters:

locale - the locale for which the name is set

name - The name value in the language that matches the locale

setDescription

public void setDescription(Locale locale,
                           String description)

Description copied from interface: EditableRepository

Sets the description for the given locale

Specified by:

setDescription in interface EditableRepository

Parameters:

locale - the locale for which the description is set

description - The description in the language that matches the locale.

setLocation

public void setLocation(URI location)

Description copied from interface: EditableRepository

Sets the location of the repository. May be a URI that is suitable for the repository implementation. Not all implementations will accept the same URI schemes.

Specified by:

setLocation in interface EditableRepository

Parameters:

location - the location URI

updateLocation

public void updateLocation(URI newLocation)
                    throws IOException

Description copied from interface: RepositoryStorage

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.

Specified by:

updateLocation in interface RepositoryStorage

Parameters:

newLocation - The URI to the new location

Throws:

IOException - If the repository cannot be relocated

addFailoverLocation

public void addFailoverLocation(URI location)

Description copied from interface: EditableRepository

Adds a failover location for the repository.

Specified by:

addFailoverLocation in interface EditableRepository

Parameters:

location - The location that should be used as failover.

removeFailoverLocation

public void removeFailoverLocation(URI location)

Description copied from interface: EditableRepository

Removes a failover location from the set.

Specified by:

removeFailoverLocation in interface EditableRepository

Parameters:

location - the location uri to remove

clearFailoverLocations

public void clearFailoverLocations()

Description copied from interface: EditableRepository

Clears the failover location set.

Specified by:

clearFailoverLocations in interface EditableRepository

setScanned

public void setScanned(boolean scanned)

Description copied from interface: EditableRepository

Sets the flag for scanning the repository. If true, the repository will be scanned. You have to set the scheduling times, if you set this to true.

Specified by:

setScanned in interface EditableRepository

Parameters:

scanned - if true, the repository is scanned regulary.

setLayout

public void setLayout(String layout)

Description copied from interface: EditableRepository

Sets the layout string.

Specified by:

setLayout in interface EditableRepository

setBaseUri

public void setBaseUri(URI baseUri)

Description copied from interface: EditableRepository

Sets the base uri for relative location uris.

Specified by:

setBaseUri in interface EditableRepository

setSchedulingDefinition

public void setSchedulingDefinition(String cronExpression)

Description copied from interface: EditableRepository

Sets the scheduling definition, that defines the times, when the regular repository jobs are started. The cronExpression must be a valid quartz cron definition.

Specified by:

setSchedulingDefinition in interface EditableRepository

Parameters:

cronExpression - the cron expression.

addFeature

protected <T extends RepositoryFeature<T>> void addFeature(RepositoryFeature<T> feature)

setIndexingContext

public void setIndexingContext(ArchivaIndexingContext context)

Description copied from interface: EditableRepository

Sets the indexing context reference.

Specified by:

setIndexingContext in interface EditableRepository

getIndexingContext

public ArchivaIndexingContext getIndexingContext()

Description copied from interface: Repository

Returns a indexing context.

Specified by:

getIndexingContext in interface Repository

Returns:

close

public void close()

Description copied from interface: Repository

Closes all resources that are opened by this repository.

Specified by:

close in interface Repository

isOpen

public boolean isOpen()

Description copied from interface: Repository

Returns the current status of this repository.

Specified by:

isOpen in interface Repository

Returns:

true, if repository has not been closed, otherwise false

handle

public void handle(RepositoryEvent event)

Specified by:

handle in interface EventHandler<RepositoryEvent>

registerEventHandler

public <T extends Event> void registerEventHandler(EventType<T> eventType,
                                                   EventHandler<? super T> eventHandler)

Specified by:

registerEventHandler in interface EventSource

unregisterEventHandler

public <T extends Event> void unregisterEventHandler(EventType<T> type,
                                                     EventHandler<? super T> eventHandler)

Specified by:

unregisterEventHandler in interface EventSource

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

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

setStorage

protected void setStorage(RepositoryStorage storage)

getStorage

protected RepositoryStorage getStorage()