Package org.opendaylight.controller.sal.binding.impl

Class RootBindingAwareBroker

    • Constructor Detail

      • RootBindingAwareBroker

        public RootBindingAwareBroker​(String instanceName)
        Deprecated, for removal: This API element is subject to removal in a future version.

    • Method Detail

      • getIdentifier

        public String getIdentifier()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        getIdentifier in interface Identifiable<String>

      • getNotificationBroker

        public NotificationProviderService getNotificationBroker()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getNotificationPublishService

        public NotificationPublishService getNotificationPublishService()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getRpcProviderRegistry

        public RpcProviderRegistry getRpcProviderRegistry()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getRpcBroker

        public RpcProviderRegistry getRpcBroker()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getMountService

        public MountPointService getMountService()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • setDataBroker

        public void setDataBroker​(DataBroker asyncDataBroker)
        Deprecated, for removal: This API element is subject to removal in a future version.

      • setMountService

        public void setMountService​(MountPointService mount)
        Deprecated, for removal: This API element is subject to removal in a future version.

      • setRpcBroker

        public void setRpcBroker​(RpcProviderRegistry rpcBroker)
        Deprecated, for removal: This API element is subject to removal in a future version.

      • setNotificationBroker

        public void setNotificationBroker​(NotificationProviderService notificationBroker)
        Deprecated, for removal: This API element is subject to removal in a future version.

      • setNotificationPublishService

        public void setNotificationPublishService​(NotificationPublishService notificationPublishService)
        Deprecated, for removal: This API element is subject to removal in a future version.

      • start

        public void start()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • registerProvider

        public BindingAwareBroker.ProviderContext registerProvider​(BindingAwareProvider provider)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: BindingAwareBroker
        Registers the BindingAwareProvider, which will use the SAL layer.

        During the registration, the broker obtains the initial functionality from consumer, using the BindingAwareProvider#getImplementations(), and register that functionality into system and concrete infrastructure services.

        Note that provider could register additional functionality at later point by using service and functionality specific APIs.

        The consumer is required to use returned session for all communication with broker or one of the broker services. The session is announced to the consumer by invoking BindingAwareProvider.onSessionInitiated(ProviderContext).

        Specified by:
        registerProvider in interface BindingAwareBroker
        Parameters:
        provider - Provider to be registered.
        Returns:
        a session unique to the provider registration.

      • close

        public void close()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Specified by:
        close in interface AutoCloseable

      • addRoutedRpcImplementation

        public <T extends RpcService> BindingAwareBroker.RoutedRpcRegistration<T> addRoutedRpcImplementation​(Class<T> type,
                                                                                                     T implementation)
                                                                                              throws IllegalStateException
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: RpcProviderRegistry
        Registers an implementation of the given routed RPC service interface.

        See the class documentation for information and example on how to use routed RPCs.

        Specified by:
        addRoutedRpcImplementation in interface RpcProviderRegistry
        Parameters:
        type - the YANG-generated interface of the RPC Service for which to register.
        implementation - the implementation instance to register.
        Returns:
        a RoutedRpcRegistration instance which can be used to register paths for the RPC implementation via invoking RoutedRpcRegistration#registerPath(Class, InstanceIdentifer). BindingAwareBroker.RpcRegistration.close() should be called to unregister the implementation and all previously registered paths when no longer needed.
        Throws:
        IllegalStateException - if the supplied RPC interface is not a routed RPC type.

      • getRpcService

        public <T extends RpcService> T getRpcService​(Class<T> module)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Description copied from interface: RpcConsumerRegistry
        Returns an implementation of a requested RPC service.

        The returned instance is not an actual implementation of the RPC service interface, but a proxy implementation of the interface that forwards to an actual implementation, if any.

        The following describes the behavior of the proxy when invoking RPC methods:

        • If an actual implementation is registered with the MD-SAL, all invocations are forwarded to the registered implementation.
        • If no actual implementation is registered, all invocations will fail by throwing IllegalStateException.
        • Prior to invoking the actual implementation, the method arguments are are validated. If any are invalid, an IllegalArgumentException is thrown.

        The returned proxy is automatically updated with the most recent registered implementation. final Future<RpcResult<SomeRpcOutput>> future = someRpcService.someRpc( ... ); Futures.addCallback(future, new FutureCallback<RpcResult<SomeRpcOutput>>() { public void onSuccess(RpcResult<SomeRpcOutput> result) { // process result ... } public void onFailure(Throwable t) { // RPC failed } });

        Specified by:
        getRpcService in interface RpcConsumerRegistry
        Parameters:
        module - the interface of the RPC Service. Typically this is an interface generated from a YANG model.
        Returns:
        the proxy for the requested RPC service. This method never returns null.