DtlsConnectorConfig.Builder (Scandium (Sc) Core 2.8.0 API)

java.lang.Object
- org.eclipse.californium.scandium.config.DtlsConnectorConfig.Builder

Enclosing class:

DtlsConnectorConfig
```
public static final class DtlsConnectorConfig.Builder
extends Object
```
A helper for creating instances of DtlsConnectorConfig based on the builder pattern.

Constructor Summary

Constructors
Constructor and Description
`DtlsConnectorConfig.Builder()` Creates a new instance for setting configuration options for a `DTLSConnector` instance.
`DtlsConnectorConfig.Builder(DtlsConnectorConfig initialConfiguration)` Create a builder from an existing DtlsConnectorConfig.

Method Summary

Methods
Modifier and Type	Method and Description
`DtlsConnectorConfig`	`build()` Creates an instance of `DtlsConnectorConfig` based on the properties set on this builder.
`DtlsConnectorConfig`	`getIncompleteConfig()` Returns a potentially incomplete configuration.
`DtlsConnectorConfig.Builder`	`setAddress(InetSocketAddress address)` Sets the IP address and port the connector should bind to Note: using IPv6 interfaces with multiple addresses including permanent and temporary (with potentially several different prefixes) currently causes issues on the server side.
`DtlsConnectorConfig.Builder`	`setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier verifier)` Sets the logic in charge of validating a X.509 certificate chain.
`DtlsConnectorConfig.Builder`	`setAdvancedPskStore(AdvancedPskStore advancedPskStore)` Sets the advanced key store to use for authenticating clients based on a pre-shared key.
`DtlsConnectorConfig.Builder`	`setApplicationLevelInfoSupplier(ApplicationLevelInfoSupplier supplier)` Sets a supplier of application level information for an authenticated peer's identity.
`DtlsConnectorConfig.Builder`	`setAutoResumptionTimeoutMillis(Long timeoutInMillis)` Set the timeout of automatic session resumption in milliseconds.
`DtlsConnectorConfig.Builder`	`setBackOffRetransmission(Integer count)` Number of retransmissions before the attempt to transmit a flight in back-off mode.
`DtlsConnectorConfig.Builder`	`setCertificateVerifier(CertificateVerifier verifier)` Deprecated. use `setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier)` instead. `StaticNewAdvancedCertificateVerifier` may be used for simple setups. More complex ones may require a custom implementation. During migration you may also use the `BridgeCertificateVerifier` in order to use old implementations for that period.
`DtlsConnectorConfig.Builder`	`setCidUpdateAddressOnNewerRecordFilter(boolean enable)` Use filter to update the ip-address from DTLS 1.2 CID records only for newer records based on epoch/sequence_number.
`DtlsConnectorConfig.Builder`	`setCipherSuiteSelector(CipherSuiteSelector cipherSuiteSelector)` Sets the cipher suite selector.
`DtlsConnectorConfig.Builder`	`setClientAuthenticationRequired(boolean authRequired)` Sets whether the connector requires DTLS clients to authenticate during the handshake.
`DtlsConnectorConfig.Builder`	`setClientAuthenticationWanted(boolean authWanted)` Sets whether the connector wants (requests) DTLS clients to authenticate during the handshake.
`DtlsConnectorConfig.Builder`	`setClientOnly()` Indicates that the DTLSConnector will only be used as a DTLS client.
`DtlsConnectorConfig.Builder`	`setConnectionIdGenerator(ConnectionIdGenerator connectionIdGenerator)` Sets the connection id generator.
`DtlsConnectorConfig.Builder`	`setConnectionListener(ConnectionListener connectionListener)`
`DtlsConnectorConfig.Builder`	`setConnectionThreadCount(int threadCount)` Set the number of thread which should be used to handle DTLS connection.
`DtlsConnectorConfig.Builder`	`setDefaultHandshakeMode(String defaultHandshakeMode)` Set the DTLSConnector default handshake mode.
`DtlsConnectorConfig.Builder`	`setEarlyStopRetransmission(boolean activate)` Activate/Deactivate experimental feature: Stop retransmission at first received handshake message.
`DtlsConnectorConfig.Builder`	`setEnableAddressReuse(boolean enable)` Enables address reuse for the socket.
`DtlsConnectorConfig.Builder`	`setEnableMultiHandshakeMessageRecords(boolean enable)` Enable to use dtls records with multiple handshake messages.
`DtlsConnectorConfig.Builder`	`setEnableMultiRecordMessages(boolean enable)` Enable to use UDP messages with multiple dtls records.
`DtlsConnectorConfig.Builder`	`setHealthHandler(DtlsHealth healthHandler)` Set the health handler.
`DtlsConnectorConfig.Builder`	`setHealthStatusInterval(Integer healthStatusIntervalSeconds)` Set the health status interval.
`DtlsConnectorConfig.Builder`	`setIdentity(PrivateKey privateKey, Certificate[] certificateChain, CertificateType... certificateTypes)` Sets the connector's identifying properties by means of a private key and a corresponding issuer certificates chain.
`DtlsConnectorConfig.Builder`	`setIdentity(PrivateKey privateKey, Certificate[] certificateChain, List<CertificateType> certificateTypes)` Sets the connector's identifying properties by means of a private key and a corresponding issuer certificates chain.
`DtlsConnectorConfig.Builder`	`setIdentity(PrivateKey privateKey, PublicKey publicKey)` Sets the connector's identifying properties by means of a private and public key pair.
`DtlsConnectorConfig.Builder`	`setKeyUsageVerification(boolean enable)` Use key usage verification for x509.
`DtlsConnectorConfig.Builder`	`setLoggingTag(String tag)` Set instance logging tag.
`DtlsConnectorConfig.Builder`	`setMaxConnections(int maxConnections)` Sets the maximum number of active connections the connector should support.
`DtlsConnectorConfig.Builder`	`setMaxDeferredProcessedIncomingRecordsSize(int maxDeferredProcessedIncomingRecordsSize)` Set maximum size of deferred processed incoming records.
`DtlsConnectorConfig.Builder`	`setMaxDeferredProcessedOutgoingApplicationDataMessages(int maxDeferredProcessedOutgoingApplicationDataMessages)` Set maximum number of deferred processed outgoing application data messages.
`DtlsConnectorConfig.Builder`	`setMaxFragmentedHandshakeMessageLength(Integer length)` Set maximum length of handshake message.
`DtlsConnectorConfig.Builder`	`setMaxFragmentLengthCode(Integer lengthCode)` Sets the maximum amount of payload data that can be received and processed by this connector in a single DTLS record.
`DtlsConnectorConfig.Builder`	`setMaxRetransmissions(int count)` Sets the maximum number of times a flight of handshake messages gets re-transmitted to a peer.
`DtlsConnectorConfig.Builder`	`setMaxTransmissionUnit(int mtu)` Set maximum transmission unit.
`DtlsConnectorConfig.Builder`	`setMaxTransmissionUnitLimit(int limit)` Set maximum transmission unit limit for auto detection.
`DtlsConnectorConfig.Builder`	`setNoServerSessionId(boolean flag)` Set whether session id is used by this server or not.
`DtlsConnectorConfig.Builder`	`setOutboundMessageBufferSize(int capacity)` Sets the number of outbound messages that can be buffered in memory before dropping messages.
`DtlsConnectorConfig.Builder`	`setPreselectedCipherSuites(CipherSuite... cipherSuites)` Sets the preselected cipher suites for the connector.
`DtlsConnectorConfig.Builder`	`setPreselectedCipherSuites(List<CipherSuite> cipherSuites)` Sets the preselected cipher suites for the connector.
`DtlsConnectorConfig.Builder`	`setPreselectedCipherSuites(String... cipherSuites)` Sets the preselected cipher suites for the connector.
`DtlsConnectorConfig.Builder`	`setProtocolVersionForHelloVerifyRequests(ProtocolVersion protocolVersion)` Set the protocol version to be used to send hello verify requests.
`DtlsConnectorConfig.Builder`	`setPskStore(PskStore pskStore)` Deprecated. use `setAdvancedPskStore(AdvancedPskStore)` instead. `AdvancedSinglePskStore` and `AdvancedMultiPskStore` may be used for simple setups. More complex ones may require a custom implementation. During migration you may also use the `BridgePskStore` in order to use old implementations for that period.
`DtlsConnectorConfig.Builder`	`setReceiverThreadCount(int threadCount)` Set the number of thread which should be used to receive datagrams from the socket.
`DtlsConnectorConfig.Builder`	`setRecommendedCipherSuitesOnly(boolean recommendedCipherSuitesOnly)` Set usage of recommended cipher suites.
`DtlsConnectorConfig.Builder`	`setRecommendedSupportedGroupsOnly(boolean recommendedSupportedGroupsOnly)` Set usage of recommended supported groups (curves).
`DtlsConnectorConfig.Builder`	`setRecordSizeLimit(Integer recordSizeLimit)` Sets record size limit.
`DtlsConnectorConfig.Builder`	`setRetransmissionTimeout(int timeout)` Sets the (starting) time to wait before a handshake package gets re-transmitted.
`DtlsConnectorConfig.Builder`	`setRpkTrustAll()` Deprecated. use `setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier)` instead. `StaticNewAdvancedCertificateVerifier` may be used for simple setups. More complex ones may require a custom implementation. During migration you may also use the `BridgeCertificateVerifier` in order to use old implementations for that period.
`DtlsConnectorConfig.Builder`	`setRpkTrustStore(TrustedRpkStore store)` Deprecated. use `setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier)` instead. `StaticNewAdvancedCertificateVerifier` may be used for simple setups. More complex ones may require a custom implementation. During migration you may also use the `BridgeCertificateVerifier` in order to use old implementations for that period.
`DtlsConnectorConfig.Builder`	`setServerOnly(boolean enable)` Indicates that the DTLSConnector will only act as server.
`DtlsConnectorConfig.Builder`	`setSniEnabled(boolean flag)` Sets whether the connector should support the use of the TLS Server Name Indication extension in the DTLS handshake.
`DtlsConnectorConfig.Builder`	`setSocketReceiveBufferSize(Integer size)` Set the size of the socket receive buffer.
`DtlsConnectorConfig.Builder`	`setSocketSendBufferSize(Integer size)` Set the size of the socket send buffer.
`DtlsConnectorConfig.Builder`	`setStaleConnectionThreshold(long threshold)` Sets the maximum number of seconds without any data being exchanged before a connection is considered stale.
`DtlsConnectorConfig.Builder`	`setSupportedCipherSuites(CipherSuite... cipherSuites)` Sets the cipher suites supported by the connector.
`DtlsConnectorConfig.Builder`	`setSupportedCipherSuites(List<CipherSuite> cipherSuites)` Sets the cipher suites supported by the connector.
`DtlsConnectorConfig.Builder`	`setSupportedCipherSuites(String... cipherSuites)` Sets the cipher suites supported by the connector.
`DtlsConnectorConfig.Builder`	`setSupportedGroups(List<XECDHECryptography.SupportedGroup> supportedGroups)` Sets the groups (curves) supported by the connector.
`DtlsConnectorConfig.Builder`	`setSupportedGroups(String... supportedGroups)` Sets the groups (curves) supported by the connector.
`DtlsConnectorConfig.Builder`	`setSupportedGroups(XECDHECryptography.SupportedGroup... supportedGroups)` Sets the groups (curves) supported by the connector.
`DtlsConnectorConfig.Builder`	`setSupportedSignatureAlgorithms(List<SignatureAndHashAlgorithm> supportedSignatureAlgorithms)` Sets the signature algorithms supported by the connector.
`DtlsConnectorConfig.Builder`	`setSupportedSignatureAlgorithms(SignatureAndHashAlgorithm... supportedSignatureAlgorithms)` Sets the signature algorithms supported by the connector.
`DtlsConnectorConfig.Builder`	`setSupportedSignatureAlgorithms(String... supportedSignatureAlgorithms)` Sets the signature algorithms supported by the connector.
`DtlsConnectorConfig.Builder`	`setTrustCertificateTypes(CertificateType... certificateTypes)` Sets the certificate types for the trust of the other peer.
`DtlsConnectorConfig.Builder`	`setTrustStore(Certificate[] trustedCerts)` Deprecated. use `setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier)` instead. `StaticNewAdvancedCertificateVerifier` may be used for simple setups. More complex ones may require a custom implementation. During migration you may also use the `BridgeCertificateVerifier` in order to use old implementations for that period.
`DtlsConnectorConfig.Builder`	`setUseAntiReplayFilter(boolean enable)` Use anti replay filter.
`DtlsConnectorConfig.Builder`	`setUseExtendedWindowFilter(int level)` Use extended window filter.
`DtlsConnectorConfig.Builder`	`setUseHandshakeStateValidation(boolean enable)` Use the handshake state validation to verify valid handshakes.
`DtlsConnectorConfig.Builder`	`setUseTruncatedCertificatePathForClientsCertificateMessage(boolean enable)` Use truncated certificate paths for client's certificate message.
`DtlsConnectorConfig.Builder`	`setUseTruncatedCertificatePathForValidation(boolean enable)` Use truncated certificate paths for validation.
`DtlsConnectorConfig.Builder`	`setUseWindowFilter(boolean enable)` Deprecated. use `setUseExtendedWindowFilter(int)` with `-1`, instead.
`DtlsConnectorConfig.Builder`	`setVerifyPeersOnResumptionThreshold(int threshold)` Sets threshold in percent of `setMaxConnections(int)`, whether a HELLO_VERIFY_REQUEST should be used also for session resumption.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DtlsConnectorConfig.Builder
```
public DtlsConnectorConfig.Builder()
```
    Creates a new instance for setting configuration options for a DTLSConnector instance. Once all options are set, clients should use the build() method to create an immutable DtlsConfigurationConfig instance which can be passed into the DTLSConnector constructor. The builder is initialized to the following default values
    - address: a wildcard address with a system chosen ephemeral port see InetSocketAddress.InetSocketAddress(int)
    - maxFragmentLength: 4096 bytes
    - maxPayloadSize: 4096 + 25 bytes (max fragment size + 25 bytes for headers)
    - maxRetransmissions: 4
    - retransmissionTimeout: 1000ms
    - clientAuthenticationRequired: true
    - outboundMessageBufferSize: 100.000
    - trustStore: empty array
    Note that when keeping the default values, at least one of the setPskStore(PskStore) or setIdentity(PrivateKey, PublicKey) methods need to be used to get a working configuration for a DTLSConnector that can be used as a client and server. It is possible to create a configuration for a DTLSConnector that can operate as a client only without the need for setting an identity. However, this is possible only if the server does not require clients to authenticate, i.e. this only works with the ECDH based cipher suites. If you want to create such a client-only configuration, you need to use the setClientOnly() method on the builder.
  - DtlsConnectorConfig.Builder
