Package org.opendaylight.restconf.common.errors

Class RestconfError

java.lang.Object
org.opendaylight.restconf.common.errors.RestconfError
All Implemented Interfaces:
Serializable
public class RestconfError extends Object implements Serializable
Encapsulates a single error within the "errors" YANG Data Template.
Author:
Devin Avery
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    RestconfError(org.opendaylight.yangtools.yang.common.ErrorType errorType, org.opendaylight.yangtools.yang.common.ErrorTag errorTag, String errorMessage)
    Constructs a RestconfError.
    RestconfError(org.opendaylight.yangtools.yang.common.ErrorType errorType, org.opendaylight.yangtools.yang.common.ErrorTag errorTag, String errorMessage, String errorAppTag)
    Constructs a RestconfError object.
    RestconfError(org.opendaylight.yangtools.yang.common.ErrorType errorType, org.opendaylight.yangtools.yang.common.ErrorTag errorTag, String errorMessage, String errorAppTag, String errorInfo)
    Constructs a RestconfError object.
    RestconfError(org.opendaylight.yangtools.yang.common.ErrorType errorType, org.opendaylight.yangtools.yang.common.ErrorTag errorTag, String errorMessage, String errorAppTag, String errorInfo, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier errorPath)
    Constructs a RestConfError object.
    RestconfError(org.opendaylight.yangtools.yang.common.ErrorType errorType, org.opendaylight.yangtools.yang.common.ErrorTag errorTag, String errorMessage, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier errorPath)
    Constructs a RestconfError object.
    RestconfError(org.opendaylight.yangtools.yang.common.RpcError rpcError)
    Constructs a RestConfError object from an RpcError.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getErrorAppTag()
     
    String
    getErrorInfo()
     
    String
    getErrorMessage()
     
    org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier
    getErrorPath()
     
    @NonNull org.opendaylight.yangtools.yang.common.ErrorTag
    getErrorTag()
     
    @NonNull org.opendaylight.yangtools.yang.common.ErrorType
    getErrorType()
     
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • RestconfError

      public RestconfError(org.opendaylight.yangtools.yang.common.ErrorType errorType, org.opendaylight.yangtools.yang.common.ErrorTag errorTag, String errorMessage)
      Constructs a RestconfError.
      Parameters:
      errorType - The enumerated type indicating the layer where the error occurred.
      errorTag - The enumerated tag representing a more specific error cause.
      errorMessage - A string which provides a plain text string describing the error.

    • RestconfError

      public RestconfError(org.opendaylight.yangtools.yang.common.ErrorType errorType, org.opendaylight.yangtools.yang.common.ErrorTag errorTag, String errorMessage, String errorAppTag)
      Constructs a RestconfError object.
      Parameters:
      errorType - The enumerated type indicating the layer where the error occurred.
      errorTag - The enumerated tag representing a more specific error cause.
      errorMessage - A string which provides a plain text string describing the error.
      errorAppTag - A string which represents an application-specific error tag that further specifies the error cause.

    • RestconfError

      public RestconfError(org.opendaylight.yangtools.yang.common.ErrorType errorType, org.opendaylight.yangtools.yang.common.ErrorTag errorTag, String errorMessage, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier errorPath)
      Constructs a RestconfError object.
      Parameters:
      errorType - The enumerated type indicating the layer where the error occurred.
      errorTag - The enumerated tag representing a more specific error cause.
      errorMessage - A string which provides a plain text string describing the error.
      errorPath - An instance identifier which contains error path

    • RestconfError

      public RestconfError(org.opendaylight.yangtools.yang.common.ErrorType errorType, org.opendaylight.yangtools.yang.common.ErrorTag errorTag, String errorMessage, String errorAppTag, String errorInfo)
      Constructs a RestconfError object.
      Parameters:
      errorType - The enumerated type indicating the layer where the error occurred.
      errorTag - The enumerated tag representing a more specific error cause.
      errorMessage - A string which provides a plain text string describing the error.
      errorAppTag - A string which represents an application-specific error tag that further specifies the error cause.
      errorInfo - A string, formatted as XML, which contains additional error information.

    • RestconfError

      public RestconfError(org.opendaylight.yangtools.yang.common.ErrorType errorType, org.opendaylight.yangtools.yang.common.ErrorTag errorTag, String errorMessage, String errorAppTag, String errorInfo, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier errorPath)
      Constructs a RestConfError object.
      Parameters:
      errorType - The enumerated type indicating the layer where the error occurred.
      errorTag - The enumerated tag representing a more specific error cause.
      errorMessage - A string which provides a plain text string describing the error.
      errorAppTag - A string which represents an application-specific error tag that further specifies the error cause.
      errorInfo - A string, formatted as XML, which contains additional error information.
      errorPath - An instance identifier which contains error path

    • RestconfError

      public RestconfError(org.opendaylight.yangtools.yang.common.RpcError rpcError)
      Constructs a RestConfError object from an RpcError.

  • Method Details

    • getErrorType

      public @NonNull org.opendaylight.yangtools.yang.common.ErrorType getErrorType()

    • getErrorTag

      public @NonNull org.opendaylight.yangtools.yang.common.ErrorTag getErrorTag()

    • getErrorInfo

      public String getErrorInfo()

    • getErrorAppTag

      public String getErrorAppTag()

    • getErrorMessage

      public String getErrorMessage()

    • getErrorPath

      public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier getErrorPath()

    • toString

      public String toString()
      Overrides:
      toString in class Object