org.opendaylight.protocol.bgp.parser

Class BGPDocumentedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.opendaylight.protocol.bgp.parser.BGPDocumentedException

All Implemented Interfaces:

Serializable

public final class BGPDocumentedException
extends Exception

There are several errors documented in RFC4271 or in draft, that have specific meaning for the BGP. This exception is used, when any of those errors occurs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BGPDocumentedException(BGPError error) Used when an error occurred that is described in an RFC or a draft.
BGPDocumentedException(String message, BGPError error) Used when an error occurred that is described in an RFC or a draft.
BGPDocumentedException(String message, BGPError error, byte[] data) Used when an error occurred that is described in an RFC or a draft.
BGPDocumentedException(String message, BGPError error, byte[] data, Exception cause) Used when an error occurred that is described in an RFC or a draft.
BGPDocumentedException(String message, BGPError error, Exception cause) Used when an error occurred that is described in an RFC or a draft.

Method Summary

Modifier and Type	Method and Description
static BGPDocumentedException	badMessageLength(String message, int length)
byte[]	getData() Returns data associated with this error.
BGPError	getError() Returns specific documented error.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BGPDocumentedException

public BGPDocumentedException(BGPError error)

Used when an error occurred that is described in an RFC or a draft.

Parameters:

error - specific documented error

BGPDocumentedException

public BGPDocumentedException(String message,
                              BGPError error)

Used when an error occurred that is described in an RFC or a draft.

Parameters:

message - message bound with this exception

error - specific documented error

BGPDocumentedException

public BGPDocumentedException(String message,
                              BGPError error,
                              Exception cause)

Used when an error occurred that is described in an RFC or a draft.

Parameters:

message - message bound with this exception

error - specific documented error

cause - cause for the error

BGPDocumentedException

public BGPDocumentedException(String message,
                              BGPError error,
                              byte[] data)

Used when an error occurred that is described in an RFC or a draft.

Parameters:

message - message bound with this exception

error - specific documented error

data - data associated with the error

BGPDocumentedException

public BGPDocumentedException(String message,
                              BGPError error,
                              byte[] data,
                              Exception cause)

Used when an error occurred that is described in an RFC or a draft.

Parameters:

message - message bound with this exception

error - specific documented error

data - data associated with the error

cause - cause for the error

Method Detail

getError

public BGPError getError()

Returns specific documented error.

Returns:

documented error

getData

public byte[] getData()

Returns data associated with this error.

Returns:

byte array data

badMessageLength

public static BGPDocumentedException badMessageLength(String message,
                                                      int length)