org.opendaylight.vtn.manager.internal.util.rpc

Class RpcInvocation<I,O>

java.lang.Object

org.opendaylight.vtn.manager.internal.util.rpc.RpcInvocation<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:

NodeRpcInvocation

public abstract class RpcInvocation<I,O>
extends Object
implements RpcRequest

RpcInvocation keeps a pair of RPC input and future associated with the RPC execution.

Constructor Summary

Constructors

Constructor and Description
RpcInvocation(I in, Future<org.opendaylight.yangtools.yang.common.RpcResult<O>> f) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
Future<org.opendaylight.yangtools.yang.common.RpcResult<O>>	getFuture() Return the future associated with the RPC execution.
I	getInput() Return the RPC input.
Object	getInputForLog() Return an object that indicates an RPC input.
O	getResult(long timeout, TimeUnit unit, org.slf4j.Logger logger) Wait for the RPC execution to complete, and return the result.
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.

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

RpcInvocation

public RpcInvocation(I in,
                     Future<org.opendaylight.yangtools.yang.common.RpcResult<O>> f)

Construct a new instance.

Parameters:

in - The RPC input.

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

Method Detail

getInput

public final I getInput()

Return the RPC input.

Returns:

The RPC input.

getFuture

public final Future<org.opendaylight.yangtools.yang.common.RpcResult<O>> getFuture()

Return the future associated with the RPC execution.

Returns:

The future associated with the RPC execution.

getResult

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

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

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 boolean needErrorLog(@Nonnull
                            Throwable cause)

Determine whether the RPC failure should be logged or not.

Parameters:

cause - An throwable thrown by the RPC implementation.

Returns:

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

getInputForLog

public Object getInputForLog()

Return an object that indicates an RPC input.

Returned object is embedded into a log message.

Specified by:

getInputForLog in interface RpcRequest

Returns:

An object that indicates an RPC input.

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

Parameters:

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

Returns:

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