com.tailf.jnc.RpcError Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of play-jnc Show documentation
play-jnc
There is a newer version: 1.1.0
package com.tailf.jnc;

/**
 * Class for 'rpc-error' elements returned in NETCONF 'rpc-reply' messages.
 * 
 * The 'rpc-error' includes the following information:
 * 

 *  {@link #errorType}
 * 
 {@link #errorTag}
 * 
 {@link #errorSeverity}
 * 
 {@link #errorAppTag}
 * 
 {@link #errorPath}
 * 
 {@link #errorMessage}
 * 
 {@link #errorInfo}
 * 
 * 
 */
public class RpcError {

    /**
     * The error type defines the conceptual layer that the error occurred.
     * Enumeration. One of:
     * 
     * transport
     * 
rpc
     * 
protocol
     * 
application
     * 
     */
    public String errorType;

    /**
     * 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
     * 
     */
    public String errorTag;

    /**
     * Contains a string identifying the error severity, as determined by the
     * device. One of:
     * 
     * error
     * 
warning
     * 
     */
    public String errorSeverity;

    /**
     * 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.
     * 
     */
    public String errorAppTag;

    /**
     * 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.
     * 
     */
    public String errorPath;

    /**
     * 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.
     */
    public String errorMessage;

    /**
     * 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.
     */
    public NodeSet errorInfo;

    /**
     * Constructor, initialized with an rpc-error element tree.
     * 
     * @param The rpc-error element tree to initialize with.
     */
    public RpcError(Element data) {
        // parse out the fields in data
        this.data = data;
        try {
            Element e = data.getFirst("self::rpc-error/error-type");
            if (e != null) {
                errorType = (String) e.getValue();
            }
            e = data.getFirst("self::rpc-error/error-tag");
            if (e != null) {
                errorTag = (String) e.getValue();
            }
            e = data.getFirst("self::rpc-error/error-severity");
            if (e != null) {
                errorSeverity = (String) e.getValue();
            }
            e = data.getFirst("self::rpc-error/error-info");
            if (e != null) {
                errorInfo = e.getChildren();
            }
            e = data.getFirst("self::rpc-error/error-message");
            if (e != null) {
                errorMessage = (String) e.getValue();
            }
            e = data.getFirst("self::rpc-error/error-app-tag");
            if (e != null) {
                errorAppTag = (String) e.getValue();
            }
            e = data.getFirst("self::rpc-error/error-path");
            if (e != null) {
                errorPath = (String) e.getValue();
            }
        } catch (final JNCException e1) {
            System.err.println("Error decoding rpc-error element: "
                    + data.toXMLString() + "\ngot exception: " + e1);
            e1.printStackTrace();
        }
    }

    /**
     * The rpc-error element tree
     */
    private Element data;

    /**
     * @return the XML string representation of the rpc-error element tree.
     */
    @Override
    public String toString() {
        return data.toXMLString();
    }
}