TransportSetup (transport 0.4.0 API)

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

All Implemented Interfaces:

Serializable
```
public class TransportSetup
extends Object
implements Serializable
```
Implements a reusable class to read transport setup information and to turn the information into transport parameters.

Author:

Holger Eichelberger, SSE

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`authenticationKey`
`private String`	`host`
`private boolean`	`hostnameVerification`
`private String`	`keyAlias`
`private String`	`keyPassword`
`private File`	`keystore`
`private String`	`password`
`private int`	`port`
`private static long`	`serialVersionUID`
`private String`	`user`

Constructor Summary

Constructors
Constructor and Description

TransportSetup()

Constructors
Constructor and Description
`TransportSetup()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TransportSetup`	`copy()` Copies this setup into a new instance.
`TransportParameter`	`createParameter()` Derives a transport parameter instance.
`String`	`getAuthenticationKey()` Returns the `IdentityStore` key for the authentication, usually a password token.
`String`	`getHost()` Returns the server/broker host name.
`boolean`	`getHostnameVerification()` Returns whether TLS hostname verification shall be performed.
`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.
`String`	`getPassword()` Returns the password.
`int`	`getPort()` Returns the server/broker port number.
`String`	`getUser()` Returns the user name.
`void`	`setAuthenticationKey(String authenticationKey)` Returns the `IdentityStore` key for the authentication, usually a password token.
`void`	`setHost(String host)` Defines the server/broker host name.
`void`	`setHostnameVerification(boolean hostnameVerification)` Returns whether TLS hostname verification shall be performed.
`void`	`setKeyAlias(String keyAlias)` Returns the alias of the key in `getKeystore()` to use.
`void`	`setKeystore(File keystore)` Returns the optional TLS keystore.
`void`	`setKeystorePassword(String keyPassword)` Returns the password for the optional TLS keystore.
`void`	`setPassword(String password)` Deprecated. #22, use `setAuthenticationKey(String)` instead
`void`	`setPort(int port)` Defines the server/broker port number.
`void`	`setUser(String user)` 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
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - host
```
private String host
```
  - port
```
private int port
```
  - keystore
```
private File keystore
```
  - keyPassword
```
private String keyPassword
```
  - keyAlias
```
private String keyAlias
```
  - hostnameVerification
```
private boolean hostnameVerification
```
  - authenticationKey
```
private String authenticationKey
```
  - password
```
private String password
```
  - user
```
private String user
```
- Constructor Detail
  - TransportSetup
```
public TransportSetup()
```
- Method Detail
  - getHost
```
public String getHost()
```
    Returns the server/broker host name.
    
    Returns:
    
    the server/broker host name.
  - getPort
```
public int getPort()
```
    Returns the server/broker port number.
    
    Returns:
    
    the server/broker port
  - getPassword
```
public String getPassword()
```
    Returns the password.
    
    Returns:
    
    the password (may be null, to be ignored then)
  - getUser
```
public String getUser()
```
    Returns the user name.
    
    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
  - setHost
```
public void setHost(String host)
```
    Defines the server/broker host name. [required by snakeyaml]
    
    Parameters:
    
    host - the server/broker host name.
  - setPort
```
public void setPort(int port)
```
    Defines the server/broker port number. [required by snakeyaml]
    
    Parameters:
    
    port - the server/broker port
  - setPassword
```
public void setPassword(String password)
```
    Deprecated. #22, use setAuthenticationKey(String) instead
    
    Defines the password. [required by snakeyaml]
    
    Parameters:
    
    password - the password
  - setUser
```
public void setUser(String user)
```
    Deprecated. #22, use setAuthenticationKey(String) instead
    
    Defines the user name. [required by snakeyaml]
    
    Parameters:
    
    user - the user name
  - setKeystore
```
public void setKeystore(File keystore)
```
    Returns the optional TLS keystore. [requred by SnakeYaml]
    
    Parameters:
    
    keystore - the TLS keystore (suffix ".jks" points to Java Key store, suffix ".p12" to PKCS12 keystore), may be null for none
  - setKeystorePassword
```
public void setKeystorePassword(String keyPassword)
```
    Returns the password for the optional TLS keystore. [requred by SnakeYaml]
    
    Parameters:
    
    keyPassword - 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
  - setKeyAlias
```
public void setKeyAlias(String keyAlias)
```
    Returns the alias of the key in getKeystore() to use. [requred by SnakeYaml]
    
    Parameters:
    
    keyAlias - the alias or null for none/first match
  - setAuthenticationKey
```
public void setAuthenticationKey(String authenticationKey)
```
    Returns the IdentityStore key for the authentication, usually a password token. [requred by SnakeYaml]
    
    Parameters:
    
    authenticationKey - the identity store key, may be empty or null
  - setHostnameVerification
```
public void setHostnameVerification(boolean hostnameVerification)
```
    Returns whether TLS hostname verification shall be performed. [requred by SnakeYaml]
    
    Parameters:
    
    hostnameVerification - false for no verification (default), true else
  - createParameter
```
public TransportParameter createParameter()
```
    Derives a transport parameter instance.
    
    Returns:
    
    the transport parameter instance
  - copy
```
public TransportSetup copy()
```
    Copies this setup into a new instance.
    
    Returns:
    
    the copied instance

Class TransportSetup

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

host

port

keystore

keyPassword

keyAlias

hostnameVerification

authenticationKey

password

user

Constructor Detail

TransportSetup

Method Detail

getHost

getPort

getPassword

getUser

getKeystore

getKeystorePassword

getKeyAlias

getAuthenticationKey

getHostnameVerification

setHost

setPort

setPassword

setUser

setKeystore

setKeystorePassword

setKeyAlias

setAuthenticationKey

setHostnameVerification

createParameter

copy