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 and Description
protected Connection	assetConnection
protected String	assetGUID
protected String	userId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAssetGUID() Return the unique identifier for the asset.
abstract AssetUniverse	getAssetProperties() Returns a comprehensive collection of properties about the requested asset.
protected abstract Connection	getConnectionForAsset() Return the connection information for the asset.
protected abstract Connector	getConnectorByConnection(Connection connection) Returns the connector corresponding to the supplied connection.
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 Detail

assetGUID

protected String assetGUID

userId

protected String userId

assetConnection

protected Connection assetConnection

Constructor Detail

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 Detail

getAssetGUID

public String getAssetGUID()

Return the unique identifier for the asset.

Returns:

guid

getConnectorByConnection

protected abstract Connector getConnectorByConnection(Connection connection)
                                               throws InvalidParameterException,
                                                      ConnectionCheckedException,
                                                      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:

InvalidParameterException - one of the parameters is null or invalid.

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

getConnectionForAsset

protected abstract Connection getConnectionForAsset()
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    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:

InvalidParameterException - the asset guid is not recognized

UserNotAuthorizedException - the user is not authorized to access the asset and/or connection

PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.

getAssetProperties

public abstract AssetUniverse getAssetProperties()
                                          throws InvalidParameterException,
                                                 PropertyServerException,
                                                 UserNotAuthorizedException

Returns a comprehensive collection of properties about the requested asset.

Returns:

a comprehensive collection of properties about the asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

logAssetAuditMessage

public abstract void logAssetAuditMessage(String discoveryService,
                                          String message)
                                   throws InvalidParameterException,
                                          PropertyServerException,
                                          UserNotAuthorizedException

Log an audit message about this asset.

Parameters:

discoveryService - name of discovery service

message - message to log

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving the asset properties from the property servers).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getConnectorToAsset

public Connector getConnectorToAsset()
                              throws InvalidParameterException,
                                     ConnectionCheckedException,
                                     ConnectorCheckedException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Return the connector to the requested asset.

Returns:

Open Connector Framework (OCF) connector

Throws:

InvalidParameterException - the asset guid is not recognized or the userId is null

ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.

ConnectorCheckedException - there are errors in the initialization of the connector.

UserNotAuthorizedException - the user is not authorized to access the asset and/or connection needed to create the connector.

PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.