Package com.atlassian.bamboo.webrepository.fisheye

Class FisheyeWebRepositoryViewer

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.webrepository.AbstractWebRepositoryViewer

com.atlassian.bamboo.webrepository.fisheye.FisheyeWebRepositoryViewer

All Implemented Interfaces:

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

public class FisheyeWebRepositoryViewer
extends AbstractWebRepositoryViewer
implements DeploymentsAwareCommitUrlProvider

URL FORMATS: file https://atlaseye.atlassian.com/browse/bamboo/branches/atlassian_bamboo_2_4_branch/atlassian-ide-plugin.shared.xml#r68584 url/browse/reponame/file~ revision https://atlaseye.atlassian.com/browse/bamboo/trunk/atlassian-ide-plugin.shared.xml?r=68584 url/browse/reponame/file?r=XXX diff https://atlaseye.atlassian.com/browse/bamboo/trunk/atlassian-ide-plugin.shared.xml?r2=68584&r1=68581 url/browse/reponame/file?r2=XX&r1=YYY -- is this working for perforce yet? - no. need to use blank, however this only works in some versions of fisheye changeset https://atlaseye.atlassian.com/changelog/bamboo?cs=68584 url/changelog/reponame?cs=blah

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	FISHEYE_REPOSITORY_NAME
protected static String	FISHEYE_REPOSITORY_PATH
protected static String	FISHEYE_REPOSITORY_URL

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
FisheyeWebRepositoryViewer()

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.
@NotNull Collection<String>	getSupportedRepositories()	The keys for the Repository classes that the web viewer currently supports.
String	getWebRepositoryPath()
String	getWebRepositoryRepoName()
String	getWebRepositoryUrl()
@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 repositoryData)	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	getWebRepositoryUrlForDiff(CommitFile file, RepositoryData repositoryData)
@Nullable String	getWebRepositoryUrlForFile(@NotNull CommitFile file, RepositoryData repositoryData)	Generate the link to a given file in a given repository
@Nullable String	getWebRepositoryUrlForRevision(CommitFile file, RepositoryData repositoryData)
@Nullable String	getWebRepositoryUrlForRevision(String revisionId, @NotNull RepositoryData repositoryData)	Provide the url to link to the given revision in the web repository
Map<String,String>	getWebRepositoryUrlForRevisions(Collection<String> revisions, RepositoryData repositoryData)
void	populateFromConfig(@NotNull org.apache.commons.configuration.HierarchicalConfiguration config)	Update the current object with data in the HierarchicalConfiguration
void	populateFromParams(@NotNull ActionParametersMap params)	takes the map of config data from action and extracts the parameters it needs
void	setCustomVariableContext(CustomVariableContext customVariableContext)
void	setWebRepositoryPath(@Nullable String webRepositoryPath)
void	setWebRepositoryRepoName(@Nullable String webRepositoryRepoName)
void	setWebRepositoryUrl(@Nullable String webRepositoryUrl)
@NotNull org.apache.commons.configuration.HierarchicalConfiguration	toConfiguration()	Generate a HierarchicalConfiguration from the current state of the object
@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

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.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.plugin.InitablePluginModule

init

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

getEditHtml, getViewHtml

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

getKey, getName, getShortKey

Field Detail

FISHEYE_REPOSITORY_URL

protected static final String FISHEYE_REPOSITORY_URL

See Also:

Constant Field Values

FISHEYE_REPOSITORY_NAME

protected static final String FISHEYE_REPOSITORY_NAME

See Also:

Constant Field Values

FISHEYE_REPOSITORY_PATH

protected static final String FISHEYE_REPOSITORY_PATH

See Also:

Constant Field Values

Constructor Detail

FisheyeWebRepositoryViewer

public FisheyeWebRepositoryViewer()

Method Detail

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.

populateFromParams

public void populateFromParams(@NotNull
                               @NotNull ActionParametersMap params)

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)

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

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)

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.

getWebRepositoryUrlForFile

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

Generate the link to a given file in a given repository

Parameters:

file - The file we want to link to.

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

Returns:

The url

getWebRepositoryUrlForRevision

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

getWebRepositoryUrlForDiff

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

getWebRepositoryUrlForCommits

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

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

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.

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.

getWebRepositoryUrlForRevisions

public Map<String,String> getWebRepositoryUrlForRevisions(Collection<String> revisions,
                                                                RepositoryData repositoryData)

getWebRepositoryUrl

public String getWebRepositoryUrl()

setWebRepositoryUrl

public void setWebRepositoryUrl(@Nullable
                                @Nullable String webRepositoryUrl)

getWebRepositoryPath

public String getWebRepositoryPath()

setWebRepositoryPath

public void setWebRepositoryPath(@Nullable
                                 @Nullable String webRepositoryPath)

getWebRepositoryRepoName

public String getWebRepositoryRepoName()

setWebRepositoryRepoName

public void setWebRepositoryRepoName(@Nullable
                                     @Nullable String webRepositoryRepoName)

setCustomVariableContext

public void setCustomVariableContext(CustomVariableContext customVariableContext)