DataEngineRESTServices (Data Engine OMAS Server-side 2.10 API)

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.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EXCEPTION_WHILE_ADDING_LINEAGE_MAPPING`
`static String`	`EXCEPTION_WHILE_CREATING_PROCESS`
`static String`	`EXCEPTION_WHILE_CREATING_PROCESS_HIERARCHY`

Constructor Summary

Constructors
Constructor and Description

DataEngineRESTServices()

Constructors
Constructor and Description
`DataEngineRESTServices()`

Method Summary

All Methods Instance Methods Concrete Methods
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
`GUIDResponse`	`addProcessHierarchy(String userId, String serverName, ProcessHierarchyRequestBody processHierarchyRequestBody)` Add the provided ProcessHierarchy relationship
`String`	`addProcessHierarchyToProcess(String userId, String serverName, ProcessHierarchy processHierarchy, String externalSourceName)` Add a a ProcessHierarchy relationship to the 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
`VoidResponse`	`deleteExternalDataEngine(String userId, String serverName, DeleteRequestBody requestBody)` Delete the external data engine.
`void`	`deleteExternalDataEngine(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)` Delete the external data engine.
`VoidResponse`	`deletePort(String userId, String serverName, DeleteRequestBody requestBody, String portType)` Delete the Port with the associated schema type and relationships
`void`	`deletePort(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, String portType, DeleteSemantic deleteSemantic)` Delete the Port with the associated schema type and relationships
`VoidResponse`	`deleteProcesses(String userId, String serverName, ProcessesDeleteRequestBody requestBody)` Delete a list of processes, with the associated port implementations, port aliases and lineage mappings
`void`	`deleteProcesses(String userId, String serverName, String externalSourceName, List<String> guids, List<String> qualifiedNames, DeleteSemantic deleteSemantic)` Delete a list of processes, with the associated port implementations, port aliases and lineage mappings.
`VoidResponse`	`deleteSchemaType(String userId, String serverName, DeleteRequestBody requestBody)` Delete the SchemaType with schema attributes and corresponding relationships
`void`	`deleteSchemaType(String userId, String serverName, String externalSourceName, String guid, String qualifiedName, DeleteSemantic deleteSemantic)` Delete the SchemaType with schema attributes and corresponding relationships
`GUIDResponse`	`getExternalDataEngine(String serverName, String userId, String qualifiedName)` Get the unique identifier from a external data engine qualified name
`ConnectionResponse`	`getInTopicConnection(String serverName, String userId)` Retrieve in topic connection details from the service instance hosting Data Engine access service
`Optional<String>`	`getPortGUID(String serverName, String userId, String qualifiedName)` Get the unique identifier of a port
`Optional<String>`	`getProcessGUID(String serverName, String userId, String qualifiedName)` Get the unique identifier of a process
`Optional<String>`	`getSchemaTypeGUID(String serverName, String userId, String qualifiedName)` Get the unique identifier of a schema type
`GUIDResponse`	`upsertDatabase(String userId, String serverName, DatabaseRequestBody databaseRequestBody)` Create or update the Database with corresponding associated schema type and relationship
`GUIDResponse`	`upsertDataFile(String serverName, String userId, DataFileRequestBody dataFileRequestBody)` Updates or inserts a DataFile or CSVFile, along with its schema, columns and folder hierarchy
`GUIDResponse`	`upsertPortAlias(String userId, String serverName, PortAliasRequestBody portAliasRequestBody)` Create or update the Port Alias with a PortDelegation relationship
`String`	`upsertPortAliasWithDelegation(String userId, String serverName, PortAlias portAlias, String processGUID, String externalSourceName)` Create or update a Port Alias with a PortDelegation relationship
`GUIDResponse`	`upsertPortImplementation(String userId, String serverName, PortImplementationRequestBody portImplementationRequestBody)` Create or update the Port Implementation with a PortSchema relationship
`String`	`upsertPortImplementation(String userId, String serverName, PortImplementation portImplementation, String processGUID, String externalSourceName)` Create or update a Port Implementation with an associated SchemaType
`ProcessListResponse`	`upsertProcesses(String userId, String serverName, List<Process> processes, String externalSourceName)`
`ProcessListResponse`	`upsertProcesses(String userId, String serverName, ProcessesRequestBody processesRequestBody)` Create or update the processes with ports, schema types and lineage mappings
`GUIDResponse`	`upsertRelationalTable(String userId, String serverName, RelationalTableRequestBody relationalTableRequestBody)` Create the Relational Table with Relational Columns and corresponding relationships
`GUIDResponse`	`upsertSchemaType(String userId, String serverName, SchemaTypeRequestBody schemaTypeRequestBody)` Create the SchemaType with schema attributes and corresponding relationships
`String`	`upsertSchemaType(String userId, String serverName, String portImplementationGUID, SchemaType schemaType, String externalSourceName)` Create or update a SchemaType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- EXCEPTION_WHILE_ADDING_LINEAGE_MAPPING
```
public static final String EXCEPTION_WHILE_ADDING_LINEAGE_MAPPING
```
  See Also:
  
  Constant Field Values
- EXCEPTION_WHILE_CREATING_PROCESS
```
public static final String EXCEPTION_WHILE_CREATING_PROCESS
```
  See Also:
  
  Constant Field Values
- EXCEPTION_WHILE_CREATING_PROCESS_HIERARCHY
```
public static final String EXCEPTION_WHILE_CREATING_PROCESS_HIERARCHY
```
  See Also:
  
  Constant Field Values

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

getExternalDataEngine
```
public GUIDResponse getExternalDataEngine(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

deleteExternalDataEngine

public VoidResponse deleteExternalDataEngine(String userId,
                                             String serverName,
                                             DeleteRequestBody requestBody)

Delete the external data engine. Not yet implemented, it will throw FunctionNotSupportedException if used

Parameters:: serverName - name of the service to route the request to; userId - identifier of calling user; requestBody - properties of the external data engine
Returns:: void response

deleteExternalDataEngine

public void deleteExternalDataEngine(String userId,
                                     String serverName,
                                     String externalSourceName,
                                     String guid,
                                     String qualifiedName,
                                     DeleteSemantic deleteSemantic)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException,
                                     FunctionNotSupportedException

Delete the external data engine. Not yet implemented, it will throw FunctionNotSupportedException if used

Parameters:: serverName - name of server instance to call; userId - the name of the calling user; externalSourceName - the unique name of the external source; guid - the unique identifier of the schema type; qualifiedName - the qualified name of the schema type; deleteSemantic - the delete semantic
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server; FunctionNotSupportedException - the repository does not support this call.

getProcessGUID

public Optional<String> getProcessGUID(String serverName,
                                       String userId,
                                       String qualifiedName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Get the unique identifier of a process

Parameters:: serverName - name of the service to route the request to; userId - identifier of calling user; qualifiedName - qualified name of the process
Returns:: the unique identifier of a process or empty optional
Throws:: InvalidParameterException; PropertyServerException; UserNotAuthorizedException

getPortGUID

public Optional<String> getPortGUID(String serverName,
                                    String userId,
                                    String qualifiedName)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Get the unique identifier of a port

Parameters:: serverName - name of the service to route the request to; userId - identifier of calling user; qualifiedName - qualified name of the port
Returns:: the unique identifier of a port or empty optional
Throws:: InvalidParameterException; PropertyServerException; UserNotAuthorizedException

getSchemaTypeGUID

public Optional<String> getSchemaTypeGUID(String serverName,
                                          String userId,
                                          String qualifiedName)
                                   throws InvalidParameterException,
                                          PropertyServerException,
                                          UserNotAuthorizedException

Get the unique identifier of a schema type

Parameters:: serverName - name of the service to route the request to; userId - identifier of calling user; qualifiedName - qualified name of the port
Returns:: the unique identifier of a port or empty optional
Throws:: InvalidParameterException; PropertyServerException; UserNotAuthorizedException

upsertSchemaType
```
public GUIDResponse upsertSchemaType(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

deleteSchemaType

public VoidResponse deleteSchemaType(String userId,
                                     String serverName,
                                     DeleteRequestBody requestBody)

Delete the SchemaType with schema attributes and corresponding relationships

Parameters:: serverName - name of server instance to call; userId - the name of the calling user; requestBody - properties of the schema type
Returns:: void response

deleteSchemaType

public void deleteSchemaType(String userId,
                             String serverName,
                             String externalSourceName,
                             String guid,
                             String qualifiedName,
                             DeleteSemantic deleteSemantic)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException,
                             FunctionNotSupportedException,
                             EntityNotDeletedException

Delete the SchemaType with schema attributes and corresponding relationships

Parameters:: serverName - name of server instance to call; userId - the name of the calling user; externalSourceName - the unique name of the external source; guid - the unique identifier of the schema type; qualifiedName - the qualified name of the schema type; deleteSemantic - the delete semantic
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server; FunctionNotSupportedException - the repository does not support this call.; EntityNotDeletedException

upsertPortImplementation

public GUIDResponse upsertPortImplementation(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

upsertPortAlias

public GUIDResponse upsertPortAlias(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

deletePort

public VoidResponse deletePort(String userId,
                               String serverName,
                               DeleteRequestBody requestBody,
                               String portType)

Delete the Port with the associated schema type and relationships

Parameters:: serverName - name of server instance to call; userId - the name of the calling user; requestBody - properties of the port; portType - the type of the port
Returns:: void response

deletePort

public void deletePort(String userId,
                       String serverName,
                       String externalSourceName,
                       String guid,
                       String qualifiedName,
                       String portType,
                       DeleteSemantic deleteSemantic)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException,
                       FunctionNotSupportedException,
                       EntityNotDeletedException

Delete the Port with the associated schema type and relationships

Parameters:: serverName - name of server instance to call; userId - the name of the calling user; externalSourceName - the unique name of the external source; guid - the unique identifier of the port; qualifiedName - the qualified name of the port; portType - the port type; deleteSemantic - the delete semantic
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server; FunctionNotSupportedException - the repository does not support this call.; EntityNotDeletedException

addProcessHierarchy
```
public GUIDResponse addProcessHierarchy(String userId,
                                        String serverName,
                                        ProcessHierarchyRequestBody processHierarchyRequestBody)
```
Add the provided ProcessHierarchy relationship

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

processHierarchyRequestBody - properties of the process hierarchy

Returns:

the unique identifier (guid) of the child of the process hierarchy that was updated

upsertProcesses

public ProcessListResponse upsertProcesses(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

deleteProcesses

public VoidResponse deleteProcesses(String userId,
                                    String serverName,
                                    ProcessesDeleteRequestBody requestBody)

Delete a list of processes, with the associated port implementations, port aliases and lineage mappings

Parameters:: userId - the name of the calling user; serverName - name of server instance to call; requestBody - properties of the processes
Returns:: void response

deleteProcesses

public void deleteProcesses(String userId,
                            String serverName,
                            String externalSourceName,
                            List<String> guids,
                            List<String> qualifiedNames,
                            DeleteSemantic deleteSemantic)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException,
                            FunctionNotSupportedException,
                            EntityNotDeletedException

Delete a list of processes, with the associated port implementations, port aliases and lineage mappings.

Parameters:: userId - the name of the calling user; externalSourceName - the unique name of the external source; guids - the unique identifiers of the processes; qualifiedNames - the qualified names of the processes; deleteSemantic - the delete semantic
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server; FunctionNotSupportedException - the repository does not support this call.; EntityNotDeletedException

upsertPortAliasWithDelegation

public String upsertPortAliasWithDelegation(String userId,
                                            String serverName,
                                            PortAlias portAlias,
                                            String processGUID,
                                            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

addProcessHierarchyToProcess

public String addProcessHierarchyToProcess(String userId,
                                           String serverName,
                                           ProcessHierarchy processHierarchy,
                                           String externalSourceName)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Add a a ProcessHierarchy relationship to the process

Parameters:: userId - the name of the calling user; serverName - name of server instance to call; processHierarchy - the process hierarchy values; externalSourceName - the unique name of the external source
Returns:: the unique identifier (guid) of the child of the process hierarchy that was updated
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

upsertPortImplementation

public String upsertPortImplementation(String userId,
                                       String serverName,
                                       PortImplementation portImplementation,
                                       String processGUID,
                                       String externalSourceName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException,
                                       FunctionNotSupportedException

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; FunctionNotSupportedException

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

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

upsertProcesses

public ProcessListResponse upsertProcesses(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

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

getInTopicConnection
```
public ConnectionResponse getInTopicConnection(String serverName,
                                               String userId)
```
Retrieve in topic connection details from the service instance hosting Data Engine access service

Parameters:

serverName - the name of server instance to call

userId - the name/identifier of the calling user

Returns:

OCF API ConnectionResponse object describing the details for the input topic connection used or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition

upsertSchemaType

public String upsertSchemaType(String userId,
                               String serverName,
                               String portImplementationGUID,
                               SchemaType schemaType,
                               String externalSourceName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create or update a SchemaType

Parameters:: userId - the name of the calling user; serverName - name of server instance to call; portImplementationGUID - the unique identifier of the port implementation; schemaType - the schema type values; externalSourceName - the unique name of the external source
Returns:: the unique identifier (guid) of the created schema type
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

upsertDatabase
```
public GUIDResponse upsertDatabase(String userId,
                                   String serverName,
                                   DatabaseRequestBody databaseRequestBody)
```
Create or update the Database with corresponding associated schema type and relationship

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

databaseRequestBody - properties of the database

Returns:

the unique identifier (guid) of the created database

upsertRelationalTable
```
public GUIDResponse upsertRelationalTable(String userId,
                                          String serverName,
                                          RelationalTableRequestBody relationalTableRequestBody)
```
Create the Relational Table with Relational Columns and corresponding relationships

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

relationalTableRequestBody - properties of the relational table

Returns:

the unique identifier (guid) of the created relational table

upsertDataFile

public GUIDResponse upsertDataFile(String serverName,
                                   String userId,
                                   DataFileRequestBody dataFileRequestBody)

Updates or inserts a DataFile or CSVFile, along with its schema, columns and folder hierarchy

Parameters:: serverName - server name; userId - user id; dataFileRequestBody - request body
Returns:: file guid

Class DataEngineRESTServices

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXCEPTION_WHILE_ADDING_LINEAGE_MAPPING

EXCEPTION_WHILE_CREATING_PROCESS

EXCEPTION_WHILE_CREATING_PROCESS_HIERARCHY

Constructor Detail

DataEngineRESTServices

Method Detail

createExternalDataEngine

getExternalDataEngine

deleteExternalDataEngine

deleteExternalDataEngine

getProcessGUID

getPortGUID

getSchemaTypeGUID

upsertSchemaType

deleteSchemaType

deleteSchemaType

upsertPortImplementation

upsertPortAlias

deletePort

deletePort

addProcessHierarchy

upsertProcesses

deleteProcesses

deleteProcesses

upsertPortAliasWithDelegation

addProcessHierarchyToProcess

upsertPortImplementation

createExternalDataEngine

addLineageMappings

upsertProcesses

addLineageMappings

getInTopicConnection

upsertSchemaType

upsertDatabase

upsertRelationalTable

upsertDataFile