Interface ScmRepositoryConfigurator

  • All Known Implementing Classes:
    DefaultScmRepositoryConfigurator

    public interface ScmRepositoryConfigurator
    Configure an SCM repository using release configuration.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.apache.maven.scm.repository.ScmRepository getConfiguredRepository​(java.lang.String url, ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings)
      Construct a configured SCM repository from a release configuration with an overridden base SCM URL.
      org.apache.maven.scm.repository.ScmRepository getConfiguredRepository​(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings)
      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.
    • Method Detail

      • getConfiguredRepository

        org.apache.maven.scm.repository.ScmRepository getConfiguredRepository​(ReleaseDescriptor releaseDescriptor,
                                                                              org.apache.maven.settings.Settings settings)
                                                                       throws org.apache.maven.scm.repository.ScmRepositoryException,
                                                                              org.apache.maven.scm.manager.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:
        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
      • getConfiguredRepository

        org.apache.maven.scm.repository.ScmRepository getConfiguredRepository​(java.lang.String url,
                                                                              ReleaseDescriptor releaseDescriptor,
                                                                              org.apache.maven.settings.Settings settings)
                                                                       throws org.apache.maven.scm.repository.ScmRepositoryException,
                                                                              org.apache.maven.scm.manager.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:
        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