org.apache.archiva.repository.base

Class ArchivaRepositoryRegistry

java.lang.Object

org.apache.archiva.repository.base.ArchivaRepositoryRegistry

All Implemented Interfaces:

EventListener, ConfigurationListener, EventHandler<Event>, EventSource, RepositoryRegistry

@Service(value="repositoryRegistry")
public class ArchivaRepositoryRegistry
extends Object
implements ConfigurationListener, EventHandler<Event>, RepositoryRegistry

Registry for repositories. This is the central entry point for repositories. It provides methods for retrieving, adding and removing repositories.

The modification methods addXX and removeXX persist the changes immediately to the configuration. If the configuration save fails the changes are rolled back.

TODO: Audit events

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
ArchivaRepositoryRegistry()

Method Summary

Modifier and Type	Method and Description
ManagedRepository	clone(ManagedRepository repo, String newId) Creates a new repository instance with the same settings as this one.
RemoteRepository	clone(RemoteRepository repo, String newId) Creates a new repository instance with the same settings as this one.
<T extends Repository> Repository	clone(T repo, String newId)
void	configurationEvent(ConfigurationEvent event) Generic event point to notify components that something has happend in the configuration.
void	destroy()
ArchivaIndexManager	getIndexManager(RepositoryType type)
Collection<ManagedRepository>	getManagedRepositories() Returns only the managed repositories.
ManagedRepository	getManagedRepository(String repoId) Convenience method, that returns the managed repository with the given id.
Collection<RemoteRepository>	getRemoteRepositories() Returns only the remote repositories.
RemoteRepository	getRemoteRepository(String repoId) Convenience method, that returns the remote repository with the given id.
Collection<Repository>	getRepositories() Returns all repositories that are registered.
Repository	getRepository(String repoId) Returns the repository with the given id.
RepositoryGroup	getRepositoryGroup(String groupId)
Collection<RepositoryGroup>	getRepositoryGroups()
void	handle(Event event)
ManagedRepository	putRepository(ManagedRepository managedRepository) Adds a new repository to the current list, or replaces the repository definition with the same id, if it exists already.
ManagedRepository	putRepository(ManagedRepositoryConfiguration managedRepositoryConfiguration) Adds a new repository or updates the repository with the same id, if it exists already.
ManagedRepository	putRepository(ManagedRepositoryConfiguration managedRepositoryConfiguration, Configuration configuration) Adds a new repository or updates the repository with the same id.
RemoteRepository	putRepository(RemoteRepository remoteRepository) Adds a remote repository, or overwrites the repository definition with the same id, if it exists already.
RemoteRepository	putRepository(RemoteRepositoryConfiguration remoteRepositoryConfiguration) Adds a new repository or updates the repository with the same id, if it exists already.
RemoteRepository	putRepository(RemoteRepository remoteRepository, Configuration configuration)
RemoteRepository	putRepository(RemoteRepositoryConfiguration remoteRepositoryConfiguration, Configuration configuration) Adds a new repository or updates the repository with the same id.
RepositoryGroup	putRepositoryGroup(RepositoryGroup repositoryGroup) Adds a new repository group to the current list, or replaces the repository group definition with the same id, if it exists already.
RepositoryGroup	putRepositoryGroup(RepositoryGroupConfiguration repositoryGroupConfiguration) Adds a new repository group or updates the repository with the same id, if it exists already.
RepositoryGroup	putRepositoryGroup(RepositoryGroupConfiguration repositoryGroupConfiguration, Configuration configuration) Adds a new repository group or updates the repository group with the same id.
<T extends Event> void	registerEventHandler(EventType<T> type, EventHandler<? super T> eventHandler)
void	reload() Reloads the registry from the configuration.
void	removeRepository(ManagedRepository managedRepository) Removes a managed repository from the registry and configuration, if it exists.
void	removeRepository(ManagedRepository managedRepository, Configuration configuration)
void	removeRepository(RemoteRepository remoteRepository) Removes the remote repository from the registry and configuration.
void	removeRepository(RemoteRepository remoteRepository, Configuration configuration)
void	removeRepository(Repository repo)
void	removeRepository(String repoId)
void	removeRepositoryGroup(RepositoryGroup repositoryGroup) Removes a repository group from the registry and configuration, if it exists.
void	removeRepositoryGroup(RepositoryGroup repositoryGroup, Configuration configuration)
void	resetIndexingContext(Repository repository) Resets the indexing context of a given repository.
void	setArchivaConfiguration(ArchivaConfiguration archivaConfiguration)
<T extends Event> void	unregisterEventHandler(EventType<T> type, EventHandler<? super T> eventHandler)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchivaRepositoryRegistry

