@PublicSpi public interface ProjectConfigurationHandler
Project
.
The implementation of this interface is responsible for serializing/deserializing project configuration data and recording references to
Jira configuration elements like users, groups, custom fields, etc.Modifier and Type | Method and Description |
---|---|
void |
deleteConfiguration(com.atlassian.jira.project.Project project)
Invoked when configuration needs to be deleted.
|
Optional<String> |
exportConfiguration(com.atlassian.jira.project.Project project,
ExportContext exportContext)
Invoked when a configuration is being exported.
|
void |
importConfiguration(String configuration,
com.atlassian.jira.project.Project project,
ImportContext importContext)
Invoked when a configuration is being imported.
|
Optional<String> exportConfiguration(com.atlassian.jira.project.Project project, ExportContext exportContext)
Optional.empty()
if there is no configuration to be exported for this particular project.
Implementers may call ConfigurationReferenceCollector
methods to handle references to
other configuration objects.project
- the currently exported Project
.exportContext
- context of the export operation.Optional
with the exported configuration or Optional.empty()
if the app does not store any configuration for
this project.ExportContext
void importConfiguration(String configuration, com.atlassian.jira.project.Project project, ImportContext importContext)
ImportContext.getImportMode()
to distinguish between merge and restore.
Implementers can call ConfigurationReferenceLookup
methods to retrieve the respective
matching configuration objects referred with ConfigurationReferenceCollector
.configuration
- the configuration as serialized by exportConfiguration(Project, ExportContext)
.project
- the currently imported Project
instance.importContext
- context of the import operation.ImportContext
,
ImportMode
void deleteConfiguration(com.atlassian.jira.project.Project project)
project
- the deleted Project
instance.Copyright © 2022. All rights reserved.