Package org.odpi.openmetadata.frameworks.governanceaction

Class GovernanceActionEngine

java.lang.Object

org.odpi.openmetadata.frameworks.governanceaction.GovernanceActionEngine

public abstract class GovernanceActionEngine
extends Object

GovernanceActionEngine provides the interface for a governance action engine. The governance action engine runs inside a governance action server. The governance action server provides the server runtime environment for the governance action engine along with the interfaces for configuring the governance action engine.

Constructor Summary

Constructors

Constructor	Description
GovernanceActionEngine()

Method Summary

Modifier and Type	Method	Description
abstract GovernanceActionStatus	getGovernanceActionStatus(String userId, String governanceActionGUID)	Request the status of an executing governance action request.
abstract String	initiateGovernanceAction(String userId, String qualifiedName, int domainIdentifier, String displayName, String description, List<String> requestSourceGUIDs, List<String> actionTargetGUIDs, Date startTime, String requestType, Map<String,String> requestParameters)	Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GovernanceActionEngine

public GovernanceActionEngine()

Method Detail

initiateGovernanceAction

public abstract String initiateGovernanceAction(String userId,
                                                String qualifiedName,
                                                int domainIdentifier,
                                                String displayName,
                                                String description,
                                                List<String> requestSourceGUIDs,
                                                List<String> actionTargetGUIDs,
                                                Date startTime,
                                                String requestType,
                                                Map<String,String> requestParameters)
                                         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 - calling user

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

actionTargetGUIDs - list of action targets for the resulting governance action service

startTime - future start time or null for "as soon as possible".

requestType - request type to identify the governance action service to run

requestParameters - properties to pass to the governance action service

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

getGovernanceActionStatus

public abstract GovernanceActionStatus getGovernanceActionStatus(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.