org.apache.archiva.repository

Interface RepositoryProvider

All Superinterfaces:

EventHandler, EventListener

All Known Implementing Classes:

MavenRepositoryProvider

public interface RepositoryProvider
extends EventHandler

This interface must be implemented by the repository implementations. The repository provider knows all about the repositories and should be the only part that uses the repository specific classes and libraries (e.g. the maven libraries). Newly created instances should always be filled with default values that make sense. null values should be avoided. References like staging repositories must not be set.

Method Summary

Modifier and Type	Method and Description
ManagedRepository	createManagedInstance(ManagedRepositoryConfiguration configuration) Creates a new managed repository instance from the given configuration.
EditableManagedRepository	createManagedInstance(String id, String name) Creates a editable managed repository instance.
RemoteRepository	createRemoteInstance(RemoteRepositoryConfiguration configuration) Creates a new remote repository instance from the given configuration.
EditableRemoteRepository	createRemoteInstance(String id, String name) Creates a editable remote repository instance.
RepositoryGroup	createRepositoryGroup(RepositoryGroupConfiguration configuration) Creates a new repository group instance from the given configuration.
EditableRepositoryGroup	createRepositoryGroup(String id, String name) Creates a editable repository group. .
ManagedRepository	createStagingInstance(ManagedRepositoryConfiguration baseConfiguration) Creates a new managed staging repository instance from the given configuration.
ManagedRepositoryConfiguration	getManagedConfiguration(ManagedRepository managedRepository) Returns a configuration object from the given managed repository instance.
RemoteRepositoryConfiguration	getRemoteConfiguration(RemoteRepository remoteRepository) Returns a configuration object from the given remote repository instance.
RepositoryGroupConfiguration	getRepositoryGroupConfiguration(RepositoryGroup repositoryGroup) Returns a configuration object from the given repository group instance.
Set<RepositoryType>	provides() Returns the types of repositories this provider can handle.
void	updateManagedInstance(EditableManagedRepository repo, ManagedRepositoryConfiguration configuration) Updates the given managed repository instance from the given configuration.
void	updateRemoteInstance(EditableRemoteRepository repo, RemoteRepositoryConfiguration configuration) Updates the given remote repository instance from the given configuration.
void	updateRepositoryGroupInstance(EditableRepositoryGroup repositoryGroup, RepositoryGroupConfiguration configuration) Updates the given remote repository instance from the given configuration.

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

handle

Method Detail

provides

Set<RepositoryType> provides()

Returns the types of repositories this provider can handle.

Returns:

the set of supported repository types

createManagedInstance

EditableManagedRepository createManagedInstance(String id,
                                                String name)
                                         throws IOException

Creates a editable managed repository instance. The provider must not check the uniqueness of the id parameter and must not track the already created instances. Each call to this method will create a new instance.

Parameters:

id - the repository identifier

name - the repository name

Returns:

a new created managed repository instance

Throws:

IOException

createRemoteInstance

EditableRemoteRepository createRemoteInstance(String id,
                                              String name)

Creates a editable remote repository instance. The provider must not check the uniqueness of the id parameter and must not track the already created instances. Each call to this method will create a new instance.

Parameters:

id - the repository identifier

name - the repository name

Returns:

a new created remote repository instance

createRepositoryGroup

EditableRepositoryGroup createRepositoryGroup(String id,
                                              String name)

Creates a editable repository group. . The provider must not check the uniqueness of the id parameter and must not track the already created instances. Each call to this method will create a new instance.

Parameters:

id - the repository identifier

name - the repository name

Returns:

A new instance of the repository group implementation

createManagedInstance

ManagedRepository createManagedInstance(ManagedRepositoryConfiguration configuration)
                                 throws RepositoryException

Creates a new managed repository instance from the given configuration. All attributes are filled from the provided configuration object.

Parameters:

configuration - the repository configuration that contains the repository data

Returns:

a new created managed repository instance

Throws:

RepositoryException - if some of the configuration values are not valid

updateManagedInstance

void updateManagedInstance(EditableManagedRepository repo,
                           ManagedRepositoryConfiguration configuration)
                    throws RepositoryException

Updates the given managed repository instance from the given configuration. All attributes are filled from the provided configuration object.

Parameters:

repo - the repository instance that should be updated

configuration - the repository configuration that contains the repository data

Throws:

RepositoryException - if some of the configuration values are not valid

createStagingInstance

ManagedRepository createStagingInstance(ManagedRepositoryConfiguration baseConfiguration)
                                 throws RepositoryException

Creates a new managed staging repository instance from the given configuration. All attributes are filled from the provided configuration object.

Parameters:

baseConfiguration - the repository configuration of the base repository that references the staging repository

Returns:

a new created managed staging repository instance

Throws:

RepositoryException - if some of the configuration values are not valid

createRemoteInstance

RemoteRepository createRemoteInstance(RemoteRepositoryConfiguration configuration)
                               throws RepositoryException

Creates a new remote repository instance from the given configuration. All attributes are filled from the provided configuration object.

Parameters:

configuration - the repository configuration that contains the repository data

Returns:

a new created remote repository instance

Throws:

RepositoryException - if some of the configuration values are not valid

updateRemoteInstance

void updateRemoteInstance(EditableRemoteRepository repo,
                          RemoteRepositoryConfiguration configuration)
                   throws RepositoryException

Updates the given remote repository instance from the given configuration. All attributes are filled from the provided configuration object.

Parameters:

repo - the repository instance that should be updated

configuration - the repository configuration that contains the repository data

Throws:

RepositoryException - if some of the configuration values are not valid

createRepositoryGroup

RepositoryGroup createRepositoryGroup(RepositoryGroupConfiguration configuration)
                               throws RepositoryException

Creates a new repository group instance from the given configuration. All attributes are filled from the provided configuration object.

Parameters:

configuration - the repository group configuration

Returns:

a new created repository group instance

Throws:

RepositoryException - if some of the configuration values are not valid

updateRepositoryGroupInstance

void updateRepositoryGroupInstance(EditableRepositoryGroup repositoryGroup,
                                   RepositoryGroupConfiguration configuration)
                            throws RepositoryException

Updates the given remote repository instance from the given configuration. All attributes are filled from the provided configuration object.

Parameters:

repositoryGroup - the repository group instance that should be updated

configuration - the repository group configuration that contains the group data

Throws:

RepositoryException - if some of the configuration values are not valid

getRemoteConfiguration

RemoteRepositoryConfiguration getRemoteConfiguration(RemoteRepository remoteRepository)
                                              throws RepositoryException

Returns a configuration object from the given remote repository instance.

Parameters:

remoteRepository - the remote repository instance

Returns:

the repository configuration with all the data that is stored in the repository instance

Throws:

RepositoryException - if the data cannot be converted

getManagedConfiguration

ManagedRepositoryConfiguration getManagedConfiguration(ManagedRepository managedRepository)
                                                throws RepositoryException

Returns a configuration object from the given managed repository instance.

Parameters:

managedRepository - the managed repository instance

Returns:

the repository configuration with all the data that is stored in the repository instance

Throws:

RepositoryException - if the data cannot be converted

getRepositoryGroupConfiguration

RepositoryGroupConfiguration getRepositoryGroupConfiguration(RepositoryGroup repositoryGroup)
                                                      throws RepositoryException

Returns a configuration object from the given repository group instance.

Parameters:

repositoryGroup - the repository group

Returns:

the repository group configuration with all the data that is stored in the repository instance

Throws:

RepositoryException - if the data cannot be converted