org.opendaylight.mdsal.dom.broker

Class DOMRpcRouter

java.lang.Object

org.opendaylight.mdsal.dom.broker.DOMRpcRouter

All Implemented Interfaces:

AutoCloseable, EventListener, DOMRpcProviderService, DOMRpcService, DOMService, org.opendaylight.yangtools.yang.model.api.SchemaContextListener

public final class DOMRpcRouter
extends Object
implements AutoCloseable, DOMRpcService, DOMRpcProviderService, org.opendaylight.yangtools.yang.model.api.SchemaContextListener

Constructor Summary

Constructors

Constructor and Description
DOMRpcRouter()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
com.google.common.util.concurrent.CheckedFuture<DOMRpcResult,DOMRpcException>	invokeRpc(org.opendaylight.yangtools.yang.model.api.SchemaPath type, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> input) Initiate invocation of an RPC.
void	onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext context)
<T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T>	registerRpcImplementation(T implementation, DOMRpcIdentifier... rpcs) Register an DOMRpcImplementation object with this service.
<T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T>	registerRpcImplementation(T implementation, Set<DOMRpcIdentifier> rpcs) Register an DOMRpcImplementation object with this service.
<T extends DOMRpcAvailabilityListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T>	registerRpcListener(T listener) Register a DOMRpcAvailabilityListener with this service to receive notifications about RPC implementations becoming (un)available.

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMRpcRouter

public DOMRpcRouter()

Method Detail

registerRpcImplementation

public <T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T> registerRpcImplementation(T implementation,
                                                                                             DOMRpcIdentifier... rpcs)

Description copied from interface: DOMRpcProviderService

Register an DOMRpcImplementation object with this service.

Specified by:

registerRpcImplementation in interface DOMRpcProviderService

Parameters:

implementation - RPC implementation, must not be null

rpcs - Array of supported RPC identifiers. Must not be null, empty, or contain a null element. Each identifier is added exactly once, no matter how many times it occurs.

Returns:

A DOMRpcImplementationRegistration object, guaranteed to be non-null.

registerRpcImplementation

public <T extends DOMRpcImplementation> DOMRpcImplementationRegistration<T> registerRpcImplementation(T implementation,
                                                                                             Set<DOMRpcIdentifier> rpcs)

Description copied from interface: DOMRpcProviderService

Register an DOMRpcImplementation object with this service.

Specified by:

registerRpcImplementation in interface DOMRpcProviderService

Parameters:

implementation - RPC implementation, must not be null

rpcs - Set of supported RPC identifiers. Must not be null, empty, or contain a null element.

Returns:

A DOMRpcImplementationRegistration object, guaranteed to be non-null.

invokeRpc

public com.google.common.util.concurrent.CheckedFuture<DOMRpcResult,DOMRpcException> invokeRpc(org.opendaylight.yangtools.yang.model.api.SchemaPath type,
                                                                                      org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> input)

Description copied from interface: DOMRpcService

Initiate invocation of an RPC. This method is guaranteed to not block on any external resources.

Specified by:

invokeRpc in interface DOMRpcService

Parameters:

type - SchemaPath of the RPC to be invoked

input - Input arguments, null if the RPC does not take any.

Returns:

A CheckedFuture which will return either a result structure, or report a subclass of DOMRpcException reporting a transport error.

registerRpcListener

public <T extends DOMRpcAvailabilityListener> org.opendaylight.yangtools.concepts.ListenerRegistration<T> registerRpcListener(T listener)

Description copied from interface: DOMRpcService

Register a DOMRpcAvailabilityListener with this service to receive notifications about RPC implementations becoming (un)available. The listener will be invoked with the current implementations reported and will be kept uptodate as implementations come and go. Users should note that using a listener does not necessarily mean that DOMRpcService.invokeRpc(SchemaPath, NormalizedNode) will not report a failure due to DOMRpcImplementationNotAvailableException and need to be ready to handle it. Implementations are encouraged to take reasonable precautions to prevent this scenario from occurring.

Specified by:

registerRpcListener in interface DOMRpcService

Parameters:

listener - DOMRpcAvailabilityListener instance to register

Returns:

A ListenerRegistration representing this registration. Performing a ListenerRegistration.close() will cancel it. Returned object is guaranteed to be non-null.

onGlobalContextUpdated

public void onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext context)

Specified by:

onGlobalContextUpdated in interface org.opendaylight.yangtools.yang.model.api.SchemaContextListener

close

public void close()

Specified by:

close in interface AutoCloseable