Package com.atlassian.bamboo.plugins.stash

Class StashWebRepositoryViewer

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.webrepository.AbstractWebRepositoryViewer

com.atlassian.bamboo.plugins.stash.StashWebRepositoryViewer

All Implemented Interfaces:

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

public class StashWebRepositoryViewer
extends AbstractWebRepositoryViewer
implements DeploymentsAwareCommitUrlProvider

URL FORMATS: file https://caviardog.atlassian.com/caviar/projects/STASH/repos/stash/browse/webapp/default/src/main/webapp/static/page/repository/editRepository.soy?at=8127e6af149297ae95219c3b0a202a84d9a20b33 revision/changeset https://caviardog.atlassian.com/caviar/projects/STASH/repos/stash/commits/8127e6af149297ae95219c3b0a202a84d9a20b33 diff https://caviardog.atlassian.com/caviar/projects/STASH/repos/stash/diff/webapp/default/src/main/webapp/static/page/repository/editRepository.soy?at=8127e6af149297ae95219c3b0a202a84d9a20b33&until=8127e6af149297ae95219c3b0a202a84d9a20b33

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	PLUGIN_KEY

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	Description
StashWebRepositoryViewer()

Method Summary

Modifier and Type	Method	Description
String	getHtmlForCommitsFull(@NotNull ResultsSummary resultsSummary, @NotNull RepositoryChangeset repositoryChangeset, @NotNull RepositoryData repositoryData)	Renders the html to display the full commits on the changes tab.
String	getHtmlForCommitsSummary(@NotNull ResultsSummary resultsSummary, @NotNull RepositoryChangeset repositoryChangeset, @NotNull RepositoryData repositoryData, int maxChanges)	Renders the html to display a summary of the commits on the Build Results Summary tab.
@Nullable String	getStashUrlForFile(@NotNull CommitFile file, RepositoryData repositoryData)	Generate the link to a given file in the selected stash repository
@Nullable String	getStashUrlForFileAtItsRevision(@NotNull CommitFile file, RepositoryData repositoryData)	Generate the link to a given file in the selected stash repository at the revision pointed by the commit
@Nullable String	getStashUrlForFileDiff(@NotNull CommitFile file, RepositoryData repositoryData)	Generate the link to a diff between given file and its direct ancestor
@NotNull Collection<String>	getSupportedRepositories()	The keys for the Repository classes that the web viewer currently supports.
@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
Map<DeploymentVersionVcsCommit,String>	getWebRepositoryUrlForDeploymentVersionCommits(Collection<DeploymentVersionVcsCommit> commits, RepositoryData repositoryData)	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
void	init(@NotNull com.atlassian.plugin.ModuleDescriptor moduleDescriptor)	Initialises the Plugin with the plugin module descriptor
@NotNull ErrorCollection	validate(@NotNull BuildConfiguration buildConfiguration)	Validates the properties in the BuildConfiguration object.

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

getKey, getName, getShortKey, 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, getTemplateRenderer, getViewHtml, populateContextForEdit, populateContextForView, prepareConfigObject, setTemplateRenderer

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.v2.build.BuildConfigurationAwarePlugin

addDefaultValues, isConfigurationMissing, prepareConfigObject

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

customizeBuildRequirements, removeBuildRequirements

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

populateFromConfig, toConfiguration

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

getEditHtml, getViewHtml

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

getKey, getName, getShortKey, populateFromParams

Field Detail

PLUGIN_KEY

public static final String PLUGIN_KEY

See Also:

Constant Field Values

Constructor Detail

StashWebRepositoryViewer

public StashWebRepositoryViewer()

Method Detail

init

public void init(@NotNull
                 @NotNull com.atlassian.plugin.ModuleDescriptor moduleDescriptor)

Description copied from interface: InitablePluginModule

Initialises the Plugin with the plugin module descriptor

Specified by:

init in interface InitablePluginModule

Overrides:

init in class BaseBuildConfigurationAwarePlugin

Parameters:

moduleDescriptor - Plugin module descriptor

getSupportedRepositories

@NotNull
public @NotNull Collection<String> getSupportedRepositories()

Description copied from interface: WebRepositoryViewer

The keys for the Repository classes that the web viewer currently supports. If list is empty or null it assumes support for all repositories.

Specified by:

getSupportedRepositories in interface WebRepositoryViewer

Overrides:

getSupportedRepositories in class AbstractWebRepositoryViewer

Returns:

a list of repositories which can be rendered by this WebRepositoryViewer.

getHtmlForCommitsFull

public String getHtmlForCommitsFull(@NotNull
                                    @NotNull ResultsSummary resultsSummary,
                                    @NotNull
                                    @NotNull RepositoryChangeset repositoryChangeset,
                                    @NotNull
                                    @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
                                       @NotNull ResultsSummary resultsSummary,
                                       @NotNull
                                       @NotNull RepositoryChangeset repositoryChangeset,
                                       @NotNull
                                       @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.

validate

@NotNull
public @NotNull ErrorCollection validate(@NotNull
                                         @NotNull BuildConfiguration buildConfiguration)

Description copied from interface: BuildConfigurationAwarePlugin

Validates the properties in the BuildConfiguration object. The name of the properties match those passed in through the form fragments in RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan) template.

Specified by:

validate in interface BuildConfigurationAwarePlugin

Overrides:

validate in class BaseBuildConfigurationAwarePlugin

Parameters:

buildConfiguration - -

Returns:

ErrorCollection keyed by the field name.

getWebRepositoryUrlForCommit

@Nullable
public @Nullable String getWebRepositoryUrlForCommit(Commit commit,
                                                     @NotNull
                                                     @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

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

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

repositoryData - the repository type the commit came from

Returns:

a full url string.

getWebRepositoryUrlForCommits

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

Description copied from interface: CommitUrlProvider

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

Specified by:

getWebRepositoryUrlForCommits in interface CommitUrlProvider

Parameters:

commits - to generate links for

repositoryDefinition - 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.

getStashUrlForFile

@Nullable
public @Nullable String getStashUrlForFile(@NotNull
                                           @NotNull CommitFile file,
                                           RepositoryData repositoryData)

Generate the link to a given file in the selected stash repository

Parameters:

file - The file we want to link to.

repositoryData - For the build (and hense the repository file belongs to).

Returns:

The url

getStashUrlForFileAtItsRevision

@Nullable
public @Nullable String getStashUrlForFileAtItsRevision(@NotNull
                                                        @NotNull CommitFile file,
                                                        RepositoryData repositoryData)

Generate the link to a given file in the selected stash repository at the revision pointed by the commit

Parameters:

file - The file we want to link to. It should contain the revision we want to link to.

repositoryData - For the build (and hense the repository file belongs to).

Returns:

The url

getStashUrlForFileDiff

@Nullable
public @Nullable String getStashUrlForFileDiff(@NotNull
                                               @NotNull CommitFile file,
                                               RepositoryData repositoryData)

Generate the link to a diff between given file and its direct ancestor

Parameters:

file - The file we want to link to.

repositoryData - For the build (and hense the repository file belongs to).

Returns:

The url