org.eclipse.californium.scandium.config

Class DtlsClusterConnectorConfig.Builder

java.lang.Object

org.eclipse.californium.scandium.config.DtlsClusterConnectorConfig.Builder

Enclosing class:

DtlsClusterConnectorConfig

public static final class DtlsClusterConnectorConfig.Builder
extends Object

Builder for cluster connector configuration.

Constructor Summary

Constructors

Constructor and Description
DtlsClusterConnectorConfig.Builder() Create new builder.
DtlsClusterConnectorConfig.Builder(DtlsClusterConnectorConfig initialConfiguration) Create new builder initialized with provided configuration.

Method Summary

Methods

Modifier and Type	Method and Description
DtlsClusterConnectorConfig	build() Creates an instance of DtlsClusterConnectorConfig based on the properties set on this builder.
DtlsClusterConnectorConfig	getIncompleteConfig() Returns a potentially incomplete configuration.
DtlsClusterConnectorConfig.Builder	setAddress(InetSocketAddress address) Sets local socket address for internal cluster connector.
DtlsClusterConnectorConfig.Builder	setBackwardMessage(Boolean enable) Enable to send outgoing messages back via original receiving connector (router).
DtlsClusterConnectorConfig.Builder	setClusterMac(Boolean enable) Enable to send forwarded and backwarded messages protected with a MAC.
DtlsClusterConnectorConfig.Builder	setSecure(String identity, SecretKey secret) Set PSK credentials.

Methods inherited from class java.lang.Object

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

Constructor Detail

DtlsClusterConnectorConfig.Builder

public DtlsClusterConnectorConfig.Builder()

Create new builder.

DtlsClusterConnectorConfig.Builder

public DtlsClusterConnectorConfig.Builder(DtlsClusterConnectorConfig initialConfiguration)

Create new builder initialized with provided configuration.

Parameters:

initialConfiguration - configuration for initialization

Method Detail

setAddress

public DtlsClusterConnectorConfig.Builder setAddress(InetSocketAddress address)

Sets local socket address for internal cluster connector.

Parameters:

address - local socket address for internal cluster connector.

Returns:

this builder for command chaining

setSecure

public DtlsClusterConnectorConfig.Builder setSecure(String identity,
                                           SecretKey secret)

Set PSK credentials.

Parameters:

identity - PSK identity for cluster internal connector. If null, encryption is disabled. In that case the secret must also be null.

secret - PSK secret for cluster internal connector. The secret is copied, therefore the caller is intended to delete it afterwards. If null, encryption is disabled. In that case the identity must also be null.

Returns:

this builder for command chaining

Throws:

IllegalArgumentException - if one argument is null and the other not.

setClusterMac

public DtlsClusterConnectorConfig.Builder setClusterMac(Boolean enable)

Enable to send forwarded and backwarded messages protected with a MAC. Enable encryption using setSecure(String, SecretKey) enables the MAC as default. Without encryption, using a MAC for forwarded and backwarded messages is not possible.

Parameters:

enable - true, to use MAC, false, otherwise.

Returns:

this builder for command chaining

setBackwardMessage

public DtlsClusterConnectorConfig.Builder setBackwardMessage(Boolean enable)

Enable to send outgoing messages back via original receiving connector (router).

Parameters:

enable - true, to send outgoing messages back via original receiving connector (router), false, to send outgoing messages directly.

Returns:

this builder for command chaining

getIncompleteConfig

public DtlsClusterConnectorConfig getIncompleteConfig()

Returns a potentially incomplete configuration. Only fields set by users are affected, there is no default value, no consistency check. To get a full usable DtlsConnectorConfig use build() instead.

Returns:

the incomplete Configuration

build

public DtlsClusterConnectorConfig build()

Creates an instance of DtlsClusterConnectorConfig based on the properties set on this builder.

Fills in default values.

Returns:

the configuration object

Throws:

IllegalStateException - if DtlsClusterConnectorConfig.address wasn't provided.