Interface WebRepositoryViewer
-
- All Superinterfaces:
BambooPluginModule
,BuildConfigurationAwarePlugin
,ConfigurablePlugin
,ConvertibleFromConfig
,InitablePluginModule
,RenderableBuildConfiguration
,Serializable
- All Known Subinterfaces:
CommitUrlProvider
,DeploymentsAwareCommitUrlProvider
- All Known Implementing Classes:
AbstractWebRepositoryViewer
,DefaultWebRepositoryViewer
,FisheyeWebRepositoryViewer
,LegacyStashWebRepositoryViewer
,NoWebRepositoryViewer
,StashWebRepositoryViewer
@Deprecated public interface WebRepositoryViewer extends ConfigurablePlugin, ConvertibleFromConfig, Serializable
Deprecated.since 5.14Module 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 implementCommitUrlProvider
-
-
Field Summary
Fields Modifier and Type Field Description static String
SELECTED_WEB_REPOSITORY_VIEWER
Deprecated.Constant for fetching out the selected web repository viewer key from aBuildConfiguration
static String
WEB_REPOSITORY
Deprecated.
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description String
getHtmlForCommitsFull(@NotNull ResultsSummary resultsSummary, @NotNull RepositoryChangeset repositoryChangeset, @NotNull RepositoryData repositoryData)
Deprecated.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)
Deprecated.Renders the html to display a summary of the commits on the Build Results Summary tab.@NotNull String
getKey()
Deprecated.The full complete plugin key for the repository viewer@NotNull String
getName()
Deprecated.The name of the web repository viewer, as displayed in the UI.@NotNull String
getShortKey()
Deprecated.The shorter version fo the plugin key (without prefix and should not contain any ':')@NotNull Collection<String>
getSupportedRepositories()
Deprecated.The keys for theRepository
classes that the web viewer currently supports.void
populateFromParams(@NotNull ActionParametersMap params)
Deprecated.takes the map of config data from action and extracts the parameters it needs-
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.fieldvalue.ConvertibleFromConfig
populateFromConfig, toConfiguration
-
Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule
init
-
Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration
getEditHtml, getViewHtml
-
-
-
-
Field Detail
-
SELECTED_WEB_REPOSITORY_VIEWER
static final String SELECTED_WEB_REPOSITORY_VIEWER
Deprecated.Constant for fetching out the selected web repository viewer key from aBuildConfiguration
- See Also:
- Constant Field Values
-
WEB_REPOSITORY
static final String WEB_REPOSITORY
Deprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
getKey
@NotNull @NotNull String getKey()
Deprecated.The full complete plugin key for the repository viewer- Returns:
- the key for the plugin
-
getShortKey
@NotNull @NotNull String getShortKey()
Deprecated.The shorter version fo the plugin key (without prefix and should not contain any ':')- Returns:
- the shorter key for this plugin.
-
getName
@NotNull @NotNull String getName()
Deprecated.The name of the web repository viewer, as displayed in the UI.- Returns:
- The name of the repository viewer
-
getSupportedRepositories
@NotNull @NotNull Collection<String> getSupportedRepositories()
Deprecated.The keys for theRepository
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
String getHtmlForCommitsFull(@NotNull @NotNull ResultsSummary resultsSummary, @NotNull @NotNull RepositoryChangeset repositoryChangeset, @NotNull @NotNull RepositoryData repositoryData)
Deprecated.Renders the html to display the full commits on the changes tab.- Parameters:
resultsSummary
- the summary to show commits forrepositoryData
- the commits belong to aka the plans repository- Returns:
- Html to be displayed on the UI in the Changes Tab.
-
getHtmlForCommitsSummary
String getHtmlForCommitsSummary(@NotNull @NotNull ResultsSummary resultsSummary, @NotNull @NotNull RepositoryChangeset repositoryChangeset, @NotNull @NotNull RepositoryData repositoryData, int maxChanges)
Deprecated.Renders the html to display a summary of the commits on the Build Results Summary tab.- Parameters:
resultsSummary
- the summary to show commits forrepositoryData
- the commits belong to aka the plans repositorymaxChanges
- 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 @NotNull ActionParametersMap params)
Deprecated.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
-
-