Package org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client

Class ConnectedAssetClientBase

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

All Implemented Interfaces:

ConnectorFactoryInterface

public class ConnectedAssetClientBase
extends Object
implements ConnectorFactoryInterface

ConnectedAssetClientBase provides a base calls for clients that support an OCF interface. In particular, it manages the retrieval of connections for assets, and the creation of connectors.

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditLog	auditLog
protected InvalidParameterHandler	invalidParameterHandler
protected static NullRequestBody	nullRequestBody
protected String	serverName
protected String	serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
ConnectedAssetClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker)	Create a new client with no authentication embedded in the HTTP request.
ConnectedAssetClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, int maxPageSize, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.
ConnectedAssetClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
ConnectedAssetClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
ConnectedAssetClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
protected String	getAssetForConnection(OCFRESTClient restClient, String serviceName, String userId, String connectionGUID)	Returns the unique identifier for the asset connected to the requested connection.
protected AssetUniverse	getAssetProperties(String serviceName, String userId, String assetGUID)	Returns a comprehensive collection of properties about the requested asset.
protected Asset	getAssetSummary(String userId, String guid, String methodName)	Return the basic properties of an asset.
protected Connection	getConnectionByGUID(OCFRESTClient restClient, String serviceName, String userId, String guid)	Returns the connection corresponding to the supplied connection GUID.
protected Connection	getConnectionByName(OCFRESTClient restClient, String serviceName, String userId, String name)	Returns the connection object corresponding to the supplied connection name.
protected Connection	getConnectionForAsset(OCFRESTClient restClient, String serviceName, String userId, String assetGUID)	Returns the connection corresponding to the supplied asset GUID.
Connector	getConnectorByConnection(String userId, Connection connection)	Returns the connector corresponding to the supplied connection.
Connector	getConnectorByGUID(String userId, String connectionGUID)	Returns the connector corresponding to the supplied connection GUID.
Connector	getConnectorByName(String userId, String connectionName)	Returns the connector corresponding to the supplied connection name.
Connector	getConnectorForAsset(String userId, String assetGUID)	Returns the connector corresponding to the supplied asset GUID.
protected Connector	getConnectorForConnection(OCFRESTClient restClient, String serviceName, String userId, Connection requestedConnection, String methodName)	Use the Open Connector Framework (OCF) to create a connector using the supplied connection.

Methods inherited from class java.lang.Object

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

Field Detail

serverName

protected String serverName

serverPlatformURLRoot

protected String serverPlatformURLRoot

auditLog

protected AuditLog auditLog

invalidParameterHandler

protected InvalidParameterHandler invalidParameterHandler

nullRequestBody

protected static NullRequestBody nullRequestBody

Constructor Detail

ConnectedAssetClientBase

public ConnectedAssetClientBase(String serverName,
                                String serverPlatformURLRoot,
                                String serviceURLMarker,
                                AuditLog auditLog)
                         throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

serviceURLMarker - indicator of the OMAS that this client is supporting

auditLog - destination for log messages

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ConnectedAssetClientBase

public ConnectedAssetClientBase(String serverName,
                                String serverPlatformURLRoot,
                                String serviceURLMarker,
                                int maxPageSize,
                                AuditLog auditLog)
                         throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

maxPageSize - maximum page size for this process

serviceURLMarker - indicator of the OMAS that this client is supporting

auditLog - destination for log messages

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ConnectedAssetClientBase

public ConnectedAssetClientBase(String serverName,
                                String serverPlatformURLRoot,
                                String serviceURLMarker)
                         throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

serviceURLMarker - indicator of the OMAS that this client is supporting

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ConnectedAssetClientBase

public ConnectedAssetClientBase(String serverName,
                                String serverPlatformURLRoot,
                                String serviceURLMarker,
                                String userId,
                                String password,
                                AuditLog auditLog)
                         throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

serviceURLMarker - indicator of the OMAS that this client is supporting

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - destination for log messages

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ConnectedAssetClientBase

public ConnectedAssetClientBase(String serverName,
                                String serverPlatformURLRoot,
                                String serviceURLMarker,
                                String userId,
                                String password)
                         throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

serviceURLMarker - indicator of the OMAS that this client is supporting

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

getAssetSummary

