org.opendaylight.controller.sal.binding.impl

Class RootBindingAwareBroker

java.lang.Object

org.opendaylight.controller.sal.binding.impl.RootBindingAwareBroker

All Implemented Interfaces:

AutoCloseable, BindingService, RouteChangePublisher<RpcContextIdentifier,org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>>, BindingAwareBroker, BindingAwareService, RpcConsumerRegistry, RpcProviderRegistry, org.opendaylight.yangtools.concepts.Identifiable<String>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

Deprecated.

@Deprecated
public class RootBindingAwareBroker
extends Object
implements org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.Identifiable<String>, BindingAwareBroker, AutoCloseable, RpcProviderRegistry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RootBindingAwareBroker.RootSalInstance Deprecated.

Nested classes/interfaces inherited from interface org.opendaylight.controller.sal.binding.api.BindingAwareBroker

BindingAwareBroker.ConsumerContext, BindingAwareBroker.ProviderContext, BindingAwareBroker.RoutedRpcRegistration<T extends org.opendaylight.yangtools.yang.binding.RpcService>, BindingAwareBroker.RpcRegistration<T extends org.opendaylight.yangtools.yang.binding.RpcService>

Constructor Summary

Constructors

Constructor and Description
RootBindingAwareBroker(String instanceName) Deprecated.

Method Summary

Modifier and Type	Method and Description
<T extends org.opendaylight.yangtools.yang.binding.RpcService> BindingAwareBroker.RoutedRpcRegistration<T>	addRoutedRpcImplementation(Class<T> type, T implementation) Deprecated. Registers an implementation of the given routed RPC service interface.
<T extends org.opendaylight.yangtools.yang.binding.RpcService> BindingAwareBroker.RpcRegistration<T>	addRpcImplementation(Class<T> type, T implementation) Deprecated. Registers a global implementation of the provided RPC service interface.
void	close() Deprecated.
String	getIdentifier() Deprecated.
MountPointService	getMountService() Deprecated.
NotificationProviderService	getNotificationBroker() Deprecated.
NotificationPublishService	getNotificationPublishService() Deprecated.
RootBindingAwareBroker.RootSalInstance	getRoot() Deprecated.
RpcProviderRegistry	getRpcBroker() Deprecated.
RpcProviderRegistry	getRpcProviderRegistry() Deprecated.
<T extends org.opendaylight.yangtools.yang.binding.RpcService> T	getRpcService(Class<T> module) Deprecated. Returns an implementation of a requested RPC service.
BindingAwareBroker.ConsumerContext	registerConsumer(BindingAwareConsumer consumer) Deprecated. Registers the BindingAwareConsumer, which will use the SAL layer.
BindingAwareBroker.ConsumerContext	registerConsumer(BindingAwareConsumer consumer, org.osgi.framework.BundleContext ctx) Deprecated.
BindingAwareBroker.ProviderContext	registerProvider(BindingAwareProvider provider) Deprecated. Registers the BindingAwareProvider, which will use the SAL layer.
BindingAwareBroker.ProviderContext	registerProvider(BindingAwareProvider provider, org.osgi.framework.BundleContext ctx) Deprecated.
<L extends RouteChangeListener<RpcContextIdentifier,org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>>> org.opendaylight.yangtools.concepts.ListenerRegistration<L>	registerRouteChangeListener(L listener) Deprecated.
void	setDataBroker(DataBroker asyncDataBroker) Deprecated.
void	setMountService(MountPointService mount) Deprecated.
void	setNotificationBroker(NotificationProviderService notificationBroker) Deprecated.
void	setNotificationPublishService(NotificationPublishService notificationPublishService) Deprecated.
void	setRpcBroker(RpcProviderRegistry rpcBroker) Deprecated.
void	start() Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RootBindingAwareBroker

public RootBindingAwareBroker(String instanceName)

Deprecated.

Method Detail

getIdentifier

public String getIdentifier()

Deprecated.

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<String>

