org.eclipse.californium.scandium.dtls

Class AlertMessage

java.lang.Object

org.eclipse.californium.scandium.dtls.AlertMessage

All Implemented Interfaces:

Serializable, DTLSMessage

public final class AlertMessage
extends Object
implements DTLSMessage, Serializable

Alert messages convey the severity of the message (warning or fatal) and a description of the alert. Alert messages with a level of fatal result in the immediate termination of the connection. In this case, other connections corresponding to the session may continue, but the session identifier MUST be invalidated, preventing the failed session from being used to establish new connections. Like other messages, alert messages are encrypted and compressed, as specified by the current connection state. For further details see RFC 5246.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlertMessage.AlertDescription See Alert Messages for the listing.
static class	AlertMessage.AlertLevel See Alert Messages for the listing.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlertMessage()
	AlertMessage(AlertMessage.AlertLevel level, AlertMessage.AlertDescription description, InetSocketAddress peerAddress) Create new instance of alert message.
	AlertMessage(AlertMessage.AlertLevel level, AlertMessage.AlertDescription description, ProtocolVersion protocolVersion, InetSocketAddress peerAddress) Create new instance of alert message.

Method Summary

Methods

Modifier and Type	Method and Description
static AlertMessage	fromByteArray(byte[] byteArray, InetSocketAddress peerAddress)
ContentType	getContentType() Gets the message's content type.
AlertMessage.AlertDescription	getDescription()
AlertMessage.AlertLevel	getLevel()
InetSocketAddress	getPeer() Gets the IP address and port of the peer this message has been received from or is to be sent to.
ProtocolVersion	getProtocolVersion() Get protocol version to use for the record on sending.
boolean	isFatal()
int	size() Gets the number of bytes representing this message as defined by TLS 1.2, Appendix A.
byte[]	toByteArray() Gets the byte array representation of this message as defined by TLS 1.2, Appendix A.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertMessage

protected AlertMessage()

AlertMessage

public AlertMessage(AlertMessage.AlertLevel level,
            AlertMessage.AlertDescription description,
            InetSocketAddress peerAddress)

Create new instance of alert message.

Parameters:

level - the alert level

description - the alert description

peerAddress - the IP address and port of the peer this message has been received from or is to be sent to

Throws:

NullPointerException - if one of the provided parameter is null

AlertMessage

public AlertMessage(AlertMessage.AlertLevel level,
            AlertMessage.AlertDescription description,
            ProtocolVersion protocolVersion,
            InetSocketAddress peerAddress)

Create new instance of alert message.

Parameters:

level - the alert level

description - the alert description

protocolVersion - protocol version of record to send. Only possible for AlertMessage.AlertDescription.PROTOCOL_VERSION alerts!

peerAddress - the IP address and port of the peer this message has been received from or is to be sent to

Throws:

NullPointerException - if one of the provided parameter is null

IllegalArgumentException - if a protocol version is provided, but the description is not AlertMessage.AlertDescription.PROTOCOL_VERSION

Since:

2.6

Method Detail

getPeer

public final InetSocketAddress getPeer()

Description copied from interface: DTLSMessage

Gets the IP address and port of the peer this message has been received from or is to be sent to.

Specified by:

getPeer in interface DTLSMessage

Returns:

the address

getContentType

public ContentType getContentType()

Description copied from interface: DTLSMessage

Gets the message's content type.

Specified by:

getContentType in interface DTLSMessage

Returns:

the type

toString

public String toString()

Overrides:

toString in class Object

size

public int size()

Description copied from interface: DTLSMessage

Gets the number of bytes representing this message as defined by TLS 1.2, Appendix A.

Specified by:

size in interface DTLSMessage

Returns:

number of bytes

toByteArray

public byte[] toByteArray()

Gets the byte array representation of this message as defined by TLS 1.2, Appendix A.

Specified by:

toByteArray in interface DTLSMessage

Returns:

the byte array

fromByteArray

public static AlertMessage fromByteArray(byte[] byteArray,
                         InetSocketAddress peerAddress)
                                  throws HandshakeException

Throws:

HandshakeException

getProtocolVersion

public ProtocolVersion getProtocolVersion()

Get protocol version to use for the record on sending.

Returns:

protocol version, or null, for fixed or negotiated version.

getLevel

public AlertMessage.AlertLevel getLevel()

getDescription

public AlertMessage.AlertDescription getDescription()

isFatal

public boolean isFatal()