Package org.opendaylight.controller.messagebus.spi

Interface EventSource

  • All Superinterfaces:
    AutoCloseable, org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.EventSourceService, org.opendaylight.yangtools.yang.binding.RpcService
    public interface EventSource
extends org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.EventSourceService, AutoCloseable
    Event source is a node in topology which is able to produce notifications. To register event source you use EventSourceRegistry.registerEventSource(EventSource). EventSourceRegistry will request registered event source to publish notifications whenever EventSourceRegistry has been asked to publish a certain type of notifications. EventSourceRegistry will call method JoinTopic to request EventSource to publish notification. Event source must implement method JoinTopic (from superinterface EventSourceService).

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      List<org.opendaylight.yangtools.yang.model.api.SchemaPath> getAvailableNotifications()
      List the types of notifications which source can produce.
      org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey getSourceNodeKey()
      Identifier of node associated with event source.

      • Methods inherited from interface org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventsource.rev141202.EventSourceService

        disJoinTopic, joinTopic

    • Method Detail

      • getSourceNodeKey

        org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey getSourceNodeKey()
        Identifier of node associated with event source.
        Returns:
        instance of NodeKey

      • getAvailableNotifications

        List<org.opendaylight.yangtools.yang.model.api.SchemaPath> getAvailableNotifications()
        List the types of notifications which source can produce.
        Returns:
        list of available notification