protected Asset getAssetSummary(String userId,
                                String guid,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Return the basic properties of an asset.

Parameters:

userId - calling user

guid - unique identifier of asset

methodName - calling method

Returns:

Asset bean

Throws:

InvalidParameterException - the name is invalid

PropertyServerException - there is a problem access in the property server

UserNotAuthorizedException - the user does not have access to the properties

getAssetProperties

protected AssetUniverse getAssetProperties(String serviceName,
                                           String userId,
                                           String assetGUID)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Returns a comprehensive collection of properties about the requested asset.

Parameters:

serviceName - name of the calling service

userId - userId of user making request.

assetGUID - unique identifier for 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.

getConnectorForConnection

protected Connector getConnectorForConnection(OCFRESTClient restClient,
                                              String serviceName,
                                              String userId,
                                              Connection requestedConnection,
                                              String methodName)
                                       throws ConnectionCheckedException,
                                              ConnectorCheckedException

Use the Open Connector Framework (OCF) to create a connector using the supplied connection.

Parameters:

restClient - client that calls REST APIs

serviceName - calling service

userId - calling user

requestedConnection - connection describing the required connector.

methodName - name of the calling method.

Returns:

a new connector.

Throws:

ConnectionCheckedException - there are issues with the values in the connection

ConnectorCheckedException - the connector had an operational issue accessing the asset.

getConnectionByGUID

protected Connection getConnectionByGUID(OCFRESTClient restClient,
                                         String serviceName,
                                         String userId,
                                         String guid)
                                  throws InvalidParameterException,
                                         PropertyServerException,
                                         UserNotAuthorizedException

Returns the connection corresponding to the supplied connection GUID.

Parameters:

restClient - client that calls REST APIs

serviceName - name of the calling service

userId - userId of user making request.

guid - the unique id for the connection within the metadata repository.

Returns:

connection instance.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

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

getConnectionByName

protected Connection getConnectionByName(OCFRESTClient restClient,
                                         String serviceName,
                                         String userId,
                                         String name)
                                  throws InvalidParameterException,
                                         PropertyServerException,
                                         UserNotAuthorizedException

Returns the connection object corresponding to the supplied connection name.

Parameters:

restClient - client that calls REST APIs

serviceName - name of the calling service

userId - String - userId of user making request.

name - this is the qualifiedName of the connection.

Returns:

Connection retrieved from property server.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property (metadata) server.

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

getConnectionForAsset

protected Connection getConnectionForAsset(OCFRESTClient restClient,
                                           String serviceName,
                                           String userId,
                                           String assetGUID)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Returns the connection corresponding to the supplied asset GUID.

Parameters:

restClient - client that calls REST APIs

serviceName - name of the calling service

userId - userId of user making request.

assetGUID - the unique id for the asset within the metadata repository.

Returns:

connector instance.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

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

getAssetForConnection

protected String getAssetForConnection(OCFRESTClient restClient,
                                       String serviceName,
                                       String userId,
                                       String connectionGUID)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Returns the unique identifier for the asset connected to the requested connection.

Parameters:

restClient - initialized client for calling REST APIs.

serviceName - name of the calling service.

userId - the userId of the requesting user.

connectionGUID - unique identifier for the connection.

Returns:

unique identifier of asset.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server.

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

getConnectorByName

public Connector getConnectorByName(String userId,
                                    String connectionName)
                             throws InvalidParameterException,
                                    ConnectionCheckedException,
                                    ConnectorCheckedException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Returns the connector corresponding to the supplied connection name.

Specified by:

getConnectorByName in interface ConnectorFactoryInterface

Parameters:

userId - userId of user making request.

connectionName - this may be the qualifiedName or displayName of the connection.

Returns:

connector instance - or null if there is no connection

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.

PropertyServerException - there is a problem retrieving information from the property server(s).

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

getConnectorForAsset

public Connector getConnectorForAsset(String userId,
                                      String assetGUID)
                               throws InvalidParameterException,
                                      ConnectionCheckedException,
                                      ConnectorCheckedException,
                                      PropertyServerException,
                                      UserNotAuthorizedException

Returns the connector corresponding to the supplied asset GUID.

Specified by:

getConnectorForAsset in interface ConnectorFactoryInterface

Parameters:

userId - userId of user making request.

assetGUID - the unique id for the asset within the metadata repository.

Returns:

connector instance - or null if there is no connection

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.

PropertyServerException - there is a problem retrieving information from the property server(s).

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

getConnectorByGUID

public Connector getConnectorByGUID(String userId,
                                    String connectionGUID)
                             throws InvalidParameterException,
                                    ConnectionCheckedException,
                                    ConnectorCheckedException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Returns the connector corresponding to the supplied connection GUID.

Specified by:

getConnectorByGUID in interface ConnectorFactoryInterface

Parameters:

userId - userId of user making request.

connectionGUID - the unique id for the connection within the metadata repository.

Returns:

connector instance - or null if there is no connection

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.

PropertyServerException - there is a problem retrieving information from the property server(s).

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

getConnectorByConnection

public Connector getConnectorByConnection(String userId,
                                          Connection connection)
                                   throws InvalidParameterException,
                                          ConnectionCheckedException,
                                          ConnectorCheckedException

Returns the connector corresponding to the supplied connection.

Specified by:

getConnectorByConnection in interface ConnectorFactoryInterface

Parameters:

userId - userId of user making request.

connection - the connection object that contains the properties needed to create the connection.

Returns:

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.