```
public DtlsConnectorConfig.Builder(DtlsConnectorConfig initialConfiguration)
```
    Create a builder from an existing DtlsConnectorConfig. This allow to create a new configuration starting from values of another one.
    
    Parameters:
    initialConfiguration - initial configuration
- Method Detail
  - setAddress
```
public DtlsConnectorConfig.Builder setAddress(InetSocketAddress address)
```
    Sets the IP address and port the connector should bind to Note: using IPv6 interfaces with multiple addresses including permanent and temporary (with potentially several different prefixes) currently causes issues on the server side. The outgoing traffic in response to incoming may select a different source address than the incoming destination address. To overcome this, please ensure that the 'any address' is not used on the server side and a separate Connector is created for each address to receive incoming traffic.
    
    Parameters:
    address - the IP address and port the connector should bind to
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalArgumentException - if the given address is unresolved
  - setEnableAddressReuse
```
public DtlsConnectorConfig.Builder setEnableAddressReuse(boolean enable)
```
    Enables address reuse for the socket.
    
    Parameters:
    enable - true if addresses should be reused.
    
    Returns:
    this builder for command chaining
  - setRecommendedCipherSuitesOnly
```
public DtlsConnectorConfig.Builder setRecommendedCipherSuitesOnly(boolean recommendedCipherSuitesOnly)
```
    Set usage of recommended cipher suites.
    
    Parameters:
    recommendedCipherSuitesOnly - true allow only recommended cipher suites, false, also allow not recommended cipher suites. Default value is true
    
    Returns:
    this builder for command chaining
  - setRecommendedSupportedGroupsOnly
