org.apache.archiva.repository

Class AbstractRepository

java.lang.Object

org.apache.archiva.repository.AbstractRepository

All Implemented Interfaces:

EditableRepository, Repository, RepositoryEventHandler, RepositoryEventListener

Direct Known Subclasses:

AbstractManagedRepository, AbstractRemoteRepository

public abstract class AbstractRepository
extends Object
implements EditableRepository, RepositoryEventListener

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
private URI	baseUri
static com.cronutils.model.definition.CronDefinition	CRON_DEFINITION
private Map<Locale,String>	descriptions
private Set<URI>	failoverLocations
(package private) Map<Class<? extends RepositoryFeature<?>>,RepositoryFeature<?>>	featureMap
private String	id
private ArchivaIndexingContext	indexingContext
private String	layout
private List<RepositoryEventListener>	listeners
private URI	location
(package private) org.slf4j.Logger	log
private Map<Locale,String>	names
private Locale	primaryLocale
protected Path	repositoryBase
private boolean	scanned
(package private) String	schedulingDefinition
private RepositoryType	type
private Set<URI>	uFailoverLocations

Constructor Summary

Constructors

Constructor and Description
AbstractRepository(Locale primaryLocale, RepositoryType type, String id, String name, Path repositoryBase)
AbstractRepository(RepositoryType type, String id, String name, Path repositoryBase)

Method Summary

Modifier and Type	Method and Description
void	addFailoverLocation(URI location) Adds a failover location for the repository.
protected <T extends RepositoryFeature<T>> void	addFeature(RepositoryFeature<T> feature)
void	addListener(RepositoryEventListener listener)
void	clearFailoverLocations() Clears the failover location set.
void	clearListeners()
void	close() Closes all resources that are opened by this repository.
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.
Path	getLocalPath() Returns the local path that this repository uses, if it stores data locally.
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.
RepositoryType	getType() This identifies the type of repository.
abstract boolean	hasIndex() Returns true, if this repository has a index available
boolean	isScanned() True, if this repository is scanned regularly.
<T> void	raise(RepositoryEvent<T> event)
void	removeFailoverLocation(URI location) Removes a failover location from the set.
void	removeListener(RepositoryEventListener listener)
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.
<T extends RepositoryFeature<T>> boolean	supportsFeature(Class<T> clazz) Returns true, if the requested feature is supported by this repository.

Methods inherited from class java.lang.Object

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

Field Detail

log

org.slf4j.Logger log

type

private final RepositoryType type

id

private final String id

names

private Map<Locale,String> names

descriptions

private Map<Locale,String> descriptions

primaryLocale

private Locale primaryLocale

location

private URI location

baseUri

private URI baseUri

failoverLocations

private Set<URI> failoverLocations

uFailoverLocations

private Set<URI> uFailoverLocations

scanned

private boolean scanned

schedulingDefinition

String schedulingDefinition

layout

private String layout

CRON_DEFINITION

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

listeners

private List<RepositoryEventListener> listeners

featureMap

Map<Class<? extends RepositoryFeature<?>>,RepositoryFeature<?>> featureMap

repositoryBase

protected Path repositoryBase

indexingContext

private ArchivaIndexingContext indexingContext

Constructor Detail

AbstractRepository

public AbstractRepository(RepositoryType type,
                          String id,
                          String name,
                          Path repositoryBase)

AbstractRepository

public AbstractRepository(Locale primaryLocale,
                          RepositoryType type,
                          String id,
                          String name,
                          Path repositoryBase)

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

Returns:

The repository location.

getLocalPath

public Path getLocalPath()

Description copied from interface: Repository

Returns the local path that this repository uses, if it stores data locally. You should keep in mind, that repository implementations may not store any data in this directory. E.g. if the repository data is handled by a database. So the content of this directory is very implementation specific. Users of this directory must know about the repository file layout if they use this path. Repository implementations should always return a valid path, even if there is no locally stored data. Some extensions may use the path to store their own repository specific data, e.g. statistics, metadata,...

Specified by:

getLocalPath in interface Repository

Returns:

the filesystem path to the 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

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

raise

public <T> void raise(RepositoryEvent<T> event)

Specified by:

raise in interface RepositoryEventListener

addListener

public void addListener(RepositoryEventListener listener)

Specified by:

addListener in interface RepositoryEventHandler

removeListener

public void removeListener(RepositoryEventListener listener)

Specified by:

removeListener in interface RepositoryEventHandler

clearListeners

public void clearListeners()

Specified by:

clearListeners in interface RepositoryEventHandler