com.atlassian.bamboo.plugins.hg

Class AbstractHgWebRepositoryViewer

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.webrepository.AbstractWebRepositoryViewer

com.atlassian.bamboo.plugins.hg.AbstractHgWebRepositoryViewer

All Implemented Interfaces:

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

Direct Known Subclasses:

BitbucketCloudRepositoryViewer, HgServeWebRepositoryViewer

public abstract class AbstractHgWebRepositoryViewer
extends AbstractWebRepositoryViewer
implements DeploymentsAwareCommitUrlProvider

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

moduleDescriptor, templateRenderer

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

SELECTED_WEB_REPOSITORY_VIEWER, WEB_REPOSITORY

Constructor Summary

Constructors

Constructor and Description
AbstractHgWebRepositoryViewer(HgWebRepositoryUrlProvider urlProvider)

Method Summary

Modifier and Type	Method and Description
String	getHtmlForCommitsFull(ResultsSummary resultsSummary, RepositoryChangeset repositoryChangeset, RepositoryData repositoryData) Renders the html to display the full commits on the changes tab.
String	getHtmlForCommitsSummary(ResultsSummary resultsSummary, RepositoryChangeset repositoryChangeset, RepositoryData repositoryData, int maxChanges) Renders the html to display a summary of the commits on the Build Results Summary tab.
protected abstract URI	getUriForRepositoryData(RepositoryData repositoryData)
String	getWebRepositoryUrlForCommit(Commit commit, RepositoryData repositoryData) Provide the url to link to the given commit in the web repository
Map<Commit,String>	getWebRepositoryUrlForCommits(Collection<Commit> commits, RepositoryData repositoryData) Used in defaultCommitSummaryView.ftl
Map<DeploymentVersionVcsCommit,String>	getWebRepositoryUrlForDeploymentVersionCommits(Collection<DeploymentVersionVcsCommit> commits, RepositoryData repositoryData) Provide the urls to link all the given commits in the web repository
String	getWebRepositoryUrlForDiff(CommitFile file, RepositoryData repositoryData) Used in defaultCommitView.ftl
String	getWebRepositoryUrlForFile(CommitFile file, RepositoryData repositoryData) Used in defaultCommitView.ftl
String	getWebRepositoryUrlForRevision(CommitFile file, RepositoryData repositoryData) Used in defaultCommitView.ftl
String	getWebRepositoryUrlForRevision(String revisionId, RepositoryData repositoryDefinition) Provide the url to link to the given revision in the web repository

Methods inherited from class com.atlassian.bamboo.webrepository.AbstractWebRepositoryViewer

getKey, getName, getShortKey, getSupportedRepositories, populateFromConfig, populateFromParams, toConfiguration

Methods inherited from class com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

customizeBuildRequirements, removeBuildRequirements

Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

addDefaultValues, getEditHtml, getViewHtml, init, populateContextForEdit, populateContextForView, prepareConfigObject, setTemplateRenderer, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Constructor Detail

AbstractHgWebRepositoryViewer

public AbstractHgWebRepositoryViewer(HgWebRepositoryUrlProvider urlProvider)

Method Detail

getWebRepositoryUrlForCommit

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

Description copied from interface: CommitUrlProvider

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

Specified by:

getWebRepositoryUrlForCommit in interface CommitUrlProvider

Parameters:

commit - the commit to links to

repositoryData - the repository type the commit came from

Returns:

a full url string.

getWebRepositoryUrlForRevision

public String getWebRepositoryUrlForRevision(String revisionId,
                                             @NotNull
                                             RepositoryData repositoryDefinition)

Description copied from interface: CommitUrlProvider

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

Specified by:

getWebRepositoryUrlForRevision in interface CommitUrlProvider

Parameters:

revisionId - the revision to links to

repositoryDefinition - the repository type the commit came from

Returns:

a full url string.

getHtmlForCommitsFull

public String getHtmlForCommitsFull(@NotNull
                                    ResultsSummary resultsSummary,
                                    @NotNull
                                    RepositoryChangeset repositoryChangeset,
                                    @NotNull
                                    RepositoryData repositoryData)

Description copied from interface: WebRepositoryViewer

Renders the html to display the full commits on the changes tab.

Specified by:

getHtmlForCommitsFull in interface WebRepositoryViewer

Parameters:

resultsSummary - the summary to show commits for

repositoryData - the commits belong to aka the plans repository

Returns:

Html to be displayed on the UI in the Changes Tab.

getHtmlForCommitsSummary

public String getHtmlForCommitsSummary(@NotNull
                                       ResultsSummary resultsSummary,
                                       @NotNull
                                       RepositoryChangeset repositoryChangeset,
                                       @NotNull
                                       RepositoryData repositoryData,
                                       int maxChanges)

Description copied from interface: WebRepositoryViewer

Renders the html to display a summary of the commits on the Build Results Summary tab.

Specified by:

getHtmlForCommitsSummary in interface WebRepositoryViewer

Parameters:

resultsSummary - the summary to show commits for

repositoryData - the commits belong to aka the plans repository

maxChanges - maximum number of commits to be shown. Negative value means that all commits should be shown.

Returns:

Html to displayed on the UI in the Build Results Summary Tab.

getWebRepositoryUrlForFile

public String getWebRepositoryUrlForFile(@NotNull
                                         CommitFile file,
                                         RepositoryData repositoryData)

Used in defaultCommitView.ftl

getWebRepositoryUrlForRevision

public String getWebRepositoryUrlForRevision(CommitFile file,
                                             RepositoryData repositoryData)

Used in defaultCommitView.ftl

getWebRepositoryUrlForDiff

public String getWebRepositoryUrlForDiff(CommitFile file,
                                         RepositoryData repositoryData)

Used in defaultCommitView.ftl

getWebRepositoryUrlForCommits

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

Used in defaultCommitSummaryView.ftl

Specified by:

getWebRepositoryUrlForCommits in interface CommitUrlProvider

Parameters:

commits - to generate links for

repositoryData - the repository type the commit came from

Returns:

a map of the commit to its url.

getWebRepositoryUrlForDeploymentVersionCommits

public Map<DeploymentVersionVcsCommit,String> getWebRepositoryUrlForDeploymentVersionCommits(Collection<DeploymentVersionVcsCommit> commits,
                                                                                             RepositoryData repositoryData)

Description copied from interface: DeploymentsAwareCommitUrlProvider

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

Specified by:

getWebRepositoryUrlForDeploymentVersionCommits in interface DeploymentsAwareCommitUrlProvider

Parameters:

commits - to generate links for

repositoryData - the repository the commit came from

Returns:

a map of the commit to its url.

getUriForRepositoryData

@Nullable
protected abstract URI getUriForRepositoryData(RepositoryData repositoryData)