com.atlassian.bamboo.webrepository
Interface CommitUrlProvider

All Superinterfaces:
BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, ConvertibleFromConfig, InitablePluginModule, RenderableBuildConfiguration, java.io.Serializable, WebRepositoryViewer
All Known Implementing Classes:
AppLinksWebRepositoryViewer, DefaultWebRepositoryViewer, FisheyeWebRepositoryViewer, HgWebRepositoryViewer, 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
 java.lang.String getWebRepositoryUrlForCommit(Commit commit, RepositoryData repositoryData)
          Provide the url to link to the given commit in the web repository
 java.util.Map<Commit,java.lang.String> getWebRepositoryUrlForCommits(java.util.Collection<Commit> commits, RepositoryData repositoryDefinition)
          Provide the urls to link all the given commits in the web repository
 java.lang.String getWebRepositoryUrlForRevision(java.lang.String revisionId, 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, 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
java.lang.String getWebRepositoryUrlForCommit(Commit commit,
                                                       @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
java.lang.String getWebRepositoryUrlForRevision(java.lang.String revisionId,
                                                         @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

java.util.Map<Commit,java.lang.String> getWebRepositoryUrlForCommits(java.util.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.


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.