```
public DtlsConnectorConfig.Builder setRecommendedSupportedGroupsOnly(boolean recommendedSupportedGroupsOnly)
```
    Set usage of recommended supported groups (curves).
    
    Parameters:
    recommendedSupportedGroupsOnly - true allow only recommended supported groups, false, also allow not recommended supported groups. Default value is true
    
    Returns:
    this builder for command chaining
    Since:
    
    2.3
  - setClientOnly
```
public DtlsConnectorConfig.Builder setClientOnly()
```
    Indicates that the DTLSConnector will only be used as a DTLS client. The build() method will allow creation of a configuration without any identity being set under the following conditions:
    - only support for ECDH based cipher suites is configured
    - this method has been invoked
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalStateException - if client only is in contradiction to server side configuration
  - setServerOnly
```
public DtlsConnectorConfig.Builder setServerOnly(boolean enable)
```
    Indicates that the DTLSConnector will only act as server. A server only accepts handshakes, it never starts them.
    
    Parameters:
    enable - true if the connector acts only as server.
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalStateException - if server only is enabled in contradiction to client side configuration
  - setDefaultHandshakeMode
```
public DtlsConnectorConfig.Builder setDefaultHandshakeMode(String defaultHandshakeMode)
```
    Set the DTLSConnector default handshake mode.
    
    Parameters:
    defaultHandshakeMode - DtlsEndpointContext.HANDSHAKE_MODE_AUTO or DtlsEndpointContext.HANDSHAKE_MODE_NONE
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalStateException - if configuration is server only and DtlsEndpointContext.HANDSHAKE_MODE_AUTO is provided
    
    IllegalArgumentException - if mode is neither DtlsEndpointContext.HANDSHAKE_MODE_AUTO nor DtlsEndpointContext.HANDSHAKE_MODE_NONE
    Since:
    
    2.1
  - setRecordSizeLimit
```
public DtlsConnectorConfig.Builder setRecordSizeLimit(Integer recordSizeLimit)
```
    Sets record size limit. Included in the CLIENT_HELLO and SERVER_HELLO to negotiate the record size limit.
    
    Parameters:
    recordSizeLimit - the record size limit, betwee 64 and 65535. Or null, if not used.
    
    Returns:
    this builder for command chaining
    Since:
    
    2.4
  - setMaxFragmentLengthCode
```
public DtlsConnectorConfig.Builder setMaxFragmentLengthCode(Integer lengthCode)
```
    Sets the maximum amount of payload data that can be received and processed by this connector in a single DTLS record.
    The value of this property is used to indicate to peers the Maximum Fragment Length as defined in RFC 6066, Section 4. It is also used to determine the amount of memory that will be allocated for receiving UDP datagrams sent by peers from the network interface.
    The code must be either null or one of the following:
    - 1 - 2^9 bytes
    - 2 - 2^10 bytes
    - 3 - 2^11 bytes
    - 4 - 2^12 bytes
    If this property is set to null, the DTLSConnector will derive its value from the network interface's Maximum Transmission Unit. This means that it will set it to a value small enough to make sure that inbound messages fit into a UDP datagram having a size less or equal to the MTU.
    Parameters:
    lengthCode - the code indicating the maximum length or null to determine the maximum fragment length based on the network interface's MTU
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalArgumentException - if the code is not one of {1, 2, 3, 4}
  - setMaxFragmentedHandshakeMessageLength
```
public DtlsConnectorConfig.Builder setMaxFragmentedHandshakeMessageLength(Integer length)
```
    Set maximum length of handshake message.
    
    Parameters:
    length - maximum length of handshake message
    
    Returns:
    this builder for command chaining
  - setEnableMultiRecordMessages
```
public DtlsConnectorConfig.Builder setEnableMultiRecordMessages(boolean enable)
```
    Enable to use UDP messages with multiple dtls records.
    
    Parameters:
    enable - true, to enabled, false, otherwise.
    
    Returns:
    this builder for command chaining
    Since:
    
    2.4
  - setEnableMultiHandshakeMessageRecords
```
public DtlsConnectorConfig.Builder setEnableMultiHandshakeMessageRecords(boolean enable)
```
    Enable to use dtls records with multiple handshake messages.
    
    Parameters:
    enable - true, to enabled, false, otherwise.
    
    Returns:
    this builder for command chaining
    Since:
    
    2.4
  - setProtocolVersionForHelloVerifyRequests
```
public DtlsConnectorConfig.Builder setProtocolVersionForHelloVerifyRequests(ProtocolVersion protocolVersion)
```
    Set the protocol version to be used to send hello verify requests. Before version 2.5.0, Californium used fixed the protocol version DTLS 1.2 to send the HelloVerifyRequest. According RFC 6347, 4.2.1. Denial-of-Service Countermeasures, that HelloVerifyRequest SHOULD be sent using protocol version DTLS 1.0. But that found to be ambiguous, because it's also requested that "The server MUST use the same version number in the HelloVerifyRequest that it would use when sending a ServerHello." With that, Californium from 2.6.0 on will, by default, reply the version the client sent in the HelloVerifyRequest, and will postpone the version negotiation until the client has verified it's endpoint ownership. If that client version is below DTLS 1.0, a DTLS 1.0 will be used. If a different behavior is wanted, you may use this setter to provide a fixed version for the HelloVerifyRequest. In order to provide backwards compatibility to version before 2.5.0 , configure to use protocol version DTLS 1.2.
    
    Parameters:
    protocolVersion - fixed protocol version to send hello verify requests. null to reply the client's version.
    
    Returns:
    this builder for command chaining
    Since:
    
    2.5
    
    See Also:
    HelloVerifyRequest
  - setSocketReceiveBufferSize
```
public DtlsConnectorConfig.Builder setSocketReceiveBufferSize(Integer size)
```
    Set the size of the socket receive buffer.
    
    Parameters:
    size - the socket receive buffer size in bytes, or null, to use the OS default.
    
    Returns:
    this builder for command chaining
  - setSocketSendBufferSize
```
public DtlsConnectorConfig.Builder setSocketSendBufferSize(Integer size)
```
    Set the size of the socket send buffer.
    
    Parameters:
    size - the socket send buffer size in bytes, or null, to use the OS default.
    
    Returns:
    this builder for command chaining
  - setHealthStatusInterval
```
public DtlsConnectorConfig.Builder setHealthStatusInterval(Integer healthStatusIntervalSeconds)
```
    Set the health status interval.
    
    Parameters:
    healthStatusIntervalSeconds - health status interval in seconds. null disable health status.
    
    Returns:
    this builder for command chaining
  - setHealthHandler
```
public DtlsConnectorConfig.Builder setHealthHandler(DtlsHealth healthHandler)
```
    Set the health handler.
    
    Parameters:
    healthHandler - health handler.
    
    Returns:
    this builder for command chaining
  - setOutboundMessageBufferSize
