Package org.odpi.openmetadata.accessservices.dataengine.client

Class DataEngineRESTConfigurationClient

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

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

org.odpi.openmetadata.accessservices.dataengine.client.DataEngineRESTClient

org.odpi.openmetadata.accessservices.dataengine.client.DataEngineRESTConfigurationClient

All Implemented Interfaces:

DataEngineClient

public class DataEngineRESTConfigurationClient
extends DataEngineRESTClient

DataEngineRESTConfigurationClient provides an extension to the client-side REST interface for obtaining Data Engine access service configuration specifics.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
DataEngineRESTConfigurationClient(String serverName, String serverPlatformRootURL)	Create DataEngineRESTConfigurationClient with unauthenticated access to the DE OMAS server.
DataEngineRESTConfigurationClient(String serverName, String serverPlatformRootURL, String userId, String password)	Instantiates a new Data Engine REST configuration client.

Method Summary

Modifier and Type	Method	Description
ConnectionResponse	getInTopicConnection(String serverName, String userId)	Retrieve input topic connection details from remote DE OMAS instance.

Methods inherited from class org.odpi.openmetadata.accessservices.dataengine.client.DataEngineRESTClient

addLineageMappings, addProcessHierarchy, createExternalDataEngine, createOrUpdatePortAlias, createOrUpdatePortImplementation, createOrUpdateProcess, createOrUpdateSchemaType, deleteConnection, deleteDatabase, deleteDatabaseSchema, deleteDataFile, deleteEndpoint, deleteExternalDataEngine, deleteFolder, deletePortAlias, deletePortImplementation, deleteProcess, deleteRelationalTable, deleteSchemaType, find, getDeleteSemantic, getExternalSourceName, setDeleteSemantic, setExternalSourceName, upsertDatabase, upsertDatabaseSchema, upsertDataFile, upsertRelationalTable

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

callAssetGetRESTCall, callAssetsGetRESTCall, callAssetsPostRESTCall, callConnectionGetRESTCall, callTagGetRESTCall, callTagListGetRESTCall, callTagListPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

callConnectorTypeGetRESTCall, callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEngineRESTConfigurationClient

public DataEngineRESTConfigurationClient(String serverName,
                                         String serverPlatformRootURL)
                                  throws InvalidParameterException

Create DataEngineRESTConfigurationClient with unauthenticated access to the DE OMAS server.

Parameters:

serverName - the server name

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

Throws:

InvalidParameterException - null URL or server name

DataEngineRESTConfigurationClient

public DataEngineRESTConfigurationClient(String serverName,
                                         String serverPlatformRootURL,
                                         String userId,
                                         String password)
                                  throws InvalidParameterException

Instantiates a new Data Engine REST configuration client.

Parameters:

serverName - name of the server to connect to

serverPlatformRootURL - 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 - null URL or server name

Method Detail

getInTopicConnection

public ConnectionResponse getInTopicConnection(String serverName,
                                               String userId)
                                        throws InvalidParameterException,
                                               PropertyServerException,
                                               UserNotAuthorizedException

Retrieve input topic connection details from remote DE OMAS instance.

Parameters:

serverName - name of the server hosting DE access service

userId - user accessing the server hosting DE access service

Returns:

ConnectionResponse OCF object

Throws:

InvalidParameterException - input parameter(s) invalid

PropertyServerException - something went wrong with the REST call stack

UserNotAuthorizedException - user is not authorized