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()

Method Summary

Modifier and Type	Method and Description
VoidResponse	addLineageMappings(String userId, String serverName, LineageMappingsRequestBody lineageMappingsRequestBody) Create LineageMappings relationships between schema attributes
void	addLineageMappings(String userId, String serverName, List<LineageMapping> lineageMappings, FFDCResponseBase response, String externalSourceName) Create LineageMappings relationships between schema attributes
void	addPortsToProcess(String userId, String serverName, String processGUID, List<String> portQualifiedNames, String externalSourceName) Create ProcessPort relationships for an existing Process
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
String	createExternalDataEngine(String userId, String serverName, SoftwareServerCapability softwareServerCapability) 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) Create or update a Port Alias with a PortDelegation relationship
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) Create or update a Port Implementation with an associated SchemaType
ProcessListResponse	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

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEngineRESTServices

public DataEngineRESTServices()

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:

userId - the name of the calling user

serverName - name of server instance to call

processesRequestBody - properties of the processes

Returns:

a list unique identifiers (GUIDs) of the created/updated processes

createOrUpdatePortAliasWithDelegation

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

Create or update a Port Alias with a PortDelegation relationship

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

portAlias - the port alias values

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created port alias

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createOrUpdatePortImplementationWithSchemaType

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

Create or update a Port Implementation with an associated SchemaType

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

portImplementation - the port implementation values

externalSourceName - the unique name of the external source

Returns:

the unique identifier (guid) of the created port alias

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createExternalDataEngine

public String createExternalDataEngine(String userId,
                                       String serverName,
                                       SoftwareServerCapability softwareServerCapability)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Create the external data engine as software server capability entity

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

softwareServerCapability - the software server values

Returns:

he unique identifier (guid) of the created external data engine

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addPortsToProcess

public void addPortsToProcess(String userId,
                              String serverName,
                              String processGUID,
                              List<String> portQualifiedNames,
                              String externalSourceName)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Create ProcessPort relationships for an existing Process

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

processGUID - the process entity unique identifier(guid)

portQualifiedNames - the list of qualified names for the port entities

externalSourceName - the unique name of the external source

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addLineageMappings

public void addLineageMappings(String userId,
                               String serverName,
                               List<LineageMapping> lineageMappings,
                               FFDCResponseBase response,
                               String externalSourceName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Create LineageMappings relationships between schema attributes

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

lineageMappings - the list of lineage mappings to be created

response - the response object that will capture the exceptions that might occur during parallel processing

externalSourceName - the unique name of the external source

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createOrUpdateProcesses

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

Parameters:

userId - the name of the calling user

serverName - name of server instance to call

processes - list of processes to be created

externalSourceName - the unique name of the external source

Returns:

a list unique identifiers (GUIDs) of the created/updated 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 - list of port qualified names

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