```
public DtlsConnectorConfig.Builder setOutboundMessageBufferSize(int capacity)
```
    Sets the number of outbound messages that can be buffered in memory before dropping messages.
    
    Parameters:
    capacity - the number of messages to buffer
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalArgumentException - if capacity < 1
  - setBackOffRetransmission
```
public DtlsConnectorConfig.Builder setBackOffRetransmission(Integer count)
```
    Number of retransmissions before the attempt to transmit a flight in back-off mode. RFC 6347, Section 4.1.1.1, Page 12 In back-off mode, UDP datagrams of maximum 512 bytes are used. Each handshake message is placed in one dtls record, or more dtls records, if the handshake message is too large and must be fragmented. Beside of the CCS and FINISH dtls records, which send together in one UDP datagram, all other records are send in separate datagrams. The DtlsConnectorConfig.useMultiHandshakeMessageRecords() and DtlsConnectorConfig.useMultiRecordMessages() has precedence over the back-off definition. Value 0, to disable it, null, for default of DtlsConnectorConfig.maxRetransmissions / 2.
    
    Parameters:
    count - the number of re-transmissions to use the back-off mode
    
    Returns:
    this builder for command chaining
    Since:
    
    2.4
  - setMaxRetransmissions
```
public DtlsConnectorConfig.Builder setMaxRetransmissions(int count)
```
    Sets the maximum number of times a flight of handshake messages gets re-transmitted to a peer.
    
    Parameters:
    count - the maximum number of re-transmissions
    
    Returns:
    this builder for command chaining
  - setMaxTransmissionUnit
```
public DtlsConnectorConfig.Builder setMaxTransmissionUnit(int mtu)
```
    Set maximum transmission unit. Maximum number of bytes sent in one transmission.
    
    Parameters:
    mtu - maximum transmission unit
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalArgumentException - if setMaxTransmissionUnitLimit(int) was already set
  - setMaxTransmissionUnitLimit
```
public DtlsConnectorConfig.Builder setMaxTransmissionUnitLimit(int limit)
```
    Set maximum transmission unit limit for auto detection. Limits maximum number of bytes sent in one transmission. Note: previous versions toke the local link MTU without limits. That results in possibly larger MTU, e.g. for localhost or some cloud nodes using "jumbo frames". If a larger MTU is required, please adjsut this limit to the requires value or use setMaxTransmissionUnit(int).
    
    Parameters:
    limit - maximum transmission unit limit. Default DtlsConnectorConfig.DEFAULT_MAX_TRANSMISSION_UNIT_LIMIT
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalArgumentException - if setMaxTransmissionUnit(int) was already set
    Since:
    
    2.3
  - setClientAuthenticationWanted
```
public DtlsConnectorConfig.Builder setClientAuthenticationWanted(boolean authWanted)
```
    Sets whether the connector wants (requests) DTLS clients to authenticate during the handshake. The handshake doesn't fail, if the client didn't authenticate itself during the handshake. That mostly requires the client to use a proprietary mechanism to authenticate itself on the application layer (e.g. username/password). It's mainly used, if the implementation of the other peer has no PSK cipher suite and client certificate should not be used for some reason. The default is false. Only used by the DTLS server side.
    
    Parameters:
    authWanted - true if clients wanted to authenticate
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalStateException - if configuration is for client only
    
    IllegalArgumentException - if authWanted is true, but setClientAuthenticationRequired(boolean) was set to true before.
  - setClientAuthenticationRequired
```
public DtlsConnectorConfig.Builder setClientAuthenticationRequired(boolean authRequired)
```
    Sets whether the connector requires DTLS clients to authenticate during the handshake. The default is true. If setClientAuthenticationWanted(boolean) is set to true, the default is false. Only used by the DTLS server side.
    
    Parameters:
    authRequired - true if clients need to authenticate
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalStateException - if configuration is for client only
    
    IllegalArgumentException - if authWanted is true, but setClientAuthenticationWanted(boolean) was set to true before.
  - setCipherSuiteSelector