public ArchivaRepositoryRegistry()

Method Detail

setArchivaConfiguration

public void setArchivaConfiguration(ArchivaConfiguration archivaConfiguration)

Specified by:

setArchivaConfiguration in interface RepositoryRegistry

destroy

@PreDestroy
public void destroy()

getIndexManager

public ArchivaIndexManager getIndexManager(RepositoryType type)

Specified by:

getIndexManager in interface RepositoryRegistry

getRepositories

public Collection<Repository> getRepositories()

Returns all repositories that are registered. There is no defined order of the returned repositories.

Specified by:

getRepositories in interface RepositoryRegistry

Returns:

a list of managed and remote repositories

getManagedRepositories

public Collection<ManagedRepository> getManagedRepositories()

Returns only the managed repositories. There is no defined order of the returned repositories.

Specified by:

getManagedRepositories in interface RepositoryRegistry

Returns:

a list of managed repositories

getRemoteRepositories

public Collection<RemoteRepository> getRemoteRepositories()

Returns only the remote repositories. There is no defined order of the returned repositories.

Specified by:

getRemoteRepositories in interface RepositoryRegistry

Returns:

a list of remote repositories

getRepositoryGroups

public Collection<RepositoryGroup> getRepositoryGroups()

Specified by:

getRepositoryGroups in interface RepositoryRegistry

getRepository

public Repository getRepository(String repoId)

Returns the repository with the given id. The returned repository may be a managed or remote repository. It returns null, if no repository is registered with the given id.

Specified by:

getRepository in interface RepositoryRegistry

Parameters:

repoId - the repository id

Returns:

the repository if found, otherwise null

getManagedRepository

public ManagedRepository getManagedRepository(String repoId)

Convenience method, that returns the managed repository with the given id. It returns null, if no managed repository is registered with this id.

Specified by:

getManagedRepository in interface RepositoryRegistry

Parameters:

repoId - the repository id

Returns:

the managed repository if found, otherwise null

getRemoteRepository

public RemoteRepository getRemoteRepository(String repoId)

Convenience method, that returns the remote repository with the given id. It returns null, if no remote repository is registered with this id.

Specified by:

getRemoteRepository in interface RepositoryRegistry

Parameters:

repoId - the repository id

Returns:

the remote repository if found, otherwise null

getRepositoryGroup

public RepositoryGroup getRepositoryGroup(String groupId)

Specified by:

getRepositoryGroup in interface RepositoryRegistry

putRepository

public ManagedRepository putRepository(ManagedRepository managedRepository)
                                throws RepositoryException

Adds a new repository to the current list, or replaces the repository definition with the same id, if it exists already. The change is saved to the configuration immediately.

Specified by:

putRepository in interface RepositoryRegistry

Parameters:

managedRepository - the new repository.

Throws:

RepositoryException - if the new repository could not be saved to the configuration.

putRepository

public ManagedRepository putRepository(ManagedRepositoryConfiguration managedRepositoryConfiguration)
                                throws RepositoryException

Adds a new repository or updates the repository with the same id, if it exists already. The configuration is saved immediately.

Specified by:

putRepository in interface RepositoryRegistry

Parameters:

