Module org.opendaylight.yangtools.yang.common
Package org.opendaylight.yangtools.yang.common

Class ErrorTag

java.lang.Object
org.opendaylight.yangtools.yang.common.ErrorTag
All Implemented Interfaces:
Serializable
@NonNullByDefault public final class ErrorTag extends Object implements Serializable
Extensible enumeration of error-tag values, as defined in RFC6241. These values are an extensible enumeration, since YANG does not place restriction on possible values in RFC8040.

Error tag defines overall error semantics. Additional tag-specific information may be associated with a particular error tag.

See Also:

  • Field Details

    • ACCESS_DENIED

      public static final ErrorTag ACCESS_DENIED
      access-denied ErrorTag.

    • BAD_ATTRIBUTE

      public static final ErrorTag BAD_ATTRIBUTE
      bad-attribute ErrorTag. Covers mechanics specified in RFC6020 section 8.3.1, bullet 6 
         For insert handling, if the value for the attributes "before" and
   "after" are not valid for the type of the appropriate key leafs,
   the server MUST reply with a "bad-attribute" error-tag in the rpc-
   error.

    • BAD_ELEMENT

      public static final ErrorTag BAD_ELEMENT
      bad-element ErrorTag. Covers mechanics specified in RFC6020 section 8.3.1, bullet 3 
         If data for more than one case branch of a choice is present, the
   server MUST reply with a "bad-element" in the rpc-error.

    • DATA_EXISTS

      public static final ErrorTag DATA_EXISTS
      data-exists ErrorTag.

    • DATA_MISSING

      public static final ErrorTag DATA_MISSING
      data-missing ErrorTag. Covers mechanics specified in RFC6020 sections 13.5 through 13.7.

    • IN_USE

      public static final ErrorTag IN_USE
      in-use ErrorTag.

    • INVALID_VALUE

      public static final ErrorTag INVALID_VALUE
      invalid-value ErrorTag. Covers mechanics specified in RFC6020 section 8.3.1, bullet 1 
         If a leaf data value does not match the type constraints for the
   leaf, including those defined in the type's "range", "length", and
   "pattern" properties, the server MUST reply with an
   "invalid-value" error-tag in the rpc-error, and with the error-
   app-tag and error-message associated with the constraint, if any
   exist.

    • LOCK_DENIED

      public static final ErrorTag LOCK_DENIED
      lock-denied ErrorTag.

    • MALFORMED_MESSAGE

      public static final ErrorTag MALFORMED_MESSAGE
      unknown-element ErrorTag. Covers mechanics specified in RFC6241, Appendix A, last item. Note the specification expressly forbids reporting this tag for NETCONF clients older than :base:1.1.

    • MISSING_ATTRIBUTE

      public static final ErrorTag MISSING_ATTRIBUTE
      missing-attribute ErrorTag.

    • MISSING_ELEMENT

      public static final ErrorTag MISSING_ELEMENT
      missing-element ErrorTag. Covers mechanics specified in RFC6020 section 8.3.1, bullet 2 
         If all keys of a list entry are not present, the server MUST reply
   with a "missing-element" error-tag in the rpc-error.
      as well as RFC6020 section 7.13.2, paragraph 2 
         If a leaf in the input tree has a "mandatory" statement with the
   value "true", the leaf MUST be present in a NETCONF RPC invocation.
   Otherwise, the server MUST return a "missing-element" error.

    • OPERATION_FAILED

      public static final ErrorTag OPERATION_FAILED
      operation-failed ErrorTag. Covers mechanics specified in RFC6020 section 13.1 through 13.4.

    • OPERATION_NOT_SUPPORTED

      public static final ErrorTag OPERATION_NOT_SUPPORTED
      operation-not-supported ErrorTag.

    • PARTIAL_OPERATION

      @Deprecated(since="RFC6241") public static final ErrorTag PARTIAL_OPERATION
      Deprecated.
      This error-info is obsolete since RFC6241.
      partial-operation ErrorTag.

    • RESOURCE_DENIED

      public static final ErrorTag RESOURCE_DENIED
      resource-denied ErrorTag.

    • ROLLBACK_FAILED

      public static final ErrorTag ROLLBACK_FAILED
      rollback-failed ErrorTag.

    • TOO_BIG

      public static final ErrorTag TOO_BIG
      too-big ErrorTag.

    • UNKNOWN_ATTRIBUTE

      public static final ErrorTag UNKNOWN_ATTRIBUTE
      unknown-element ErrorTag. Covers mechanics specified in RFC6020 section 8.3.1, bullet 7 
         If the attributes "before" and "after" appears in any element that
   is not a list whose "ordered-by" property is "user", the server
   MUST reply with an "unknown-attribute" error-tag in the rpc-error.

    • UNKNOWN_ELEMENT

      public static final ErrorTag UNKNOWN_ELEMENT
      unknown-element ErrorTag. Covers mechanics specified in RFC6020 section 8.3.1, bullet 4 
         If data for a node tagged with "if-feature" is present, and the
   feature is not supported by the device, the server MUST reply with
   an "unknown-element" error-tag in the rpc-error.
      as well as RFC6020 section 8.3.1, bullet 5 
         If data for a node tagged with "when" is present, and the "when"
   condition evaluates to "false", the server MUST reply with an
   "unknown-element" error-tag in the rpc-error.

    • UNKNOWN_NAMESPACE

      public static final ErrorTag UNKNOWN_NAMESPACE
      unknown-namespace ErrorTag.

  • Constructor Details

    • ErrorTag

      public ErrorTag(String elementBody)

  • Method Details

    • elementBody

      public String elementBody()
      Return the XML element body of this object.
      Returns:
      element body of this object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(@Nullable Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object