Package org.odpi.openmetadata.frameworks.discovery

Class DiscoveryAssetStore

java.lang.Object
org.odpi.openmetadata.frameworks.discovery.DiscoveryAssetStore
public abstract class DiscoveryAssetStore extends Object
DiscoveryAssetStore defines the interface to a connector broker backed by a metadata store that returns information about the Asset that a Discovery Engine is to analyze. The userId that is passed on the call by the discovery engine.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection
    assetConnection
     
    protected String
    assetGUID
     
    protected String
    userId
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    DiscoveryAssetStore(String assetGUID, String userId)
    Constructor sets up the key parameters for accessing the asset store.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAssetGUID()
    Return the unique identifier for the asset.
    abstract org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse
    getAssetProperties()
    Returns a comprehensive collection of properties about the requested asset.
    protected abstract org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection
    getConnectionForAsset()
    Return the connection information for the asset.
    protected abstract org.odpi.openmetadata.frameworks.connectors.Connector
    getConnectorByConnection(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Returns the connector corresponding to the supplied connection.
    org.odpi.openmetadata.frameworks.connectors.Connector
    getConnectorToAsset()
    Return the connector to the requested asset.
    abstract void
    logAssetAuditMessage(String discoveryService, String message)
    Log an audit message about this asset.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • assetGUID

      protected String assetGUID

    • userId

      protected String userId

    • assetConnection

      protected org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection assetConnection

  • Constructor Details

    • DiscoveryAssetStore

      public DiscoveryAssetStore(String assetGUID, String userId)
      Constructor sets up the key parameters for accessing the asset store.
      Parameters:
      userId - calling user
      assetGUID - unique identifier of the asset that the annotations should be attached to

  • Method Details

    • getAssetGUID

      public String getAssetGUID()
      Return the unique identifier for the asset.
      Returns:
      guid

    • getConnectorByConnection

      protected abstract org.odpi.openmetadata.frameworks.connectors.Connector getConnectorByConnection(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Returns the connector corresponding to the supplied connection.
      Parameters:
      connection - the connection object that contains the properties needed to create the connection.
      Returns:
      Connector connector instance
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      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.

    • getConnectionForAsset

      protected abstract org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection getConnectionForAsset() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the connection information for the asset. This is used to create the connector. The connector is an Open Connector Framework (OCF) connector that provides access to the asset's data and metadata properties.
      Returns:
      Connection bean
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the asset guid is not recognized
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to access the asset and/or connection
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.

    • getAssetProperties

      public abstract org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse getAssetProperties() 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.
      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.

    • logAssetAuditMessage

      public abstract void logAssetAuditMessage(String discoveryService, String message) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Log an audit message about this asset.
      Parameters:
      discoveryService - name of discovery service
      message - message to log
      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() 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.
      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.