Interface AssetManagerInterface

  • All Known Implementing Classes:
    ExternalAssetManagerClient

    public interface AssetManagerInterface
    AssetManagerInterface provides the interface for retrieving the identity of an external asset manager. The definition of the external asset manager may also be created using the IT Infrastructure OMAS.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addExternalIdentifier​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String openMetadataElementGUID, java.lang.String openMetadataElementTypeName, ExternalIdentifierProperties externalIdentifierProperties)
      Add a new external identifier to an existing open metadata element.
      void confirmSynchronization​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String openMetadataElementGUID, java.lang.String openMetadataElementTypeName, java.lang.String externalIdentifier)
      Confirm that the values of a particular metadata element have been synchronized.
      java.lang.String createExternalAssetManager​(java.lang.String userId, AssetManagerProperties assetManagerProperties)
      Create information about the external asset manager.
      java.util.List<ElementHeader> getElementsForExternalIdentifier​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String externalIdentifier, int startFrom, int pageSize)
      Return the list of headers for open metadata elements that are associated with a particular external identifier.
      java.lang.String getExternalAssetManagerGUID​(java.lang.String userId, java.lang.String qualifiedName)
      Retrieve the unique identifier of the external asset manager from its qualified name.
      void removeExternalIdentifier​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String openMetadataElementGUID, java.lang.String openMetadataElementTypeName, java.lang.String externalIdentifier)
      Remove an external identifier from an existing open metadata element.
      void updateExternalIdentifier​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String openMetadataElementGUID, java.lang.String openMetadataElementTypeName, ExternalIdentifierProperties externalIdentifierProperties)
      Update the description of a specific external identifier.
    • Method Detail

      • createExternalAssetManager

        java.lang.String createExternalAssetManager​(java.lang.String userId,
                                                    AssetManagerProperties assetManagerProperties)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
        Create information about the external asset manager. This is represented as a software capability and all information that is specific to the external asset manager (such as the identifiers of the metadata elements it stores) will be linked to it.
        Parameters:
        userId - calling user
        assetManagerProperties - description of the integration daemon (specify qualified name at a minimum)
        Returns:
        unique identifier of the asset management's software capability
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - user not authorized to issue this request
        PropertyServerException - problem accessing the property server
      • getExternalAssetManagerGUID

        java.lang.String getExternalAssetManagerGUID​(java.lang.String userId,
                                                     java.lang.String qualifiedName)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException
        Retrieve the unique identifier of the external asset manager from its qualified name. Typically the qualified name comes from the integration connector configuration.
        Parameters:
        userId - calling user
        qualifiedName - unique name to use for the external asset
        Returns:
        unique identifier of the external asset manager's software capability
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - user not authorized to issue this request
        PropertyServerException - problem accessing the property server
      • addExternalIdentifier

        void addExternalIdentifier​(java.lang.String userId,
                                   java.lang.String assetManagerGUID,
                                   java.lang.String assetManagerName,
                                   java.lang.String openMetadataElementGUID,
                                   java.lang.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​(java.lang.String userId,
                                      java.lang.String assetManagerGUID,
                                      java.lang.String assetManagerName,
                                      java.lang.String openMetadataElementGUID,
                                      java.lang.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​(java.lang.String userId,
                                      java.lang.String assetManagerGUID,
                                      java.lang.String assetManagerName,
                                      java.lang.String openMetadataElementGUID,
                                      java.lang.String openMetadataElementTypeName,
                                      java.lang.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​(java.lang.String userId,
                                    java.lang.String assetManagerGUID,
                                    java.lang.String assetManagerName,
                                    java.lang.String openMetadataElementGUID,
                                    java.lang.String openMetadataElementTypeName,
                                    java.lang.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

        java.util.List<ElementHeader> getElementsForExternalIdentifier​(java.lang.String userId,
                                                                       java.lang.String assetManagerGUID,
                                                                       java.lang.String assetManagerName,
                                                                       java.lang.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