Package org.odpi.openmetadata.repositoryservices.connectors.omrstopic

Interface OMRSTopic

All Known Implementing Classes:
OMRSTopicConnector
public interface OMRSTopic
OMRSTopic defines the interface to the messaging Topic for OMRS Events. It implemented by the OMRSTopicConnector.

  • Method Details

    • setEventProtocolLevel

      void setEventProtocolLevel(OMRSEventProtocolVersion eventProtocolVersion)
      Set up the version of the protocol to use for events.
      Parameters:
      eventProtocolVersion - version enum

    • registerListener

      @Deprecated void registerListener(OMRSTopicListener newListener)
      Deprecated.
      Register a listener object. This object will be supplied with all the events received on the topic.
      Parameters:
      newListener - object implementing the OMRSTopicListener interface

    • registerListener

      void registerListener(OMRSTopicListener newListener, String serviceName)
      Register a listener object. This object will be supplied with all the events received on the topic.
      Parameters:
      newListener - object implementing the OMRSTopicListener interface
      serviceName - name of service that the listener is from

    • registerListener

      void registerListener(OMRSTopicRepositoryEventListener newListener, String serviceName)
      Register a listener object. This object will be supplied with all the events received on the topic.
      Parameters:
      newListener - object implementing the OMRSTopicRepositoryEventListener interface
      serviceName - name of service that the listener is from

    • sendRegistryEvent

      CompletableFuture<Boolean> sendRegistryEvent(OMRSRegistryEvent event) throws ConnectorCheckedException
      Sends the supplied event to the topic.
      Parameters:
      event - OMRSRegistryEvent object containing the event properties.
      Throws:
      ConnectorCheckedException - the connector is not able to communicate with the event bus

    • sendTypeDefEvent

      CompletableFuture<Boolean> sendTypeDefEvent(OMRSTypeDefEvent event) throws ConnectorCheckedException
      Sends the supplied event to the topic.
      Parameters:
      event - OMRSTypeDefEvent object containing the event properties.
      Returns:
      a future that has the result (boolean) of sendEvent
      Throws:
      ConnectorCheckedException - the connector is not able to communicate with the event bus

    • sendInstanceEvent

      void sendInstanceEvent(OMRSInstanceEvent event) throws ConnectorCheckedException
      Sends the supplied event to the topic.
      Parameters:
      event - OMRSInstanceEvent object containing the event properties.
      Throws:
      ConnectorCheckedException - the connector is not able to communicate with the event bus