Package 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	Description
private TransportParameter	instance

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TransportParameterBuilder()	Prevents external creation.

Method Summary

Modifier and Type	Method	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(TransportParameter params)	Creates a transport parameter builder from (a copy of) the given transport parameters.
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	setKeystoreKey(String keystoreKey)	Sets up the optional TLS keystore key to be obtained from IdentityStore.
TransportParameter.TransportParameterBuilder	setMqttQoS(MqttQoS qos)	Defines the MQTT QoS level (may not apply to other protocols).

Methods inherited from class java.lang.Object

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

Field Details

instance

private TransportParameter instance

Constructor Details

TransportParameterBuilder

private TransportParameterBuilder()

Prevents external creation.

Method Details

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

newBuilder

public static TransportParameter.TransportParameterBuilder newBuilder(TransportParameter params)

Creates a transport parameter builder from (a copy of) the given transport parameters.

Parameters:

params - the parameters to copy from

Returns:

the transport parameter builder

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

setKeystoreKey

public TransportParameter.TransportParameterBuilder setKeystoreKey(String keystoreKey)

Sets up the optional TLS keystore key to be obtained from IdentityStore.

Parameters:

keystoreKey - the (logical) key to access the keystore (null for none)

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