org.eclipse.californium.scandium

Class DtlsClusterConnector

java.lang.Object

org.eclipse.californium.scandium.DTLSConnector

org.eclipse.californium.scandium.DtlsClusterConnector

All Implemented Interfaces:

org.eclipse.californium.elements.Connector, RecordLayer

Direct Known Subclasses:

DtlsManagedClusterConnector

public class DtlsClusterConnector
extends DTLSConnector

DTLS cluster connector.

Forwards foreign cid records (tls_cid) to other connectors based on the passed in DtlsClusterConnector.ClusterNodesProvider. Requires a NodeConnectionIdGenerator in DtlsConnectorConfig in order to extract the node-id from the record's CID and to retrieve the own node-id.

In order to preserve the original source address, the forwarded records are prepended by a header, which contains that original address. The forwarded records are exchange using a separate endpoint (port) to easier separate the cluster internal traffic from external record traffic. That additional endpoint is configured using DtlsClusterConnectorConfig.

Generally, if a forwarded tls_cid record is processed and a message is sent back by that final destination connector, that sent message is backwarded to the original receiving connector. That is required for the most network setup in order to keep all NATs and load-balancers working. If your network permits to send outgoing messages also from other endpoints, DtlsClusterConnectorConfig can be used to configure that.

Since:

2.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DtlsClusterConnector.ClusterNodesProvider Cluster nodes provider.

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

DTLSConnector.Worker

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CLUSTER_ADDRESS_LENGTH_OFFSET Offset for address length of cluster records.
protected static int	CLUSTER_ADDRESS_OFFSET Offset for address of cluster records.
protected static int	CLUSTER_MAC_LENGTH Length of cluster Mac, if used.
protected static int	CLUSTER_PORT_OFFSET Offset for port of cluster records.
protected static int	CLUSTER_RECORD_TYPE_OFFSET Offset of cluster record type.
protected DtlsClusterHealth	clusterHealth DTLS cluster health statistic.
protected DatagramSocket	clusterInternalSocket Datagram socket for cluster internal communication.
protected static int	MAX_ADDRESS_LENGTH Maximum address length for cluster records.
protected static int	MAX_DATAGRAM_OFFSET Maximum datagram offset for cluster records.
protected static int	MIN_ADDRESS_LENGTH Maximum address length for cluster records.
static Byte	RECORD_TYPE_INCOMING Type of incoming forwarded messages.
static Byte	RECORD_TYPE_OUTGOING Type of outgoing forwarded messages.

Fields inherited from class org.eclipse.californium.scandium.DTLSConnector

config, connectionIdGenerator, health, inboundDatagramBufferSize, KEY_TLS_SERVER_HOST_NAME, timer

Fields inherited from interface org.eclipse.californium.scandium.dtls.RecordLayer

DEFAULT_ETH_MTU, DEFAULT_IPV4_MTU, DEFAULT_IPV6_MTU, IPV4_HEADER_LENGTH, IPV6_HEADER_LENGTH, MAX_MTU

Constructor Summary

Constructors

Modifier	Constructor and Description
	DtlsClusterConnector(DtlsConnectorConfig configuration, DtlsClusterConnectorConfig clusterConfiguration, DtlsClusterConnector.ClusterNodesProvider nodes) Create dtls connector with cluster support.
	DtlsClusterConnector(DtlsConnectorConfig configuration, DtlsClusterConnectorConfig clusterConfiguration, DtlsClusterConnector.ClusterNodesProvider nodes, SessionCache sessionCache) Create dtls connector with cluster support and session cache.
protected	DtlsClusterConnector(DtlsConnectorConfig configuration, DtlsClusterConnectorConfig clusterConfiguration, ResumptionSupportingConnectionStore connectionStore, boolean startReceiver) Create dtls connector with cluster support and connection store.

Method Summary

Methods

Modifier and Type	Method and Description
protected DtlsHealth	createDefaultHealthHandler(DtlsConnectorConfig configuration) Create default health handler.
protected boolean	ensureLength(Byte type, DatagramPacket clusterPacket) Ensure, that the packet is large enough for a valid cluster internal message.
protected int	getClusterMacLength() Get cluster MAC length.
protected Byte	getClusterRecordType(DatagramPacket clusterPacket) Check, if internal message is forwarded or backwarded record.
int	getNodeID() Get connector's node-id.
protected void	init(InetSocketAddress bindAddress, DatagramSocket socket, Integer mtu) Initialize socket ad start connector.
protected void	processDatagram(DatagramPacket packet, InetSocketAddress router) Process received datagram.
protected void	processDatagramFromClusterNetwork(Byte type, DatagramPacket clusterPacket) Process received cluster internal message.
protected void	processManagementDatagramFromClusterNetwork(DatagramPacket clusterPacket) Process cluster internal management message.
protected void	sendDatagramToClusterNetwork(DatagramPacket clusterPacket) Send cluster internal message.
protected void	sendRecord(Record record) For Record.getRouter() destinations, backwards massage to original receiving connector (router).
void	setClusterNodesProvider(DtlsClusterConnector.ClusterNodesProvider nodes) Set cluster nodes provider.
protected void	startReceiver() Start receiver threads for cluster internal communication.
void	stop() Stop also socket and threads for cluster internal communication.

