org.odpi.openmetadata.accessservices.dataengine.server.service

Class DataEngineRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.dataengine.server.service.DataEngineRESTServices

public class DataEngineRESTServices
extends Object

The DataEngineRESTServices provides the server-side implementation of the Data Engine Open Metadata Assess Service (OMAS). This service provide the functionality to create processes, ports with schema types and corresponding relationships.

Constructor Summary

Constructors

Constructor and Description
DataEngineRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	addLineageMappings(String userId, String serverName, LineageMappingsRequestBody lineageMappingsRequestBody) Create LineageMappings relationships between schema types
GUIDResponse	addPortsToProcess(String userId, String serverName, String processGuid, PortListRequestBody portListRequestBody) Create ProcessPort relationships for an existing Process
GUIDResponse	createPortAlias(String userId, String serverName, PortAliasRequestBody portAliasRequestBody) Create the Port Alias with a PortDelegation relationship
GUIDResponse	createPortImplementation(String userId, String serverName, PortImplementationRequestBody portImplementationRequestBody) Create the Port Implementation with a PortSchema relationship
ProcessListResponse	createProcesses(String userId, String serverName, ProcessesRequestBody processesRequestBody) Create the processes with ports, schema types and lineage mappings
GUIDResponse	createSchemaType(String userId, String serverName, SchemaTypeRequestBody schemaTypeRequestBody) Create the Port Implementation with a PortSchema relationship
GUIDResponse	createSoftwareServer(String serverName, String userId, SoftwareServerCapabilityRequestBody requestBody) Create the software server capability entity
GUIDResponse	getSoftwareServerByQualifiedName(String serverName, String userId, String qualifiedName) Get the unique identifier from a software server capability definition

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEngineRESTServices

public DataEngineRESTServices()

Default constructor

Method Detail

createSoftwareServer

public GUIDResponse createSoftwareServer(String serverName,
                                         String userId,
                                         SoftwareServerCapabilityRequestBody requestBody)

Create the software server capability entity

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the server

Returns:

the unique identifier (guid) of the created server

getSoftwareServerByQualifiedName

public GUIDResponse getSoftwareServerByQualifiedName(String serverName,
                                                     String userId,
                                                     String qualifiedName)

Get the unique identifier from a 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

createSchemaType

public GUIDResponse createSchemaType(String userId,
                                     String serverName,
                                     SchemaTypeRequestBody schemaTypeRequestBody)

Create the Port Implementation with a PortSchema relationship

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

schemaTypeRequestBody - properties of the schema type

Returns:

the unique identifier (guid) of the created schema type

createPortImplementation

public GUIDResponse createPortImplementation(String userId,
                                             String serverName,
                                             PortImplementationRequestBody portImplementationRequestBody)

Create the Port Implementation with a PortSchema relationship

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

portImplementationRequestBody - properties of the port

Returns:

the unique identifier (guid) of the created port

createPortAlias

public GUIDResponse createPortAlias(String userId,
                                    String serverName,
                                    PortAliasRequestBody portAliasRequestBody)

Create the Port Alias with a PortDelegation relationship

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

portAliasRequestBody - properties of the port

Returns:

the unique identifier (guid) of the created port

createProcesses

public ProcessListResponse createProcesses(String userId,
                                           String serverName,
                                           ProcessesRequestBody processesRequestBody)

Create the processes with ports, schema types and lineage mappings

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

processesRequestBody - properties of the processes

Returns:

a list unique identifiers (GUIDs) of the created processes

addPortsToProcess

public GUIDResponse addPortsToProcess(String userId,
                                      String serverName,
                                      String processGuid,
                                      PortListRequestBody portListRequestBody)

Create ProcessPort relationships for an existing Process

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

portListRequestBody - guids of ports

Returns:

the unique identifier (guid) of the updated process entity

addLineageMappings

public VoidResponse addLineageMappings(String userId,
                                       String serverName,
                                       LineageMappingsRequestBody lineageMappingsRequestBody)

Create LineageMappings relationships between schema types

Parameters:

userId - the name of the calling user

serverName - ame of server instance to call

lineageMappingsRequestBody - list of lineage mappings

Returns:

void response