com.atlassian.bamboo.webrepository
Interface WebRepositoryViewer

All Superinterfaces:

BambooPluginModule, ConfigurablePlugin, ConvertibleFromConfig, InitablePluginModule, java.io.Serializable

All Known Subinterfaces:

CommitUrlProvider

All Known Implementing Classes:

AbstractWebRepositoryViewer, DefaultWebRepositoryViewer, FisheyeWebRepositoryViewer, NoWebRepositoryViewer

public interface WebRepositoryViewer
extends ConfigurablePlugin, ConvertibleFromConfig, java.io.Serializable

Module that decorates change information with required stuff for web repository browsing (e.g linking files) If you would like web repository links to be provided within you html notifications, also implement CommitUrlProvider

Field Summary

static java.lang.String

SELECTED_WEB_REPOSITORY_VIEWER Constant for fetching out the selected web repository viewer key from a BuildConfiguration

Method Summary

java.lang.String	getHtmlForCommitsFull(ExtendedBuildResultsSummary buildResultsSummary, Repository repository) Renders the html to display the full commits on the changes tab.
java.lang.String	getHtmlForCommitsSummary(ExtendedBuildResultsSummary buildResultsSummary, Repository repository) Renders the html to display a summary of the commits on the Build Results Summary tab.
java.lang.String	getKey() The full complete plugin key for the repository viewer
java.lang.String	getName() The name of the web repository viewer, as displayed in the UI.
java.lang.String	getShortKey() The shorter version fo the plugin key (without prefix & should not contain any ':')
java.util.Collection<java.lang.String>	getSupportedRepositories() The keys for the Repository classes that the web viewer currently supports.
void	populateFromParams(ActionParametersMap params) takes the map of config data from action and extracts the parameters it needs

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

addDefaultValues, customizeBuildRequirements, getEditHtml, getViewHtml, prepareConfigObject, removeBuildRequirements, validate

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

init

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

populateFromConfig, toConfiguration

Field Detail

SELECTED_WEB_REPOSITORY_VIEWER

static final java.lang.String SELECTED_WEB_REPOSITORY_VIEWER

Constant for fetching out the selected web repository viewer key from a BuildConfiguration

See Also:

Constant Field Values

Method Detail

getKey

@NotNull
java.lang.String getKey()

The full complete plugin key for the repository viewer

Returns:

the key for the plugin

getShortKey

@NotNull
java.lang.String getShortKey()

The shorter version fo the plugin key (without prefix & should not contain any ':')

Returns:

the shorter key for this plugin.

getName

@NotNull
java.lang.String getName()

The name of the web repository viewer, as displayed in the UI.

Returns:

The name of the repository viewer

getSupportedRepositories

@NotNull
java.util.Collection<java.lang.String> getSupportedRepositories()

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

Returns:

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

getHtmlForCommitsFull

java.lang.String getHtmlForCommitsFull(@NotNull
                                       ExtendedBuildResultsSummary buildResultsSummary,
                                       Repository repository)

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

Parameters:

buildResultsSummary - the summary to show commits for

repository - the commits belong to aka the plans repository

Returns:

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

getHtmlForCommitsSummary

java.lang.String getHtmlForCommitsSummary(@NotNull
                                          ExtendedBuildResultsSummary buildResultsSummary,
                                          Repository repository)

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

Parameters:

buildResultsSummary - the summary to show commits for

repository - the commits belong to aka the plans repository

Returns:

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

populateFromParams

void populateFromParams(@NotNull
                        ActionParametersMap params)

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

Parameters:

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