org.odpi.openmetadata.accessservices.dataengine.server.handlers

Class ProcessHandler

java.lang.Object

org.odpi.openmetadata.accessservices.dataengine.server.handlers.ProcessHandler

public class ProcessHandler
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.

Constructor Summary

Constructors

Constructor and Description

ProcessHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, DataEngineRegistrationHandler dataEngineRegistrationHandler, AssetHandler assetHandler, List<String> defaultZones, List<String> supportedZones) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
void	addProcessPortRelationship(String userId, String processGUID, String portGUID, String externalSourceName) Create ProcessPort relationships between a Process asset and the corresponding Ports.
String	createProcess(String userId, Process process, String externalSourceName) Create the process
String	findProcess(String userId, String qualifiedName) Find out if the Process object is already stored in the repository.
Set<String>	getPortsForProcess(String userId, String processGUID, String portTypeName) Retrieve all port objects that are connected to the process
void	setSecurityVerifier(OpenMetadataServerSecurityVerifier securityVerifier) Set up a new security verifier (the handler runs with a default verifier until this method is called).
void	updateProcess(String userId, String processGUID, Process updatedProcess) Update the process
void	updateProcessStatus(String userId, String guid, InstanceStatus instanceStatus) Update the process instance status

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessHandler

public ProcessHandler(String serviceName,
                      String serverName,
                      InvalidParameterHandler invalidParameterHandler,
                      RepositoryHandler repositoryHandler,
                      OMRSRepositoryHelper repositoryHelper,
                      DataEngineRegistrationHandler dataEngineRegistrationHandler,
                      AssetHandler assetHandler,
                      List<String> defaultZones,
                      List<String> supportedZones)

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

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

dataEngineRegistrationHandler - provides calls for retrieving external data engine guid

assetHandler - provides utilities for manipulating the repository services assets

defaultZones - setting of the default zones for the handler

supportedZones - setting of the supported zones for the handler

Method Detail

setSecurityVerifier

public void setSecurityVerifier(OpenMetadataServerSecurityVerifier securityVerifier)

Set up a new security verifier (the handler runs with a default verifier until this method is called).

The security verifier provides authorization checks for access and maintenance changes to open metadata. Authorization checks are enabled through the OpenMetadataServerSecurityConnector.

Parameters:

securityVerifier - new security verifier

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,
                          String processGUID,
                          Process updatedProcess)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Update the process

Parameters:

userId - the name of the calling user

processGUID - the guid of the process to be updated

updatedProcess - the new values of the process

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

findProcess

public String findProcess(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:

unique identifier of the process or null

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addProcessPortRelationship

public void addProcessPortRelationship(String userId,
                                       String processGUID,
                                       String portGUID,
                                       String externalSourceName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Create ProcessPort relationships between a Process asset and the corresponding Ports. Verifies that the relationship is not present before creating it

Parameters:

userId - the name of the calling user

processGUID - the unique identifier of the process

portGUID - the unique identifier of the port

externalSourceName - the unique name of the external source

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

updateProcessStatus

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

Update the process instance status

Parameters:

userId - the name of the calling user

guid - the guid name of the process

instanceStatus - the status of the process

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getPortsForProcess

public Set<String> 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 unique identifiers for 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