org.eclipse.californium.scandium.dtls

Class SessionTicket

java.lang.Object

org.eclipse.californium.scandium.dtls.SessionTicket

All Implemented Interfaces:

Destroyable

public final class SessionTicket
extends Object
implements Destroyable

A container for a session's crypto parameters that are required for resuming the session by means of an abbreviated handshake.

Method Summary

Methods

Modifier and Type	Method and Description
static SessionTicket	decode(org.eclipse.californium.elements.util.DatagramReader source) Creates a session from a byte array containing the binary encoding of a plain text session ticket that has been created by encode(DatagramWriter).
void	destroy()
void	encode(org.eclipse.californium.elements.util.DatagramWriter writer) Serializes this session into a plain text session ticket following the structure defined in RFC 5077.
boolean	equals(Object obj)
CipherSuite	getCipherSuite() Gets the cipher suite.
Principal	getClientIdentity() Gets the client's identity.
CompressionMethod	getCompressionMethod() Gets the compression method.
SecretKey	getMasterSecret() Gets the master secret.
ProtocolVersion	getProtocolVersion() Gets the protocol version.
ServerNames	getServerNames() Gets the server names.
long	getTimestamp() Gets the timestamp in milliseconds.
int	hashCode()
boolean	isDestroyed()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

encode

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

Serializes this session into a plain text session ticket following the structure defined in RFC 5077.

 struct {
   ProtocolVersion protocol_version;
   CipherSuite cipher_suite;
   CompressionMethod compression_method;
   opaque master_secret[48];
   ClientIdentity client_identity;
   uint32 timestamp;
   *ServerNames server_names;*
 } StatePlaintext;
 

(The server names are added to be able to check provided server names on session resumption with the server names provided on the full handshake of the session)

This method is useful for e.g. sharing the session with other nodes by means of a cache server or database so that a client can resume a session on another node if this node fails.

The timestampMillis are encoded in seconds. encode and decode therefore lose the milliseconds precision.

Parameters:

writer - The writer to serialize to.

decode

public static SessionTicket decode(org.eclipse.californium.elements.util.DatagramReader source)

Creates a session from a byte array containing the binary encoding of a plain text session ticket that has been created by encode(DatagramWriter).

This method is useful for e.g. sharing the write state with other nodes by means of a cache server or database so that a client can resume a session on another node if this node fails.

Parameters:

source - The encoded session ticket.

Returns:

The session object created from the ticket. Note that the session contains pending state information only and thus requires an abbreviated handshake to take place in order to create current read and write state. Returns null if the session ticket is not encoded according to the structure defined by encode(DatagramWriter).

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

destroy

public void destroy()
             throws DestroyFailedException

Specified by:

destroy in interface Destroyable

Throws:

DestroyFailedException

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

getProtocolVersion

public final ProtocolVersion getProtocolVersion()

Gets the protocol version.

Returns:

the protocol version

getMasterSecret

public final SecretKey getMasterSecret()

Gets the master secret.

Returns:

the master secret

getCipherSuite

public final CipherSuite getCipherSuite()

Gets the cipher suite.

Returns:

the cipher suite

getCompressionMethod

public final CompressionMethod getCompressionMethod()

Gets the compression method.

Returns:

the compression method

getServerNames

public final ServerNames getServerNames()

Gets the server names.

Returns:

the server names, or null, if not available.

getClientIdentity

public final Principal getClientIdentity()

Gets the client's identity.

Returns:

the principal of client's identity, or null, if not available.

getTimestamp

public final long getTimestamp()

Gets the timestamp in milliseconds.

Returns:

the timestamp

See Also:

System.currentTimeMillis()