Package com.atlassian.bamboo.vcs.configurator

Interface VcsMavenPomAccessor

All Known Implementing Classes:

GitMavenPomAccessor, LegacyMavenPomAccessor, SvnMavenPomAccessor

public interface VcsMavenPomAccessor

Handles configuring this repository type during importing project from Maven. Note that in order to support import from Maven functionality, related VcsWorkingCopyManager must implement NoContextVcsWorkingCopyManager

Since:

5.14

Field Summary

Fields

Modifier and Type	Field	Description
static String	POM_XML

Method Summary

Modifier and Type	Method	Description
default @NotNull File	findPomFileInWorkingCopy(VcsWorkingCopy checkoutDirectory, String mavenPath)	Look for maven in the current directory or throw exception if not found.
@NotNull String	getMavenScmProviderKey()	Return Maven's SCM provider key for this repository type.
default @Nullable VcsBranch	parseMavenScmUrlToVcsBranch(@NotNull String mavenScmUrl, @Nullable VcsRepositoryData existingData)	Parse and setup internal structures from Maven's SCM URL provider specific part.
Map<String,String>	parseMavenScmUrlToVcsLocation(@NotNull String mavenScmUrl, @Nullable VcsRepositoryData existingData)	Parse and setup internal structures from Maven's SCM URL provider specific part.

Field Detail

POM_XML

static final String POM_XML

See Also:

Constant Field Values

Method Detail

getMavenScmProviderKey

@NotNull
@NotNull String getMavenScmProviderKey()

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

Returns:

Maven's SCM provider key

parseMavenScmUrlToVcsLocation

Map<String,String> parseMavenScmUrlToVcsLocation(@NotNull
                                                       @NotNull String mavenScmUrl,
                                                       @Nullable
                                                       @Nullable VcsRepositoryData existingData)
                                                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

Returns:

new vcs location configuration

Throws:

IllegalArgumentException - When SCM URL string cannot be parsed

parseMavenScmUrlToVcsBranch

@Nullable
default @Nullable VcsBranch parseMavenScmUrlToVcsBranch(@NotNull
                                                        @NotNull String mavenScmUrl,
                                                        @Nullable
                                                        @Nullable VcsRepositoryData existingData)
                                                 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 If there is no branch support it returns null;

Parameters:

mavenScmUrl - Provider specific part of Maven SCM URL

Returns:

new vcs branch configuration

Throws:

IllegalArgumentException - When SCM URL string cannot be parsed

findPomFileInWorkingCopy

@NotNull
default @NotNull File findPomFileInWorkingCopy(VcsWorkingCopy checkoutDirectory,
                                               String mavenPath)
                                        throws RepositoryException

Look for maven in the current directory or throw exception if not found. Default implementation simply looks at the content of the working dir.

Parameters:

checkoutDirectory -

mavenPath -

Returns:

Throws:

RepositoryException