com.botronsoft.cmj.spi.configuration.global

Interface GlobalConfigurationHandler

@PublicSpi
public interface GlobalConfigurationHandler

Implement this interface to handle export/import for custom configuration which is global for the Jira instance. The implementation of this interface is responsible for serializing/deserializing global configuration data and recording references to Jira configuration elements like users, groups, custom fields, etc.

See Also:

ConfigurationReferenceCollector, ConfigurationReferenceLookup

Method Summary

Modifier and Type	Method and Description
void	deleteConfiguration() Invoked when configuration needs to be deleted.
Optional<String>	exportConfiguration(ExportContext exportContext) Invoked when a configuration is being exported.
void	importConfiguration(String configuration, ImportContext importContext) Invoked when a configuration is being imported.

Method Detail

exportConfiguration

Optional<String> exportConfiguration(ExportContext exportContext)

Invoked when a configuration is being exported. This method will be called by Configuration Manager when the app which implements it is selected for export. Implementors may return Optional.empty() if there is no configuration to be exported. Implementers may call ConfigurationReferenceCollector methods to handle references to other configuration objects.

Parameters:

exportContext - context of the export operation.

Returns:

an Optional with the exported configuration or Optional.empty() if the app does not store any global configuration.

See Also:

ExportContext

importConfiguration

void importConfiguration(String configuration,
                         ImportContext importContext)

Invoked when a configuration is being imported. Use * ImportContext.getImportMode() to distinguish between merge and restore. Implementers can call ConfigurationReferenceLookup methods to retrieve the respective matching configuration objects referred with ConfigurationReferenceCollector.

Parameters:

configuration - the configuration as serialized by exportConfiguration(ExportContext).

importContext - context of the import operation.

See Also:

ImportContext, ImportMode

deleteConfiguration

void deleteConfiguration()

Invoked when configuration needs to be deleted. This method will be called by Configuration Manager when app data is deleted - this can happen only when system snapshot is deployed in "restore" mode and the snapshot does not contain any app data.