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

Interface RpcError

public interface RpcError
Representation of an error.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getApplicationTag()
    Returns a short string that identifies the specific type of error condition as determined by the application reporting the error.
    Throwable
    getCause()
    Returns an exception cause.
    ErrorType
    getErrorType()
    Returns the conceptual layer at which the error occurred.
    String
    getInfo()
    Returns a string containing additional information to provide extended and/or implementation-specific debugging information.
    String
    getMessage()
    Returns a string suitable for human display that describes the error condition.
    ErrorSeverity
    getSeverity()
    Returns the error severity, as determined by the application reporting the error.
    ErrorTag
    getTag()
    Returns a short string that identifies the general type of error condition.

  • Method Details

    • getSeverity

      ErrorSeverity getSeverity()
      Returns the error severity, as determined by the application reporting the error.
      Returns:
      an ErrorSeverity enum.

    • getTag

      ErrorTag getTag()
      Returns a short string that identifies the general type of error condition.

      The following outlines suggested values as defined by (RFC6241): 

          access-denied
    bad-attribute
    bad-element
    data-exists
    data-missing
    in-use
    invalid-value
    lock-denied
    malformed-message
    missing-attribute
    missing-element
    operation-failed
    operation-not-supported
    resource-denied
    rollback-failed
    too-big
    unknown-attribute
    unknown-element
    unknown-namespace
      Returns:
      a string if available or null otherwise.

    • getApplicationTag

      String getApplicationTag()
      Returns a short string that identifies the specific type of error condition as determined by the application reporting the error.
      Returns:
      a string if available or null otherwise.

    • getMessage

      String getMessage()
      Returns a string suitable for human display that describes the error condition.
      Returns:
      a message string.

    • getInfo

      String getInfo()
      Returns a string containing additional information to provide extended and/or implementation-specific debugging information.
      Returns:
      a string if available or null otherwise.

    • getCause

      Throwable getCause()
      Returns an exception cause.
      Returns:
      a Throwable if the error was triggered by exception, null otherwise.

    • getErrorType

      ErrorType getErrorType()
      Returns the conceptual layer at which the error occurred.
      Returns:
      an ErrorType enum.