org.opendaylight.controller.config.util.xml

Class DocumentedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.opendaylight.controller.config.util.xml.DocumentedException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConfigHandlingException, MissingNameSpaceException, OperationNotPermittedException, UnexpectedElementException, UnexpectedNamespaceException

public class DocumentedException
extends Exception

Checked exception to communicate an error that needs to be sent to the netconf client.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentedException.ErrorSeverity
static class	DocumentedException.ErrorTag
static class	DocumentedException.ErrorType

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_APP_TAG
static String	ERROR_INFO
static String	ERROR_MESSAGE
static String	ERROR_PATH
static String	ERROR_SEVERITY
static String	ERROR_TAG
static String	ERROR_TYPE
static String	RPC_ERROR

Constructor Summary

Constructors

Constructor and Description
DocumentedException(String message)
DocumentedException(String message, DocumentedException.ErrorType errorType, DocumentedException.ErrorTag errorTag, DocumentedException.ErrorSeverity errorSeverity)
DocumentedException(String message, DocumentedException.ErrorType errorType, DocumentedException.ErrorTag errorTag, DocumentedException.ErrorSeverity errorSeverity, Map<String,String> errorInfo)
DocumentedException(String message, Exception cause)
DocumentedException(String message, Exception cause, DocumentedException.ErrorType errorType, DocumentedException.ErrorTag errorTag, DocumentedException.ErrorSeverity errorSeverity)
DocumentedException(String message, Exception cause, DocumentedException.ErrorType errorType, DocumentedException.ErrorTag errorTag, DocumentedException.ErrorSeverity errorSeverity, Map<String,String> errorInfo)

Method Summary

Modifier and Type	Method and Description
static DocumentedException	fromXMLDocument(Document fromDoc)
Map<String,String>	getErrorInfo()
DocumentedException.ErrorSeverity	getErrorSeverity()
DocumentedException.ErrorTag	getErrorTag()
DocumentedException.ErrorType	getErrorType()
String	toString()
Document	toXMLDocument()
static DocumentedException	wrap(ConflictingVersionException e)
static <E extends Exception> DocumentedException	wrap(E exception)
static DocumentedException	wrap(ValidationException e)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

RPC_ERROR

public static final String RPC_ERROR

See Also:

Constant Field Values

ERROR_TYPE

public static final String ERROR_TYPE

See Also:

Constant Field Values

ERROR_TAG

public static final String ERROR_TAG

See Also:

Constant Field Values

ERROR_SEVERITY

public static final String ERROR_SEVERITY

See Also:

Constant Field Values

ERROR_APP_TAG

public static final String ERROR_APP_TAG

See Also:

Constant Field Values

ERROR_PATH

public static final String ERROR_PATH

See Also:

Constant Field Values

ERROR_MESSAGE

public static final String ERROR_MESSAGE

See Also:

Constant Field Values

ERROR_INFO

public static final String ERROR_INFO

See Also:

Constant Field Values

Constructor Detail

DocumentedException

public DocumentedException(String message)

DocumentedException

public DocumentedException(String message,
                           Exception cause)

DocumentedException

public DocumentedException(String message,
                           DocumentedException.ErrorType errorType,
                           DocumentedException.ErrorTag errorTag,
                           DocumentedException.ErrorSeverity errorSeverity)

DocumentedException

public DocumentedException(String message,
                           DocumentedException.ErrorType errorType,
                           DocumentedException.ErrorTag errorTag,
                           DocumentedException.ErrorSeverity errorSeverity,
                           Map<String,String> errorInfo)

DocumentedException

public DocumentedException(String message,
                           Exception cause,
                           DocumentedException.ErrorType errorType,
                           DocumentedException.ErrorTag errorTag,
                           DocumentedException.ErrorSeverity errorSeverity)

DocumentedException

public DocumentedException(String message,
                           Exception cause,
                           DocumentedException.ErrorType errorType,
                           DocumentedException.ErrorTag errorTag,
                           DocumentedException.ErrorSeverity errorSeverity,
                           Map<String,String> errorInfo)

Method Detail

wrap

public static <E extends Exception> DocumentedException wrap(E exception)
                                                      throws DocumentedException

Throws:

DocumentedException

wrap

public static DocumentedException wrap(ValidationException e)
                                throws DocumentedException

Throws:

DocumentedException

wrap

public static DocumentedException wrap(ConflictingVersionException e)
                                throws DocumentedException

Throws:

DocumentedException

fromXMLDocument

public static DocumentedException fromXMLDocument(Document fromDoc)

getErrorType

public DocumentedException.ErrorType getErrorType()

getErrorTag

public DocumentedException.ErrorTag getErrorTag()

getErrorSeverity

public DocumentedException.ErrorSeverity getErrorSeverity()

getErrorInfo

public Map<String,String> getErrorInfo()

toXMLDocument

public Document toXMLDocument()

toString

public String toString()

Overrides:

toString in class Throwable