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

Interface RpcRequest

All Known Implementing Classes:

AddFlowRpc, GetFlowStatsRpc, NodeRpcInvocation, RemoveFlowRpc, RpcInvocation, SendBarrierRpc, TransmitPacketRpc

public interface RpcRequest

RpcRequest describes an RPC request.

This interface is used to embed RPC request information into a log message.

Method Summary

Modifier and Type	Method and Description
Object	getInputForLog() Return an object that indicates an RPC input.
String	getName() Return the name of the RPC.
boolean	needErrorLog(Collection<org.opendaylight.yangtools.yang.common.RpcError> errors) Determine whether the RPC failure should be logged or not.

Method Detail

getName

String getName()

Return the name of the RPC.

Returns:

The name of the RPC.

getInputForLog

Object getInputForLog()

Return an object that indicates an RPC input.

Returned object is embedded into a log message.

Returns:

An object that indicates an RPC input.

needErrorLog

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

Determine whether the RPC failure should be logged or not.

Parameters:

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

Returns:

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