Methods inherited from class org.eclipse.californium.scandium.DTLSConnector

clearConnectionState, close, createConnectionStore, destroy, dropReceivedRecord, forceResumeAllSessions, forceResumeSessionFor, getAddress, getMaxDatagramSize, getMaximumFragmentLength, getMaximumTransmissionUnit, getProtocol, getSessionByAddress, isRunning, onInitializeHandshaker, processDatagram, processRecord, receiveNextDatagramFromNetwork, send, sendFlight, sendNextDatagramOverNetwork, setAlertHandler, setEndpointContextMatcher, setExecutor, setRawDataReceiver, start, start, startDropConnectionsForPrincipal, startForEach, startTerminateConnectionsForPrincipal, startTerminateConnectionsForPrincipal, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLUSTER_RECORD_TYPE_OFFSET

protected static final int CLUSTER_RECORD_TYPE_OFFSET

Offset of cluster record type.

See Also:

Constant Field Values

CLUSTER_PORT_OFFSET

protected static final int CLUSTER_PORT_OFFSET

Offset for port of cluster records.

See Also:

Constant Field Values

CLUSTER_ADDRESS_LENGTH_OFFSET

protected static final int CLUSTER_ADDRESS_LENGTH_OFFSET

Offset for address length of cluster records.

See Also:

Constant Field Values

CLUSTER_ADDRESS_OFFSET

protected static final int CLUSTER_ADDRESS_OFFSET

Offset for address of cluster records.

See Also:

Constant Field Values

MIN_ADDRESS_LENGTH

protected static final int MIN_ADDRESS_LENGTH

Maximum address length for cluster records.

See Also:

Constant Field Values

MAX_ADDRESS_LENGTH

protected static final int MAX_ADDRESS_LENGTH

Maximum address length for cluster records.

See Also:

Constant Field Values

CLUSTER_MAC_LENGTH

protected static final int CLUSTER_MAC_LENGTH

Length of cluster Mac, if used.

See Also:

getClusterMacLength(), Constant Field Values

MAX_DATAGRAM_OFFSET

protected static final int MAX_DATAGRAM_OFFSET

Maximum datagram offset for cluster records.

See Also:

Constant Field Values

RECORD_TYPE_INCOMING

public static final Byte RECORD_TYPE_INCOMING

Type of incoming forwarded messages. Unassigned according IANA, TLS ContentType, and no collision with CoAP messages RFC 7252, Message Format (1. byte, version 0b01, others xx xxxx).

RECORD_TYPE_OUTGOING

public static final Byte RECORD_TYPE_OUTGOING

Type of outgoing forwarded messages. Unassigned according IANA, TLS ContentType, and no collision with CoAP messages RFC 7252, Message Format (1. byte, version 0b01, others xx xxxx).

clusterHealth

protected final DtlsClusterHealth clusterHealth

DTLS cluster health statistic.

clusterInternalSocket

protected volatile DatagramSocket clusterInternalSocket

Datagram socket for cluster internal communication.

Constructor Detail

DtlsClusterConnector

public DtlsClusterConnector(DtlsConnectorConfig configuration,
                    DtlsClusterConnectorConfig clusterConfiguration,
                    DtlsClusterConnector.ClusterNodesProvider nodes)

Create dtls connector with cluster support.

Parameters:

configuration - dtls configuration

clusterConfiguration - cluster internal connector configuration

nodes - nodes provider

Throws:

IllegalArgumentException - if the configuration doesn't provide a cid generator, or the cid generator only supports, but doesn't use cids, or the cid generator is no NodeConnectionIdGenerator.

DtlsClusterConnector

public DtlsClusterConnector(DtlsConnectorConfig configuration,
                    DtlsClusterConnectorConfig clusterConfiguration,
                    DtlsClusterConnector.ClusterNodesProvider nodes,
                    SessionCache sessionCache)

Create dtls connector with cluster support and session cache.

Parameters:

configuration - dtls configuration

clusterConfiguration - cluster internal connector configuration

nodes - nodes provider

sessionCache - session cache. May be null.

Throws:

IllegalArgumentException - if the configuration doesn't provide a cid generator, or the cid generator only supports, but doesn't use cids, or the cid generator is no NodeConnectionIdGenerator.

