com.atlassian.bamboo.repository
Interface MavenPomAccessor

All Known Implementing Classes:

CvsRepositoryMavenPomAccessor, GitMavenPomAccessor, HgMavenPomAccessor, MavenPomAccessorAbstract, PerforceRepositoryMavenPomAccessor, SvnRepositoryMavenPomAccessor

public interface MavenPomAccessor

Method Summary

File	checkoutMavenPom(File destinationPath) Checkout Maven POM and return File pointing to the project file
String	getMavenPomCheckoutAccessEditHtml(BuildConfiguration buildConfiguration) Returns HTML for the Maven POM import configuration of the repository
String	getMavenScmProviderKey() Return Maven's SCM provider key for this repository type.
void	parseMavenScmUrl(String mavenScmUrl) Parse and setup internal structures from Maven's SCM URL provider specific part.

Method Detail

getMavenScmProviderKey

@NotNull
String getMavenScmProviderKey()

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

Returns:

Maven's SCM provider key

parseMavenScmUrl

void parseMavenScmUrl(@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
File checkoutMavenPom(@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

getMavenPomCheckoutAccessEditHtml

@Nullable
String getMavenPomCheckoutAccessEditHtml(@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