Package 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, Serializable

Direct Known Subclasses:

DefaultWebRepositoryViewer, FisheyeWebRepositoryViewer, LegacyStashWebRepositoryViewer, NoWebRepositoryViewer, StashWebRepositoryViewer

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

Constructors

Constructor	Description
AbstractWebRepositoryViewer()

Method Summary

Modifier and Type	Method	Description
@NotNull String	getKey()	The full complete plugin key for the repository viewer
@NotNull String	getName()	The name of the web repository viewer, as displayed in the UI.
@NotNull String	getShortKey()	The shorter version fo the plugin key (without prefix and should not contain any ':')
@NotNull Collection<String>	getSupportedRepositories()	The keys for the Repository classes that the web viewer currently supports.
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
@NotNull 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, removeBuildRequirements

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

addDefaultValues, getEditHtml, getTemplateRenderer, getViewHtml, init, 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.v2.build.BuildConfigurationAwarePlugin

addDefaultValues, isConfigurationMissing, prepareConfigObject, validate

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

getHtmlForCommitsFull, getHtmlForCommitsSummary

Constructor Detail

AbstractWebRepositoryViewer

public AbstractWebRepositoryViewer()

Method Detail

getKey

@NotNull
public @NotNull 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 @NotNull String getShortKey()

Description copied from interface: WebRepositoryViewer

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

Specified by:

getShortKey in interface WebRepositoryViewer

Returns:

the shorter key for this plugin.

getName

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

Returns:

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

populateFromParams

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

Returns:

Always returns an HierarchicalConfiguration. Never null