org.odpi.openmetadata.accessservices.datamanager.client

Class DataManagerIntegratorClient

java.lang.Object

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

org.odpi.openmetadata.accessservices.datamanager.client.DataManagerIntegratorClient

All Implemented Interfaces:

DataManagerIntegratorInterface

public class DataManagerIntegratorClient
extends ConnectedAssetClientBase
implements DataManagerIntegratorInterface

DatabaseManagerClient is the client for managing resources from a relational database server.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

auditLog, invalidParameterHandler, nullRequestBody, serverName, serverPlatformRootURL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	createDataManagerIntegrator(String userId, SoftwareServerCapabilitiesProperties integratorCapabilities) Create information about the integration daemon that is managing the acquisition of metadata from the data manager.
String	getDataManagerIntegratorGUID(String userId, String qualifiedName) Retrieve the unique identifier of the integration daemon.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

getAssetForConnection, getAssetProperties, getAssetSummary, getConnectionByGUID, getConnectionForAsset, getConnectorForConnection

Methods inherited from class java.lang.Object

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

Constructor Detail

DataManagerIntegratorClient

public DataManagerIntegratorClient(String serverName,
                                   String serverManagerRootURL,
                                   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

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

auditLog - logging destination

Throws:

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

DataManagerIntegratorClient

public DataManagerIntegratorClient(String serverName,
                                   String serverManagerRootURL)
                            throws InvalidParameterException

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

Parameters:

serverName - name of the server to connect to

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

Throws:

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

DataManagerIntegratorClient

public DataManagerIntegratorClient(String serverName,
                                   String serverManagerRootURL,
                                   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

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

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

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

DataManagerIntegratorClient

public DataManagerIntegratorClient(String serverName,
                                   String serverManagerRootURL,
                                   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

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

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

createDataManagerIntegrator

public String createDataManagerIntegrator(String userId,
                                          SoftwareServerCapabilitiesProperties integratorCapabilities)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Create information about the integration daemon that is managing the acquisition of metadata from the data manager. Typically this is Egeria's data manager proxy.

Specified by:

createDataManagerIntegrator in interface DataManagerIntegratorInterface

Parameters:

userId - calling user

integratorCapabilities - description of the integration daemon (specify qualified name at a minimum)

Returns:

unique identifier of the integration daemon's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getDataManagerIntegratorGUID

public String getDataManagerIntegratorGUID(String userId,
                                           String qualifiedName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Retrieve the unique identifier of the integration daemon.

Specified by:

getDataManagerIntegratorGUID in interface DataManagerIntegratorInterface

Parameters:

userId - calling user

qualifiedName - unique name of the integration daemon

Returns:

unique identifier of the integration daemon's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server