Package org.odpi.openmetadata.accessservices.governanceengine.api

Interface GovernanceProcessingInterface

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

    • Method Detail

      • initiateGovernanceAction

        String initiateGovernanceAction​(String userId,
                                String qualifiedName,
                                int domainIdentifier,
                                String displayName,
                                String description,
                                List<String> requestSourceGUIDs,
                                List<NewActionTarget> actionTargets,
                                List<String> receivedGuards,
                                Date startTime,
                                String governanceEngineName,
                                String requestType,
                                Map<String,​String> requestParameters,
                                String processName,
                                String requestSourceName,
                                String originatorServiceName,
                                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
        processName - name of the process that this action is a part of
        requestSourceName - source of the request
        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

        String initiateGovernanceActionProcess​(String userId,
                                       String processQualifiedName,
                                       List<String> requestSourceGUIDs,
                                       List<NewActionTarget> actionTargets,
                                       Date startTime,
                                       Map<String,​String> requestParameters,
                                       String originatorServiceName,
                                       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

      • updateActionTargetStatus

        void updateActionTargetStatus​(String userId,
                              String actionTargetGUID,
                              GovernanceActionStatus status,
                              Date startDate,
                              Date completionDate,
                              String completionMessage)
                       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.
        completionMessage - message to describe completion results or reasons for failure
        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​(String userId,
                            String governanceActionGUID,
                            Map<String,​String> requestParameters,
                            CompletionStatus status,
                            List<String> outputGuards,
                            List<NewActionTarget> newActionTargets,
                            String completionMessage)
                     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
        completionMessage - message to describe completion results or reasons for failure
        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