```
public DtlsConnectorConfig.Builder setCipherSuiteSelector(CipherSuiteSelector cipherSuiteSelector)
```
    Sets the cipher suite selector.
    The connector will use these selector to determine the cipher suite and parameters during the handshake.
    
    Parameters:
    cipherSuiteSelector - the cipher suite selector. Default (DefaultCipherSuiteSelector.
    
    Returns:
    this builder for command chaining
    Since:
    
    2.3
  - setPreselectedCipherSuites
```
public DtlsConnectorConfig.Builder setPreselectedCipherSuites(CipherSuite... cipherSuites)
```
    Sets the preselected cipher suites for the connector. If no supported cipher suites are provided, consider only this subset of CipherSuite to be automatically selected as supported cipher suites depending on other setting (e.g. if settings allow only PSK, only PSK compatible cipher suite from this list will be selected). Not used, if supported cipher suites are provided.
    
    Parameters:
    cipherSuites - the preselected cipher suites
    
    Returns:
    this builder for command chaining
    Since:
    
    2.5
  - setPreselectedCipherSuites
```
public DtlsConnectorConfig.Builder setPreselectedCipherSuites(List<CipherSuite> cipherSuites)
```
    Sets the preselected cipher suites for the connector. If no supported cipher suites are provided, consider only this subset of CipherSuite to be automatically selected as supported cipher suites depending on other setting (e.g. if settings allow only PSK, only PSK compatible cipher suite from this list will be selected). Not used, if supported cipher suites are provided.
    
    Parameters:
    cipherSuites - the preselected cipher suites
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalArgumentException - if the list is empty, or "TLS_NULL_WITH_NULL_NULL" is contained.
    Since:
    
    2.5
  - setPreselectedCipherSuites
```
public DtlsConnectorConfig.Builder setPreselectedCipherSuites(String... cipherSuites)
```
    Sets the preselected cipher suites for the connector. If no supported cipher suites are provided, consider only this subset of CipherSuite to be automatically selected as supported cipher suites depending on other setting (e.g. if settings allow only PSK, only PSK compatible cipher suite from this list will be selected). Not used, if supported cipher suites are provided.
    
    Parameters:
    cipherSuites - the names of the preselected cipher suites
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalArgumentException - if at least one name is not available, or "TLS_NULL_WITH_NULL_NULL" is contained.
    Since:
    
    2.5
  - setSupportedCipherSuites
```
public DtlsConnectorConfig.Builder setSupportedCipherSuites(CipherSuite... cipherSuites)
```
    Sets the cipher suites supported by the connector.
    The connector will use these cipher suites (in exactly the same order) during the DTLS handshake when negotiating a cipher suite with a peer.
    
    Parameters:
    cipherSuites - the supported cipher suites in the order of preference
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given array is null
    
    IllegalArgumentException - if the given array is empty, contains CipherSuite.TLS_NULL_WITH_NULL_NULL, contains a cipher suite, not supported by the JVM, or violates the setRecommendedCipherSuitesOnly(boolean) setting.
  - setSupportedCipherSuites
```
public DtlsConnectorConfig.Builder setSupportedCipherSuites(List<CipherSuite> cipherSuites)
```
    Sets the cipher suites supported by the connector.
    The connector will use these cipher suites (in exactly the same order) during the DTLS handshake when negotiating a cipher suite with a peer.
    
    Parameters:
    cipherSuites - the supported cipher suites in the order of preference
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given list is null
    
    IllegalArgumentException - if the given list is empty, contains CipherSuite.TLS_NULL_WITH_NULL_NULL, contains a cipher suite, not supported by the JVM, or violates the setRecommendedCipherSuitesOnly(boolean) setting.
  - setSupportedCipherSuites
```
public DtlsConnectorConfig.Builder setSupportedCipherSuites(String... cipherSuites)
```
    Sets the cipher suites supported by the connector.
    The connector will use these cipher suites (in exactly the same order) during the DTLS handshake when negotiating a cipher suite with a peer.
    
    Parameters:
    cipherSuites - the names of supported cipher suites in the order of preference (see IANA registry for a list of cipher suite names)
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given array is null
    
    IllegalArgumentException - if the given array is empty, contains CipherSuite.TLS_NULL_WITH_NULL_NULL, contains a cipher suite, not supported by the JVM, contains a name, which is not supported, or violates the setRecommendedCipherSuitesOnly(boolean) setting.
  - setSupportedSignatureAlgorithms
```
public DtlsConnectorConfig.Builder setSupportedSignatureAlgorithms(SignatureAndHashAlgorithm... supportedSignatureAlgorithms)
```
    Sets the signature algorithms supported by the connector.
    The connector will use these signature algorithms (in exactly the same order) during the DTLS handshake.
    
    Parameters:
    supportedSignatureAlgorithms - the supported signature algorithms in the order of preference. No arguments, if no specific extension is to be used for a client, and the server uses SignatureAndHashAlgorithm.DEFAULT.
    
    Returns:
    this builder for command chaining
    Since:
    
    2.3
  - setSupportedSignatureAlgorithms
```
public DtlsConnectorConfig.Builder setSupportedSignatureAlgorithms(List<SignatureAndHashAlgorithm> supportedSignatureAlgorithms)
```
    Sets the signature algorithms supported by the connector.
    The connector will use these signature algorithms (in exactly the same order) during the DTLS handshake.
    
    Parameters:
    supportedSignatureAlgorithms - the list of supported signature algorithms in the order of preference. Empty, if no specific extension is to be used for a client, and the server uses SignatureAndHashAlgorithm.DEFAULT.
    
    Returns:
    this builder for command chaining
    Since:
    
    2.3
  - setSupportedSignatureAlgorithms
```
public DtlsConnectorConfig.Builder setSupportedSignatureAlgorithms(String... supportedSignatureAlgorithms)
```
    Sets the signature algorithms supported by the connector.
    The connector will use these signature algorithms (in exactly the same order) during the DTLS handshake.
    
    Parameters:
    supportedSignatureAlgorithms - the list of supported signature algorithm names in the order of preference. Empty, if no specific extension is to be used for a client, and the server uses SignatureAndHashAlgorithm.DEFAULT.
    
    Returns:
    this builder for command chaining
    Since:
    
    2.3
    
    See Also:
    SignatureAndHashAlgorithm.valueOf(String)
  - setSupportedGroups
```
public DtlsConnectorConfig.Builder setSupportedGroups(XECDHECryptography.SupportedGroup... supportedGroups)
```
    Sets the groups (curves) supported by the connector.
    The connector will use these supported groups (in exactly the same order) during the DTLS handshake when negotiating a curve with a peer. According RFC 8422, 5.1. Client Hello Extensions, Actions of the receiver This affects both, curves for ECDH and the certificates for ECDSA.
    
    Parameters:
    supportedGroups - the supported groups (curves) in the order of preference
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given array is null
    
    IllegalArgumentException - if the given array is empty, contains a group (curve), not supported by the JVM, or violates the setRecommendedCipherSuitesOnly(boolean) setting.
    Since:
    
    2.3
  - setSupportedGroups
```
public DtlsConnectorConfig.Builder setSupportedGroups(List<XECDHECryptography.SupportedGroup> supportedGroups)
```
    Sets the groups (curves) supported by the connector.
    The connector will use these supported groups (in exactly the same order) during the DTLS handshake when negotiating a curve with a peer. According RFC 8422, 5.1. Client Hello Extensions, Actions of the receiver This affects both, curves for ECDH and the certificates for ECDSA.
    
    Parameters:
    supportedGroups - the supported groups (curves) in the order of preference
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given list is null
    
    IllegalArgumentException - if the given list is empty, contains a group (curve), not supported by the JVM, or violates the setRecommendedCipherSuitesOnly(boolean) setting.
    Since:
    
    2.3
  - setSupportedGroups
```
public DtlsConnectorConfig.Builder setSupportedGroups(String... supportedGroups)
```
    Sets the groups (curves) supported by the connector.
    The connector will use these supported groups (in exactly the same order) during the DTLS handshake when negotiating a curve with a peer. According RFC 8422, 5.1. Client Hello Extensions, Actions of the receiver This affects both, curves for ECDH and the certificates for ECDSA.
    
    Parameters:
    supportedGroups - the names of supported groups (curves) in the order of preference (see IANA registry for a list of supported group names)
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given array is null
    
    IllegalArgumentException - if the given array is empty, contains a group (curve), not supported by the JVM, or violates the setRecommendedCipherSuitesOnly(boolean) setting.
    Since:
    
    2.3
  - setEarlyStopRetransmission
```
public DtlsConnectorConfig.Builder setEarlyStopRetransmission(boolean activate)
```
    Activate/Deactivate experimental feature: Stop retransmission at first received handshake message.
    
    Parameters:
    activate - Set it to true if retransmissions should be stopped as soon as we receive a handshake message
    
    Returns:
    this builder for command chaining
  - setRetransmissionTimeout
```
public DtlsConnectorConfig.Builder setRetransmissionTimeout(int timeout)
```
    Sets the (starting) time to wait before a handshake package gets re-transmitted. On each retransmission, the time is doubled.
    
    Parameters:
    timeout - the time in milliseconds
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalArgumentException - if the given timeout is negative
  - setPskStore
```
@Deprecated
public DtlsConnectorConfig.Builder setPskStore(PskStore pskStore)
```
    Deprecated. use setAdvancedPskStore(AdvancedPskStore) instead. AdvancedSinglePskStore and AdvancedMultiPskStore may be used for simple setups. More complex ones may require a custom implementation. During migration you may also use the BridgePskStore in order to use old implementations for that period.
    
    Sets the key store to use for authenticating clients based on a pre-shared key. If used together with setIdentity(PrivateKey, PublicKey) or setIdentity(PrivateKey, Certificate[], CertificateType...) the default preference uses the certificate based cipher suites. To change that, use setSupportedCipherSuites(CipherSuite...) or setSupportedCipherSuites(String...). Also set the advanced PSK store using AdvancedInMemoryPskStore.
    
    Parameters:
    pskStore - the key store
    
    Returns:
    this builder for command chaining
  - setAdvancedPskStore
```
public DtlsConnectorConfig.Builder setAdvancedPskStore(AdvancedPskStore advancedPskStore)
```
    Sets the advanced key store to use for authenticating clients based on a pre-shared key. If used together with setIdentity(PrivateKey, PublicKey) or setIdentity(PrivateKey, Certificate[], CertificateType...) the default preference uses the certificate based cipher suites. To change that, use setSupportedCipherSuites(CipherSuite...) or setSupportedCipherSuites(String...). Resets setPskStore(PskStore) to null.
    
    Parameters:
    advancedPskStore - the advanced key store
    
    Returns:
    this builder for command chaining
    Since:
    
    2.3
  - setIdentity
```
public DtlsConnectorConfig.Builder setIdentity(PrivateKey privateKey,
                                      PublicKey publicKey)
```
    Sets the connector's identifying properties by means of a private and public key pair.
    Using this method implies that the connector only supports RawPublicKey mode for authenticating to a peer. Please ensure, that you setup setRpkTrustStore(TrustedRpkStore), or setRpkTrustAll(), if you want to trust the other peer using RAW_PUBLIC_KEY also. If X_509 is intended to be supported together with RAW_PUBLIC_KEY, please use setIdentity(PrivateKey, Certificate[], CertificateType...) instead and provide RAW_PUBLIC_KEY together with X_509 in the wanted preference order. If used together with setPskStore(PskStore), the default preference uses this certificate based cipher suites. To change that, use setSupportedCipherSuites(CipherSuite...) or setSupportedCipherSuites(String...).
    
    Parameters:
    privateKey - the private key used for creating signatures
    publicKey - the public key a peer can use to verify possession of the private key
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if any of the given keys is null
    See Also:
    setRpkTrustAll(), setRpkTrustStore(TrustedRpkStore)
  - setIdentity
```
public DtlsConnectorConfig.Builder setIdentity(PrivateKey privateKey,
                                      Certificate[] certificateChain,
                                      CertificateType... certificateTypes)
```
    Sets the connector's identifying properties by means of a private key and a corresponding issuer certificates chain.
    In server mode the key and certificates are used to prove the server's identity to the client. In client mode the key and certificates are used to prove the client's identity to the server. Please ensure, that you setup either setCertificateVerifier(CertificateVerifier), setTrustStore(Certificate[]), setRpkTrustAll(), setRpkTrustStore(TrustedRpkStore), if you want to trust the other peer also using certificates. If used together with setPskStore(PskStore), the default preference uses this certificate based cipher suites. To change that, use setSupportedCipherSuites(CipherSuite...) or setSupportedCipherSuites(String...).
    
    Parameters:
    privateKey - the private key used for creating signatures
    certificateChain - the chain of X.509 certificates asserting the private key subject's identity. The endpoint's certificate must be at position 0, the certificate signed by a trusted CA must be at the highest position. A self-signed top-level certificate will be removed for outgoing CertificateMessage. If used for a client side CertificateMessage, the chain will be truncated to the first certificate of one of the received certificate authorities.
    certificateTypes - list of certificate types in the order of preference. Default is X_509. To support RAW_PUBLIC_KEY also, use X_509 and RAW_PUBLIC_KEY in the order of the preference. If only RAW_PUBLIC_KEY is used, the certificate chain will be set to null.
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given private key or certificate chain is null
    
    IllegalArgumentException - if the certificate chain does not contain any certificates, or contains a non-X.509 certificate
    See Also:
    setTrustStore(Certificate[]), setCertificateVerifier(CertificateVerifier), setRpkTrustAll(), setRpkTrustStore(TrustedRpkStore)
  - setIdentity
```
public DtlsConnectorConfig.Builder setIdentity(PrivateKey privateKey,
                                      Certificate[] certificateChain,
                                      List<CertificateType> certificateTypes)
```
    Sets the connector's identifying properties by means of a private key and a corresponding issuer certificates chain.
    In server mode the key and certificates are used to prove the server's identity to the client. In client mode the key and certificates are used to prove the client's identity to the server. Please ensure, that you setup either setCertificateVerifier(CertificateVerifier), setTrustStore(Certificate[]), setRpkTrustAll(), setRpkTrustStore(TrustedRpkStore), if you want to trust the other peer also using certificates. If used together with setPskStore(PskStore), the default preference uses this certificate based cipher suites. To change that, use setSupportedCipherSuites(CipherSuite...) or setSupportedCipherSuites(String...).
    
    Parameters:
    privateKey - the private key used for creating signatures
    certificateChain - the chain of X.509 certificates asserting the private key subject's identity. The endpoint's certificate must be at position 0, the certificate signed by a trusted CA must be at the highest position. A self-signed top-level certificate will be removed for outgoing CertificateMessage. If used for a client side CertificateMessage, the chain will be truncated to the first certificate of one of the received certificate authorities.
    certificateTypes - list of certificate types in the order of preference. Default is X_509. To support RAW_PUBLIC_KEY also, use X_509 and RAW_PUBLIC_KEY in the order of the preference. If only RAW_PUBLIC_KEY is used, the certificate chain will be set to null.
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given private key or certificate chain is null
    
    IllegalArgumentException - if the certificate chain does not contain any certificates, or contains a non-X.509 certificate. Or the provide certificateTypes is empty.
    See Also:
    setTrustStore(Certificate[]), setCertificateVerifier(CertificateVerifier), setRpkTrustAll(), setRpkTrustStore(TrustedRpkStore)
  - setTrustStore
```
@Deprecated
public DtlsConnectorConfig.Builder setTrustStore(Certificate[] trustedCerts)
```
    Deprecated. use setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier) instead. StaticNewAdvancedCertificateVerifier may be used for simple setups. More complex ones may require a custom implementation. During migration you may also use the BridgeCertificateVerifier in order to use old implementations for that period.
    Sets the root certificates the connector should use:
    - as the trust anchor when verifying a peer's identity based on an X.509 certificate chain. This is default behavior, which can be overridden when passing a custom CertificateVerifier to this builder.
    - as the list of certificate authorities when the server is requesting a client certificate during the DTLS handshake.
    When a RFC5250 compliant verification is required, use only self-signed top-level certificates as root certificates. Using intermediate CA certificates may fail, if the other peer send a certificate chain, which doesn't end at one of the provided CAs. trustedCerts MUST NOT contain several certificates with same subject. If you need that you should consider to use setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier) instead. This method must not be called, if setCertificateVerifier(CertificateVerifier) or setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier) is already set. Note: since 2.5 supports null to reset the trusted certificates in order to use specific NewAdvancedCertificateVerifier instead of the default implementation.
    Parameters:
    trustedCerts - the trusted root certificates. If empty (length of zero), trust all valid certificate chains without limiting the trust to specific trust anchors. If null, reset trusted certificates.
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    IllegalArgumentException - if the array contains a non-X.509 certificate or several certificates with same subjects
    
    IllegalStateException - if setCertificateVerifier(CertificateVerifier) or setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier) is already set.
    See Also:
    setTrustCertificateTypes(org.eclipse.californium.scandium.dtls.CertificateType...)
  - setCertificateVerifier
