org.opendaylight.vtn.manager.internal.util.inventory

Class NodeRpcInvocation<I,O>

java.lang.Object

org.opendaylight.vtn.manager.internal.util.rpc.RpcInvocation<I,O>

org.opendaylight.vtn.manager.internal.util.inventory.NodeRpcInvocation<I,O>

Type Parameters:

I - The type of the RPC input.

O - The type of the RPC output.

All Implemented Interfaces:

RpcRequest

Direct Known Subclasses:

AddFlowRpc, GetFlowStatsRpc, RemoveFlowRpc, SendBarrierRpc, TransmitPacketRpc

public abstract class NodeRpcInvocation<I,O>
extends RpcInvocation<I,O>

NodeRpcInvocation describes an invocation of RPC routed to the specific switch.

Constructor Summary

Constructors

Constructor and Description
NodeRpcInvocation(NodeRpcWatcher w, I in, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nref, Future<org.opendaylight.yangtools.yang.common.RpcResult<O>> f) Construct a new instance.
NodeRpcInvocation(NodeRpcWatcher w, I in, org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nref, Future<org.opendaylight.yangtools.yang.common.RpcResult<O>> f, boolean discon) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	complete() Complete the observation of the RPC invocation.
String	getNode() Return the identifier of the node associated with the RPC invocation.
NodeRpcWatcher	getNodeRpcWatcher() Return the node RPC watcher.
O	getResult(long timeout, TimeUnit unit, org.slf4j.Logger logger) Wait for the RPC execution to complete, and return the result.
boolean	isDisconnected() Determine whether the secure channel for the target node was disconnected or not.
boolean	isNodeRemoved() Determine whether the target node was removed or not.
boolean	needErrorLog(Collection<org.opendaylight.yangtools.yang.common.RpcError> errors) Determine whether the RPC failure should be logged or not.
boolean	needErrorLog(Throwable cause) Determine whether the RPC failure should be logged or not.
boolean	onNodeRemoved() Invoked when the target node has been removed.
void	start() Start the observation of the RPC invocation.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.rpc.RpcInvocation

getFuture, getInput, getInputForLog

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.vtn.manager.internal.util.rpc.RpcRequest

getName

Constructor Detail

NodeRpcInvocation

public NodeRpcInvocation(NodeRpcWatcher w,
                         I in,
                         org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nref,
                         Future<org.opendaylight.yangtools.yang.common.RpcResult<O>> f)

Construct a new instance.

An error caused by secure channel disconnection will be logged.

Parameters:

w - The node RPC watcher.

in - The RPC input.

nref - Reference to the target node.

f - The future associated with the RPC execution with in.

NodeRpcInvocation

public NodeRpcInvocation(NodeRpcWatcher w,
                         I in,
                         org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nref,
                         Future<org.opendaylight.yangtools.yang.common.RpcResult<O>> f,
                         boolean discon)

Construct a new instance.

Parameters:

w - The node RPC watcher.

in - The RPC input.

nref - Reference to the target node.

f - The future associated with the RPC execution with in.

discon - Determine whether an error caused by disconnection of OpenFlow secure channel should be logged or not.

Method Detail

getNodeRpcWatcher

public final NodeRpcWatcher getNodeRpcWatcher()

Return the node RPC watcher.

Returns:

The node RPC watcher.

getNode

public final String getNode()

Return the identifier of the node associated with the RPC invocation.

Returns:

The node-id value that specifies the target switch.

onNodeRemoved

public final boolean onNodeRemoved()

Invoked when the target node has been removed.

Returns:

true if the RPC invocation has been canceled. false if the RPC invocation has already completed.

isNodeRemoved

public final boolean isNodeRemoved()

Determine whether the target node was removed or not.

Returns:

true if the target node was removed. false otherwise.

isDisconnected

public final boolean isDisconnected()

Determine whether the secure channel for the target node was disconnected or not.

Returns:

true if the secure channel for the target node was disconnected. false otherwise.

start

public final void start()

Start the observation of the RPC invocation.

complete

public final void complete()

Complete the observation of the RPC invocation.

getResult

public final O getResult(long timeout,
                         TimeUnit unit,
                         org.slf4j.Logger logger)
                  throws VTNException

Wait for the RPC execution to complete, and return the result.

The RPC invocation will be canceled if the target node is removed.

Overrides:

getResult in class RpcInvocation<I,O>

Parameters:

timeout - The maximum time to wait.

unit - The time unit of the timeout argument.

logger - A Logger instance.

Returns:

The result of the RPC.

Throws:

VTNException - An error occurred.

needErrorLog

public final boolean needErrorLog(@Nonnull
                                  Throwable cause)

Determine whether the RPC failure should be logged or not.

Overrides:

needErrorLog in class RpcInvocation<I,O>

Parameters:

cause - An throwable thrown by the RPC implementation.

Returns:

true if the RPC failure should be logged. false otherwise.

needErrorLog

public boolean needErrorLog(@Nonnull
                            Collection<org.opendaylight.yangtools.yang.common.RpcError> errors)

Determine whether the RPC failure should be logged or not.

Specified by:

needErrorLog in interface RpcRequest

Overrides:

needErrorLog in class RpcInvocation<I,O>

Parameters:

errors - A collection of RPC errors returned by the RPC implementation.

Returns:

true if the RPC failure should be logged. false otherwise.