com.tailf.jnc.JNCException Maven / Gradle / Ivy
Show all versions of jnc Show documentation
package com.tailf.jnc;
/**
* 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.
*/
public class JNCException extends Exception {
private static final long serialVersionUID = 1L;
public JNCException(int errorCode, Object opaqueData) {
this.errorCode = errorCode;
this.opaqueData = opaqueData;
if (errorCode == RPC_REPLY_ERROR) {
// set rpcErrors array to the returned errors
final Element t = (Element) opaqueData;
try {
final NodeSet errors = t.get("self::rpc-reply/rpc-error");
if (errors != null) {
rpcErrors = new RpcError[errors.size()];
for (int i = 0; i < errors.size(); i++) {
rpcErrors[i] = new RpcError(errors.get(i));
}
}
} catch (final Exception e) {
System.err.println("rpc-error can't be parsed: "
+ t.toXMLString());
e.printStackTrace();
}
}
}
/**
* An error code indicating what went wrong. This field may take any of
* these values:
*
* - {@link #AUTH_FAILED}
*
- {@link #PATH_ERROR}
*
- {@link #PATH_CREATE_ERROR}
*
- {@link #PARSER_ERROR}
*
- {@link #RPC_REPLY_ERROR}
*
- {@link #SESSION_ERROR}
*
- {@link #ELEMENT_ALREADY_IN_USE}
*
- {@link #ELEMENT_MISSING}
*
- {@link #NOTIFICATION_ERROR}
*
- {@link #TIMEOUT_ERROR}
*
- {@link #REVISION_ERROR}
*
*
* Depending on the value the opaqueData field may be set accordingly. If
* so this is described below for each possible value.
*/
protected int errorCode;
/**
* Contextual information describing the error. The meaning of this field
* as is described for each possible errorCode value.
*/
protected Object opaqueData = null;
/**
* If errorCode is RPC_REPLY_ERROR the rpc-error is parsed and the
* rpcErrors array will contain the returned error information.
*/
private RpcError[] rpcErrors;
public static final int AUTH_FAILED = -1;
public static final int PATH_ERROR = -3;
public static final int PATH_CREATE_ERROR = -4;
public static final int PARSER_ERROR = -5;
/**
* 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.
*/
public static final int RPC_REPLY_ERROR = -6;
/**
* A session error occured. The opaqueData field is a string describing the
* error.
*/
public static final int SESSION_ERROR = -7;
/**
* This element has already been used. The opaqueData field is the
* offending Element object.
*/
public static final int ELEMENT_ALREADY_IN_USE = -8;
/**
* This element does not exist. The opaqueData field is a path pointing to
* the missing element.
*/
public static final int ELEMENT_MISSING = -9;
/**
* Notification error. The received message was not a notification.
*/
public static final int NOTIFICATION_ERROR = -10;
/**
* Timeout error. The timeout specified when creating the SSHSession object
* expired.
*/
public static final int TIMEOUT_ERROR = -11;
/**
* 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.
*/
public static final int REVISION_ERROR = -12;
/**
* 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.
*/
public static final int MESSAGE_ID_MISMATCH = -13;
/**
* The toString method uses both of errorCode and opaqueData fields to
* generate an appropriate error string.
*/
@Override
public String toString() {
switch (errorCode) {
case AUTH_FAILED:
return "Authentication failed";
case PATH_ERROR:
return "Error in path: " + opaqueData;
case PATH_CREATE_ERROR:
return "Error in create path: " + opaqueData;
case PARSER_ERROR:
return "Parse error: " + opaqueData;
case RPC_REPLY_ERROR:
if (opaqueData != null) {
Element rpc = (Element) opaqueData;
return "rpc-reply error: " + rpc.toXMLString();
} else {
return "rpc-reply error";
}
case SESSION_ERROR:
return "Session error: " + opaqueData;
case ELEMENT_ALREADY_IN_USE:
return "Element has already been used: "
+ ((Element) opaqueData).name;
case ELEMENT_MISSING:
return "Element does not exists: " + opaqueData;
case NOTIFICATION_ERROR:
return "Notification error: " + opaqueData;
case TIMEOUT_ERROR:
return "Timeout error: " + opaqueData;
case REVISION_ERROR:
return "Revision error: " + opaqueData;
case MESSAGE_ID_MISMATCH:
return "Message ID mismatch: " + opaqueData;
default:
return "Internal error: " + errorCode;
}
}
}