Package org.opendaylight.controller.sal.binding.api

Interface BindingAwareConsumer

  • All Known Implementing Classes:
    AbstractBindingAwareConsumer
    @Deprecated(forRemoval=true)
public interface BindingAwareConsumer
    Deprecated, for removal: This API element is subject to removal in a future version.
    A developer implemented component that gets registered with the Broker.

    Semantically, a consumer may:

    1. Subscribe for Notifications
    2. Invoke RPCs
    3. Read from either the operational or config data tree
    4. Write to the config data tree
    If you need to:
    1. Emit Notifications
    2. Provide the implementation of RPCs
    3. Write to the operational data tree

    Consider using a BindingAwareProvider

    Examples:

    To get a NotificationService:

    {code public void onSessionInitiated(ProviderContext session) { NotificationProviderService notificationService = session.getSALService(NotificationProviderService.class); notificationService.publish(notification) } where notification is an instance of a modeled Notification. For more information on sending notifications via the NotificationProviderService see org.opendaylight.controller.sal.binding.api.NotificationProviderService

    A consumer can *invoke* and RPC ( ie, call foo(fooArgs)) but it cannot register an RPC implementation with the MD-SAL that others can invoke(call). To get an invokable RPC:

    {code public void onSessionInitiated(ProviderContext session) { MyService rpcFlowSalService = session.getRpcService(MyService.class); }

    Where MyService.class is a Service interface generated from a yang model with RPCs modeled in it. The returned rpcFlowSalService can be used like any other object by invoking its methods. Note, nothing special needs to be done for RoutedRPCs. They just work.

    To get a DataBroker to allow access to the data tree:

    {code public void onSessionInitiated(final ProviderContext session) { DataBroker databroker = session.getSALService(BindingDataBroker.class); } }

    • Method Detail

      • onSessionInitialized

        void onSessionInitialized​(BindingAwareBroker.ConsumerContext session)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Callback signaling initialization of the consumer session to the SAL.

        The consumer MUST use the session for all communication with SAL or retrieving SAL infrastructure services.

        This method is invoked by BindingAwareBroker.registerConsumer(BindingAwareConsumer)

        Parameters:
        session - Unique session between consumer and SAL.