Class GovernanceActionProcessClient

  • All Implemented Interfaces:
    GovernanceActionProcessInterface

    public class GovernanceActionProcessClient
    extends java.lang.Object
    implements GovernanceActionProcessInterface
    GovernanceEngineClient sits in the governance context of a governance action service when it is running in the engine host OMAG server. It is however shared by all the governance action services running in an engine service so that we only need one connector to the topic listener for the watchdog governance services.
    • Constructor Summary

      Constructors 
      Constructor Description
      GovernanceActionProcessClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      GovernanceActionProcessClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String serverUserId, java.lang.String serverPassword)
      Create a new client that passes userId and password in each HTTP request.
      GovernanceActionProcessClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, GovernanceEngineRESTClient restClient, int maxPageSize)
      Create a new client that passes userId and password in each HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String createGovernanceActionProcess​(java.lang.String userId, GovernanceActionProcessProperties processProperties, ProcessStatus initialStatus)
      Create a new metadata element to represent a governance action process.
      java.lang.String createGovernanceActionType​(java.lang.String userId, GovernanceActionTypeProperties actionTypeProperties)
      Create a new metadata element to represent a governance action type.
      java.util.List<GovernanceActionProcessElement> findGovernanceActionProcesses​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of governance action process metadata elements that contain the search string.
      java.util.List<GovernanceActionTypeElement> findGovernanceActionTypes​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of governance action type metadata elements that contain the search string.
      GovernanceActionTypeElement getFirstActionType​(java.lang.String userId, java.lang.String processGUID)
      Return the governance action type that is the first step in a governance action process.
      GovernanceActionProcessElement getGovernanceActionProcessByGUID​(java.lang.String userId, java.lang.String processGUID)
      Retrieve the governance action process metadata element with the supplied unique identifier.
      java.util.List<GovernanceActionProcessElement> getGovernanceActionProcessesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of governance action process metadata elements with a matching qualified or display name.
      GovernanceActionTypeElement getGovernanceActionTypeByGUID​(java.lang.String userId, java.lang.String actionTypeGUID)
      Retrieve the governance action type metadata element with the supplied unique identifier.
      java.util.List<GovernanceActionTypeElement> getGovernanceActionTypesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of governance action type metadata elements with a matching qualified or display name.
      java.util.List<NextGovernanceActionTypeElement> getNextGovernanceActionTypes​(java.lang.String userId, java.lang.String actionTypeGUID, int startFrom, int pageSize)
      Return the lust of next action type defined for the governance action process.
      void publishGovernanceActionProcess​(java.lang.String userId, java.lang.String processGUID)
      Update the zones for the asset so that it becomes visible to consumers.
      void removeFirstActionType​(java.lang.String userId, java.lang.String processGUID)
      Remove the link between a governance process and that governance action type that defines its first step.
      void removeGovernanceActionProcess​(java.lang.String userId, java.lang.String processGUID)
      Remove the metadata element representing a governance action process.
      void removeGovernanceActionType​(java.lang.String userId, java.lang.String actionTypeGUID)
      Remove the metadata element representing a governance action type.
      void removeNextActionType​(java.lang.String userId, java.lang.String actionLinkGUID)
      Remove a follow on step from a governance action process.
      void setupFirstActionType​(java.lang.String userId, java.lang.String processGUID, java.lang.String actionTypeGUID, java.lang.String guard)
      Set up a link between an governance action process and a governance action type.
      java.lang.String setupNextActionType​(java.lang.String userId, java.lang.String currentActionTypeGUID, java.lang.String nextActionTypeGUID, java.lang.String guard, boolean mandatoryGuard, boolean ignoreMultipleTriggers)
      Add a link between two governance action types to show that one follows on from the other when a governance action process is executing.
      void updateGovernanceActionProcess​(java.lang.String userId, java.lang.String processGUID, boolean isMergeUpdate, ProcessStatus processStatus, GovernanceActionProcessProperties processProperties)
      Update the metadata element representing a governance action process.
      void updateGovernanceActionType​(java.lang.String userId, java.lang.String actionTypeGUID, boolean isMergeUpdate, GovernanceActionTypeProperties actionTypeProperties)
      Update the metadata element representing a governance action type.
      void updateNextActionType​(java.lang.String userId, java.lang.String nextActionLinkGUID, java.lang.String guard, boolean mandatoryGuard, boolean ignoreMultipleTriggers)
      Update the properties of the link between two governance action types that shows that one follows on from the other when a governance action process is executing.
      void withdrawGovernanceActionProcess​(java.lang.String userId, java.lang.String processGUID)
      Update the zones for the asset so that it is no longer visible to consumers.
      • Methods inherited from class java.lang.Object

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