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

Class RpcException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.opendaylight.vtn.manager.VTNException

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MacMapException

public class RpcException
extends VTNException

RpcException is an exception which indicates the failure of the RPC request.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RpcException(RpcErrorTag tag, VtnErrorTag etag, String msg) Construct a new exception that internally stores the given RpcErrorTag and VtnErrorTag instances.
RpcException(RpcErrorTag tag, VtnErrorTag etag, String msg, Throwable cause) Construct a new exception that indicates the VTN Manager has caught an unexpected exception while it is processing the RPC request.
RpcException(String message) Construct a new exception that indicates an unexpected internall error has been detected.
RpcException(String message, Throwable cause) Construct a new exception that indicates an unexpected internall error has been detected.

Method Summary

Modifier and Type	Method and Description
static RpcException	getBadArgumentException(String desc) Return a new RpcException which notifies an invalid argument.
static RpcException	getBadArgumentException(String desc, Throwable cause) Return a new RpcException which notifies an invalid argument.
static RpcException	getDataExistsException(String desc) Return a new RpcException which notifies a resource confliction.
static RpcException	getDataExistsException(String desc, Throwable cause) Return a new RpcException which notifies a resource confliction.
RpcErrorTag	getErrorTag() Return the RpcErrorTag instance to be set as error-tag in RPC error.
static RpcException	getMissingArgumentException(String desc) Return a new RpcException which notifies an missing element in the request.
static RpcException	getNotFoundException(String desc) Return a new RpcException which notifies an missing data object.
static RpcException	getNotFoundException(String desc, Throwable cause) Return a new RpcException which notifies an missing data object.
static RpcException	getNullArgumentException(String desc) Return a new RpcException which indicates a null is specified as argument unexpectedly.

Methods inherited from class org.opendaylight.vtn.manager.VTNException

getVtnErrorTag

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RpcException

public RpcException(RpcErrorTag tag,
                    VtnErrorTag etag,
                    String msg)

Construct a new exception that internally stores the given RpcErrorTag and VtnErrorTag instances.

Parameters:

tag - A RpcErrorTag instance.

etag - A VtnErrorTag instance.

msg - The detailed message.

RpcException

public RpcException(RpcErrorTag tag,
                    VtnErrorTag etag,
                    String msg,
                    Throwable cause)

Construct a new exception that indicates the VTN Manager has caught an unexpected exception while it is processing the RPC request.

Parameters:

tag - A RpcErrorTag instance.

etag - A VtnErrorTag instance.

msg - The detailed message.

cause - The Throwable instance which indicates the cause of error.

RpcException

public RpcException(String message)

Construct a new exception that indicates an unexpected internall error has been detected.

Parameters:

message - The defailed message.

RpcException

public RpcException(String message,
                    Throwable cause)

Construct a new exception that indicates an unexpected internall error has been detected.

Parameters:

message - The defailed message.

cause - The Throwable instance which indicates the cause of error.

Method Detail

getNullArgumentException

public static final RpcException getNullArgumentException(String desc)

Return a new RpcException which indicates a null is specified as argument unexpectedly.

Parameters:

desc - Brief description of the argument.

Returns:

An RpcException.

getBadArgumentException

public static final RpcException getBadArgumentException(String desc)

Return a new RpcException which notifies an invalid argument.

Parameters:

desc - Brief description of the argument.

Returns:

An RpcException.

getBadArgumentException

public static final RpcException getBadArgumentException(String desc,
                                                         Throwable cause)

Return a new RpcException which notifies an invalid argument.

Parameters:

desc - Brief description of the argument.

cause - A Throwable which indicates the cause of error.

Returns:

An RpcException.

getMissingArgumentException

public static final RpcException getMissingArgumentException(String desc)

Return a new RpcException which notifies an missing element in the request.

Parameters:

desc - Brief description of the argument.

Returns:

An RpcException.

getNotFoundException

public static final RpcException getNotFoundException(String desc)

Return a new RpcException which notifies an missing data object.

Parameters:

desc - Brief description of the missing data.

Returns:

An RpcException.

getNotFoundException

public static final RpcException getNotFoundException(String desc,
                                                      Throwable cause)

Return a new RpcException which notifies an missing data object.

Parameters:

desc - Brief description of the missing data.

cause - A Throwable which indicates the cause of error.

Returns:

An RpcException.

getDataExistsException

public static final RpcException getDataExistsException(String desc)

Return a new RpcException which notifies a resource confliction.

Parameters:

desc - Brief description of the resource.

Returns:

An RpcException.

getDataExistsException

public static final RpcException getDataExistsException(String desc,
                                                        Throwable cause)

Return a new RpcException which notifies a resource confliction.

Parameters:

desc - Brief description of the resource.

cause - A Throwable which indicates the cause of error.

Returns:

An RpcException.

getErrorTag

public final RpcErrorTag getErrorTag()

Return the RpcErrorTag instance to be set as error-tag in RPC error.

Returns:

An RpcErrorTag instance.