TransportParameter (transport 0.4.0 API)

java.lang.Object
- de.iip_ecosphere.platform.transport.connectors.TransportParameter

```
public class TransportParameter
extends Object
```
Captures common transport parameter for all connector types. Connectors shall document which of the optional settings are required.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TransportParameter.CloseAction` Automatic connector closing actions.
`static class`	`TransportParameter.TransportParameterBuilder` A builder for transport parameter.

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`actionTimeout`
`private String`	`applicationId`
`private String`	`authenticationKey`
`private boolean`	`autoApplicationId`
`private TransportParameter.CloseAction`	`closeAction`
`private String`	`host`
`private boolean`	`hostnameVerification`
`private int`	`keepAlive`
`private String`	`keyAlias`
`private String`	`keyPassword`
`private File`	`keystore`
`private String`	`password`
`private int`	`port`
`private MqttQoS`	`qos`
`private String`	`user`

Constructor Summary

Constructors
Modifier Constructor and Description

private TransportParameter(String host, int port)
Creates a transport parameter instance.

Constructors
Modifier	Constructor and Description
`private`	`TransportParameter(String host, int port)` Creates a transport parameter instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getActionTimeout()` Returns the timeout for individual send/receive actions.
`String`	`getApplicationId()` Returns the unique application/client identifier.
`String`	`getAuthenticationKey()` Returns the `IdentityStore` key for the authentication, usually a password token.
`boolean`	`getAutoApplicationId()` Returns whether the application identification is expected to be unique or shall be made unique upon first connect.
`TransportParameter.CloseAction`	`getCloseAction()` Returns the close action.
`String`	`getHost()` Returns the network name of the host.
`boolean`	`getHostnameVerification()` Returns whether TLS hostname verification shall be performed.
`int`	`getKeepAlive()` Returns the time to keep a connection alive.
`String`	`getKeyAlias()` Returns the alias of the key in `getKeystore()` to use.
`File`	`getKeystore()` Returns the optional TLS keystore.
`String`	`getKeystorePassword()` Returns the password for the optional TLS keystore.
`MqttQoS`	`getMqttQoS()` Returns the MQTT QoS level (may not apply to other protocols).
`String`	`getPassword()` Deprecated. #22, use `getAuthenticationKey()` instead
`int`	`getPort()` Returns the TCP communication port of the host.
`String`	`getUser()` Deprecated. #22, use `getAuthenticationKey()` instead

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

- Field Detail
  - host
```
private String host
```
  - port
```
private int port
```
  - actionTimeout
```
private int actionTimeout
```
  - applicationId
```
private String applicationId
```
  - autoApplicationId
```
private boolean autoApplicationId
```
  - keepAlive
```
private int keepAlive
```
  - keystore
```
private File keystore
```
  - keyPassword
```
private String keyPassword
```
  - keyAlias
```
private String keyAlias
```
  - hostnameVerification
```
private boolean hostnameVerification
```
  - authenticationKey
```
private String authenticationKey
```
  - user
```
private String user
```
  - password
```
private String password
```
  - qos
```
private MqttQoS qos
```
  - closeAction
```
private TransportParameter.CloseAction closeAction
```
- Constructor Detail
  - TransportParameter
```
private TransportParameter(String host,
                           int port)
```
    Creates a transport parameter instance.
    
    Parameters:
    
    host - the network name of the host
    
    port - the TCP communication port of the host
- Method Detail
  - getHost
```
public String getHost()
```
    Returns the network name of the host.
    
    Returns:
    
    the name
  - getPort
```
public int getPort()
```
    Returns the TCP communication port of the host.
    
    Returns:
    
    the port
  - getActionTimeout
```
public int getActionTimeout()
```
    Returns the timeout for individual send/receive actions.
    
    Returns:
    
    the timeout in milliseconds
  - getKeepAlive
```
public int getKeepAlive()
```
    Returns the time to keep a connection alive.
    
    Returns:
    
    the time in milliseconds
  - getApplicationId
```
public String getApplicationId()
```
    Returns the unique application/client identifier.
    
    Returns:
    
    the unique application/client identifier
  - getAutoApplicationId
```
public boolean getAutoApplicationId()
```
    Returns whether the application identification is expected to be unique or shall be made unique upon first connect. May be ignored if not applicable.
    
    Returns:
    
    true (default) for make unique, false else
  - getPassword
```
public String getPassword()
```
    Deprecated. #22, use getAuthenticationKey() instead
    
    Returns the password. [preliminary]
    
    Returns:
    
    the password (may be null, to be ignored then)
  - getUser
```
public String getUser()
```
    Deprecated. #22, use getAuthenticationKey() instead
    
    Returns the user name. [preliminary]
    
    Returns:
    
    the user name (may be null, to be ignored then)
  - getKeystore
```
public File getKeystore()
```
    Returns the optional TLS keystore.
    
    Returns:
    
    the TLS keystore (suffix ".jks" points to Java Key store, suffix ".p12" to PKCS12 keystore), may be null for none
  - getKeystorePassword
```
public String getKeystorePassword()
```
    Returns the password for the optional TLS keystore.
    
    Returns:
    
    the TLS keystore password, 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
  - getKeyAlias
```
public String getKeyAlias()
```
    Returns the alias of the key in getKeystore() to use.
    
    Returns:
    
    the alias or null for none/first match
  - getAuthenticationKey
```
public String getAuthenticationKey()
```
    Returns the IdentityStore key for the authentication, usually a password token.
    
    Returns:
    
    the identity store key, may be empty or null
  - getHostnameVerification
```
public boolean getHostnameVerification()
```
    Returns whether TLS hostname verification shall be performed.
    
    Returns:
    
    false for no verification (default), true else
  - getMqttQoS
```
public MqttQoS getMqttQoS()
```
    Returns the MQTT QoS level (may not apply to other protocols).
    
    Returns:
    
    the QoS level
  - getCloseAction
```
public TransportParameter.CloseAction getCloseAction()
```
    Returns the close action.
    
    Returns:
    
    the close action (default is TransportParameter.CloseAction.UNSUBSCRIBE)

Class TransportParameter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

host

port

actionTimeout

applicationId

autoApplicationId

keepAlive

keystore

keyPassword

keyAlias

hostnameVerification

authenticationKey

user

password

qos

closeAction

Constructor Detail

TransportParameter

Method Detail

getHost

getPort

getActionTimeout

getKeepAlive

getApplicationId

getAutoApplicationId

getPassword

getUser

getKeystore

getKeystorePassword

getKeyAlias

getAuthenticationKey

getHostnameVerification

getMqttQoS

getCloseAction