com.tailf.jnc

Class RpcError

java.lang.Object

com.tailf.jnc.RpcError

public class RpcError
extends java.lang.Object

Class for 'rpc-error' elements returned in NETCONF 'rpc-reply' messages.

The 'rpc-error' includes the following information:

• errorType
• errorTag
• errorSeverity
• errorAppTag
• errorPath
• errorMessage
• errorInfo

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	errorAppTag Contains a string identifying the data-model-specific or implementation-specific error condition, if one exists.
NodeSet	errorInfo Contains protocol- or data-model-specific error content.
java.lang.String	errorMessage Contains a string suitable for human display that describes the error condition.
java.lang.String	errorPath Contains the absolute XPath expression identifying the element path to the node that is associated with the error being reported in a particular rpc-error element.
java.lang.String	errorSeverity Contains a string identifying the error severity, as determined by the device.
java.lang.String	errorTag Contains a string identifying the error condition.
java.lang.String	errorType The error type defines the conceptual layer that the error occurred.

Constructor Summary

Constructors

Constructor and Description
RpcError(Element data) Constructor, initialized with an rpc-error element tree.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

errorType

public java.lang.String errorType

The error type defines the conceptual layer that the error occurred. Enumeration. One of:

• transport
• rpc
• protocol
• application

errorTag

public java.lang.String errorTag

Contains a string identifying the error condition. One of:

• in-use
• invalid-value
• too-big
• missing-attribute
• bad-attribute
• unknown-attribute
• missing-element
• bad-element
• unknown-element
• unknown-namespace
• access-denied
• lock-denied
• resource-denied
• rollback-failed
• data-exists
• data-missing
• operation-not-supported
• operation-failed
• partial-operation

errorSeverity

public java.lang.String errorSeverity

Contains a string identifying the error severity, as determined by the device. One of:

• error
• warning

errorAppTag

public java.lang.String errorAppTag

Contains a string identifying the data-model-specific or implementation-specific error condition, if one exists. This element will not be present if no appropriate application error tag can be associated with a particular error condition.

errorPath

public java.lang.String errorPath

Contains the absolute XPath expression identifying the element path to the node that is associated with the error being reported in a particular rpc-error element. This element will not be present if no appropriate payload element can be associated with a particular error condition, or if the 'bad-element' string returned in the 'error-info' container is sufficient to identify the node associated with the error. When the XPath expression is interpreted, the set of namespace declarations are those in scope on the rpc-error element, including the default namespace.

errorMessage

public java.lang.String errorMessage

Contains a string suitable for human display that describes the error condition. This element will not be present if no appropriate message is provided for a particular error condition.

errorInfo

public NodeSet errorInfo

Contains protocol- or data-model-specific error content. This element will not be present if no such error content is provided for a particular error condition.

Constructor Detail

RpcError

public RpcError(Element data)

Constructor, initialized with an rpc-error element tree.

Parameters:

The - rpc-error element tree to initialize with.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the XML string representation of the rpc-error element tree.