org.apache.maven.plugins.release.scm
Interface ScmRepositoryConfigurator

All Known Implementing Classes:

DefaultScmRepositoryConfigurator

public interface ScmRepositoryConfigurator

Configure an SCM repository using release configuration.

Author:

Brett Porter

Field Summary

static java.lang.String

ROLE The Plexus role.

Method Summary

org.apache.maven.scm.repository.ScmRepository	getConfiguredRepository(ReleaseConfiguration releaseConfiguration) Construct a configured SCM repository from a release configuration.
org.apache.maven.scm.provider.ScmProvider	getRepositoryProvider(org.apache.maven.scm.repository.ScmRepository repository) Get the SCM provider used for the given SCM repository.

Field Detail

ROLE

static final java.lang.String ROLE

The Plexus role.

Method Detail

getConfiguredRepository

org.apache.maven.scm.repository.ScmRepository getConfiguredRepository(ReleaseConfiguration releaseConfiguration)
                                                                      throws org.apache.maven.scm.repository.ScmRepositoryException,
                                                                             org.apache.maven.scm.manager.NoSuchScmProviderException

Construct a configured SCM repository from a release configuration.

Parameters:

releaseConfiguration - the configuration to insert into the repository

Returns:

the repository created

Throws:

org.apache.maven.scm.repository.ScmRepositoryException - if it is not possible to create a suitable SCM repository

org.apache.maven.scm.manager.NoSuchScmProviderException - if the requested SCM provider is not available

getRepositoryProvider

org.apache.maven.scm.provider.ScmProvider getRepositoryProvider(org.apache.maven.scm.repository.ScmRepository repository)
                                                                throws org.apache.maven.scm.manager.NoSuchScmProviderException

Get the SCM provider used for the given SCM repository.

Parameters:

repository - the SCM repository

Returns:

the SCM provider

Throws:

org.apache.maven.scm.manager.NoSuchScmProviderException - if the requested SCM provider is not available