Package com.atlassian.bamboo.repository.ui

Interface EditActionAwareRepository

All Superinterfaces:

BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, ConvertibleFromConfig, DescriptionProvider, InitablePluginModule, NameProvider, RenderableBuildConfiguration, Repository, RepositoryV2, Serializable

All Known Subinterfaces:

StashRepository

All Known Implementing Classes:

BitbucketRepository, GitRepository, StashRepositoryImpl

@ExperimentalApi
public interface EditActionAwareRepository
extends Repository

Repository that needs to perform additional actions before edit page is rendered for the repository and/or if additional, possibly failing, action needs to be taken before configuration is saved.

Since:

5.4

Field Summary

Fields inherited from interface com.atlassian.bamboo.repository.Repository

SELECTED_REPOSITORY, UNKNOWN_HOST

Method Summary

Modifier and Type	Method	Description
void	beforeEditPageRendering(@NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)	Action to be taken before rendering the edit page.
ErrorCollection	beforeSave(@NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)	Action to be taken before repository is saved from the UI.

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.utils.DescriptionProvider

getDescription

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.repository.Repository

getHost, getKey, getLocationIdentifier, getMinimalEditHtml, getName, getShortKey

Methods inherited from interface com.atlassian.bamboo.v2.build.repository.RepositoryV2

collectChangesSinceLastBuild, getSourceCodeDirectory, isRepositoryDifferent

Method Details

beforeEditPageRendering

void beforeEditPageRendering(@NotNull
 @NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)

Action to be taken before rendering the edit page. Configuration can be modified by this method. Example use is verifying configuration so that proper warnings can be displayed before user takes any action.

Parameters:

configuration - configuration to be loaded into the UI

beforeSave

ErrorCollection beforeSave(@NotNull
 @NotNull org.apache.commons.configuration.HierarchicalConfiguration configuration)

Action to be taken before repository is saved from the UI. The method is called after the validate() method and only if validation is successful. If this method returns with error the configuration is not saved. Configuration can be modified by this method and the changes will be persisted.

Parameters:

configuration -

Returns:

collection of error messages. Should be empty if call is successful.