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

Interface ExternalAssetManagerInterface

public interface ExternalAssetManagerInterface
ExternalAssetManagerInterface 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

    Modifier and Type
    Method
    Description
    String
    createExternalAssetManager(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.softwarecapabilities.AssetManagerProperties assetManagerProperties)
    Create information about the external asset manager.
    String
    getExternalAssetManagerGUID(String userId, String qualifiedName)
    Retrieve the unique identifier of the external asset manager from its qualified name.

  • Method Details

    • createExternalAssetManager

      String createExternalAssetManager(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.softwarecapabilities.AssetManagerProperties assetManagerProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • getExternalAssetManagerGUID

      String getExternalAssetManagerGUID(String userId, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server