DtlsClusterConnector

protected DtlsClusterConnector(DtlsConnectorConfig configuration,
                    DtlsClusterConnectorConfig clusterConfiguration,
                    ResumptionSupportingConnectionStore connectionStore,
                    boolean startReceiver)

Create dtls connector with cluster support and connection store.

Parameters:

configuration - dtls configuration

clusterConfiguration - cluster internal connector configuration

connectionStore - connection store

startReceiver - true, start receiver threads for cluster internal communication on init(InetSocketAddress, DatagramSocket, Integer), false, otherwise.

Throws:

IllegalArgumentException - if the configuration doesn't provide a cid generator, or the cid generator only supports, but doesn't use cids, or the cid generator is no NodeConnectionIdGenerator.

Method Detail

createDefaultHealthHandler

protected DtlsHealth createDefaultHealthHandler(DtlsConnectorConfig configuration)

Create default health handler. Creates a DtlsClusterHealthLogger.

Overrides:

createDefaultHealthHandler in class DTLSConnector

Parameters:

configuration - configuration

Returns:

default health handler.

init

protected void init(InetSocketAddress bindAddress,
        DatagramSocket socket,
        Integer mtu)
             throws IOException

Initialize socket ad start connector. Creates also socket and threads for cluster internal communication. The threads are only create, if startReceiver is true.

Overrides:

init in class DTLSConnector

Parameters:

bindAddress - address to bind socket

socket - socket

mtu - mtu of socket, or null, if socket implementation doesn't use a special mtu.

Throws:

IOException - I/O error

startReceiver

protected void startReceiver()

Start receiver threads for cluster internal communication. After starting the threads, the clusterInternalSocket may be locked by these threads calling DatagramSocket.receive(DatagramPacket).

stop

public void stop()

Stop also socket and threads for cluster internal communication.

Specified by:

stop in interface org.eclipse.californium.elements.Connector

Overrides:

stop in class DTLSConnector

getClusterMacLength

protected int getClusterMacLength()

Get cluster MAC length.

Returns:

cluster MAC length. 0, if cluster MAC is not used.

setClusterNodesProvider

public void setClusterNodesProvider(DtlsClusterConnector.ClusterNodesProvider nodes)

Set cluster nodes provider.

Parameters:

nodes - cluster nodes provider

getNodeID

public int getNodeID()

Get connector's node-id.

Returns:

node-id.

getClusterRecordType

protected Byte getClusterRecordType(DatagramPacket clusterPacket)

Check, if internal message is forwarded or backwarded record.

Parameters:

clusterPacket - cluster internal message

Returns:

RECORD_TYPE_INCOMING, if message is forwarded, RECORD_TYPE_OUTGOING, if message is backwarded, null, otherwise.

ensureLength

protected boolean ensureLength(Byte type,
                   DatagramPacket clusterPacket)

Ensure, that the packet is large enough for a valid cluster internal message.

Parameters:

type - RECORD_TYPE_INCOMING or RECORD_TYPE_OUTGOING.

clusterPacket - the cluster internal message.

Returns:

true, if the cluster internal message is large enough, false, if it is too short.

processDatagramFromClusterNetwork

protected void processDatagramFromClusterNetwork(Byte type,
                                     DatagramPacket clusterPacket)
                                          throws IOException

Process received cluster internal message.

Parameters:

type - cluster record type. RECORD_TYPE_INCOMING or RECORD_TYPE_OUTGOING.

clusterPacket - cluster internal message

Throws:

IOException - if an io-error occurred.

processManagementDatagramFromClusterNetwork

protected void processManagementDatagramFromClusterNetwork(DatagramPacket clusterPacket)
                                                    throws IOException

Process cluster internal management message. Not used for forwarded or backwarded tls_cid records.

Parameters:

clusterPacket - cluster internal management message.

Throws:

IOException - if an i/o-error occurred

sendDatagramToClusterNetwork

protected void sendDatagramToClusterNetwork(DatagramPacket clusterPacket)
                                     throws IOException

Send cluster internal message. Used for forwarded or backwarded tls_cid records.

Parameters:

clusterPacket - cluster internal message

Throws:

IOException - if an i/o-error occurred.

processDatagram

protected void processDatagram(DatagramPacket packet,
                   InetSocketAddress router)

Process received datagram. Potentially called by multiple threads. Test for CID records and forward foreign records to other nodes, based on the returned node-id of the NodeConnectionIdGenerator.

Overrides:

processDatagram in class DTLSConnector

Parameters:

packet - received message

router - router address, null, if no router is used.

sendRecord

protected void sendRecord(Record record)
                   throws IOException

For Record.getRouter() destinations, backwards massage to original receiving connector (router).

Overrides:

sendRecord in class DTLSConnector

Throws:

IOException