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 Summary

Modifier and Type	Method	Description
void	claimGovernanceAction(String userId, String governanceActionGUID)	Request that execution of a governance action is allocated to the caller.
List<GovernanceActionElement>	findGovernanceActions(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of governance action metadata elements that contain the search string.
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.
List<GovernanceActionElement>	getGovernanceActionsByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of governance action metadata elements with a matching qualified or display name.
void	recordCompletionStatus(String userId, String governanceActionGUID, Map<String,String> requestParameters, org.odpi.openmetadata.frameworks.governanceaction.properties.CompletionStatus status, List<String> outputGuards, List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> newActionTargets, String completionMessage)	Declare that all the processing for the governance action service is finished and the status of the work.
void	updateActionTargetStatus(String userId, String actionTargetGUID, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionStatus status, Date startDate, Date completionDate, String completionMessage)	Update the status of a specific action target.
void	updateGovernanceActionStatus(String userId, String governanceActionGUID, org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionStatus governanceActionStatus)	Update the status of the governance action - providing the caller is permitted.

Method Details

getGovernanceAction

GovernanceActionElement getGovernanceAction(String userId,
 String governanceActionGUID)
                                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

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.

claimGovernanceAction

void claimGovernanceAction(String userId,
 String governanceActionGUID)
                    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 governance action is allocated to the caller.

Parameters:

userId - identifier of calling user

governanceActionGUID - identifier of the governance 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.

getGovernanceActions

List<GovernanceActionElement> getGovernanceActions(String userId,
 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 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:

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.

getActiveGovernanceActions

List<GovernanceActionElement> getActiveGovernanceActions(String userId,
 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 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:

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.

getActiveClaimedGovernanceActions

List<GovernanceActionElement> getActiveClaimedGovernanceActions(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 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:

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.

findGovernanceActions

List<GovernanceActionElement> findGovernanceActions(String userId,
 String searchString,
 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 list of governance action 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

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceActionsByName

List<GovernanceActionElement> getGovernanceActionsByName(String userId,
 String name,
 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 list of governance action 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

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

updateActionTargetStatus

void updateActionTargetStatus(String userId,
 String actionTargetGUID,
 org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionStatus 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 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:

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

updateGovernanceActionStatus

void updateGovernanceActionStatus(String userId,
 String governanceActionGUID,
 org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionStatus governanceActionStatus)
                           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 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:

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.

recordCompletionStatus

void recordCompletionStatus(String userId,
 String governanceActionGUID,
 Map<String,String> requestParameters,
 org.odpi.openmetadata.frameworks.governanceaction.properties.CompletionStatus status,
 List<String> outputGuards,
 List<org.odpi.openmetadata.frameworks.governanceaction.properties.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

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:

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