managedRepositoryConfiguration - the repository configuration

Returns:

the updated or created repository

Throws:

RepositoryException - if an error occurs, or the configuration is not valid.

putRepository

public ManagedRepository putRepository(ManagedRepositoryConfiguration managedRepositoryConfiguration,
                                       Configuration configuration)
                                throws RepositoryException

Adds a new repository or updates the repository with the same id. The given configuration object is updated, but the configuration is not saved.

Specified by:

putRepository in interface RepositoryRegistry

Parameters:

managedRepositoryConfiguration - the new or changed managed repository configuration

configuration - the configuration object (may be null)

Returns:

the new or updated repository

Throws:

RepositoryException - if the configuration cannot be saved or updated

putRepositoryGroup

public RepositoryGroup putRepositoryGroup(RepositoryGroup repositoryGroup)
                                   throws RepositoryException

Adds a new repository group to the current list, or replaces the repository group definition with the same id, if it exists already. The change is saved to the configuration immediately.

Specified by:

putRepositoryGroup in interface RepositoryRegistry

Parameters:

repositoryGroup - the new repository group.

Throws:

RepositoryException - if the new repository group could not be saved to the configuration.

putRepositoryGroup

public RepositoryGroup putRepositoryGroup(RepositoryGroupConfiguration repositoryGroupConfiguration)
                                   throws RepositoryException

Adds a new repository group or updates the repository with the same id, if it exists already. The configuration is saved immediately.

Specified by:

putRepositoryGroup in interface RepositoryRegistry

Parameters:

repositoryGroupConfiguration - the repository configuration

Returns:

the updated or created repository

Throws:

RepositoryException - if an error occurs, or the configuration is not valid.

putRepositoryGroup

public RepositoryGroup putRepositoryGroup(RepositoryGroupConfiguration repositoryGroupConfiguration,
                                          Configuration configuration)
                                   throws RepositoryException

Adds a new repository group or updates the repository group with the same id. The given configuration object is updated, but the configuration is not saved.

Specified by:

putRepositoryGroup in interface RepositoryRegistry

Parameters:

repositoryGroupConfiguration - The configuration of the new or changed repository group.

configuration - The configuration object. If it is null, the configuration is not saved.

Returns:

The new or updated repository group

Throws:

RepositoryException - if the configuration cannot be saved or updated

putRepository

public RemoteRepository putRepository(RemoteRepository remoteRepository,
                                      Configuration configuration)
                               throws RepositoryException

Specified by:

putRepository in interface RepositoryRegistry

Throws:

RepositoryException

putRepository

public RemoteRepository putRepository(RemoteRepository remoteRepository)
                               throws RepositoryException

Adds a remote repository, or overwrites the repository definition with the same id, if it exists already. The modification is saved to the configuration immediately.

Specified by:

putRepository in interface RepositoryRegistry

Parameters:

remoteRepository - the remote repository to add

Throws:

RepositoryException - if an error occurs during configuration save

putRepository

public RemoteRepository putRepository(RemoteRepositoryConfiguration remoteRepositoryConfiguration)
                               throws RepositoryException

Adds a new repository or updates the repository with the same id, if it exists already. The configuration is saved immediately.

Specified by:

putRepository in interface RepositoryRegistry

Parameters:

remoteRepositoryConfiguration - the repository configuration

Returns:

the updated or created repository

Throws:

RepositoryException - if an error occurs, or the configuration is not valid.

putRepository

public RemoteRepository putRepository(RemoteRepositoryConfiguration remoteRepositoryConfiguration,
                                      Configuration configuration)
                               throws RepositoryException

Adds a new repository or updates the repository with the same id. The given configuration object is updated, but the configuration is not saved.

Specified by:

putRepository in interface RepositoryRegistry

Parameters:

remoteRepositoryConfiguration - the new or changed repository configuration

configuration - the configuration object

Returns:

the new or updated repository

Throws:

RepositoryException - if the configuration cannot be saved or updated

