Package org.odpi.openmetadata.frameworks.governanceaction.client

Class WatchDogEventClient

java.lang.Object
org.odpi.openmetadata.frameworks.governanceaction.client.WatchDogEventClient
All Implemented Interfaces:
GovernanceCompletionInterface, SpecialGovernanceActionInterface
public abstract class WatchDogEventClient extends Object implements GovernanceCompletionInterface, SpecialGovernanceActionInterface
OpenGovernanceClient provides services to support the governance context. It is implemented by a metadata repository provider. In Egeria, this class is implemented partly by the GAF metadata management services and partly by the Governance Action OMES running in the engine host OMAG Server.

  • Constructor Details

    • WatchDogEventClient

      public WatchDogEventClient(String serviceURLMarker, String serverName, String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services

  • Method Details

    • registerListener

      public abstract void registerListener(WatchdogGovernanceListener listener, List<WatchdogEventType> interestingEventTypes, List<String> interestingMetadataTypes, String specificInstance) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Register a listener to receive events about changes to metadata elements in the open metadata store. There can be only one registered listener. If this method is called more than once, the new parameters replace the existing parameters. This means the watchdog governance action service can change the listener and the parameters that control the types of events received while it is running. The types of events passed to the listener are controlled by the combination of the interesting event types and the interesting metadata types. That is an event is only passed to the listener if it matches both the interesting event types and the interesting metadata types. If specific instance, interestingEventTypes or interestingMetadataTypes are null, it defaults to "any". If the listener parameter is null, no more events are passed to the listener.
      Parameters:
      listener - listener object to receive events
      interestingEventTypes - types of events that should be passed to the listener
      interestingMetadataTypes - types of elements that are the subject of the interesting event types
      specificInstance - unique identifier of a specific instance to watch for
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one or more of the type names are unrecognized

    • disconnectListener

      public abstract void disconnectListener()
      Unregister the listener from the event infrastructure.

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      print out of variables in a JSON-style