Package org.odpi.openmetadata.frameworks.integration.context

Class ConnectedAssetContext

java.lang.Object
org.odpi.openmetadata.frameworks.integration.context.ConnectedAssetContext
public class ConnectedAssetContext extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConnectedAssetContext(String userId, OpenIntegrationClient openIntegrationClient)
    Constructor sets up the key parameters for accessing the asset store.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse
    getAssetProperties(String assetGUID)
    Returns a comprehensive collection of properties about the requested asset.
    org.odpi.openmetadata.frameworks.connectors.Connector
    getConnectorToAsset(String assetGUID, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Return the connector to the requested asset.
    String
    saveConnection(String assetGUID, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Returns the unique identifier corresponding to the supplied connection.
    String
    saveConnection(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Returns the unique identifier corresponding to the supplied connection.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConnectedAssetContext

      public ConnectedAssetContext(String userId, OpenIntegrationClient openIntegrationClient)
      Constructor sets up the key parameters for accessing the asset store.
      Parameters:
      userId - calling user
      openIntegrationClient - client to make the calls

  • Method Details

    • saveConnection

      public String saveConnection(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Returns the unique identifier corresponding to the supplied connection.
      Parameters:
      connection - the connection object that contains the properties needed to create the connection.
      Returns:
      guid
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving the asset properties from the property servers.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.

    • saveConnection

      public String saveConnection(String assetGUID, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Returns the unique identifier corresponding to the supplied connection.
      Parameters:
      assetGUID - the unique identifier of an asset to attach the connection to
      connection - the connection object that contains the properties needed to create the connection.
      Returns:
      guid
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving the asset properties from the property servers.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.

    • getAssetProperties

      public org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse getAssetProperties(String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Returns a comprehensive collection of properties about the requested asset.
      Parameters:
      assetGUID - the unique identifier of an asset to attach the connection to
      Returns:
      a comprehensive collection of properties about the asset.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving the asset properties from the property servers.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getConnectorToAsset

      public org.odpi.openmetadata.frameworks.connectors.Connector getConnectorToAsset(String assetGUID, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the connector to the requested asset.
      Parameters:
      assetGUID - the unique identifier of an asset to attach the connection to
      auditLog - optional logging destination
      Returns:
      Open Connector Framework (OCF) connector
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the asset guid is not recognized or the userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to access the asset and/or connection needed to create the connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.