Package org.odpi.openmetadata.frameworks.governanceaction.client

Interface GovernanceCompletionInterface

public interface GovernanceCompletionInterface
GovernanceCompletionInterface provides support for completing a governance service.

  • Method Details

    • updateEngineActionStatus

      void updateEngineActionStatus(String userId, String engineActionGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.EngineActionStatus engineActionStatus) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the status of the engine action - providing the caller is permitted.
      Parameters:
      userId - identifier of calling user
      engineActionGUID - identifier of the engine action request
      engineActionStatus - new status enum
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the metadata store.

    • getActiveClaimedEngineActions

      List<EngineActionElement> getActiveClaimedEngineActions(String userId, String governanceEngineGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the engine actions that are still in process and that have been claimed by this caller's userId. This call is used when the caller restarts.
      Parameters:
      userId - userId of caller
      governanceEngineGUID - unique identifier of governance engine
      startFrom - starting from element
      pageSize - maximum elements to return
      Returns:
      list of engine action elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the metadata store.

    • claimEngineAction

      void claimEngineAction(String userId, String engineActionGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Request that execution of a engine action is allocated to the caller.
      Parameters:
      userId - identifier of calling user
      engineActionGUID - identifier of the engine action request.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the metadata store.

    • updateActionTargetStatus

      void updateActionTargetStatus(String userId, String actionTargetGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.EngineActionStatus status, Date startDate, Date completionDate, String completionMessage) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the status of a specific action target. By default, these values are derived from the values for the governance action service. However, if the governance action service has to process name target elements, then setting the status on each individual target will show the progress of the governance action service.
      Parameters:
      userId - caller's userId
      actionTargetGUID - unique identifier of the target element.
      status - status enum to show its progress
      startDate - date/time that the governance action service started processing the target
      completionDate - date/time that the governance process completed processing this target.
      completionMessage - message to describe completion results or reasons for failure
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the action target GUID is not recognized
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update the action target properties
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem connecting to the metadata store

    • recordCompletionStatus

      void recordCompletionStatus(String userId, String engineActionGUID, Map<String,String> requestParameters, CompletionStatus status, List<String> outputGuards, List<NewActionTarget> newActionTargets, String completionMessage) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Declare that all the processing for the governance action service is finished and the status of the work.
      Parameters:
      userId - caller's userId
      engineActionGUID - unique identifier of the associated engine action
      requestParameters - request properties from the caller (will be passed onto any follow on actions)
      status - completion status enum value
      outputGuards - optional guard strings for triggering subsequent action(s)
      newActionTargets - list of action target names to GUIDs for the resulting governance action service
      completionMessage - message to describe completion results or reasons for failure
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the completion status is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update the governance action service status
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem connecting to the metadata store