com.atlassian.bamboo.webrepository

Interface CommitUrlProvider

All Superinterfaces:

BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, ConvertibleFromConfig, InitablePluginModule, RenderableBuildConfiguration, Serializable, WebRepositoryViewer

All Known Subinterfaces:

DeploymentsAwareCommitUrlProvider

All Known Implementing Classes:

DefaultWebRepositoryViewer, FisheyeWebRepositoryViewer, LegacyStashWebRepositoryViewer, NoWebRepositoryViewer, StashWebRepositoryViewer

public interface CommitUrlProvider
extends WebRepositoryViewer

If implementing this interface Bamboo's notifications can make use of it to provide web repository links within html emails

Field Summary

Fields inherited from interface com.atlassian.bamboo.webrepository.WebRepositoryViewer

SELECTED_WEB_REPOSITORY_VIEWER, WEB_REPOSITORY

Method Summary

Modifier and Type	Method and Description
@Nullable String	getWebRepositoryUrlForCommit(Commit commit, @NotNull RepositoryData repositoryData) Provide the url to link to the given commit in the web repository
Map<Commit,String>	getWebRepositoryUrlForCommits(Collection<Commit> commits, RepositoryData repositoryDefinition) Provide the urls to link all the given commits in the web repository
@Nullable String	getWebRepositoryUrlForRevision(String revisionId, @NotNull RepositoryData repositoryData) Provide the url to link to the given revision in the web repository

Methods inherited from interface com.atlassian.bamboo.webrepository.WebRepositoryViewer

getHtmlForCommitsFull, getHtmlForCommitsSummary, getKey, getName, getShortKey, getSupportedRepositories, populateFromParams

Methods inherited from interface com.atlassian.bamboo.v2.build.ConfigurablePlugin

customizeBuildRequirements, removeBuildRequirements

Methods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin

addDefaultValues, isConfigurationMissing, prepareConfigObject, validate

Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule

init

Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration

getEditHtml, getViewHtml

Methods inherited from interface com.atlassian.bamboo.fieldvalue.ConvertibleFromConfig

populateFromConfig, toConfiguration

Method Detail

getWebRepositoryUrlForCommit

@Nullable
@Nullable String getWebRepositoryUrlForCommit(Commit commit,
                                                        @NotNull
                                                        @NotNull RepositoryData repositoryData)

Provide the url to link to the given commit in the web repository

Parameters:

commit - the commit to links to

repositoryData - the repository type the commit came from

Returns:

a full url string.

getWebRepositoryUrlForRevision

@Nullable
@Nullable String getWebRepositoryUrlForRevision(String revisionId,
                                                          @NotNull
                                                          @NotNull RepositoryData repositoryData)

Provide the url to link to the given revision in the web repository

Parameters:

revisionId - the revision to links to

repositoryData - the repository type the commit came from

Returns:

a full url string.

getWebRepositoryUrlForCommits

Map<Commit,String> getWebRepositoryUrlForCommits(Collection<Commit> commits,
                                                 RepositoryData repositoryDefinition)

Provide the urls to link all the given commits in the web repository

Parameters:

commits - to generate links for

repositoryDefinition - the repository type the commit came from

Returns:

a map of the commit to its url.