java.lang.Object
- org.odpi.openmetadata.accessservices.dataengine.server.handlers.DataEngineProcessHandler

```
public class DataEngineProcessHandler
extends Object
```
ProcessHandler manages Process objects from the property server. It runs server-side in the DataEngine OMAS and creates process entities and relationships through the OMRSRepositoryConnector.

Field Summary

Fields
Modifier and Type Field Description

static String PROCESS_GUID_PARAMETER_NAME

Constructor Summary

Constructors
Constructor	Description
`DataEngineProcessHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, OMRSRepositoryHelper repositoryHelper, AssetHandler<Process> assetHandler, DataEngineRegistrationHandler registrationHandler, DataEngineCommonHandler dataEngineCommonHandler)`	Construct the handler information needed to interact with the repository services

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`createProcess(String userId, Process process, String externalSourceName)`	Create the process
`Optional<EntityDetail>`	`findProcessEntity(String userId, String qualifiedName)`	Find out if the Process object is already stored in the repository.
`Set<EntityDetail>`	`getPortsForProcess(String userId, String processGUID, String portTypeName)`	Retrieve all port objects that are connected to the process
`void`	`removeProcess(String userId, String processGUID, String externalSourceName, DeleteSemantic deleteSemantic)`	Remove the process
`void`	`updateProcess(String userId, EntityDetail originalProcessEntity, Process updatedProcess, String externalSourceName)`	Update the process
`void`	`updateProcessStatus(String userId, String processGUID, InstanceStatus instanceStatus, String externalSourceName)`	Update the process instance status
`void`	`upsertProcessHierarchyRelationship(String userId, ParentProcess parentProcess, String processGUID, String externalSourceName)`

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

Field Detail
- PROCESS_GUID_PARAMETER_NAME
```
public static final String PROCESS_GUID_PARAMETER_NAME
```
  See Also:
  
  Constant Field Values

Constructor Detail

DataEngineProcessHandler

public DataEngineProcessHandler(String serviceName,
                                String serverName,
                                InvalidParameterHandler invalidParameterHandler,
                                OMRSRepositoryHelper repositoryHelper,
                                AssetHandler<Process> assetHandler,
                                DataEngineRegistrationHandler registrationHandler,
                                DataEngineCommonHandler dataEngineCommonHandler)

Construct the handler information needed to interact with the repository services

Parameters:: serviceName - name of this service; serverName - name of the local server; invalidParameterHandler - handler for managing parameter errors; repositoryHelper - provides utilities for manipulating the repository services objects; assetHandler - provides utilities for manipulating the repository services assets; dataEngineCommonHandler - provides utilities for manipulating entities; registrationHandler - provides utilities for manipulating software server capability entities

Method Detail

createProcess

public String createProcess(String userId,
                            Process process,
                            String externalSourceName)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Create the process

Parameters:: userId - the name of the calling user; process - the values of the process; externalSourceName - the unique name of the external source
Returns:: unique identifier of the process in the repository
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

updateProcess

public void updateProcess(String userId,
                          EntityDetail originalProcessEntity,
                          Process updatedProcess,
                          String externalSourceName)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Update the process

Parameters:: userId - the name of the calling user; originalProcessEntity - the created process entity; updatedProcess - the new values of the process; externalSourceName - the external data engine
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

findProcessEntity
```
public Optional<EntityDetail> findProcessEntity(String userId,
                                                String qualifiedName)
                                         throws UserNotAuthorizedException,
                                                PropertyServerException,
                                                InvalidParameterException
```
Find out if the Process object is already stored in the repository. It uses the fully qualified name to retrieve the entity

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the process to be searched

Returns:

optional with entity details if found, empty optional if not found

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

updateProcessStatus

public void updateProcessStatus(String userId,
                                String processGUID,
                                InstanceStatus instanceStatus,
                                String externalSourceName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Update the process instance status

Parameters:: userId - the name of the calling user; processGUID - the process GUID; instanceStatus - the status of the process; externalSourceName - the external data engine
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getPortsForProcess

public Set<EntityDetail> getPortsForProcess(String userId,
                                            String processGUID,
                                            String portTypeName)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Retrieve all port objects that are connected to the process

Parameters:: userId - the name of the calling user; processGUID - the unique identifier of the process; portTypeName - the type of the port to be retrieved
Returns:: A set of the retrieved ports or an empty set
Throws:: InvalidParameterException - the bean properties are invalid; UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

upsertProcessHierarchyRelationship

public void upsertProcessHierarchyRelationship(String userId,
                                               ParentProcess parentProcess,
                                               String processGUID,
                                               String externalSourceName)
                                        throws InvalidParameterException,
                                               PropertyServerException,
                                               UserNotAuthorizedException

Throws:: InvalidParameterException; PropertyServerException; UserNotAuthorizedException

removeProcess

public void removeProcess(String userId,
                          String processGUID,
                          String externalSourceName,
                          DeleteSemantic deleteSemantic)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException,
                          FunctionNotSupportedException

Remove the process

Parameters:: userId - the name of the calling user; processGUID - unique identifier of the port to be removed; externalSourceName - the external data engine; 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.

Class DataEngineProcessHandler

Field Summary