org.apache.archiva.repository

Interface EditableRepository

All Superinterfaces:

EventSource, Repository, RepositoryStorage

All Known Subinterfaces:

EditableManagedRepository, EditableRemoteRepository, EditableRepositoryGroup

All Known Implementing Classes:

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

public interface EditableRepository
extends Repository

This is the editable part of a repository. Normally a repository should also implement this interface but it is not required. Capabilities and features are a integral part of the implementation and not provided here by the interface. Feature setting methods are provided by the features itself.

Method Summary

Modifier and Type	Method and Description
void	addFailoverLocation(URI location) Adds a failover location for the repository.
void	clearFailoverLocations() Clears the failover location set.
Locale	getPrimaryLocale() Returns the primary locale used for setting the default values for name and description.
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
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.

Methods inherited from interface org.apache.archiva.repository.Repository

close, getCapabilities, getDescription, getDescription, getFailoverLocations, getFeature, getId, getIndexingContext, getLayout, getLocalPath, getLocation, getName, getName, getSchedulingDefinition, getType, hasIndex, isOpen, isScanned, supportsFeature

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

getPrimaryLocale

Locale getPrimaryLocale()

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

Returns:

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

setName

void setName(Locale locale,
             String name)

Sets the name for the given locale

Parameters:

locale - the locale for which the name is set

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

setDescription

void setDescription(Locale locale,
                    String description)

Sets the description for the given locale

Parameters:

locale - the locale for which the description is set

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

setLocation

void setLocation(URI location)
          throws UnsupportedURIException

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.

Parameters:

location - the location URI

Throws:

UnsupportedURIException - if the URI scheme is not supported by the repository type.

setBaseUri

void setBaseUri(URI baseUri)

Sets the base uri for relative location uris.

Parameters:

baseUri -

addFailoverLocation

void addFailoverLocation(URI location)
                  throws UnsupportedURIException

Adds a failover location for the repository.

Parameters:

location - The location that should be used as failover.

Throws:

UnsupportedURIException - if the URI scheme is not supported by the repository type.

removeFailoverLocation

void removeFailoverLocation(URI location)

Removes a failover location from the set.

Parameters:

location - the location uri to remove

clearFailoverLocations

void clearFailoverLocations()

Clears the failover location set.

setScanned

void setScanned(boolean scanned)

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.

Parameters:

scanned - if true, the repository is scanned regulary.

setSchedulingDefinition

void setSchedulingDefinition(String cronExpression)
                      throws IllegalArgumentException

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

Parameters:

cronExpression - the cron expression.

Throws:

IllegalArgumentException - if the cron expression is not valid.

setLayout

void setLayout(String layout)

Sets the layout string.

Parameters:

layout -

setIndexingContext

void setIndexingContext(ArchivaIndexingContext context)

Sets the indexing context reference.

Parameters:

context -