org.apache.archiva.repository

Interface Repository

All Superinterfaces:

EventSource, RepositoryStorage

All Known Subinterfaces:

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

All Known Implementing Classes:

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

public interface Repository
extends EventSource, RepositoryStorage

Base interface for repositories. Created by Martin Stockhammer on 21.09.17.

Method Summary

Modifier and Type	Method and Description
void	close() Closes all resources that are opened by this repository.
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.
String	getSchedulingDefinition() Returns the definition, when the repository jobs are executed.
RepositoryType	getType() This identifies the type of repository.
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.
<T extends RepositoryFeature<T>> boolean	supportsFeature(Class<T> clazz) Returns true, if the requested feature is supported by this repository.

Methods inherited from interface org.apache.archiva.event.EventSource

registerEventHandler, unregisterEventHandler

Methods inherited from interface org.apache.archiva.repository.storage.RepositoryStorage

addAsset, consumeData, consumeDataFromChannel, copyAsset, copyAsset, getAsset, moveAsset, moveAsset, removeAsset, updateLocation, writeData, writeDataToChannel

Method Detail

getId

String getId()

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

Returns:

The identifier.

getName

String getName()

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

Returns:

The display name of the repository

getName

String getName(Locale locale)

Returns the name in the given locale.

Parameters:

locale -

Returns:

getDescription

String getDescription()

Returns a description of this repository.

Returns:

The description.

getDescription

String getDescription(Locale locale)

Returns the description for the given locale.

Parameters:

locale -

Returns:

getType

RepositoryType getType()

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

Returns:

A unique identifier for the repository type.

getLocation

URI getLocation()

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 RepositoryStorage

Returns:

The repository location.

getLocalPath

StorageAsset getLocalPath()

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.

getFailoverLocations

Set<URI> getFailoverLocations()

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

Returns:

isScanned

boolean isScanned()

True, if this repository is scanned regularly.

getSchedulingDefinition

String getSchedulingDefinition()

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

Returns:

hasIndex

boolean hasIndex()

Returns true, if this repository has a index available

Returns:

getLayout

String getLayout()

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

Returns:

getCapabilities

RepositoryCapabilities getCapabilities()

Returns the capabilities of the repository implementation.

Returns:

getFeature

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

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

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

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

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

Type Parameters:

T - The requested feature class

Parameters:

clazz - The requested feature class

Returns:

True, if the feature is supported, otherwise false.

getIndexingContext

ArchivaIndexingContext getIndexingContext()

Returns a indexing context.

Returns:

Throws:

UnsupportedOperationException

close

void close()

Closes all resources that are opened by this repository.

isOpen

boolean isOpen()

Returns the current status of this repository.

Returns:

true, if repository has not been closed, otherwise false