Package org.odpi.openmetadata.accessservices.assetmanager.api

Interface ExternalIdentifierManagerInterface

All Known Implementing Classes:

AssetManagerBaseClient, CollaborationExchangeClient, ConnectionExchangeClient, DataAssetExchangeClient, ExchangeClientBase, ExternalAssetManagerClient, ExternalReferenceExchangeClient, GlossaryExchangeClient, GovernanceExchangeClient, InfrastructureExchangeClient, LineageExchangeClient, SchemaExchangeClientBase, StewardshipExchangeClient, ValidValuesExchangeClient

public interface ExternalIdentifierManagerInterface

ExternalIdentifierManagerInterface provides the interface for managing external identifiers.

Method Summary

Modifier and Type	Method	Description
void	addExternalIdentifier(String userId, String assetManagerGUID, String assetManagerName, String openMetadataElementGUID, String openMetadataElementTypeName, ExternalIdentifierProperties externalIdentifierProperties)	Add a new external identifier to an existing open metadata element.
void	confirmSynchronization(String userId, String assetManagerGUID, String assetManagerName, String openMetadataElementGUID, String openMetadataElementTypeName, String externalIdentifier)	Confirm that the values of a particular metadata element have been synchronized.
List<ElementHeader>	getElementsForExternalIdentifier(String userId, String assetManagerGUID, String assetManagerName, String externalIdentifier, int startFrom, int pageSize)	Return the list of headers for open metadata elements that are associated with a particular external identifier.
void	removeExternalIdentifier(String userId, String assetManagerGUID, String assetManagerName, String openMetadataElementGUID, String openMetadataElementTypeName, String externalIdentifier)	Remove an external identifier from an existing open metadata element.
void	updateExternalIdentifier(String userId, String assetManagerGUID, String assetManagerName, String openMetadataElementGUID, String openMetadataElementTypeName, ExternalIdentifierProperties externalIdentifierProperties)	Update the description of a specific external identifier.

Method Details

addExternalIdentifier

void addExternalIdentifier(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String openMetadataElementGUID,
 String openMetadataElementTypeName,
 ExternalIdentifierProperties externalIdentifierProperties)
                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add a new external identifier to an existing open metadata element.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem

openMetadataElementTypeName - type name for the open metadata element

externalIdentifierProperties - optional properties used to define an external identifier

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

updateExternalIdentifier

void updateExternalIdentifier(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String openMetadataElementGUID,
 String openMetadataElementTypeName,
 ExternalIdentifierProperties externalIdentifierProperties)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the description of a specific external identifier.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalIdentifierProperties - optional properties used to define an external identifier

openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem

openMetadataElementTypeName - type name for the open metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

removeExternalIdentifier

void removeExternalIdentifier(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String openMetadataElementGUID,
 String openMetadataElementTypeName,
 String externalIdentifier)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove an external identifier from an existing open metadata element. The open metadata element is not affected.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem

openMetadataElementTypeName - type name for the open metadata element

externalIdentifier - unique identifier of this element in the third party asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

confirmSynchronization

void confirmSynchronization(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String openMetadataElementGUID,
 String openMetadataElementTypeName,
 String externalIdentifier)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Confirm that the values of a particular metadata element have been synchronized. This is important from an audit point of view, and to allow bidirectional updates of metadata using optimistic locking.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

openMetadataElementGUID - unique identifier (GUID) of this element in open metadata

openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)

externalIdentifier - unique identifier of this element in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getElementsForExternalIdentifier

List<ElementHeader> getElementsForExternalIdentifier(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String externalIdentifier,
 int startFrom,
 int pageSize)
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of headers for open metadata elements that are associated with a particular external identifier.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalIdentifier - unique identifier of this element in the external asset manager

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of element headers

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server