org.odpi.openmetadata.accessservices.dataplatform.client

Class DataPlatformClient

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.dataplatform.client.DataPlatformClient

Deprecated.

@Deprecated
public class DataPlatformClient
extends OCFRESTClient

DataPlatformClient provides the client implementation for the Data Platform OMAS.

Field Summary

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

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor and Description
DataPlatformClient(String serverName, String serverPlatformURLRoot) Deprecated. Constructor for no authentication.
DataPlatformClient(String serverName, String serverPlatformURLRoot, String userId, String password) Deprecated. Constructor for simple userId and password authentication.

Method Summary

Modifier and Type	Method and Description
GUIDResponse	createDeployedDatabaseSchema(String userId, DeployedDatabaseSchema deployedDatabaseSchema) Deprecated. Create deployed database schema asset from external source.
GUIDResponse	createExternalDataPlatform(String userId, DataPlatform dataPlatformProperties) Deprecated. Create the software server capability entity for registering external data platforms.
String	getExternalSourceName() Deprecated.
void	setExternalSourceName(String externalSourceName) Deprecated.

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

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

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

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

DataPlatformClient

public DataPlatformClient(String serverName,
                          String serverPlatformURLRoot)
                   throws InvalidParameterException

Deprecated.

Constructor for no authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

Throws:

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

DataPlatformClient

public DataPlatformClient(String serverName,
                          String serverPlatformURLRoot,
                          String userId,
                          String password)
                   throws InvalidParameterException

Deprecated.

Constructor for simple userId and password authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

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

Method Detail

createExternalDataPlatform

public GUIDResponse createExternalDataPlatform(String userId,
                                               DataPlatform dataPlatformProperties)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Deprecated.

Create the software server capability entity for registering external data platforms.

Parameters:

userId - the name of the calling user

dataPlatformProperties - the software server capability bean

Returns:

unique identifier of the server in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createDeployedDatabaseSchema

public GUIDResponse createDeployedDatabaseSchema(String userId,
                                                 DeployedDatabaseSchema deployedDatabaseSchema)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Deprecated.

Create deployed database schema asset from external source.

Parameters:

userId - the user id

deployedDatabaseSchema - the deployed database schema

Returns:

the string

Throws:

InvalidParameterException - the invalid parameter exception

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - the property server exception

getExternalSourceName

public String getExternalSourceName()

Deprecated.

setExternalSourceName

public void setExternalSourceName(String externalSourceName)

Deprecated.