```
@Deprecated
public DtlsConnectorConfig.Builder setCertificateVerifier(CertificateVerifier verifier)
```
    Deprecated. use setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier) instead. StaticNewAdvancedCertificateVerifier may be used for simple setups. More complex ones may require a custom implementation. During migration you may also use the BridgeCertificateVerifier in order to use old implementations for that period.
    Sets the logic in charge of validating a X.509 certificate chain. Here are a few use cases where a custom implementation would be needed:
    - client certificate authentication based on a dynamic trusted CA
    - revocation not provided by the default implementation (e.g. OCSP)
    - cipher suites restriction per client
    This method must not be called, if setTrustStore(Certificate[]) is already set.
    Parameters:
    verifier - certificate verifier
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given certificate verifier is null
    
    IllegalStateException - if setTrustStore(Certificate[]) or setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier) is already set.
    See Also:
    setTrustCertificateTypes(org.eclipse.californium.scandium.dtls.CertificateType...)
  - setAdvancedCertificateVerifier
```
public DtlsConnectorConfig.Builder setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier verifier)
```
    Sets the logic in charge of validating a X.509 certificate chain. Here are a few use cases where a custom implementation would be needed:
    - client certificate authentication based on a dynamic trusted CA
    - revocation not provided by the default implementation (e.g. OCSP)
    - cipher suites restriction per client
    This method must not be called, if setTrustStore(Certificate[]) is already set.
    Parameters:
    verifier - new advanced certificate verifier
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given certificate verifier is null
    
    IllegalStateException - if setTrustStore(Certificate[]) is already set.
    Since:
    
    2.5
    
    See Also:
    setTrustCertificateTypes(org.eclipse.californium.scandium.dtls.CertificateType...)
  - setApplicationLevelInfoSupplier
```
public DtlsConnectorConfig.Builder setApplicationLevelInfoSupplier(ApplicationLevelInfoSupplier supplier)
```
    Sets a supplier of application level information for an authenticated peer's identity.
    
    Parameters:
    supplier - The supplier.
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    NullPointerException - if supplier is null.
  - setRpkTrustStore
