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	createSoftwareServer(String serverName, String userId, RegistrationRequestBody registrationRequestBody) Create the software server capability entity
RegistrationRequestBody	getSoftwareServerCapabilityByQualifiedName(String serverName, String userId, String qualifiedName) Return the software server capability definition

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

createSoftwareServer

public GUIDResponse createSoftwareServer(String serverName,
                                         String userId,
                                         RegistrationRequestBody registrationRequestBody)

Create the software server capability entity

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

registrationRequestBody - properties of the server

Returns:

the unique identifier (guid) of the created server

getSoftwareServerCapabilityByQualifiedName

public RegistrationRequestBody getSoftwareServerCapabilityByQualifiedName(String serverName,
                                                                          String userId,
                                                                          String qualifiedName)

Return the software server capability definition

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