Package com.atlassian.bamboo.repository

Interface MavenPomAccessor

All Known Implementing Classes:

GitMavenPomAccessor, MavenPomAccessorAbstract, PerforceRepositoryMavenPomAccessor, SvnRepositoryMavenPomAccessor

public interface MavenPomAccessor

Method Summary

Modifier and Type	Method	Description
void	addDefaultValues(@NotNull BuildConfiguration buildConfiguration)	Allows setting default values in build configuration for the repository to be added into a plan.
@NotNull File	checkoutMavenPom(@NotNull File destinationPath)	Checkout Maven POM and return File pointing to the project file
@Nullable String	getMavenPomCheckoutAccessEditHtml(@NotNull BuildConfiguration buildConfiguration)	Returns HTML for the Maven POM import configuration of the repository
@NotNull String	getMavenScmProviderKey()	Return Maven's SCM provider key for this repository type.
void	parseMavenScmUrl(@NotNull String mavenScmUrl)	Parse and setup internal structures from Maven's SCM URL provider specific part.

Method Detail

getMavenScmProviderKey

@NotNull
@NotNull String getMavenScmProviderKey()

Return Maven's SCM provider key for this repository type.

Returns:

Maven's SCM provider key

parseMavenScmUrl

void parseMavenScmUrl(@NotNull
                      @NotNull String mavenScmUrl)
               throws IllegalArgumentException

Parse and setup internal structures from Maven's SCM URL provider specific part. Maven SCM URL format is defined in http://maven.apache.org/scm/scm-url-format.html

Parameters:

mavenScmUrl - Provider specific part of Maven SCM URL

Throws:

IllegalArgumentException - When SCM URL string cannot be parsed

checkoutMavenPom

@NotNull
@NotNull File checkoutMavenPom(@NotNull
                               @NotNull File destinationPath)
                        throws RepositoryException

Checkout Maven POM and return File pointing to the project file

Parameters:

destinationPath - Checkout destination

Returns:

File object referencing Maven project file

Throws:

RepositoryException - In case of repository access problems

addDefaultValues

void addDefaultValues(@NotNull
                      @NotNull BuildConfiguration buildConfiguration)

Allows setting default values in build configuration for the repository to be added into a plan. This method is called before ConvertibleFromConfig.populateFromConfig(HierarchicalConfiguration)

Parameters:

buildConfiguration - build configuration

getMavenPomCheckoutAccessEditHtml

@Nullable
@Nullable String getMavenPomCheckoutAccessEditHtml(@NotNull
                                                   @NotNull BuildConfiguration buildConfiguration)

Returns HTML for the Maven POM import configuration of the repository

Parameters:

buildConfiguration - BuildConfiguration object

Returns:

HTML for the Maven POM import configuration of the repository