getRoot

public RootBindingAwareBroker.RootSalInstance getRoot()

Deprecated.

getNotificationBroker

public NotificationProviderService getNotificationBroker()

Deprecated.

getNotificationPublishService

public NotificationPublishService getNotificationPublishService()

Deprecated.

getRpcProviderRegistry

public RpcProviderRegistry getRpcProviderRegistry()

Deprecated.

getRpcBroker

public RpcProviderRegistry getRpcBroker()

Deprecated.

getMountService

public MountPointService getMountService()

Deprecated.

setDataBroker

public void setDataBroker(DataBroker asyncDataBroker)

Deprecated.

setMountService

public void setMountService(MountPointService mount)

Deprecated.

setRpcBroker

public void setRpcBroker(RpcProviderRegistry rpcBroker)

Deprecated.

setNotificationBroker

public void setNotificationBroker(NotificationProviderService notificationBroker)

Deprecated.

setNotificationPublishService

public void setNotificationPublishService(NotificationPublishService notificationPublishService)

Deprecated.

start

public void start()

Deprecated.

registerConsumer

public BindingAwareBroker.ConsumerContext registerConsumer(BindingAwareConsumer consumer,
                                                           org.osgi.framework.BundleContext ctx)

Deprecated.

Specified by:

registerConsumer in interface BindingAwareBroker

registerConsumer

public BindingAwareBroker.ConsumerContext registerConsumer(BindingAwareConsumer consumer)

Deprecated.

Description copied from interface: BindingAwareBroker

Registers the BindingAwareConsumer, which will use the SAL layer.

Note that consumer 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 BindingAwareConsumer#onSessionInitialized(ConsumerContext).

Specified by:

registerConsumer in interface BindingAwareBroker

Parameters:

consumer - Consumer to be registered.

Returns:

a session specific to consumer registration

registerProvider

public BindingAwareBroker.ProviderContext registerProvider(BindingAwareProvider provider,
                                                           org.osgi.framework.BundleContext ctx)

Deprecated.

Specified by:

registerProvider in interface BindingAwareBroker

registerProvider

public BindingAwareBroker.ProviderContext registerProvider(BindingAwareProvider provider)

Deprecated.

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.

Specified by:

close in interface AutoCloseable

addRoutedRpcImplementation

public <T extends org.opendaylight.yangtools.yang.binding.RpcService> BindingAwareBroker.RoutedRpcRegistration<T> addRoutedRpcImplementation(Class<T> type,
                                                                                                                                             T implementation)
                                                                                                                                      throws IllegalStateException

Deprecated.

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.

addRpcImplementation

public <T extends org.opendaylight.yangtools.yang.binding.RpcService> BindingAwareBroker.RpcRegistration<T> addRpcImplementation(Class<T> type,
                                                                                                                                 T implementation)
                                                                                                                          throws IllegalStateException

Deprecated.

Description copied from interface: RpcProviderRegistry

Registers a global implementation of the provided RPC service interface. All methods of the interface are required to be implemented.

Specified by:

addRpcImplementation in interface RpcProviderRegistry

Parameters:

type - the YANG-generated interface of the RPC Service for which to register.

implementation - "the implementation of the RPC service interface.

Returns:

an RpcRegistration instance that should be used to unregister the RPC implementation when no longer needed by calling BindingAwareBroker.RpcRegistration.close().

Throws:

IllegalStateException - if the supplied RPC interface is a routed RPC type.

getRpcService

public <T extends org.opendaylight.yangtools.yang.binding.RpcService> T getRpcService(Class<T> module)

Deprecated.

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.

registerRouteChangeListener

public <L extends RouteChangeListener<RpcContextIdentifier,org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>>> org.opendaylight.yangtools.concepts.ListenerRegistration<L> registerRouteChangeListener(L listener)

Deprecated.

Specified by:

registerRouteChangeListener in interface RouteChangePublisher<RpcContextIdentifier,org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?>>