org.odpi.openmetadata.accessservices.dataengine.server.spring

Class DataEngineResource

java.lang.Object

org.odpi.openmetadata.accessservices.dataengine.server.spring.DataEngineResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/data-engine/users/{userId}")
public class DataEngineResource
extends Object

The DataEngineResource provides the server-side implementation of the Data Engine Open Metadata Assess Service (OMAS). This interface facilitates the creation of processes, ports and schema types, with all the needed relationships.

Constructor Summary

Constructors

Constructor and Description
DataEngineResource() Default Constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	addLineageMappings(String userId, String serverName, LineageMappingsRequestBody lineageMappingsRequestBody) Add LineageMapping relationships
GUIDResponse	addPortsToProcess(String userId, String serverName, String processGuid, PortListRequestBody portListRequestBody) Add ports to an existing Process entity
GUIDResponse	createExternalDataEngine(String serverName, String userId, DataEngineRegistrationRequestBody requestBody) Register external data engine as source of metadata by creating a software server capability entity
GUIDResponse	createOrUpdatePortAlias(String userId, String serverName, PortAliasRequestBody portAliasRequestBody) Create the PortAlias entity
GUIDResponse	createOrUpdatePortImplementation(String userId, String serverName, PortImplementationRequestBody portImplementationRequestBody) Create the PortImplementation entity
GUIDListResponse	createOrUpdateProcesses(String userId, String serverName, ProcessesRequestBody processesRequestBody) Create or update the Process entities with ports, schema types and all needed relationships
GUIDResponse	createOrUpdateSchemaType(String userId, String serverName, SchemaTypeRequestBody requestBody) Create a SchemaType entity with all the needed relationships
GUIDResponse	getExternalDataEngineByQualifiedName(String serverName, String userId, String qualifiedName) Return the unique identifier of an external data engine from a software server capability definition.
ConnectionResponse	getInTopicConnection(String serverName, String userId) Get connection details used to access Data Engine OMAS input topic

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEngineResource

public DataEngineResource()

Default Constructor

Method Detail

createExternalDataEngine

@PostMapping(path="/registration")
public GUIDResponse createExternalDataEngine(@PathVariable(value="serverName")
                                                                                String serverName,
                                                                                @PathVariable(value="userId")
                                                                                String userId,
                                                                                @RequestBody
                                                                                DataEngineRegistrationRequestBody requestBody)

Register external data engine as source of metadata by creating a software server capability entity

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties of the entity

Returns:

unique identifier of the created process

getExternalDataEngineByQualifiedName

@GetMapping(path="/registration/{qualifiedName}")
public GUIDResponse getExternalDataEngineByQualifiedName(@PathVariable
                                                                                                           String serverName,
                                                                                                           @PathVariable
                                                                                                           String userId,
                                                                                                           @PathVariable
                                                                                                           String qualifiedName)

Return the unique identifier of an external data engine from a software server capability definition.

Parameters:

serverName - name of server instance to call

userId - identifier of calling user

qualifiedName - qualified name of the software server capability

Returns:

unique identified of the software server

createOrUpdateSchemaType

@PostMapping(path="/schema-types")
public GUIDResponse createOrUpdateSchemaType(@PathVariable(value="userId")
                                                                                String userId,
                                                                                @PathVariable(value="serverName")
                                                                                String serverName,
                                                                                @RequestBody
                                                                                SchemaTypeRequestBody requestBody)

Create a SchemaType entity with all the needed relationships

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

requestBody - properties for the schema type

Returns:

unique identifier of the created entity

createOrUpdatePortImplementation

@PostMapping(path="/port-implementations")
public GUIDResponse createOrUpdatePortImplementation(@PathVariable(value="userId")
                                                                                                String userId,
                                                                                                @PathVariable(value="serverName")
                                                                                                String serverName,
                                                                                                @RequestBody
                                                                                                PortImplementationRequestBody portImplementationRequestBody)

Create the PortImplementation entity

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

portImplementationRequestBody - properties of the port implementation

Returns:

unique identifier of the created port implementation

createOrUpdatePortAlias

@PostMapping(path="/port-aliases")
public GUIDResponse createOrUpdatePortAlias(@PathVariable(value="userId")
                                                                               String userId,
                                                                               @PathVariable(value="serverName")
                                                                               String serverName,
                                                                               @RequestBody
                                                                               PortAliasRequestBody portAliasRequestBody)

Create the PortAlias entity

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

portAliasRequestBody - properties of the port alias

Returns:

unique identifier of the created port alias

createOrUpdateProcesses

@PostMapping(path="/processes")
public GUIDListResponse createOrUpdateProcesses(@PathVariable(value="userId")
                                                                                String userId,
                                                                                @PathVariable(value="serverName")
                                                                                String serverName,
                                                                                @RequestBody
                                                                                ProcessesRequestBody processesRequestBody)

Create or update the Process entities with ports, schema types and all needed relationships

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

processesRequestBody - properties of the process

Returns:

unique identifier of the created process

addPortsToProcess

@PostMapping(path="/processes/{processGuid}/ports")
public GUIDResponse addPortsToProcess(@PathVariable(value="userId")
                                                                                          String userId,
                                                                                          @PathVariable(value="serverName")
                                                                                          String serverName,
                                                                                          @PathVariable(value="processGuid")
                                                                                          String processGuid,
                                                                                          @RequestBody
                                                                                          PortListRequestBody portListRequestBody)

Add ports to an existing Process entity

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

processGuid - the guid of the process

portListRequestBody - list of port unique identifiers

Returns:

unique identifier of the updated process

addLineageMappings

@PostMapping(path="/lineage-mappings")
public VoidResponse addLineageMappings(@PathVariable(value="userId")
                                                                              String userId,
                                                                              @PathVariable(value="serverName")
                                                                              String serverName,
                                                                              @RequestBody
                                                                              LineageMappingsRequestBody lineageMappingsRequestBody)

Add LineageMapping relationships

Parameters:

serverName - name of server instance to call

userId - the name of the calling user

lineageMappingsRequestBody - properties of the mappings

Returns:

unique identifier of the created entity

getInTopicConnection

@GetMapping(path="/topics/in-topic-connection")
public ConnectionResponse getInTopicConnection(@PathVariable
                                                                                               String serverName,
                                                                                               @PathVariable
                                                                                               String userId)

Get connection details used to access Data Engine OMAS input topic

Parameters:

serverName - name of server instance to call

userId - name of the calling user

Returns:

OCF API ConnectionResponse object describing the details for the in 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