nl.teslanet.mule.connectors.coap.api.config.dtls

Class DtlsParams

java.lang.Object

nl.teslanet.mule.connectors.coap.api.config.dtls.DtlsParams

All Implemented Interfaces:

VisitableConfig

public class DtlsParams
extends Object
implements VisitableConfig

Configuration items that are DTLS specific.

Field Summary

Fields

Modifier and Type	Field and Description
Integer	antiReplayFilterWindowExtension Limit the anti replay filter window extension to given number of postponed records.
String	autoHandshakeTimeout The period in milliseconds [ms] after which, without exchanged messages, new messages will initiate a handshake.
Integer	deferredMsgCapacity The maximum number of messages sent during a handshake that are processed deferred after the handshake.
Integer	dtlsConnectorThreadCount The number of connector threads.
Integer	dtlsReceiverThreadCount The number of receiver threads.
Integer	handshakeCapacity Maximum number of jobs for handshake results.
Integer	handshakeRecordBufferSize The size [Bytes] of the buffer for Handshake records with future handshake message sequence number or records with future epochs.
Integer	inboundMsgCapacity Maximum number of jobs for inbound messages.
Integer	maxConnections The maximum number of active connections.
Integer	outboundMsgCapacity Maximum number of jobs for outbound messages.
boolean	removeStaleDoublePrincipals Remove stale connections, if the principal has also a newer connection.
String	staleConnectionThreshold Stale connections (no messages are exchanged within the threshold) can get removed for new connections.
boolean	updateAddressOnNewerCidRecords Update the ip-address from DTLS 1.2 CID records only for newer records based on epoch/sequence_number.
boolean	useAntiReplayFilter Use anti replay filter.
boolean	useExtendedAntiReplayFilterWindow Use extended anti replay filter window passing postponed records.
Integer	verifyPeersOnResumptionThreshold The threshold defines the maximum percentage of handshakes without HELLO_VERIFY_REQUEST.

Constructor Summary

Constructors

Constructor and Description
DtlsParams()

Method Summary

Modifier and Type	Method and Description
void	accept(ConfigVisitor visitor) Accept visitor.
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

maxConnections

@Parameter
 @Optional(defaultValue="150000")
 @Summary(value="The maximum number of active connections.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer maxConnections

The maximum number of active connections.

staleConnectionThreshold

@Parameter
 @Optional(defaultValue="30m")
 @Summary(value="Stale connections (no messages are exchanged within the threshold)\n can get removed for new connections.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String staleConnectionThreshold

Stale connections (no messages are exchanged within the threshold) can get removed for new connections.

updateAddressOnNewerCidRecords

@Parameter
 @Optional(defaultValue="true")
 @Summary(value="Update the ip-address from DTLS 1.2 CID records only for newer records\nbased on epoch/sequence_number.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public boolean updateAddressOnNewerCidRecords

Update the ip-address from DTLS 1.2 CID records only for newer records based on epoch/sequence_number.

removeStaleDoublePrincipals

@Parameter
 @Optional(defaultValue="false")
 @Summary(value="Remove stale connections, if the principal has also a newer connection. \nRequires to have unique principals.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public boolean removeStaleDoublePrincipals

Remove stale connections, if the principal has also a newer connection. Intended to free heap earlier for dynamic shared systems, Requires to have unique principals.

outboundMsgCapacity

@Parameter
 @Optional(defaultValue="50000")
 @Summary(value="Maximum number of jobs for outbound messages.\nThe value must be 64 or larger.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer outboundMsgCapacity

Maximum number of jobs for outbound messages. The value must be 64 or larger.

inboundMsgCapacity

@Parameter
 @Optional(defaultValue="50000")
 @Summary(value="Maximum number of jobs for inbound messages.\nThe value must be 64 or larger.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer inboundMsgCapacity

Maximum number of jobs for inbound messages. (Value must be 64 or larger).

dtlsReceiverThreadCount

@Parameter
 @Optional
 @Summary(value="The number of receiver threads. \nDefault value is 2 if number of CORES > 3, otherwise 1.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer dtlsReceiverThreadCount

The number of receiver threads. Default value is 2 if number of CORES > 3, otherwise 1.

dtlsConnectorThreadCount

@Parameter
 @Optional
 @Summary(value="The number of connector threads. \nThese threads handle most cryptographic \nfunctions for both incoming and outgoing messages. \nDefault value is the number of CORES.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer dtlsConnectorThreadCount

The number of connector threads. These threads handle most cryptographic functions for both incoming and outgoing messages. Default value is the number of CORES.

handshakeCapacity

@Parameter
 @Optional(defaultValue="5000")
 @Summary(value="Maximum number of jobs for handshake results.\nThe value must be 64 or larger.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer handshakeCapacity

Maximum number of jobs for handshake results. (Value must be 64 or larger).

handshakeRecordBufferSize

@Parameter
 @Optional(defaultValue="8192")
 @Summary(value="The size [Bytes] of the buffer for Handshake records with future handshake message sequence number \nor records with future epochs.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer handshakeRecordBufferSize

The size [Bytes] of the buffer for Handshake records with future handshake message sequence number or records with future epochs.

deferredMsgCapacity

@Parameter
 @Optional(defaultValue="10")
 @Summary(value="The maximum number of messages sent during a handshake that are processed deferred after the handshake.\nAbove this number messages are dropped.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer deferredMsgCapacity

The maximum number of messages sent during a handshake that are processed deferred after the handshake. Above this number messages are dropped.

autoHandshakeTimeout

@Parameter
 @Optional
 @Summary(value="The period after which, without exchanged messages, \nnew messages will initiate a handshake. Clients use {@code 30[s]} as \na common value to compensate assumed NAT timeouts. Not used by servers.\nDefault no auto handshake is initiated")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String autoHandshakeTimeout

The period in milliseconds [ms] after which, without exchanged messages, new messages will initiate a handshake. Clients use 30000ms as a common value to compensate assumed NAT timeouts. Not used by servers.

verifyPeersOnResumptionThreshold

@Parameter
 @Optional(defaultValue="30")
 @Summary(value="The threshold defines the maximum percentage of handshakes without HELLO_VERIFY_REQUEST.\nWhen 0 peers are verified on all resumptions.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer verifyPeersOnResumptionThreshold

The threshold defines the maximum percentage of handshakes without HELLO_VERIFY_REQUEST. When 0 peers are verified on all resumptions.

useAntiReplayFilter

@Parameter
 @Optional(defaultValue="true")
 @Summary(value="Use anti replay filter.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public boolean useAntiReplayFilter

Use anti replay filter.

See Also:

RFC6347 4.1.2.6. Anti-Replay

useExtendedAntiReplayFilterWindow

@Parameter
 @Optional(defaultValue="false")
 @Summary(value="Use anti replay filter.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public boolean useExtendedAntiReplayFilterWindow

Use extended anti replay filter window passing postponed records.

See Also:

RFC6347 4.1.2.6. Anti-Replay

antiReplayFilterWindowExtension

@Parameter
 @Optional
 @Summary(value="Limit the anti replay filter window extension to given number of postponed records.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer antiReplayFilterWindowExtension

Limit the anti replay filter window extension to given number of postponed records.

Constructor Detail

DtlsParams

public DtlsParams()

Method Detail

accept

public void accept(ConfigVisitor visitor)
            throws ConfigException

Accept visitor.

Specified by:

accept in interface VisitableConfig

Parameters:

visitor - The visitor of the configuration object.

Throws:

ConfigException - When the visit was not successful.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()