Package org.opendaylight.controller.md.sal.dom.spi

Class ForwardingDOMRpcService

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.controller.md.sal.dom.spi.ForwardingDOMRpcService

All Implemented Interfaces:

DOMRpcService, DOMService, DOMService

@Deprecated(forRemoval=true)
public abstract class ForwardingDOMRpcService
extends ForwardingObject
implements DOMRpcService

Deprecated, for removal: This API element is subject to removal in a future version.

Use ForwardingDOMRpcService instead.

Utility DOMRpcService which forwards all requests to a backing delegate instance.

Constructor Summary

Constructors

Constructor	Description
ForwardingDOMRpcService()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
protected abstract @NonNull DOMRpcService	delegate()	Deprecated, for removal: This API element is subject to removal in a future version.
CheckedFuture<DOMRpcResult,DOMRpcException>	invokeRpc(SchemaPath type, NormalizedNode<?,?> input)	Deprecated, for removal: This API element is subject to removal in a future version. Initiate invocation of an RPC.
<T extends DOMRpcAvailabilityListener> ListenerRegistration<T>	registerRpcListener(T listener)	Deprecated, for removal: This API element is subject to removal in a future version. Register a DOMRpcAvailabilityListener with this service to receive notifications about RPC implementations becoming (un)available.

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingDOMRpcService

public ForwardingDOMRpcService()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Detail

delegate

protected abstract @NonNull DOMRpcService delegate()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

delegate in class ForwardingObject

invokeRpc

public CheckedFuture<DOMRpcResult,DOMRpcException> invokeRpc(SchemaPath type,
                                                                   NormalizedNode<?,?> input)

Deprecated, for removal: This API element is subject to removal in a future version.

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> ListenerRegistration<T> registerRpcListener(T listener)

Deprecated, for removal: This API element is subject to removal in a future version.

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 of this interface 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.