com.botronsoft.cmj.spi.configuration.field

Interface CustomFieldConfigurationHandler

@PublicSpi
public interface CustomFieldConfigurationHandler

Implement this interface to handle export/import for custom configuration data used by a CustomField. The implementation of this interface is responsible for serializing/deserializing custom field configuration data and recording references to Jira configuration elements like workflows, users, groups, other custom fields, etc.

See Also:

ConfigurationReferenceCollector, ConfigurationReferenceLookup

Method Summary

Modifier and Type	Method and Description
void	deleteConfiguration(com.atlassian.jira.issue.fields.config.FieldConfigScheme customFieldContext) Invoked when configuration needs to be deleted.
String	exportConfiguration(com.atlassian.jira.issue.fields.config.FieldConfigScheme customFieldContext, ExportContext exportContext) Invoked when a configuration is being exported.
void	importConfiguration(String configuration, com.atlassian.jira.issue.fields.config.FieldConfigScheme customFieldContext, ImportContext importContext) Invoked when a configuration is being imported.

Method Detail

exportConfiguration

String exportConfiguration(com.atlassian.jira.issue.fields.config.FieldConfigScheme customFieldContext,
                           ExportContext exportContext)

Invoked when a configuration is being exported. This method will be called by Configuration Manager for each context of the currently exported field. Implementers may call ConfigurationReferenceCollector methods to handle references to other configuration objects.

Parameters:

customFieldContext - the currently exported FieldConfigScheme.

exportContext - context of the export operation.

Returns:

the exported configuration serialized as a string.

See Also:

ExportContext

importConfiguration

void importConfiguration(String configuration,
                         com.atlassian.jira.issue.fields.config.FieldConfigScheme customFieldContext,
                         ImportContext importContext)

Invoked when a configuration is being imported. This method will be called by Configuration Manager for each context of the currently imported field. Implementers can call ConfigurationReferenceLookup methods to retrieve the respective matching configuration objects referred with ConfigurationReferenceCollector.

Parameters:

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

customFieldContext - the currently imported FieldConfigScheme instance.

importContext - context of the import operation.

See Also:

ImportContext

deleteConfiguration

void deleteConfiguration(com.atlassian.jira.issue.fields.config.FieldConfigScheme customFieldContext)

Invoked when configuration needs to be deleted. This method will be called by Configuration Manager when a custom field context is deleted so any configuration stored by the app and associated with this context can also be deleted.

Parameters:

customFieldContext - the deleted FieldConfigScheme instance.