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

Class RpcUtils

java.lang.Object

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

public final class RpcUtils
extends Object

RpcUtils class is a collection of utility class methods for RPC implementation.

Method Summary

Modifier and Type	Method and Description
static <T> T	checkResult(RpcRequest rpc, org.opendaylight.yangtools.yang.common.RpcResult<T> result, org.slf4j.Logger logger) Check the given RPC result.
static <T> org.opendaylight.yangtools.yang.common.RpcResultBuilder<T>	getErrorBuilder(Class<T> type, Exception e) Construct a new RPC error builder from the given Exception.
static <T> org.opendaylight.yangtools.yang.common.RpcResultBuilder<T>	getErrorBuilder(Class<T> type, RpcErrorTag tag, String msg, VtnErrorTag vtnTag, String info) Construct a new RPC error builder.
static RpcException	getInvalidOperationException(VtnUpdateOperationType op) Return a new RpcException that indicates the RPC request has failed due to invalid VtnUpdateOperationType value.
static RpcException	getNullInputException() Return a new RpcException that indicates the RPC request has failed due to null RPC input.

Methods inherited from class java.lang.Object

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

Method Detail

getNullInputException

public static RpcException getNullInputException()

Return a new RpcException that indicates the RPC request has failed due to null RPC input.

Returns:

An RpcException instance.

getInvalidOperationException

public static RpcException getInvalidOperationException(VtnUpdateOperationType op)

Return a new RpcException that indicates the RPC request has failed due to invalid VtnUpdateOperationType value.

Parameters:

op - A VtnUpdateOperationType value.

Returns:

An RpcException instance.

getErrorBuilder

public static <T> org.opendaylight.yangtools.yang.common.RpcResultBuilder<T> getErrorBuilder(Class<T> type,
                                                                                             RpcErrorTag tag,
                                                                                             String msg,
                                                                                             VtnErrorTag vtnTag,
                                                                                             String info)

Construct a new RPC error builder.

Type Parameters:

T - The type of RPC output.

Parameters:

type - A Class that indicates the type of RPC output.

tag - An RpcErrorTag instance that indicates an error tag.

msg - An error message.

vtnTag - A VtnErrorTag instance to be set as application-specific tag.

info - An additional debugging information.

Returns:

A RpcResultBuilder instance.

getErrorBuilder

public static <T> org.opendaylight.yangtools.yang.common.RpcResultBuilder<T> getErrorBuilder(Class<T> type,
                                                                                             Exception e)

Construct a new RPC error builder from the given Exception.

Type Parameters:

T - The type of RPC output.

Parameters:

type - A Class that indicates the type of RPC output.

e - An Exception instance.

Returns:

A RpcResultBuilder instance.

checkResult

public static <T> T checkResult(RpcRequest rpc,
                                org.opendaylight.yangtools.yang.common.RpcResult<T> result,
                                org.slf4j.Logger logger)
                         throws VTNException

Check the given RPC result.

Type Parameters:

T - The type of the value returned by the RPC.

Parameters:

rpc - An RpcRequest instance.

result - An RpcResult instance.

logger - A Logger instance.

Returns:

The value returned by the RPC.

Throws:

VTNException - The RPC call was failed.