org.eclipse.californium.scandium.dtls

Class ServerNameExtension

java.lang.Object

org.eclipse.californium.scandium.dtls.HelloExtension

org.eclipse.californium.scandium.dtls.ServerNameExtension

public final class ServerNameExtension
extends HelloExtension

Conveys information specified by the Server Name Indication TLS extension.

See RFC 6066, Section 3 for additional details.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.californium.scandium.dtls.HelloExtension

HelloExtension.ExtensionType

Field Summary

Fields inherited from class org.eclipse.californium.scandium.dtls.HelloExtension

LENGTH_BITS, TYPE_BITS

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtensionData(org.eclipse.californium.elements.util.DatagramWriter writer) Adds binary encoding of this extension's data.
static ServerNameExtension	emptyServerNameIndication() Creates a new empty Server Name Indication extension.
static ServerNameExtension	forServerNames(ServerNames serverNames) Creates a new instance for a server name list.
static ServerNameExtension	fromExtensionDataReader(org.eclipse.californium.elements.util.DatagramReader extensionDataReader, InetSocketAddress peerAddress) Creates a new instance from its byte representation.
int	getLength() Gets the overall length of this extension's corresponding Extension struct.
ServerNames	getServerNames() Gets the server name list conveyed in this extension.

Methods inherited from class org.eclipse.californium.scandium.dtls.HelloExtension

fromExtensionDataReader, toByteArray, toString

Methods inherited from class java.lang.Object

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

Method Detail

emptyServerNameIndication

public static ServerNameExtension emptyServerNameIndication()

Creates a new empty Server Name Indication extension.

This method should be used by a server that wants to include an empty Server Name Indication extension in its SERVER_HELLO handshake message.

Returns:

The new instance.

forServerNames

public static ServerNameExtension forServerNames(ServerNames serverNames)

Creates a new instance for a server name list.

This constructor should be used by a client who wants to include the Server Name Indication extension in its CLIENT_HELLO handshake message.

Parameters:

serverNames - The server names.

Returns:

The new instance.

Throws:

NullPointerException - if the server name list is null.

addExtensionData

public void addExtensionData(org.eclipse.californium.elements.util.DatagramWriter writer)

Description copied from class: HelloExtension

Adds binary encoding of this extension's data.

This implementation does not do anything. Sub-classes should override this method and use the passed-in writer to add their extension_data bytes to the Extension data structure.

NB: Subclasses MUST NOT write the extension's type code to the writer as this will already have been done by the HelloExtension.toByteArray() method.

Specified by:

addExtensionData in class HelloExtension

Parameters:

writer - the writer to use for serialization

fromExtensionDataReader

public static ServerNameExtension fromExtensionDataReader(org.eclipse.californium.elements.util.DatagramReader extensionDataReader,
                                          InetSocketAddress peerAddress)
                                                   throws HandshakeException

Creates a new instance from its byte representation.

Parameters:

extensionDataReader - The byte representation.

peerAddress - The IP address and port that the extension has been received from.

Returns:

The instance.

Throws:

HandshakeException - if the byte representation could not be parsed.

getServerNames

public ServerNames getServerNames()

Gets the server name list conveyed in this extension.

Returns:

The server names.

getLength

public int getLength()

Description copied from class: HelloExtension

Gets the overall length of this extension's corresponding Extension struct.

Note that this includes the 2 bytes indicating the extension type.

Specified by:

getLength in class HelloExtension

Returns:

the length in bytes