Interface GovernanceProcessingInterface

  • All Known Implementing Classes:
    GovernanceEngineClient

    public interface GovernanceProcessingInterface
    GovernanceProcessingInterface provides support for the execution of Governance Action Processes through Governance Actions.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void claimGovernanceAction​(java.lang.String userId, java.lang.String governanceActionGUID)
      Request that execution of a governance action is allocated to the caller.
      java.util.List<GovernanceActionElement> getActiveClaimedGovernanceActions​(java.lang.String userId, java.lang.String governanceEngineGUID, int startFrom, int pageSize)
      Retrieve the governance actions that are still in process and that have been claimed by this caller's userId.
      java.util.List<GovernanceActionElement> getActiveGovernanceActions​(java.lang.String userId, int startFrom, int pageSize)
      Retrieve the governance actions that are still in process.
      GovernanceActionElement getGovernanceAction​(java.lang.String userId, java.lang.String governanceActionGUID)
      Request the status of an executing governance action request.
      java.util.List<GovernanceActionElement> getGovernanceActions​(java.lang.String userId, int startFrom, int pageSize)
      Retrieve the governance actions that are known to the server.
      java.lang.String initiateGovernanceAction​(java.lang.String userId, java.lang.String qualifiedName, int domainIdentifier, java.lang.String displayName, java.lang.String description, java.util.List<java.lang.String> requestSourceGUIDs, java.util.List<NewActionTarget> actionTargets, java.util.List<java.lang.String> receivedGuards, java.util.Date startTime, java.lang.String governanceEngineName, java.lang.String requestType, java.util.Map<java.lang.String,​java.lang.String> requestParameters, java.lang.String originatorServiceName, java.lang.String originatorEngineName)
      Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type.
      java.lang.String initiateGovernanceActionProcess​(java.lang.String userId, java.lang.String processQualifiedName, java.util.List<java.lang.String> requestSourceGUIDs, java.util.List<NewActionTarget> actionTargets, java.util.Date startTime, java.util.Map<java.lang.String,​java.lang.String> requestParameters, java.lang.String originatorServiceName, java.lang.String originatorEngineName)
      Using the named governance action process as a template, initiate a chain of governance actions.
      void recordCompletionStatus​(java.lang.String userId, java.lang.String governanceActionGUID, java.util.Map<java.lang.String,​java.lang.String> requestParameters, CompletionStatus status, java.util.List<java.lang.String> outputGuards, java.util.List<NewActionTarget> newActionTargets)
      Declare that all the processing for the governance action service is finished and the status of the work.
      void updateActionTargetStatus​(java.lang.String userId, java.lang.String actionTargetGUID, GovernanceActionStatus status, java.util.Date startDate, java.util.Date completionDate)
      Update the status of a specific action target.
      void updateGovernanceActionStatus​(java.lang.String userId, java.lang.String governanceActionGUID, GovernanceActionStatus governanceActionStatus)
      Update the status of the governance action - providing the caller is permitted.
    • Method Detail

      • initiateGovernanceAction

        java.lang.String initiateGovernanceAction​(java.lang.String userId,
                                                  java.lang.String qualifiedName,
                                                  int domainIdentifier,
                                                  java.lang.String displayName,
                                                  java.lang.String description,
                                                  java.util.List<java.lang.String> requestSourceGUIDs,
                                                  java.util.List<NewActionTarget> actionTargets,
                                                  java.util.List<java.lang.String> receivedGuards,
                                                  java.util.Date startTime,
                                                  java.lang.String governanceEngineName,
                                                  java.lang.String requestType,
                                                  java.util.Map<java.lang.String,​java.lang.String> requestParameters,
                                                  java.lang.String originatorServiceName,
                                                  java.lang.String originatorEngineName)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException
        Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type. The governance action remains to act as a record of the actions taken for auditing.
        Parameters:
        userId - caller's userId
        qualifiedName - unique identifier to give this governance action
        domainIdentifier - governance domain associated with this action (0=ALL)
        displayName - display name for this action
        description - description for this action
        requestSourceGUIDs - request source elements for the resulting governance action service
        actionTargets - list of action target names to GUIDs for the resulting governance action service
        receivedGuards - list of guards to initiate the governance action
        startTime - future start time or null for "as soon as possible"
        governanceEngineName - name of the governance engine that should execute the request
        requestType - request type to identify the governance action service to run
        requestParameters - properties to pass to the governance action service
        originatorServiceName - unique name of the requesting governance service (if initiated by a governance engine).
        originatorEngineName - optional unique name of the requesting governance engine (if initiated by a governance engine).
        Returns:
        unique identifier of the governance action
        Throws:
        InvalidParameterException - null qualified name
        UserNotAuthorizedException - this governance action service is not authorized to create a governance action
        PropertyServerException - there is a problem with the metadata store
      • initiateGovernanceActionProcess

        java.lang.String initiateGovernanceActionProcess​(java.lang.String userId,
                                                         java.lang.String processQualifiedName,
                                                         java.util.List<java.lang.String> requestSourceGUIDs,
                                                         java.util.List<NewActionTarget> actionTargets,
                                                         java.util.Date startTime,
                                                         java.util.Map<java.lang.String,​java.lang.String> requestParameters,
                                                         java.lang.String originatorServiceName,
                                                         java.lang.String originatorEngineName)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException
        Using the named governance action process as a template, initiate a chain of governance actions.
        Parameters:
        userId - caller's userId
        processQualifiedName - unique name of the governance action process to use
        requestSourceGUIDs - request source elements for the resulting governance action service
        actionTargets - map of action target names to GUIDs for the resulting governance action service
        startTime - future start time or null for "as soon as possible"
        requestParameters - request properties to be passed to the first governance action
        originatorServiceName - unique name of the requesting governance service (if initiated by a governance engine).
        originatorEngineName - optional unique name of the governance engine (if initiated by a governance engine).
        Returns:
        unique identifier of the first governance action of the process
        Throws:
        InvalidParameterException - null or unrecognized qualified name of the process
        UserNotAuthorizedException - this governance action service is not authorized to create a governance action process
        PropertyServerException - there is a problem with the metadata store
      • getActiveClaimedGovernanceActions

        java.util.List<GovernanceActionElement> getActiveClaimedGovernanceActions​(java.lang.String userId,
                                                                                  java.lang.String governanceEngineGUID,
                                                                                  int startFrom,
                                                                                  int pageSize)
                                                                           throws InvalidParameterException,
                                                                                  UserNotAuthorizedException,
                                                                                  PropertyServerException
        Retrieve the governance 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 governance action elements
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        UserNotAuthorizedException - user not authorized to issue this request.
        PropertyServerException - there was a problem detected by the metadata store.
      • updateActionTargetStatus

        void updateActionTargetStatus​(java.lang.String userId,
                                      java.lang.String actionTargetGUID,
                                      GovernanceActionStatus status,
                                      java.util.Date startDate,
                                      java.util.Date completionDate)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      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 governance action service.
        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.
        Throws:
        InvalidParameterException - the action target GUID is not recognized
        UserNotAuthorizedException - the governance action service is not authorized to update the action target properties
        PropertyServerException - there is a problem connecting to the metadata store
      • recordCompletionStatus

        void recordCompletionStatus​(java.lang.String userId,
                                    java.lang.String governanceActionGUID,
                                    java.util.Map<java.lang.String,​java.lang.String> requestParameters,
                                    CompletionStatus status,
                                    java.util.List<java.lang.String> outputGuards,
                                    java.util.List<NewActionTarget> newActionTargets)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Declare that all the processing for the governance action service is finished and the status of the work.
        Parameters:
        userId - caller's userId
        governanceActionGUID - unique identifier of the governance action to update
        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
        Throws:
        InvalidParameterException - the completion status is null
        UserNotAuthorizedException - the governance action service is not authorized to update the governance action service status
        PropertyServerException - there is a problem connecting to the metadata store