public class TransportSetup extends Object implements Serializable
| 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 and Description |
|---|
TransportSetup() |
| 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 |
private static final long serialVersionUID
private String host
private int port
private File keystore
private String keyPassword
private String keyAlias
private boolean hostnameVerification
private String authenticationKey
private String password
private String user
public String getHost()
public int getPort()
public String getPassword()
public String getUser()
public File getKeystore()
public String getKeystorePassword()
IdentityStore to obtain a password token before using it as a plaintext password as
fallbackpublic String getKeyAlias()
getKeystore() to use.public String getAuthenticationKey()
IdentityStore key for the authentication, usually a password token.public boolean getHostnameVerification()
false for no verification (default), true elsepublic void setHost(String host)
host - the server/broker host name.public void setPort(int port)
port - the server/broker portpublic void setPassword(String password)
setAuthenticationKey(String) insteadpassword - the passwordpublic void setUser(String user)
setAuthenticationKey(String) insteaduser - the user namepublic void setKeystore(File keystore)
keystore - the TLS keystore (suffix ".jks" points to Java Key store, suffix ".p12" to PKCS12 keystore), may
be null for nonepublic void setKeystorePassword(String keyPassword)
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 fallbackpublic void setKeyAlias(String keyAlias)
getKeystore() to use. [requred by SnakeYaml]keyAlias - the alias or null for none/first matchpublic void setAuthenticationKey(String authenticationKey)
IdentityStore key for the authentication, usually a password token. [requred by SnakeYaml]authenticationKey - the identity store key, may be empty or nullpublic void setHostnameVerification(boolean hostnameVerification)
hostnameVerification - false for no verification (default), true elsepublic TransportParameter createParameter()
public TransportSetup copy()
Copyright © 2022. All rights reserved.