```
@Deprecated
public DtlsConnectorConfig.Builder setRpkTrustStore(TrustedRpkStore store)
```
    Deprecated. use setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier) instead. StaticNewAdvancedCertificateVerifier may be used for simple setups. More complex ones may require a custom implementation. During migration you may also use the BridgeCertificateVerifier in order to use old implementations for that period.
    
    Sets the store for trusted raw public keys.
    
    Parameters:
    store - the raw public keys trust store
    
    Returns:
    this builder for command chaining
    See Also:
    setTrustCertificateTypes(org.eclipse.californium.scandium.dtls.CertificateType...)
  - setRpkTrustAll
```
@Deprecated
public DtlsConnectorConfig.Builder setRpkTrustAll()
```
    Deprecated. use setAdvancedCertificateVerifier(NewAdvancedCertificateVerifier) instead. StaticNewAdvancedCertificateVerifier may be used for simple setups. More complex ones may require a custom implementation. During migration you may also use the BridgeCertificateVerifier in order to use old implementations for that period.
    
    Sets the store for trusted raw public key to trust all public keys.
    
    Returns:
    this builder for command chaining
  - setTrustCertificateTypes
```
public DtlsConnectorConfig.Builder setTrustCertificateTypes(CertificateType... certificateTypes)
```
    Sets the certificate types for the trust of the other peer. In the order of preference. If trusted certificates are provided with one of the setter below, the certificate type are adjusted in the order RAW_PUBLIC_KEY and X_509. This setter could be used to change that order. If a certificate type is included in this list, but the related trusted certificates are not provided, build() will throw a IllegalStateException.
    
    Parameters:
    certificateTypes - certificate types in order of preference
    
    Returns:
    this builder for command chaining
    
    Throws:
    
    NullPointerException - if the given certificate types is null
    
    IllegalArgumentException - if the certificate types are empty
    See Also:
    setRpkTrustAll(), setRpkTrustStore(TrustedRpkStore), setCertificateVerifier(CertificateVerifier), setTrustStore(Certificate[])
  - setMaxDeferredProcessedOutgoingApplicationDataMessages
```
public DtlsConnectorConfig.Builder setMaxDeferredProcessedOutgoingApplicationDataMessages(int maxDeferredProcessedOutgoingApplicationDataMessages)
```
    Set maximum number of deferred processed outgoing application data messages. Application data messages sent during a handshake may be dropped or processed deferred after the handshake. Set this to limit the maximum number of messages, which are intended to be processed deferred. If more messages are sent, these messages are dropped.
    
    Parameters:
    maxDeferredProcessedOutgoingApplicationDataMessages - maximum number of deferred processed messages
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    IllegalArgumentException - if the given limit is < 0.
  - setMaxDeferredProcessedIncomingRecordsSize
```
public DtlsConnectorConfig.Builder setMaxDeferredProcessedIncomingRecordsSize(int maxDeferredProcessedIncomingRecordsSize)
```
    Set maximum size of deferred processed incoming records. Handshake records with future handshake message sequence number or records with future epochs received during a handshake may be dropped or processed deferred. Set this to limit the maximum size of all records, which are intended to be processed deferred. If more records are received, these records are dropped.
    
    Parameters:
    maxDeferredProcessedIncomingRecordsSize - maximum size of all deferred handshake records
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    IllegalArgumentException - if the given limit is < 0.
  - setMaxConnections
```
public DtlsConnectorConfig.Builder setMaxConnections(int maxConnections)
```
    Sets the maximum number of active connections the connector should support.
    An active connection is a connection that has been used within the last staleConnectionThreshold seconds. After that it is considered to be stale.
    Once the maximum number of active connections is reached, new connections will only be accepted by the connector, if stale connections exist (which will be evicted one-by-one on an oldest-first basis).
    The default value of this property is DtlsConnectorConfig.DEFAULT_MAX_CONNECTIONS.
    
    Parameters:
    maxConnections - The maximum number of active connections to support.
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    IllegalArgumentException - if the given limit is < 1.
    See Also:
    setStaleConnectionThreshold(long)
  - setStaleConnectionThreshold
```
public DtlsConnectorConfig.Builder setStaleConnectionThreshold(long threshold)
```
    Sets the maximum number of seconds without any data being exchanged before a connection is considered stale.
    Once a connection becomes stale, it is eligible for eviction when a peer wants to establish a new connection and the connector already has maxConnections connections with peers established. Note that a connection is no longer considered stale, once data is being exchanged over it before it got evicted.
    
    Parameters:
    threshold - The number of seconds.
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    IllegalArgumentException - if the given threshold is < 1.
    See Also:
    setMaxConnections(int)
  - setConnectionIdGenerator
```
public DtlsConnectorConfig.Builder setConnectionIdGenerator(ConnectionIdGenerator connectionIdGenerator)
```
    Sets the connection id generator.
    
    Parameters:
    connectionIdGenerator - connection id generator. null for not supported. The generator may only support the use of a connection id without using it by itself. In that case ConnectionIdGenerator.useConnectionId() must return false.
    
    Returns:
    this builder for command chaining.
  - setConnectionThreadCount
```
public DtlsConnectorConfig.Builder setConnectionThreadCount(int threadCount)
```
    Set the number of thread which should be used to handle DTLS connection.
    The default value is 6 * #(CPU cores).
    
    Parameters:
    threadCount - the number of threads.
    
    Returns:
    this builder for command chaining.
  - setReceiverThreadCount
```
public DtlsConnectorConfig.Builder setReceiverThreadCount(int threadCount)
```
    Set the number of thread which should be used to receive datagrams from the socket.
    The default value is half of #(CPU cores).
    
    Parameters:
    threadCount - the number of threads.
    
    Returns:
    this builder for command chaining.
  - setAutoResumptionTimeoutMillis
```
public DtlsConnectorConfig.Builder setAutoResumptionTimeoutMillis(Long timeoutInMillis)
```
    Set the timeout of automatic session resumption in milliseconds.
    The default value is null, for no automatic session resumption. The configured value may be overridden by the endpoint context attribute DtlsEndpointContext.KEY_RESUMPTION_TIMEOUT.
    
    Parameters:
    timeoutInMillis - the number of milliseconds. Usually values around 30000 milliseconds are useful, depending on the setup of NATS on the path. Smaller timeouts are only useful for unit test, they would trigger too many resumption handshakes.
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    IllegalArgumentException - if the timeout is below 1 millisecond
  - setSniEnabled
```
public DtlsConnectorConfig.Builder setSniEnabled(boolean flag)
```
    Sets whether the connector should support the use of the TLS Server Name Indication extension in the DTLS handshake.
    The default value of this property is null. If this property is not set explicitly, then the build() method will set it to true.
    
    Parameters:
    flag - true if SNI should be used.
    
    Returns:
    this builder for command chaining.
  - setVerifyPeersOnResumptionThreshold
```
public DtlsConnectorConfig.Builder setVerifyPeersOnResumptionThreshold(int threshold)
```
    Sets threshold in percent of setMaxConnections(int), whether a HELLO_VERIFY_REQUEST should be used also for session resumption. Note: a value larger than 0 will call SessionCache.get(org.eclipse.californium.scandium.dtls.SessionId). If that implementation is expensive, please ensure, that this value is configured with 0. Otherwise, CLIENT_HELLOs with invalid session ids may be spoofed and gets too expensive. Note: if spoofing is considered to be relevant for the used network environment, please set this to 0 in order to disable this function.
    
    Parameters:
    threshold - 0 := always use HELLO_VERIFY_REQUEST, 1 ... 100 := dynamically determine to use HELLO_VERIFY_REQUEST. Default is based on DtlsConnectorConfig.DEFAULT_VERIFY_PEERS_ON_RESUMPTION_THRESHOLD_IN_PERCENT
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    IllegalArgumentException - if threshold is not between 0 and 100
  - setNoServerSessionId
