Package org.odpi.openmetadata.frameworkservices.omf.server

Class ExternalIdentifierRESTServices

java.lang.Object
org.odpi.openmetadata.frameworkservices.omf.server.ExternalIdentifierRESTServices
public class ExternalIdentifierRESTServices extends Object
The ExternalIdentifierRESTServices provides the server-side implementation of the services that are generic for all types of asset managers.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExternalIdentifierRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
    Add the description of a specific external identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    confirmSynchronization(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationProperties requestBody)
    Confirm that the values of a particular metadata element have been synchronized.
    org.odpi.openmetadata.commonservices.ffdc.rest.ElementHeadersResponse
    getElementsForExternalIdentifier(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
    Retrieve the unique identifier of the external asset manager from its qualified name.
    org.odpi.openmetadata.frameworkservices.omf.rest.MetadataCorrelationHeadersResponse
    getExternalIdentifiers(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the external identifiers for a particular metadata element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
    Remove an external identifier from an existing open metadata element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeExternalScope(String serverName, String serviceURLMarker, String userId, String externalScopeGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody requestBody)
    Remove the scope associated with a collection of external identifiers.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
    Update the description of a specific external identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse
    validateExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
    That the external identifier matches the open metadata GUID.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ExternalIdentifierRESTServices

      public ExternalIdentifierRESTServices()
      Default constructor

  • Method Details

    • addExternalIdentifier

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
      Add the description of a specific external identifier.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • updateExternalIdentifier

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
      Update the description of a specific external identifier.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • validateExternalIdentifier

      public org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse validateExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
      That the external identifier matches the open metadata GUID.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • removeExternalIdentifier

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeExternalIdentifier(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
      Remove an external identifier from an existing open metadata element. The open metadata element is not affected.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      openMetadataElementGUID - unique identifier (GUID) of the element in the open metadata ecosystem
      openMetadataElementTypeName - type name of the element in the open metadata ecosystem (default referenceable)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • removeExternalScope

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeExternalScope(String serverName, String serviceURLMarker, String userId, String externalScopeGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody requestBody)
      Remove the scope associated with a collection of external identifiers. All associated external identifiers are removed too. The linked open metadata elements are not affected.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      externalScopeGUID - unique identifier (GUID) of the scope element in the open metadata ecosystem
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifier of this element in the external asset manager plus additional mapping properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • confirmSynchronization

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse confirmSynchronization(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, org.odpi.openmetadata.frameworks.openmetadata.properties.MetadataCorrelationProperties requestBody)
      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:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      openMetadataElementGUID - unique identifier (GUID) of this element in open metadata
      openMetadataElementTypeName - type name for the open metadata element
      requestBody - details of the external identifier and its scope
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • getExternalIdentifiers

      public org.odpi.openmetadata.frameworkservices.omf.rest.MetadataCorrelationHeadersResponse getExternalIdentifiers(String serverName, String serviceURLMarker, String userId, String openMetadataElementGUID, String openMetadataElementTypeName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the external identifiers for a particular metadata element.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      openMetadataElementGUID - unique identifier (GUID) of this element in open metadata
      openMetadataElementTypeName - type name for the open metadata element
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - details of the external identifier and its scope
      Returns:
      list of correlation header elements, null if null or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

    • getElementsForExternalIdentifier

      public org.odpi.openmetadata.commonservices.ffdc.rest.ElementHeadersResponse getElementsForExternalIdentifier(String serverName, String serviceURLMarker, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworkservices.omf.rest.UpdateMetadataCorrelatorsRequestBody requestBody)
      Retrieve the unique identifier of the external asset manager from its qualified name. Typically, the qualified name comes from the integration connector configuration.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - details of the external identifier
      Returns:
      list of linked elements, null if null or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server