Class GovernanceActionProcessStepHandler<B>


public class GovernanceActionProcessStepHandler<B> extends OpenMetadataAPIGenericHandler<B>
GovernanceActionProcessStepHandler manages GovernanceActionProcessStep entities and their relationships.
  • Constructor Details

    • GovernanceActionProcessStepHandler

      public GovernanceActionProcessStepHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)
      Construct the handler for metadata elements.
      Parameters:
      converter - specific converter for this bean class
      beanClass - name of bean class that is represented by the generic class B
      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
      localServerUserId - userId for this server
      securityVerifier - open metadata security services verifier
      supportedZones - list of zones that the access service is allowed to serve Asset instances from.
      defaultZones - list of zones that the access service should set in all new Asset instances.
      publishZones - list of zones that the access service sets up in published Asset instances.
      auditLog - destination for audit log events.
  • Method Details

    • createGovernanceActionProcessStep

      public String createGovernanceActionProcessStep(String userId, String qualifiedName, int domainIdentifier, String displayName, String description, Map<String,String> additionalProperties, String governanceEngineGUID, String requestType, Map<String,String> requestParameters, boolean ignoreMultipleTriggers, int waitTime, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create a new metadata element to represent a governance action process step.
      Parameters:
      userId - calling user
      qualifiedName - unique name for the governance action
      domainIdentifier - governance domain for this governance action
      displayName - short display name for the governance action
      description - description of the governance action
      additionalProperties - additional properties for a governance action
      governanceEngineGUID - unique identifier of governance engine to execute the request
      requestType - type of request
      requestParameters - properties for the request type
      ignoreMultipleTriggers - prevent multiple instances of the next step to run (or not)
      waitTime - minimum number of minutes to wait before running the governance action
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      serviceSupportedZones - supported zones for calling service
      effectiveTime - what is the effective time for related queries needed to do the update
      methodName - calling method
      Returns:
      unique identifier of the new governance action process step
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • updateGovernanceActionProcessStep

      public void updateGovernanceActionProcessStep(String userId, String processStepGUID, boolean isMergeUpdate, String qualifiedName, int domainIdentifier, String displayName, String description, Map<String,String> additionalProperties, String governanceEngineGUID, String requestType, Map<String,String> requestParameters, boolean ignoreMultipleTriggers, int waitTime, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the metadata element representing a governance action process step.
      Parameters:
      userId - calling user
      processStepGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      qualifiedName - unique name for the governance action
      domainIdentifier - governance domain for this governance action
      displayName - short display name for the governance action
      description - description of the governance action
      additionalProperties - additional properties for a governance action
      governanceEngineGUID - unique identifier of governance engine to execute the request
      requestType - type of request
      requestParameters - properties for the request type
      ignoreMultipleTriggers - prevent multiple instances of the next step to run (or not)
      waitTime - minimum number of minutes to wait before running the governance action
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      serviceSupportedZones - supported zones for calling service
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • removeGovernanceActionProcessStep

      public void removeGovernanceActionProcessStep(String userId, String processStepGUID, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the metadata element representing a governance action process step.
      Parameters:
      userId - calling user
      processStepGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      serviceSupportedZones - supported zones for calling service
      effectiveTime - what is the effective time for related queries needed to do the update
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • findGovernanceActionProcessSteps

      public List<B> findGovernanceActionProcessSteps(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the list of governance action process step metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      searchStringParameterName - parameter supplying search string
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      serviceSupportedZones - supported zones for calling service
      effectiveTime - what is the effective time for related queries needed to do the update
      methodName - calling method
      Returns:
      list of matching metadata elements
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • getGovernanceActionProcessStepsByName

      public List<B> getGovernanceActionProcessStepsByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the list of governance action process step metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      userId - calling user
      name - name to search for
      nameParameterName - name of parameter supplying name
      startFrom - paging start point
      pageSize - maximum results that can be returned
      serviceSupportedZones - supported zones for calling service
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Returns:
      list of matching metadata elements
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • getGovernanceActionProcessStepByGUID

      public B getGovernanceActionProcessStepByGUID(String userId, String processStepGUID, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the governance action process step metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      processStepGUID - unique identifier of the governance action process step
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      serviceSupportedZones - supported zones for calling service
      methodName - calling method
      Returns:
      requested metadata element
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • setupFirstProcessStep

      public void setupFirstProcessStep(String userId, String processGUID, String processStepGUID, String guard, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Set up a link between a governance action process and a governance action process step. This defines the first step in the process.
      Parameters:
      userId - calling user
      processGUID - unique identifier of the governance action process
      processStepGUID - unique identifier of the governance action process step
      guard - initial guard to pass to the first governance service called
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship (null for all time)
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      serviceSupportedZones - supported zones for calling service
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • getFirstProcessStep

      public B getFirstProcessStep(String userId, String processGUID, Relationship firstActionProcessStepLink, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Return the governance action process step that is the first step in a governance action process.
      Parameters:
      userId - calling user
      processGUID - unique identifier of the governance action process
      firstActionProcessStepLink - Governance Action Flow relationship (if known)
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      serviceSupportedZones - supported zones for calling service
      methodName - calling method
      Returns:
      properties of the governance action process step
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • getFirstActionProcessStepLink

      public Relationship getFirstActionProcessStepLink(String userId, String processGUID, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Return the governance action process step that is the first step in a governance action process.
      Parameters:
      userId - calling user
      processGUID - unique identifier of the governance action process
      serviceSupportedZones - supported zones for calling service
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Returns:
      properties of the governance action process step
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • removeFirstProcessStep

      public void removeFirstProcessStep(String userId, String processGUID, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the link between a governance process and that governance action process step that defines its first step.
      Parameters:
      userId - calling user
      processGUID - unique identifier of the governance action process
      serviceSupportedZones - supported zones for calling service
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • setupNextProcessStep

      public String setupNextProcessStep(String userId, String currentActionProcessStepGUID, String nextActionProcessStepGUID, String guard, boolean mandatoryGuard, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.
      Parameters:
      userId - calling user
      currentActionProcessStepGUID - unique identifier of the governance action process step that defines the previous step in the governance action process
      nextActionProcessStepGUID - unique identifier of the governance action process step that defines the next step in the governance action process
      guard - guard required for this next step to proceed - or null for always run the next step.
      mandatoryGuard - means that no next steps can run if this guard is not returned
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      serviceSupportedZones - supported zones for calling service
      effectiveTime - what is the effective time for related queries needed to do the update
      methodName - calling method
      Returns:
      unique identifier of the new link
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • updateNextProcessStep

      public void updateNextProcessStep(String userId, String nextProcessStepLinkGUID, String guard, boolean mandatoryGuard, Date effectiveFrom, Date effectiveTo, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the properties of the link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.
      Parameters:
      userId - calling user
      nextProcessStepLinkGUID - unique identifier of the relationship between the governance action process steps
      guard - guard required for this next step to proceed - or null for always run the next step.
      mandatoryGuard - means that no next steps can run if this guard is not returned
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • getNextGovernanceActionProcessSteps

      public List<Relationship> getNextGovernanceActionProcessSteps(String userId, String processStepGUID, int startFrom, int pageSize, List<String> serviceSupportedZones, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Return the list of next action process step defined for the governance action process.
      Parameters:
      userId - calling user
      processStepGUID - unique identifier of the current governance action process step
      startFrom - paging start point
      pageSize - maximum results that can be returned
      serviceSupportedZones - supported zones for calling service
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      Returns:
      return the list of relationships and attached governance action process steps.
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)
    • removeNextProcessStep

      public void removeNextProcessStep(String userId, String actionLinkGUID, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove a follow-on step from a governance action process.
      Parameters:
      userId - calling user
      actionLinkGUID - unique identifier of the relationship between the governance action process steps
      methodName - calling method
      Throws:
      InvalidParameterException - one of the parameters is invalid
      UserNotAuthorizedException - the user is not authorized to issue this request
      PropertyServerException - there is a problem reported in the open metadata server(s)