```
public DtlsConnectorConfig.Builder setNoServerSessionId(boolean flag)
```
    Set whether session id is used by this server or not.
    
    Parameters:
    flag - true if no session id is used by this server.
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    IllegalArgumentException - if no session id should be used and the configuration is for client only.
  - setUseAntiReplayFilter
```
public DtlsConnectorConfig.Builder setUseAntiReplayFilter(boolean enable)
```
    Use anti replay filter.
    
    Parameters:
    enable - true to enable filter. Default true.
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    IllegalArgumentException - if window filter is active.
    See Also:
    "http://tools.ietf.org/html/rfc6347#section-4.1"
  - setUseWindowFilter
```
@Deprecated
public DtlsConnectorConfig.Builder setUseWindowFilter(boolean enable)
```
    Deprecated. use setUseExtendedWindowFilter(int) with -1, instead.
    
    Use window filter. Messages too old for the filter window will pass the filter.
    
    Parameters:
    enable - true to enable filter. Default false.
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    IllegalArgumentException - if anti replay window filter is active.
    See Also:
    "http://tools.ietf.org/html/rfc6347#section-4.1"
  - setUseExtendedWindowFilter
```
public DtlsConnectorConfig.Builder setUseExtendedWindowFilter(int level)
```
    Use extended window filter. The value will be subtracted from to lower receive window boundary. A value of -1 will set that calculated value to 0. Messages between lower receive window boundary and that calculated value will pass the filter, for other messages the filter is applied.
    
    Parameters:
    level - value to extend lower receive window boundary, 0 to disable the extended lower boundary. For backwards compatibility use -1, to extend the lower boundary down to 0, Default 0 for disabled.
    
    Returns:
    this builder for command chaining.
    
    Throws:
    
    IllegalArgumentException - if anti replay window filter is active.
    Since:
    
    2.4
    
    See Also:
    "http://tools.ietf.org/html/rfc6347#section-4.1"
  - setCidUpdateAddressOnNewerRecordFilter
```
public DtlsConnectorConfig.Builder setCidUpdateAddressOnNewerRecordFilter(boolean enable)
```
    Use filter to update the ip-address from DTLS 1.2 CID records only for newer records based on epoch/sequence_number. Only used, if a connection ID generator setConnectionIdGenerator(ConnectionIdGenerator) is provided, which "uses" CID. If the "anti-replay-filter is switched off, it's not recommended to switch this off also!
    
    Parameters:
    enable - true to enable filter, false to disable filter. Default true.
    
    Returns:
    this builder for command chaining.
  - setUseHandshakeStateValidation
```
public DtlsConnectorConfig.Builder setUseHandshakeStateValidation(boolean enable)
```
    Use the handshake state validation to verify valid handshakes. Note: the handshake state validation is used by default. If a client can't process a handshake in the assumed way, the state validation may be disabled at the risk of potential more vulnerability. Please report us a capture of such handshakes in order to decide, if the state validation gets adapted.
    
    Parameters:
    enable - true to enable state machine. Default true.
    
    Returns:
    this builder for command chaining.
  - setKeyUsageVerification
```
public DtlsConnectorConfig.Builder setKeyUsageVerification(boolean enable)
```
    Use key usage verification for x509.
    
    Parameters:
    enable - true to verify the key usage of x509 certificates. Default true.
    
    Returns:
    this builder for command chaining.
    Since:
    
    2.1
  - setUseTruncatedCertificatePathForClientsCertificateMessage
```
public DtlsConnectorConfig.Builder setUseTruncatedCertificatePathForClientsCertificateMessage(boolean enable)
```
    Use truncated certificate paths for client's certificate message. Truncate certificate path according the received certificate authorities in the CertificateRequest for the client's CertificateMessage.
    
    Parameters:
    enable - true to truncate the certificate path according the received certificate authorities. Default true.
    
    Returns:
    this builder for command chaining.
    Since:
    
    2.1
  - setUseTruncatedCertificatePathForValidation
```
public DtlsConnectorConfig.Builder setUseTruncatedCertificatePathForValidation(boolean enable)
```
    Use truncated certificate paths for validation. Truncate certificate path according the available trusted certificates before validation.
    
    Parameters:
    enable - true to truncate the certificate path according the available trusted certificates. Default true.
    
    Returns:
    this builder for command chaining.
    Since:
    
    2.1
  - setLoggingTag
```
public DtlsConnectorConfig.Builder setLoggingTag(String tag)
```
    Set instance logging tag.
    
    Parameters:
    tag - logging tag of configure instance
    
    Returns:
    this builder for command chaining.
  - setConnectionListener
```
public DtlsConnectorConfig.Builder setConnectionListener(ConnectionListener connectionListener)
```
  - getIncompleteConfig
```
public DtlsConnectorConfig 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 DtlsConnectorConfig build()
```
    Creates an instance of DtlsConnectorConfig based on the properties set on this builder.
    If the supportedCipherSuites property has not been set, the builder tries to derive a reasonable set of cipher suites from the pskStore and identity properties as follows:
    1. If only the pskStore is set: {TLS_PSK_WITH_AES_128_CCM_8, TLS_PSK_WITH_AES_128_CBC_SHA256}
    2. If only the identity is set: {TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256}
    3. If both the pskStore and the identity are set: {TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_PSK_WITH_AES_128_CCM_8, TLS_PSK_WITH_AES_128_CBC_SHA256}
    Returns:
    the configuration object
    
    Throws:
    
    IllegalStateException - if the configuration is inconsistent

Class DtlsConnectorConfig.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DtlsConnectorConfig.Builder

DtlsConnectorConfig.Builder

Method Detail

setAddress

setEnableAddressReuse

setRecommendedCipherSuitesOnly

setRecommendedSupportedGroupsOnly

setClientOnly

setServerOnly

setDefaultHandshakeMode

setRecordSizeLimit

setMaxFragmentLengthCode

setMaxFragmentedHandshakeMessageLength

setEnableMultiRecordMessages

setEnableMultiHandshakeMessageRecords

setProtocolVersionForHelloVerifyRequests

setSocketReceiveBufferSize

setSocketSendBufferSize

setHealthStatusInterval

setHealthHandler

setOutboundMessageBufferSize

setBackOffRetransmission

setMaxRetransmissions

setMaxTransmissionUnit

setMaxTransmissionUnitLimit

setClientAuthenticationWanted

setClientAuthenticationRequired

setCipherSuiteSelector

setPreselectedCipherSuites

setPreselectedCipherSuites

setPreselectedCipherSuites

setSupportedCipherSuites

setSupportedCipherSuites

setSupportedCipherSuites

setSupportedSignatureAlgorithms

setSupportedSignatureAlgorithms

setSupportedSignatureAlgorithms

setSupportedGroups

setSupportedGroups

setSupportedGroups

setEarlyStopRetransmission

setRetransmissionTimeout

setPskStore

setAdvancedPskStore

setIdentity

setIdentity

setIdentity

setTrustStore

setCertificateVerifier

setAdvancedCertificateVerifier

setApplicationLevelInfoSupplier

setRpkTrustStore

setRpkTrustAll

setTrustCertificateTypes

setMaxDeferredProcessedOutgoingApplicationDataMessages

setMaxDeferredProcessedIncomingRecordsSize

setMaxConnections

setStaleConnectionThreshold

setConnectionIdGenerator

setConnectionThreadCount

setReceiverThreadCount

setAutoResumptionTimeoutMillis

setSniEnabled

setVerifyPeersOnResumptionThreshold

setNoServerSessionId

setUseAntiReplayFilter

setUseWindowFilter

setUseExtendedWindowFilter

setCidUpdateAddressOnNewerRecordFilter

setUseHandshakeStateValidation

setKeyUsageVerification

setUseTruncatedCertificatePathForClientsCertificateMessage

setUseTruncatedCertificatePathForValidation

setLoggingTag

setConnectionListener