com.tailf.jnc

Class JNCException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.tailf.jnc.JNCException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

YangException

public class JNCException
extends java.lang.Exception

Exception class for errors produced by this library.

JNCException uses an errorCode field to indicate what went wrong. Depending on errorCode an opaqueData field may point to contextual information describing the error. The toString method uses both of these fields to print an appropriate error string describing the error.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTH_FAILED
static int	ELEMENT_ALREADY_IN_USE This element has already been used.
static int	ELEMENT_MISSING This element does not exist.
protected int	errorCode An error code indicating what went wrong.
static int	MESSAGE_ID_MISMATCH Message-id mismatch.
static int	NOTIFICATION_ERROR Notification error.
protected java.lang.Object	opaqueData Contextual information describing the error.
static int	PARSER_ERROR
static int	PATH_CREATE_ERROR
static int	PATH_ERROR
static int	REVISION_ERROR Revision error.
static int	RPC_REPLY_ERROR An rpc-reply with one or more reply-error elements was returned from the device.
static int	SESSION_ERROR A session error occured.
static int	TIMEOUT_ERROR Timeout error.

Constructor Summary

Constructors

Constructor and Description
JNCException(int errorCode, java.lang.Object opaqueData)

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString() The toString method uses both of errorCode and opaqueData fields to generate an appropriate error string.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

errorCode

protected int errorCode

An error code indicating what went wrong. This field may take any of these values:

• AUTH_FAILED
• PATH_ERROR
• PATH_CREATE_ERROR
• PARSER_ERROR
• RPC_REPLY_ERROR
• SESSION_ERROR
• ELEMENT_ALREADY_IN_USE
• ELEMENT_MISSING
• NOTIFICATION_ERROR
• TIMEOUT_ERROR
• REVISION_ERROR

Depending on the value the opaqueData field may be set accordingly. If so this is described below for each possible value.

opaqueData

protected java.lang.Object opaqueData

Contextual information describing the error. The meaning of this field as is described for each possible errorCode value.

AUTH_FAILED

public static final int AUTH_FAILED

See Also:

Constant Field Values

PATH_ERROR

public static final int PATH_ERROR

See Also:

Constant Field Values

PATH_CREATE_ERROR

public static final int PATH_CREATE_ERROR

See Also:

Constant Field Values

PARSER_ERROR

public static final int PARSER_ERROR

See Also:

Constant Field Values

RPC_REPLY_ERROR

public static final int RPC_REPLY_ERROR

An rpc-reply with one or more reply-error elements was returned from the device. The opaqueData field contains the error (in XML format) returned from the device.

See Also:

Constant Field Values

SESSION_ERROR

public static final int SESSION_ERROR

A session error occured. The opaqueData field is a string describing the error.

See Also:

Constant Field Values

ELEMENT_ALREADY_IN_USE

public static final int ELEMENT_ALREADY_IN_USE

This element has already been used. The opaqueData field is the offending Element object.

See Also:

Constant Field Values

ELEMENT_MISSING

public static final int ELEMENT_MISSING

This element does not exist. The opaqueData field is a path pointing to the missing element.

See Also:

Constant Field Values

NOTIFICATION_ERROR

public static final int NOTIFICATION_ERROR

Notification error. The received message was not a notification.

See Also:

Constant Field Values

TIMEOUT_ERROR

public static final int TIMEOUT_ERROR

Timeout error. The timeout specified when creating the SSHSession object expired.

See Also:

Constant Field Values

REVISION_ERROR

public static final int REVISION_ERROR

Revision error. When we tried to encode a configuration tree in order to send it to a device - A revision error was encountered. This only applies to Client code. A revision error occurs when we try to encode something the receiving node doesn't understand, such as an unknown enumeration or bit value.

See Also:

Constant Field Values

MESSAGE_ID_MISMATCH

public static final int MESSAGE_ID_MISMATCH

Message-id mismatch. The message-id attribute in the rpc-reply we received from the Netconf server didn't match the message-id in the rpc we sent.

See Also:

Constant Field Values

Constructor Detail

JNCException

public JNCException(int errorCode,
                    java.lang.Object opaqueData)

Method Detail

toString

public java.lang.String toString()

The toString method uses both of errorCode and opaqueData fields to generate an appropriate error string.

Overrides:

toString in class java.lang.Throwable