Interface ExternalIdentifiersInterface
- All Known Implementing Classes:
OpenMetadataClient
,OpenMetadataClientBase
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreClient
,OpenMetadataStoreHandler
public interface ExternalIdentifiersInterface
ExternalIdentifiersInterface provides the interface for managing external identifiers.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.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.getMetadataCorrelationHeaders
(String userId, String externalScopeGUID, String externalScopeName, String openMetadataElementGUID, String openMetadataElementTypeName) Assemble the correlation headers attached to the supplied element guid.getVendorProperties
(String userId, String openMetadataElementGUID, String openMetadataElementTypeName) Return the vendor properties associated with an element.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.void
validateExternalIdentifier
(String userId, String externalScopeGUID, String externalScopeName, String openMetadataElementGUID, String openMetadataElementTypeName, String elementExternalIdentifier) Check that the supplied external identifier matches the element GUID.
-
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 userassetManagerGUID
- unique identifier of software capability representing the callerassetManagerName
- unique name of software capability representing the calleropenMetadataElementGUID
- unique identifier (GUID) of the element in the open metadata ecosystemopenMetadataElementTypeName
- type name for the open metadata elementexternalIdentifierProperties
- optional properties used to define an external identifier- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userassetManagerGUID
- unique identifier of software capability representing the callerassetManagerName
- unique name of software capability representing the callerexternalIdentifierProperties
- optional properties used to define an external identifieropenMetadataElementGUID
- unique identifier (GUID) of the element in the open metadata ecosystemopenMetadataElementTypeName
- type name for the open metadata element- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userassetManagerGUID
- unique identifier of software capability representing the callerassetManagerName
- unique name of software capability representing the calleropenMetadataElementGUID
- unique identifier (GUID) of the element in the open metadata ecosystemopenMetadataElementTypeName
- type name for the open metadata elementexternalIdentifier
- unique identifier of this element in the third party asset manager- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userassetManagerGUID
- unique identifier of software capability representing the callerassetManagerName
- unique name of software capability representing the calleropenMetadataElementGUID
- unique identifier (GUID) of this element in open metadataopenMetadataElementTypeName
- 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 invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- 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 userassetManagerGUID
- unique identifier of software capability representing the callerassetManagerName
- unique name of software capability representing the callerexternalIdentifier
- unique identifier of this element in the external asset managerstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of element headers
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
validateExternalIdentifier
void validateExternalIdentifier(String userId, String externalScopeGUID, String externalScopeName, String openMetadataElementGUID, String openMetadataElementTypeName, String elementExternalIdentifier) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Check that the supplied external identifier matches the element GUID.- Parameters:
userId
- calling userexternalScopeGUID
- unique identifier of software server capability representing the callerexternalScopeName
- unique name of software server capability representing the calleropenMetadataElementGUID
- element guid used for the lookupopenMetadataElementTypeName
- type name for the open metadata elementelementExternalIdentifier
- external identifier value- Throws:
InvalidParameterException
- one of the parameters is invalid.UserNotAuthorizedException
- the user is not authorized to make this request.PropertyServerException
- the repository is not available or not working properly.
-
getMetadataCorrelationHeaders
List<MetadataCorrelationHeader> getMetadataCorrelationHeaders(String userId, String externalScopeGUID, String externalScopeName, String openMetadataElementGUID, String openMetadataElementTypeName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Assemble the correlation headers attached to the supplied element guid. This includes the external identifiers plus information on the scope and usage.- Parameters:
userId
- calling userexternalScopeGUID
- unique identifier of software server capability representing the callerexternalScopeName
- unique name of software server capability representing the calleropenMetadataElementGUID
- unique identifier (GUID) of this element in open metadataopenMetadataElementTypeName
- type name for the open metadata element- Returns:
- list of correlation headers (note if asset manager identifiers are present, only the matching correlation header is returned)
- Throws:
InvalidParameterException
- one of the parameters is invalid.UserNotAuthorizedException
- the user is not authorized to make this request.PropertyServerException
- the repository is not available or not working properly.
-
getVendorProperties
Map<String,Map<String, getVendorPropertiesString>> (String userId, String openMetadataElementGUID, String openMetadataElementTypeName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return the vendor properties associated with an element. The inner map holds the specific properties for each vendor. The outer maps the vendor identifier to the properties.- Parameters:
userId
- calling useropenMetadataElementGUID
- unique identifier (GUID) of this element in open metadataopenMetadataElementTypeName
- type name for the open metadata element- Returns:
- map of vendor properties
- Throws:
InvalidParameterException
- one of the parameters is invalid.UserNotAuthorizedException
- the user is not authorized to make this request.PropertyServerException
- the repository is not available or not working properly.
-