com.atlassian.bamboo.webrepository
Class AbstractWebRepositoryViewer

java.lang.Object
  com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin
      com.atlassian.bamboo.v2.build.BaseConfigurablePlugin
          com.atlassian.bamboo.webrepository.AbstractWebRepositoryViewer

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultWebRepositoryViewer, FisheyeWebRepositoryViewer, HgWebRepositoryViewer, NoWebRepositoryViewer

public abstract class AbstractWebRepositoryViewer
extends BaseConfigurablePlugin
implements WebRepositoryViewer

See Also:

Serialized Form

Field Summary

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

AbstractWebRepositoryViewer()

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	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	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	populateFromConfig(org.apache.commons.configuration.HierarchicalConfiguration config) Update the current object with data in the HierarchicalConfiguration
void	populateFromParams(ActionParametersMap params) takes the map of config data from action and extracts the parameters it needs
org.apache.commons.configuration.HierarchicalConfiguration	toConfiguration() Generate a HierarchicalConfiguration from the current state of the object

Methods inherited from class com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

customizeBuildRequirements, customizeBuildRequirements, removeBuildRequirements, removeBuildRequirements

Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

addDefaultValues, getEditHtml, getViewHtml, init, isConfigurationMissing, populateContextForEdit, populateContextForView, prepareConfigObject, setTemplateRenderer, validate

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

getHtmlForCommitsFull, getHtmlForCommitsSummary, getHtmlForCommitsSummary

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

Constructor Detail

AbstractWebRepositoryViewer

public AbstractWebRepositoryViewer()

Method Detail

getKey

@NotNull
public java.lang.String getKey()

Description copied from interface: WebRepositoryViewer

The full complete plugin key for the repository viewer

Specified by:

getKey in interface WebRepositoryViewer

Returns:

the key for the plugin

getShortKey

@NotNull
public java.lang.String getShortKey()

Description copied from interface: WebRepositoryViewer

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

Specified by:

getShortKey in interface WebRepositoryViewer

Returns:

the shorter key for this plugin.

getName

@NotNull
public java.lang.String getName()

Description copied from interface: WebRepositoryViewer

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

Specified by:

getName in interface WebRepositoryViewer

Returns:

The name of the repository viewer

getSupportedRepositories

@NotNull
public java.util.Collection<java.lang.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

Returns:

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

populateFromParams

public void populateFromParams(@NotNull
                               ActionParametersMap params)

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

Specified by:

populateFromParams in interface WebRepositoryViewer

Parameters:

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

populateFromConfig

public void populateFromConfig(@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

toConfiguration

@NotNull
public 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

Returns:

Always returns an HierarchicalConfiguration. Never null

getHtmlForCommitsFull

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