de.iip_ecosphere.platform.transport.connectors

Class TransportParameter.TransportParameterBuilder

java.lang.Object

de.iip_ecosphere.platform.transport.connectors.TransportParameter.TransportParameterBuilder

Enclosing class:

TransportParameter

public static class TransportParameter.TransportParameterBuilder
extends Object

A builder for transport parameter. Connectors shall indicate the required settings.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field and Description
private TransportParameter	instance

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TransportParameterBuilder() Prevents external creation.

Method Summary

Modifier and Type	Method and Description
TransportParameter	build() Returns the created instance.
static TransportParameter.TransportParameterBuilder	newBuilder(de.iip_ecosphere.platform.support.ServerAddress addr) Creates a new builder.
static TransportParameter.TransportParameterBuilder	newBuilder(String host, int port) Creates a new builder.
TransportParameter.TransportParameterBuilder	setActionTimeout(int actionTimeout) Sets the action timeout.
TransportParameter.TransportParameterBuilder	setApplicationId(String applicationId) Defines the optional application id.
TransportParameter.TransportParameterBuilder	setAuthenticationKey(String authenticationKey) Defines the IdentityStore key for the authentication, usually a password token.
TransportParameter.TransportParameterBuilder	setAutoApplicationId(boolean autoApplicationId) Defines whether the application identification is expected to be unique or shall be made unique upon first connect.
TransportParameter.TransportParameterBuilder	setCloseAction(TransportParameter.CloseAction action) Defines the close action.
TransportParameter.TransportParameterBuilder	setHostnameVerification(boolean hostnameVerification) Defines whether TLS hostname verification shall be performed.
TransportParameter.TransportParameterBuilder	setKeepAlive(int keepAlive) Sets the keep alive time.
TransportParameter.TransportParameterBuilder	setKeyAlias(String alias) Sets up optional TLS key alias.
TransportParameter.TransportParameterBuilder	setKeystore(File keystore, String password) Sets up optional TLS encryption details.
TransportParameter.TransportParameterBuilder	setMqttQoS(MqttQoS qos) Defines the MQTT QoS level (may not apply to other protocols).
TransportParameter.TransportParameterBuilder	setUser(String user, String password) Deprecated. #22, use setAuthenticationKey(String) instead

Methods inherited from class java.lang.Object

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

Field Detail

instance

private TransportParameter instance

Constructor Detail

TransportParameterBuilder

private TransportParameterBuilder()

Prevents external creation.

Method Detail

newBuilder

public static TransportParameter.TransportParameterBuilder newBuilder(String host,
                                                                      int port)

Creates a new builder.

Parameters:

host - the network name of the host

port - the TCP communication port of the host

Returns:

the builder instance

newBuilder

public static TransportParameter.TransportParameterBuilder newBuilder(de.iip_ecosphere.platform.support.ServerAddress addr)

Creates a new builder.

Parameters:

addr - the server address (schema ignored)

Returns:

the builder instance

setApplicationId

public TransportParameter.TransportParameterBuilder setApplicationId(String applicationId)

Defines the optional application id. Optional, remains empty if unset.

Parameters:

applicationId - the client/application id

Returns:

this

setAutoApplicationId

public TransportParameter.TransportParameterBuilder setAutoApplicationId(boolean autoApplicationId)

Defines whether the application identification is expected to be unique or shall be made unique upon first connect. May be ignored if not applicable.

Parameters:

autoApplicationId - true (default) for make unique, false else

Returns:

this

setKeepAlive

public TransportParameter.TransportParameterBuilder setKeepAlive(int keepAlive)

Sets the keep alive time. Optional, remains 2000 if unset.

Parameters:

keepAlive - the time to keep a connection alive (heartbeat) in milliseconds

Returns:

this

setActionTimeout

public TransportParameter.TransportParameterBuilder setActionTimeout(int actionTimeout)

Sets the action timeout. Optional, remains 1000 if unset.

Parameters:

actionTimeout - the timeout in milliseconds for send/receive actions

Returns:

this

setUser

public TransportParameter.TransportParameterBuilder setUser(String user,
                                                            String password)

Deprecated. #22, use setAuthenticationKey(String) instead

Sets plain user information. Preliminary!!!

Parameters:

user - the user name

password - the password

Returns:

this

setKeystore

public TransportParameter.TransportParameterBuilder setKeystore(File keystore,
                                                                String password)

Sets up optional TLS encryption details.

Parameters:

keystore - the TLS keystore (suffix ".jks" points to Java Key store, suffix ".p12" to PKCS12 keystore), may be null for none; validity of the type of keystore may depend on the transport connector implementation, e.g., PKCS12 may not work with all forms

password - the TLS keystore, may be null for none; the transport connector shall try a resolution via the IdentityStore to obtain a password token before using it as a plaintext password as fallback

Returns:

this

setKeyAlias

public TransportParameter.TransportParameterBuilder setKeyAlias(String alias)

Sets up optional TLS key alias.

Parameters:

alias - key alias, may be null for none/first match

Returns:

this

setAuthenticationKey

public TransportParameter.TransportParameterBuilder setAuthenticationKey(String authenticationKey)

Defines the IdentityStore key for the authentication, usually a password token.

Parameters:

authenticationKey - the identity store key, may be empty or null

Returns:

this

setHostnameVerification

public TransportParameter.TransportParameterBuilder setHostnameVerification(boolean hostnameVerification)

Defines whether TLS hostname verification shall be performed.

Parameters:

hostnameVerification - false for no verification, true else

Returns:

this

setMqttQoS

public TransportParameter.TransportParameterBuilder setMqttQoS(MqttQoS qos)

Defines the MQTT QoS level (may not apply to other protocols).

Parameters:

qos - the QoS level (default is MqttQoS.AT_LEAST_ONCE

Returns:

this

setCloseAction

public TransportParameter.TransportParameterBuilder setCloseAction(TransportParameter.CloseAction action)

Defines the close action.

Parameters:

action - the action (default is TransportParameter.CloseAction.UNSUBSCRIBE)

Returns:

this

build

public TransportParameter build()

Returns the created instance.

Returns:

the created instance