public abstract class AbstractArtifactHandlerConfigurator extends Object implements ArtifactHandlerConfigurator
Modifier and Type | Field and Description |
---|---|
static String |
NON_SHARED_ARTIFACT_OPTION_NAME |
static String |
SHARED_ARTIFACT_OPTION_NAME |
Constructor and Description |
---|
AbstractArtifactHandlerConfigurator() |
Modifier and Type | Method and Description |
---|---|
MessageCollection |
beforeSave(Map<String,String> artifactHandlersConfigurationBeforeSave,
Map<String,String> existingArtifactHandlersConfiguration)
Pre save action handler, allows to gather feedback from configurator before artifact handler configuration saving.
|
void |
decorateConfigurationForRuntime(Map<String,String> artifactHandlersConfiguration)
Decorate artifact handlers configuration for runtime.
|
Map<String,String> |
getArtifactHandlerConfiguration(Map<String,String> configuration)
Filter out configuration of the artifact handler from the given map.
|
protected String |
getConfigurationKey(String key) |
Map<String,String> |
getEncryptedArtifactHandlerConfiguration(Map<String,String> configuration)
Filter out configuration of the artifact handler from the given map and encrypt sensitive field values.
|
void |
init(ArtifactHandlerModuleDescriptor moduleDescriptor)
Initialises the Plugin with the plugin module descriptor
|
boolean |
isConfigurationComplete(Map<String,String> configuration)
Validate if configuration of the artifact handler is complete
|
void |
populateContextForEdit(Map<String,Object> context) |
void |
postProcessConfiguration(ActionParametersMap actionParametersMap)
Any configuration adjustments that need to happen before configuration is saved should be done here.
|
void |
validateConfiguration(Map<String,String> newArtifactHandlersConfiguration,
Map<String,String> oldArtifactHandlersConfiguration,
ErrorCollection errorCollection)
Validate configuration.
|
public static final String SHARED_ARTIFACT_OPTION_NAME
public static final String NON_SHARED_ARTIFACT_OPTION_NAME
public void init(@NotNull ArtifactHandlerModuleDescriptor moduleDescriptor)
InitablePluginModule
init
in interface InitablePluginModule<ArtifactHandlerModuleDescriptor>
moduleDescriptor
- Plugin module descriptorpublic void postProcessConfiguration(ActionParametersMap actionParametersMap)
ArtifactHandlerConfigurator
postProcessConfiguration
in interface ArtifactHandlerConfigurator
public void populateContextForEdit(@NotNull Map<String,Object> context)
populateContextForEdit
in interface ArtifactHandlerConfigurator
public void decorateConfigurationForRuntime(@NotNull Map<String,String> artifactHandlersConfiguration)
ArtifactHandlerConfigurator
decorateConfigurationForRuntime
in interface ArtifactHandlerConfigurator
artifactHandlersConfiguration
- artifact handlers configuration mappublic void validateConfiguration(@NotNull Map<String,String> newArtifactHandlersConfiguration, @NotNull Map<String,String> oldArtifactHandlersConfiguration, @NotNull ErrorCollection errorCollection)
ArtifactHandlerConfigurator
validateConfiguration
in interface ArtifactHandlerConfigurator
newArtifactHandlersConfiguration
- new configuration to be validatedoldArtifactHandlersConfiguration
- existing configurationerrorCollection
- error collection to be set on validation failurepublic boolean isConfigurationComplete(@NotNull Map<String,String> configuration)
ArtifactHandlerConfigurator
isConfigurationComplete
in interface ArtifactHandlerConfigurator
configuration
- configuration to be validatedpublic Map<String,String> getEncryptedArtifactHandlerConfiguration(@NotNull Map<String,String> configuration)
ArtifactHandlerConfigurator
getEncryptedArtifactHandlerConfiguration
in interface ArtifactHandlerConfigurator
public Map<String,String> getArtifactHandlerConfiguration(@NotNull Map<String,String> configuration)
ArtifactHandlerConfigurator
getArtifactHandlerConfiguration
in interface ArtifactHandlerConfigurator
public MessageCollection beforeSave(Map<String,String> artifactHandlersConfigurationBeforeSave, Map<String,String> existingArtifactHandlersConfiguration)
ArtifactHandlerConfigurator
beforeSave
in interface ArtifactHandlerConfigurator
artifactHandlersConfigurationBeforeSave
- updated configurationexistingArtifactHandlersConfiguration
- existing configurationCopyright © 2019 Atlassian Software Systems Pty Ltd. All rights reserved.