Class GovernanceContextClient

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.client.OpenGovernanceClientBase
org.odpi.openmetadata.frameworkservices.gaf.client.GovernanceContextClientBase
org.odpi.openmetadata.accessservices.governanceengine.client.GovernanceContextClient
All Implemented Interfaces:
org.odpi.openmetadata.frameworks.governanceaction.client.ActionControlInterface, org.odpi.openmetadata.frameworks.governanceaction.client.DuplicateManagementInterface, org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionProcessInterface, org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceActionTypeInterface, org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceCompletionInterface, org.odpi.openmetadata.frameworks.governanceaction.client.WatchDogEventInterface

public class GovernanceContextClient extends org.odpi.openmetadata.frameworkservices.gaf.client.GovernanceContextClientBase
GovernanceContextClient 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
    GovernanceContextClient(String serverName, String serverPlatformURLRoot, int maxPageSize)
    Create a new client with no authentication embedded in the HTTP request.
    GovernanceContextClient(String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword, int maxPageSize)
    Create a new client that passes userId and password in each HTTP request.
    GovernanceContextClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworkservices.gaf.client.rest.GAFRESTClient restClient, int maxPageSize)
    Create a new client that passes userId and password in each HTTP request.
  • Method Summary

    Methods inherited from class org.odpi.openmetadata.frameworkservices.gaf.client.GovernanceContextClientBase

    claimEngineAction, disconnectListener, getActiveClaimedEngineActions, recordCompletionStatus, registerListener, setListenerManager, updateActionTargetStatus, updateEngineActionStatus

    Methods inherited from class org.odpi.openmetadata.frameworkservices.gaf.client.OpenGovernanceClientBase

    cancelEngineAction, createGovernanceActionProcess, createGovernanceActionProcessStep, createGovernanceActionType, findEngineActions, findGovernanceActionProcesses, findGovernanceActionProcessSteps, findGovernanceActionTypes, getActiveEngineActions, getEngineAction, getEngineActions, getEngineActionsByName, getFirstActionProcessStep, getGovernanceActionProcessByGUID, getGovernanceActionProcessesByName, getGovernanceActionProcessGraph, getGovernanceActionProcessStepByGUID, getGovernanceActionProcessStepsByName, getGovernanceActionTypeByGUID, getGovernanceActionTypesByName, getNextGovernanceActionProcessSteps, initiateEngineAction, initiateGovernanceActionProcess, initiateGovernanceActionType, linkConsolidatedDuplicate, linkElementsAsPeerDuplicates, publishGovernanceActionProcess, removeFirstActionProcessStep, removeGovernanceActionProcess, removeGovernanceActionProcessStep, removeGovernanceActionType, removeNextActionProcessStep, setupFirstActionProcessStep, setupNextActionProcessStep, updateGovernanceActionProcess, updateGovernanceActionProcessStep, updateGovernanceActionType, updateNextActionProcessStep, withdrawGovernanceActionProcess

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • GovernanceContextClient

      public GovernanceContextClient(String serverName, String serverPlatformURLRoot, int maxPageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      maxPageSize - pre-initialized parameter limit
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • GovernanceContextClient

      public GovernanceContextClient(String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword, int maxPageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      serverUserId - caller's userId embedded in all HTTP requests
      serverPassword - caller's password embedded in all HTTP requests
      maxPageSize - pre-initialized parameter limit
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • GovernanceContextClient

      public GovernanceContextClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworkservices.gaf.client.rest.GAFRESTClient restClient, int maxPageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      restClient - pre-initialized REST client
      maxPageSize - pre-initialized parameter limit
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem with the information about the remote OMAS