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 Summary

Modifier and Type	Method and Description
void	claimGovernanceAction(String userId, String governanceActionGUID) Request that execution of a governance action is allocated to the caller.
String	createIncidentReport(String userId, String qualifiedName, int domainIdentifier, String background, List<IncidentImpactedElement> impactedResources, List<IncidentDependency> previousIncidents, Map<String,Integer> incidentClassifiers, Map<String,String> additionalProperties, String originatorGUID) Create an incident report to capture the situation detected by this governance action service.
List<GovernanceActionElement>	getActiveClaimedGovernanceActions(String userId, 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.
List<GovernanceActionElement>	getActiveGovernanceActions(String userId, int startFrom, int pageSize) Retrieve the governance actions that are still in process.
GovernanceActionElement	getGovernanceAction(String userId, String governanceActionGUID) Request the status of an executing governance action request.
List<GovernanceActionElement>	getGovernanceActions(String userId, int startFrom, int pageSize) Retrieve the governance actions that are known to the server.
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 originatorServiceName, String originatorEngineName) Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type.
String	initiateGovernanceActionProcess(String userId, String processQualifiedName, List<String> requestSourceGUIDs, List<NewActionTarget> actionTargets, Date startTime, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName) Using the named governance action process as a template, initiate a chain of governance actions.
void	recordCompletionStatus(String userId, String governanceActionGUID, Map<String,String> requestParameters, CompletionStatus status, List<String> outputGuards, List<NewActionTarget> newActionTargets) Declare that all of the processing for the governance action service is finished and the status of the work.
void	updateActionTargetStatus(String userId, String actionTargetGUID, GovernanceActionStatus status, Date startDate, Date completionDate) Update the status of a specific action target.
void	updateGovernanceActionStatus(String userId, String governanceActionGUID, GovernanceActionStatus governanceActionStatus) Update the status of the governance action - providing the caller is permitted.

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 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

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

createIncidentReport

String createIncidentReport(String userId,
                            String qualifiedName,
                            int domainIdentifier,
                            String background,
                            List<IncidentImpactedElement> impactedResources,
                            List<IncidentDependency> previousIncidents,
                            Map<String,Integer> incidentClassifiers,
                            Map<String,String> additionalProperties,
                            String originatorGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Create an incident report to capture the situation detected by this governance action service. This incident report will be processed by other governance activities.

Parameters:

userId - caller's userId

qualifiedName - unique identifier to give this new incident report

domainIdentifier - governance domain associated with this action (0=ALL)

background - description of the situation

impactedResources - details of the resources impacted by this situation

previousIncidents - links to previous incident reports covering this situation

incidentClassifiers - initial classifiers for the incident report

additionalProperties - additional arbitrary properties for the incident reports

originatorGUID - the unique identifier of the person or process that created the incident

Returns:

unique identifier of the resulting incident report

Throws:

InvalidParameterException - null or non-unique qualified name for the incident report

UserNotAuthorizedException - this governance action service is not authorized to create a incident report

PropertyServerException - there is a problem with the metadata store

getGovernanceAction

GovernanceActionElement getGovernanceAction(String userId,
                                            String governanceActionGUID)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Request the status of an executing governance action request.

Parameters:

userId - identifier of calling user

governanceActionGUID - identifier of the governance action request.

Returns:

status enum

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.

claimGovernanceAction

void claimGovernanceAction(String userId,
                           String governanceActionGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Request that execution of a governance action is allocated to the caller.

Parameters:

userId - identifier of calling user

governanceActionGUID - identifier of the governance action request.

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.

getGovernanceActions

List<GovernanceActionElement> getGovernanceActions(String userId,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the governance actions that are known to the server.

Parameters:

userId - userId of caller

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.

getActiveGovernanceActions

List<GovernanceActionElement> getActiveGovernanceActions(String userId,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Retrieve the governance actions that are still in process.

Parameters:

userId - userId of caller

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.

getActiveClaimedGovernanceActions

List<GovernanceActionElement> getActiveClaimedGovernanceActions(String userId,
                                                                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(String userId,
                              String actionTargetGUID,
                              GovernanceActionStatus status,
                              Date startDate,
                              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

updateGovernanceActionStatus

void updateGovernanceActionStatus(String userId,
                                  String governanceActionGUID,
                                  GovernanceActionStatus governanceActionStatus)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Update the status of the governance action - providing the caller is permitted.

Parameters:

userId - identifier of calling user

governanceActionGUID - identifier of the governance action request

governanceActionStatus - new status enum

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.

recordCompletionStatus

void recordCompletionStatus(String userId,
                            String governanceActionGUID,
                            Map<String,String> requestParameters,
                            CompletionStatus status,
                            List<String> outputGuards,
                            List<NewActionTarget> newActionTargets)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Declare that all of 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