org.odpi.openmetadata.accessservices.dataplatform.server

Class DataPlatformRestServices

java.lang.Object

org.odpi.openmetadata.accessservices.dataplatform.server.DataPlatformRestServices

public class DataPlatformRestServices
extends Object

The DataPlatformRestServices provides the server-side implementation of the Data Platform Open Metadata Assess Service (OMAS). This service provides the functionality to register data platforms as software server capabilities for publishing metadata from them.

Constructor Summary

Constructors

Constructor and Description
DataPlatformRestServices()
DataPlatformRestServices(DataPlatformInstanceHandler dataPlatformInstanceHandler)

Method Summary

Modifier and Type	Method and Description
GUIDResponse	createDeployedDatabaseSchema(String serverName, String userId, DeployedDatabaseSchemaRequestBody deployedDatabaseSchemaRequestBody) Create deployed database schema guid response.
GUIDResponse	createExternalDataPlatform(String serverName, String userId, DataPlatformRegistrationRequestBody dataPlatformRegistrationRequestBody) Create the software server capability entity from an external data platforms
DataPlatformRegistrationRequestBody	getExternalDataPlatformByQualifiedName(String serverName, String userId, String qualifiedName) Return the software server capability definition from an external data platform

Methods inherited from class java.lang.Object

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

Constructor Detail

DataPlatformRestServices

public DataPlatformRestServices()

DataPlatformRestServices

public DataPlatformRestServices(DataPlatformInstanceHandler dataPlatformInstanceHandler)

Method Detail

createExternalDataPlatform

public GUIDResponse createExternalDataPlatform(String serverName,
                                               String userId,
                                               DataPlatformRegistrationRequestBody dataPlatformRegistrationRequestBody)

Create the software server capability entity from an external data platforms

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

dataPlatformRegistrationRequestBody - properties of the server

Returns:

the unique identifier (guid) of the created server

getExternalDataPlatformByQualifiedName

public DataPlatformRegistrationRequestBody getExternalDataPlatformByQualifiedName(String serverName,
                                                                                  String userId,
                                                                                  String qualifiedName)

Return the software server capability definition from an external data platform

Parameters:

serverName - name of the service to route the request to

userId - identifier of calling user

qualifiedName - qualified name of the server

Returns:

the unique identifier from a software server capability definition

createDeployedDatabaseSchema

public GUIDResponse createDeployedDatabaseSchema(String serverName,
                                                 String userId,
                                                 DeployedDatabaseSchemaRequestBody deployedDatabaseSchemaRequestBody)

Create deployed database schema guid response.

Parameters:

serverName - the server name

userId - the user id

deployedDatabaseSchemaRequestBody - the deployed database schema request body

Returns:

the guid response