com.botronsoft.cmj.spi.configuration

Interface AppMappingContext

@PublicApi
public interface AppMappingContext

Interface that allows SPI implementations to record and lookup source to target id mappings of app configuration objects during import. If an SPI handler creates a new configuration object during import, it can record the mapping between the old id on the source system and the new id on the target system so that other SPI handlers of the same app can use this mapping to replace id references in the configuration or issue data they import. An example would be a ProjectConfigurationHandler which imports some objects that are later referenced by data imported in an IssueDataHandler.

Method Summary

Modifier and Type	Method and Description
Optional<Long>	lookupMapping(String type, Long sourceId) Returns an Optional of the target id of an app specific object if such mapping was previously recorded or an empty Optional otherwise.
Optional<String>	lookupMapping(String type, String sourceId) Returns an Optional of the target id of an app specific object if such mapping was previously recorded or an empty Optional otherwise.
void	recordMapping(String type, Long sourceId, Long targetId) Records a mapping between source and target id for objects of the given type.
void	recordMapping(String type, String sourceId, String targetId) Records a mapping between source and target id for objects of the given type.

Method Detail

recordMapping

void recordMapping(String type,
                   String sourceId,
                   String targetId)

Records a mapping between source and target id for objects of the given type. Both source id and target id are of type String.

Parameters:

type - the type of the object - this is provided by the app handlers and represents a category of configuration objects, the same type must be used for lookup.

sourceId - the source id of the object.

targetId - the target id of the object.

recordMapping

void recordMapping(String type,
                   Long sourceId,
                   Long targetId)

Records a mapping between source and target id for objects of the given type. Both source id and target id are of type Long.

Parameters:

type - the type of the object - this is provided by the app handlers and represents a category of configuration objects, the same * type must be used for lookup.

sourceId - the source id of the object.

targetId - the target id of the object.

lookupMapping

Optional<String> lookupMapping(String type,
                               String sourceId)

Returns an Optional of the target id of an app specific object if such mapping was previously recorded or an empty Optional otherwise.

Parameters:

type - the type of the object - this is provided by the app handlers and represents a category of configuration objects, the same type must be used when recording the mapping.

sourceId - the source id of the object.

Returns:

an Optional of the target id of an app specific object if such mapping was previously recorded or an empty Optional otherwise.

lookupMapping

Optional<Long> lookupMapping(String type,
                             Long sourceId)

Returns an Optional of the target id of an app specific object if such mapping was previously recorded or an empty Optional otherwise.

Parameters:

type - the type of the object - this is provided by the app handlers and represents a category of configuration objects, the same type must be used when recording the mapping.

sourceId - the source id of the object.

Returns:

an Optional of the target id of an app specific object if such mapping was previously recorded or an empty Optional otherwise.