com.atlassian.bamboo.webrepository
Interface WebRepositoryViewer

All Superinterfaces:

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

All Known Subinterfaces:

CommitUrlProvider

All Known Implementing Classes:

AbstractWebRepositoryViewer, DefaultWebRepositoryViewer, FisheyeWebRepositoryViewer, HgWebRepositoryViewer, NoWebRepositoryViewer, StashWebRepositoryViewer

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
static java.lang.String	WEB_REPOSITORY

Method Summary

java.lang.String	getHtmlForCommitsFull(ResultsSummary resultsSummary, RepositoryChangeset repositoryChangeset, RepositoryData repositoryData) Renders the html to display the full commits on the changes tab.
java.lang.String	getHtmlForCommitsFull(ResultsSummary resultsSummary, RepositoryChangeset repositoryChangeset, RepositoryDefinition repositoryData) Deprecated. since 4.0 use getHtmlForCommitsFull(ResultsSummary, RepositoryChangeset, RepositoryData)
java.lang.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.
java.lang.String	getHtmlForCommitsSummary(ResultsSummary resultsSummary, RepositoryChangeset repositoryChangeset, RepositoryDefinition repositoryDefinition) Deprecated. since 3.4 use getHtmlForCommitsSummary(ResultsSummary, RepositoryChangeset, RepositoryData, int)
java.lang.String	getHtmlForCommitsSummary(ResultsSummary resultsSummary, RepositoryChangeset repositoryChangeset, RepositoryDefinition repositoryData, int maxChanges) Deprecated. since 4.0 use getHtmlForCommitsSummary(ResultsSummary, RepositoryChangeset, RepositoryData, int)
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

customizeBuildRequirements, removeBuildRequirements

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

addDefaultValues, 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

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

WEB_REPOSITORY

static final java.lang.String WEB_REPOSITORY

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
                                       ResultsSummary resultsSummary,
                                       @NotNull
                                       RepositoryChangeset repositoryChangeset,
                                       @NotNull
                                       RepositoryData repositoryData)

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

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

java.lang.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.

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.

getHtmlForCommitsSummary

@Deprecated
java.lang.String getHtmlForCommitsSummary(@NotNull
                                                     ResultsSummary resultsSummary,
                                                     @NotNull
                                                     RepositoryChangeset repositoryChangeset,
                                                     @NotNull
                                                     RepositoryDefinition repositoryDefinition)

Deprecated. since 3.4 use getHtmlForCommitsSummary(ResultsSummary, RepositoryChangeset, RepositoryData, int)

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

Parameters:

resultsSummary - the summary to show commits for

repositoryData - the commits belong to aka the plans repository

Returns:

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

getHtmlForCommitsFull

@Deprecated
java.lang.String getHtmlForCommitsFull(@NotNull
                                                  ResultsSummary resultsSummary,
                                                  @NotNull
                                                  RepositoryChangeset repositoryChangeset,
                                                  @NotNull
                                                  RepositoryDefinition repositoryData)

Deprecated. since 4.0 use getHtmlForCommitsFull(ResultsSummary, RepositoryChangeset, RepositoryData)

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

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

@Deprecated
java.lang.String getHtmlForCommitsSummary(@NotNull
                                                     ResultsSummary resultsSummary,
                                                     @NotNull
                                                     RepositoryChangeset repositoryChangeset,
                                                     @NotNull
                                                     RepositoryDefinition repositoryData,
                                                     int maxChanges)

Deprecated. since 4.0 use getHtmlForCommitsSummary(ResultsSummary, RepositoryChangeset, RepositoryData, int)

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

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

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