removeRepository

public void removeRepository(String repoId)
                      throws RepositoryException

Specified by:

removeRepository in interface RepositoryRegistry

Throws:

RepositoryException

removeRepository

public void removeRepository(Repository repo)
                      throws RepositoryException

Specified by:

removeRepository in interface RepositoryRegistry

Throws:

RepositoryException

removeRepository

public void removeRepository(ManagedRepository managedRepository)
                      throws RepositoryException

Removes a managed repository from the registry and configuration, if it exists. The change is saved to the configuration immediately.

Specified by:

removeRepository in interface RepositoryRegistry

Parameters:

managedRepository - the managed repository to remove

Throws:

RepositoryException - if a error occurs during configuration save

removeRepository

public void removeRepository(ManagedRepository managedRepository,
                             Configuration configuration)
                      throws RepositoryException

Specified by:

removeRepository in interface RepositoryRegistry

Throws:

RepositoryException

removeRepositoryGroup

public void removeRepositoryGroup(RepositoryGroup repositoryGroup)
                           throws RepositoryException

Removes a repository group from the registry and configuration, if it exists. The change is saved to the configuration immediately.

Specified by:

removeRepositoryGroup in interface RepositoryRegistry

Parameters:

repositoryGroup - the repository group to remove

Throws:

RepositoryException - if a error occurs during configuration save

removeRepositoryGroup

public void removeRepositoryGroup(RepositoryGroup repositoryGroup,
                                  Configuration configuration)
                           throws RepositoryException

Specified by:

removeRepositoryGroup in interface RepositoryRegistry

Throws:

RepositoryException

removeRepository

public void removeRepository(RemoteRepository remoteRepository)
                      throws RepositoryException

Removes the remote repository from the registry and configuration. The change is saved to the configuration immediately.

Specified by:

removeRepository in interface RepositoryRegistry

Parameters:

remoteRepository - the remote repository to remove

Throws:

RepositoryException - if a error occurs during configuration save

removeRepository

public void removeRepository(RemoteRepository remoteRepository,
                             Configuration configuration)
                      throws RepositoryException

Specified by:

removeRepository in interface RepositoryRegistry

Throws:

RepositoryException

reload

public void reload()

Reloads the registry from the configuration.

Specified by:

reload in interface RepositoryRegistry

resetIndexingContext

public void resetIndexingContext(Repository repository)
                          throws IndexUpdateFailedException

Resets the indexing context of a given repository.

Specified by:

resetIndexingContext in interface RepositoryRegistry

Parameters:

repository - The repository

Throws:

IndexUpdateFailedException - If the index could not be resetted.

clone

public ManagedRepository clone(ManagedRepository repo,
                               String newId)
                        throws RepositoryException

Creates a new repository instance with the same settings as this one. The cloned repository is not registered or saved to the configuration.

Specified by:

clone in interface RepositoryRegistry

Parameters:

repo - The origin repository

Returns:

The cloned repository.

Throws:

RepositoryException

clone

public <T extends Repository> Repository clone(T repo,
                                               String newId)
                                        throws RepositoryException

Specified by:

clone in interface RepositoryRegistry

Throws:

RepositoryException

clone

public RemoteRepository clone(RemoteRepository repo,
                              String newId)
                       throws RepositoryException

Creates a new repository instance with the same settings as this one. The cloned repository is not registered or saved to the configuration.

Specified by:

clone in interface RepositoryRegistry

Parameters:

repo - The origin repository

Returns:

The cloned repository.

Throws:

RepositoryException

configurationEvent

public void configurationEvent(ConfigurationEvent event)

Description copied from interface: ConfigurationListener

Generic event point to notify components that something has happend in the configuration.

Specified by:

configurationEvent in interface ConfigurationListener

registerEventHandler

public <T extends Event> void registerEventHandler(EventType<T> type,
                                                   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

handle

public void handle(Event event)

Specified by:

handle in interface EventHandler<Event>