org.opendaylight.yangtools.yang.common

Interface RpcError

public interface RpcError

Representation of an error.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RpcError.ErrorSeverity
static class	RpcError.ErrorType

Method Summary

Modifier and Type	Method and 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.
RpcError.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.
RpcError.ErrorSeverity	getSeverity() Returns the error severity, as determined by the application reporting the error.
String	getTag() Returns a short string that identifies the general type of error condition.

Method Detail

getSeverity

RpcError.ErrorSeverity getSeverity()

Returns the error severity, as determined by the application reporting the error.

Returns:

an RpcError.ErrorSeverity enum.

getTag

String getTag()

Returns a short string that identifies the general type of error condition.

The following outlines suggested values as defined by netconf (RFC 6241):

    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

RpcError.ErrorType getErrorType()

Returns the conceptual layer at which the error occurred.

Returns:

an RpcError.ErrorType enum.