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

    • GovernanceActionEngine

      public GovernanceActionEngine()
  • Method Details

    • 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.
      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
      unique identifier of the governance action
      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.
      userId - identifier of calling user
      governanceActionGUID - identifier of the governance action request.
      status enum
      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.