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 attributes
GUIDResponse	addPortsToProcess(String userId, String serverName, String processGuid, PortListRequestBody portListRequestBody) Create ProcessPort relationships for an existing Process
GUIDResponse	createExternalDataEngine(String serverName, String userId, DataEngineRegistrationRequestBody requestBody) Create the external data engine as software server capability entity
GUIDResponse	createOrUpdatePortAlias(String userId, String serverName, PortAliasRequestBody portAliasRequestBody) Create or update the Port Alias with a PortDelegation relationship
String	createOrUpdatePortAliasWithDelegation(String userId, String serverName, PortAlias portAlias, String externalSourceName)
GUIDResponse	createOrUpdatePortImplementation(String userId, String serverName, PortImplementationRequestBody portImplementationRequestBody) Create or update the Port Implementation with a PortSchema relationship
String	createOrUpdatePortImplementationWithSchemaType(String userId, String serverName, PortImplementation portImplementation, String externalSourceName)
GUIDResponse	createOrUpdateProcess(String userId, String serverName, Process process, String externalSourceName) Create the process with ports, schema types and lineage mappings
List<GUIDResponse>	createOrUpdateProcesses(String userId, String serverName, List<Process> processes, String externalSourceName)
ProcessListResponse	createOrUpdateProcesses(String userId, String serverName, ProcessesRequestBody processesRequestBody) Create or update the processes with ports, schema types and lineage mappings
GUIDResponse	createOrUpdateSchemaType(String userId, String serverName, SchemaTypeRequestBody schemaTypeRequestBody) Create the SchemaType with schema attributes and corresponding relationships
GUIDResponse	getExternalDataEngineByQualifiedName(String serverName, String userId, String qualifiedName) Get the unique identifier from a external data engine qualified name
List<GUIDResponse>	getGuidResponses(ProcessListResponse response, List<GUIDResponse> createdProcesses)
void	handleFailedProcesses(ProcessListResponse response, List<GUIDResponse> failedProcesses)
void	updateProcessStatus(String userId, String serverName, GUIDResponse response, InstanceStatus instanceStatus)

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

createExternalDataEngine

public GUIDResponse createExternalDataEngine(String serverName,
                                             String userId,
                                             DataEngineRegistrationRequestBody requestBody)

Create the external data engine as 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 external data engine

getExternalDataEngineByQualifiedName

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

Get the unique identifier from a external data engine qualified name

Parameters:

serverName - name of the service to route the request to

userId - identifier of calling user

qualifiedName - qualified name of the external data engine

Returns:

the unique identifier from a software server capability definition for an external data engine

createOrUpdateSchemaType

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

Create the SchemaType with schema attributes and corresponding relationships

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

createOrUpdatePortImplementation

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

Create or update 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

createOrUpdatePortAlias

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

Create or update 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

createOrUpdateProcesses

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

Create or update 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/updated processes

handleFailedProcesses

public void handleFailedProcesses(ProcessListResponse response,
                                  List<GUIDResponse> failedProcesses)

getGuidResponses

public List<GUIDResponse> getGuidResponses(ProcessListResponse response,
                                           List<GUIDResponse> createdProcesses)

updateProcessStatus

public void updateProcessStatus(String userId,
                                String serverName,
                                GUIDResponse response,
                                InstanceStatus instanceStatus)

createOrUpdateProcesses

public List<GUIDResponse> createOrUpdateProcesses(String userId,
                                                  String serverName,
                                                  List<Process> processes,
                                                  String externalSourceName)

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 attributes

Parameters:

userId - the name of the calling user

serverName - ame of server instance to call

lineageMappingsRequestBody - list of lineage mappings

Returns:

void response

createOrUpdateProcess

public GUIDResponse createOrUpdateProcess(String userId,
                                          String serverName,
                                          Process process,
                                          String externalSourceName)

Create the process with ports, schema types and lineage mappings

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

process - properties of the process

Returns:

the unique identifier (guid) of the created process

createOrUpdatePortImplementationWithSchemaType

public String createOrUpdatePortImplementationWithSchemaType(String userId,
                                                             String serverName,
                                                             PortImplementation portImplementation,
                                                             String externalSourceName)
                                                      throws InvalidParameterException,
                                                             PropertyServerException,
                                                             UserNotAuthorizedException

Throws:

InvalidParameterException

PropertyServerException

UserNotAuthorizedException

createOrUpdatePortAliasWithDelegation

public String createOrUpdatePortAliasWithDelegation(String userId,
                                                    String serverName,
                                                    PortAlias portAlias,
                                                    String externalSourceName)
                                             throws InvalidParameterException,
                                                    PropertyServerException,
                                                    UserNotAuthorizedException

Throws:

InvalidParameterException

PropertyServerException

UserNotAuthorizedException