com.atlassian.bamboo.webrepository.stash

Class LegacyStashWebRepositoryViewer

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.webrepository.AbstractWebRepositoryViewer

com.atlassian.bamboo.webrepository.stash.LegacyStashWebRepositoryViewer

All Implemented Interfaces:

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

Deprecated.

use LegacyStashWebRepositoryViewer from new Stash plugin

@Deprecated
public class LegacyStashWebRepositoryViewer
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 and Description
protected static String	STASH_PROJECT Deprecated.
protected static String	STASH_REPOSITORY_NAME Deprecated.
protected static String	STASH_URL Deprecated.

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
LegacyStashWebRepositoryViewer() Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getHtmlForCommitsFull(@NotNull ResultsSummary resultsSummary, @NotNull RepositoryChangeset repositoryChangeset, @NotNull RepositoryData repositoryData) Deprecated. 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) Deprecated. Renders the html to display a summary of the commits on the Build Results Summary tab.
String	getStashProject() Deprecated.
String	getStashRepositoryName() Deprecated.
String	getStashUrl() Deprecated.
@Nullable String	getStashUrlForFile(@NotNull CommitFile file, RepositoryData repositoryData) Deprecated. Generate the link to a given file in the selected stash repository
@Nullable String	getStashUrlForFileAtItsRevision(@NotNull CommitFile file, RepositoryData repositoryData) Deprecated. 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) Deprecated. Generate the link to a diff between given file and its direct ancestor
@NotNull Collection<String>	getSupportedRepositories() Deprecated. The keys for the Repository classes that the web viewer currently supports.
@Nullable String	getWebRepositoryUrlForCommit(Commit commit, @NotNull RepositoryData repositoryData) Deprecated. Provide the url to link to the given commit in the web repository
Map<Commit,String>	getWebRepositoryUrlForCommits(Collection<Commit> commits, RepositoryData repositoryDefinition) Deprecated. Provide the urls to link all the given commits in the web repository
Map<DeploymentVersionVcsCommit,String>	getWebRepositoryUrlForDeploymentVersionCommits(Collection<DeploymentVersionVcsCommit> commits, RepositoryData repositoryData) Deprecated. Provide the urls to link all the given commits in the web repository
String	getWebRepositoryUrlForDiff(@NotNull CommitFile file, RepositoryData repositoryData) Deprecated.
String	getWebRepositoryUrlForFile(@NotNull CommitFile file, RepositoryData repositoryData) Deprecated.
String	getWebRepositoryUrlForRevision(@NotNull CommitFile file, RepositoryData repositoryData) Deprecated.
@Nullable String	getWebRepositoryUrlForRevision(String revisionId, @NotNull RepositoryData repositoryData) Deprecated. Provide the url to link to the given revision in the web repository
void	populateFromConfig(@NotNull org.apache.commons.configuration.HierarchicalConfiguration config) Deprecated. Update the current object with data in the HierarchicalConfiguration
void	populateFromParams(@NotNull ActionParametersMap params) Deprecated. takes the map of config data from action and extracts the parameters it needs
void	setCustomVariableContext(CustomVariableContext customVariableContext) Deprecated.
void	setStashProject(@Nullable String stashProject) Deprecated.
void	setStashRepositoryName(@Nullable String stashRepositoryName) Deprecated.
void	setStashUrl(@Nullable String stashUrl) Deprecated.
void	setTextProvider(com.opensymphony.xwork2.TextProvider textProvider) Deprecated.
@NotNull org.apache.commons.configuration.HierarchicalConfiguration	toConfiguration() Deprecated. Generate a HierarchicalConfiguration from the current state of the object
@NotNull ErrorCollection	validate(@NotNull BuildConfiguration buildConfiguration) Deprecated. Validates the properties in the BuildConfiguration object.

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

getKey, getName, getShortKey

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, init, 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.webrepository.WebRepositoryViewer

getKey, getName, getShortKey

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

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

init

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

getEditHtml, getViewHtml

Field Detail

STASH_URL

protected static final String STASH_URL

Deprecated.

See Also:

Constant Field Values

STASH_PROJECT

protected static final String STASH_PROJECT

Deprecated.

See Also:

Constant Field Values

STASH_REPOSITORY_NAME

protected static final String STASH_REPOSITORY_NAME

Deprecated.

See Also:

Constant Field Values

Constructor Detail

LegacyStashWebRepositoryViewer

public LegacyStashWebRepositoryViewer()

Deprecated.

Method Detail

getSupportedRepositories

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

Deprecated.

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)

Deprecated.

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)

Deprecated.

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.

populateFromParams

public void populateFromParams(@NotNull
                               @NotNull ActionParametersMap params)

Deprecated.

Description copied from class: AbstractWebRepositoryViewer

takes the map of config data from action and extracts the parameters it needs

Specified by:

populateFromParams in interface WebRepositoryViewer

Overrides:

populateFromParams in class AbstractWebRepositoryViewer

Parameters:

params - map of key (String), value (String []) pairs from action

populateFromConfig

public void populateFromConfig(@NotNull
                               @NotNull org.apache.commons.configuration.HierarchicalConfiguration config)

Deprecated.

Description copied from interface: ConvertibleFromConfig

Update the current object with data in the HierarchicalConfiguration

Specified by:

populateFromConfig in interface ConvertibleFromConfig

Overrides:

populateFromConfig in class AbstractWebRepositoryViewer

toConfiguration

@NotNull
public @NotNull org.apache.commons.configuration.HierarchicalConfiguration toConfiguration()

Deprecated.

Description copied from interface: ConvertibleFromConfig

Generate a HierarchicalConfiguration from the current state of the object

Specified by:

toConfiguration in interface ConvertibleFromConfig

Overrides:

toConfiguration in class AbstractWebRepositoryViewer

Returns:

Always returns an HierarchicalConfiguration. Never null

validate

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

Deprecated.

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)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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)

Deprecated.

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

getWebRepositoryUrlForFile

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

Deprecated.

getWebRepositoryUrlForRevision

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

Deprecated.

getWebRepositoryUrlForDiff

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

Deprecated.

getStashUrl

public String getStashUrl()

Deprecated.

setStashUrl

public void setStashUrl(@Nullable
                        @Nullable String stashUrl)

Deprecated.

getStashProject

public String getStashProject()

Deprecated.

setStashProject

public void setStashProject(@Nullable
                            @Nullable String stashProject)

Deprecated.

getStashRepositoryName

public String getStashRepositoryName()

Deprecated.

setStashRepositoryName

public void setStashRepositoryName(@Nullable
                                   @Nullable String stashRepositoryName)

Deprecated.

setCustomVariableContext

public void setCustomVariableContext(CustomVariableContext customVariableContext)

Deprecated.

setTextProvider

public void setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)

Deprecated.