ScmRepositoryConfigurator (Maven Release Manager 2.5.3 API)

All Known Implementing Classes:

DefaultScmRepositoryConfigurator
```
public interface ScmRepositoryConfigurator
```
Configure an SCM repository using release configuration.

Author:

Brett Porter

Field Summary

Fields
Modifier and Type Field and Description

static String ROLE
The Plexus role.

Fields
Modifier and Type	Field and Description
`static String`	`ROLE` The Plexus role.

Method Summary

Methods
Modifier and Type	Method and Description
`ScmRepository`	`getConfiguredRepository(ReleaseDescriptor releaseDescriptor, Settings settings)` Construct a configured SCM repository from a release configuration.
`ScmRepository`	`getConfiguredRepository(String url, ReleaseDescriptor releaseDescriptor, Settings settings)` Construct a configured SCM repository from a release configuration with an overridden base SCM URL.
`ScmProvider`	`getRepositoryProvider(ScmRepository repository)` Get the SCM provider used for the given SCM repository.

- Field Detail
  - ROLE
```
static final String ROLE
```
    The Plexus role.
- Method Detail
  - getConfiguredRepository
```
ScmRepository getConfiguredRepository(ReleaseDescriptor releaseDescriptor,
                                    Settings settings)
                                      throws ScmRepositoryException,
                                             NoSuchScmProviderException
```
    Construct a configured SCM repository from a release configuration.
    
    Parameters:
    releaseDescriptor - the configuration to insert into the repository
    settings - the settings.xml configuraiton
    
    Returns:
    the repository created
    
    Throws:
    
    ScmRepositoryException - if it is not possible to create a suitable SCM repository
    
    NoSuchScmProviderException - if the requested SCM provider is not available
  - getRepositoryProvider
```
ScmProvider getRepositoryProvider(ScmRepository repository)
                                  throws NoSuchScmProviderException
```
    Get the SCM provider used for the given SCM repository.
    
    Parameters:
    repository - the SCM repository
    
    Returns:
    the SCM provider
    
    Throws:
    
    NoSuchScmProviderException - if the requested SCM provider is not available
  - getConfiguredRepository
```
ScmRepository getConfiguredRepository(String url,
                                    ReleaseDescriptor releaseDescriptor,
                                    Settings settings)
                                      throws ScmRepositoryException,
                                             NoSuchScmProviderException
```
    Construct a configured SCM repository from a release configuration with an overridden base SCM URL.
    
    Parameters:
    url - the SCM URL to use instead of the one from the release descriptor
    releaseDescriptor - the configuration to insert into the repository
    settings - the settings.xml configuraiton
    
    Returns:
    the repository created
    
    Throws:
    
    ScmRepositoryException - if it is not possible to create a suitable SCM repository
    
    NoSuchScmProviderException - if the requested SCM provider is not available

Interface ScmRepositoryConfigurator

Field Summary

Method Summary

Field Detail

ROLE

Method Detail

getConfiguredRepository

getRepositoryProvider

getConfiguredRepository