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

Class DataEngineProcessHandler

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.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataEngineProcessHandler(String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, org.odpi.openmetadata.commonservices.generichandlers.AssetHandler<org.odpi.openmetadata.accessservices.dataengine.model.Process> assetHandler, DataEngineRegistrationHandler registrationHandler, DataEngineCommonHandler dataEngineCommonHandler)
    Construct the handler information needed to interact with the repository services

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    createProcess(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Process process, String externalSourceName)
    Create the process
    Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail>
    findProcessEntity(String userId, String qualifiedName)
    Find out if the Process object is already stored in the repository.
    Set<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.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, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic)
    Remove the process
    void
    updateProcess(String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail originalProcessEntity, org.odpi.openmetadata.accessservices.dataengine.model.Process updatedProcess, String externalSourceName)
    Update the process
    void
    updateProcessStatus(String userId, String processGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus instanceStatus, String externalSourceName)
    Update the process instance status
    void
    upsertProcessHierarchyRelationship(String userId, org.odpi.openmetadata.accessservices.dataengine.model.ParentProcess parentProcess, String processGUID, String externalSourceName)
    Creates a process hierarchy relationship

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DataEngineProcessHandler

      public DataEngineProcessHandler(String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, org.odpi.openmetadata.commonservices.generichandlers.AssetHandler<org.odpi.openmetadata.accessservices.dataengine.model.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 engine entities

  • Method Details

    • createProcess

      public String createProcess(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Process process, String externalSourceName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • updateProcess

      public void updateProcess(String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail originalProcessEntity, org.odpi.openmetadata.accessservices.dataengine.model.Process updatedProcess, String externalSourceName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • findProcessEntity

      public Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> findProcessEntity(String userId, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • updateProcessStatus

      public void updateProcessStatus(String userId, String processGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus instanceStatus, String externalSourceName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • getPortsForProcess

      public Set<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> getPortsForProcess(String userId, String processGUID, String portTypeName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • upsertProcessHierarchyRelationship

      public void upsertProcessHierarchyRelationship(String userId, org.odpi.openmetadata.accessservices.dataengine.model.ParentProcess parentProcess, String processGUID, String externalSourceName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Creates a process hierarchy relationship
      Parameters:
      userId - the name of the calling user
      parentProcess - the parent process
      processGUID - the process GUID
      externalSourceName - the external data engine
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • removeProcess

      public void removeProcess(String userId, String processGUID, String externalSourceName, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.repositoryservices.ffdc.exception.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server
      org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException - the repository does not support this call.