Package org.summerboot.jexpress.integration.mqtt

Class MqttClientConfig

java.lang.Object

org.summerboot.jexpress.boot.config.BootConfig

org.summerboot.jexpress.integration.mqtt.MqttClientConfig

All Implemented Interfaces:

JExpressConfig

public abstract class MqttClientConfig
extends BootConfig

Author:

Changski Tie Zheng Zhang 张铁铮, 魏泽北, 杜旺财, 杜富贵

Nested Class Summary

Nested classes/interfaces inherited from class org.summerboot.jexpress.boot.config.BootConfig

BootConfig.ThreadingMode

Field Summary

Fields

Modifier and Type	Field	Description
protected String	clientId
protected int	defaultQoS
protected static final String	FILENAME_TRUSTSTORE_4CLIENT
protected static final String	ID
protected static final String	KEY_kmf_AliasKey
protected static final String	KEY_kmf_AliasPwdKey
protected static final String	KEY_kmf_key
protected static final String	KEY_kmf_StorePwdKey
protected static final String	KEY_tmf_key
protected static final String	KEY_tmf_StorePwdKey
protected KeyManagerFactory	kmf
protected String	password
protected String	serverURI
protected SocketFactory	socketFactory
protected String	sslProtocol
protected TrustManagerFactory	tmf
protected String	username
protected boolean	verifyHostname

Fields inherited from class org.summerboot.jexpress.boot.config.BootConfig

BR, cache, cfgFile, configName, CPU_CORE, DESC_KMF, DESC_PLAINPWD, DESC_TMF, FILENAME_KEYSTORE, FILENAME_SRC_TRUSTSTORE, generateTemplate, logger, props

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MqttClientConfig()

Method Summary

Modifier and Type	Method	Description
org.eclipse.paho.mqttv5.client.MqttAsyncClient	build()
org.eclipse.paho.mqttv5.client.MqttAsyncClient	build(org.eclipse.paho.mqttv5.client.MqttClientPersistence persistence, org.eclipse.paho.mqttv5.client.MqttPingSender pingSender, ScheduledExecutorService executorService)
org.eclipse.paho.mqttv5.client.MqttConnectionOptions	buildConnectionOptions()
org.eclipse.paho.mqttv5.client.MqttConnectionOptions	buildConnectionOptions(String username, String password)
org.eclipse.paho.mqttv5.client.MqttConnectionOptions	buildConnectionOptions(String username, String password, SocketFactory socketFactory)
protected void	generateTemplate_keystore(StringBuilder sb)
protected void	generateTemplate_truststore(StringBuilder sb)
String	getClientId()
int	getDefaultQoS()
KeyManagerFactory	getKmf()
String	getPassword()
String	getServerURI()
SocketFactory	getSocketFactory()
String	getSslProtocol()
TrustManagerFactory	getTmf()
String	getUsername()
boolean	isVerifyHostname()
protected void	loadCustomizedConfigs(File cfgFile, boolean isReal, ConfigUtil helper, Properties props)
static void	main(String[] args)
protected void	preLoad(File cfgFile, boolean isReal, ConfigUtil helper, Properties props)
void	shutdown()
void	shutdown(org.eclipse.paho.mqttv5.client.MqttAsyncClient asyncClient)

Methods inherited from class org.summerboot.jexpress.boot.config.BootConfig

buildThreadPoolExecutor, createIfNotExist, generateTemplate, getCfgFile, getLength, getProperties, info, instance, lineBreak, load, loadField, name, parse, registerSingleton, temp, updateConfigFile, updateFilePath

Methods inherited from class java.lang.Object

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

Field Details

FILENAME_TRUSTSTORE_4CLIENT

protected static final String FILENAME_TRUSTSTORE_4CLIENT

See Also:

• Constant Field Values

ID

protected static final String ID

See Also:

• Constant Field Values

serverURI

@ConfigHeader(title="1. MQTT.client server endpoint",
              desc="protocol: tcp/ssl/local/ws/wss",
              format="protocol://servername:port",
              example="ssl://localhost:8883")
@Config(key="MQTT.client.serverURI",
        predefinedValue="ssl://localhost:8883",
        required=true)
protected volatile String serverURI

sslProtocol

@Config(key="MQTT.client.ssl.Protocol",
        defaultValue="TLSv1.3")
protected String sslProtocol

KEY_kmf_key

protected static final String KEY_kmf_key

See Also:

• Constant Field Values

KEY_kmf_StorePwdKey

protected static final String KEY_kmf_StorePwdKey

See Also:

• Constant Field Values

KEY_kmf_AliasKey

protected static final String KEY_kmf_AliasKey

See Also:

• Constant Field Values

KEY_kmf_AliasPwdKey

protected static final String KEY_kmf_AliasPwdKey

See Also:

• Constant Field Values

kmf

@ConfigHeader(title="2. MQTT.client keystore")
@Config(key="MQTT.client.ssl.KeyStore",
        StorePwdKey="MQTT.client.ssl.KeyStorePwd",
        AliasKey="MQTT.client.ssl.KeyAlias",
        AliasPwdKey="MQTT.client.ssl.KeyPwd",
        desc="Path to key store file. Use SSL/TLS when keystore is provided, otherwise use plain socket",
        callbackMethodName4Dump="generateTemplate_keystore")
protected volatile KeyManagerFactory kmf

KEY_tmf_key

protected static final String KEY_tmf_key

See Also:

• Constant Field Values

KEY_tmf_StorePwdKey

protected static final String KEY_tmf_StorePwdKey

See Also:

• Constant Field Values

tmf

@ConfigHeader(title="3. MQTT.client truststore")
@Config(key="MQTT.client.ssl.TrustStore",
        StorePwdKey="MQTT.client.ssl.TrustStorePwd",
        callbackMethodName4Dump="generateTemplate_truststore",
        desc="Path to trust store file. Auth the remote peer certificate when a truststore is provided, otherwise blindly trust all remote peer certificate")
protected volatile TrustManagerFactory tmf

verifyHostname

@Config(key="MQTT.client.VerifyHostname",
        defaultValue="true")
protected volatile boolean verifyHostname

socketFactory

protected volatile SocketFactory socketFactory

clientId

@ConfigHeader(title="4. MQTT.client user credential")
@Config(key="MQTT.client.clientId")
protected volatile String clientId

username

@Config(key="MQTT.client.username")
protected volatile String username

password

@Config(key="MQTT.client.password",
        validate=Encrypted)
protected volatile String password

defaultQoS

@ConfigHeader(title="5. MQTT.client messaging")
@Config(key="MQTT.client.defaultQoS",
        defaultValue="2",
        desc="0=At most once, Fire-and-Forget (QoS 0), 1=At least once (QoS 1), 2=Exactly once (QoS 2)")
protected volatile int defaultQoS

Constructor Details

MqttClientConfig

protected MqttClientConfig()

Method Details

main

public static void main(String[] args)

generateTemplate_keystore

protected void generateTemplate_keystore(StringBuilder sb)

generateTemplate_truststore

protected void generateTemplate_truststore(StringBuilder sb)

preLoad

protected void preLoad(File cfgFile,
 boolean isReal,
 ConfigUtil helper,
 Properties props)

Overrides:

preLoad in class BootConfig

loadCustomizedConfigs

protected void loadCustomizedConfigs(File cfgFile,
 boolean isReal,
 ConfigUtil helper,
 Properties props)
                              throws Exception

Specified by:

loadCustomizedConfigs in class BootConfig

Throws:

Exception

shutdown

public void shutdown()

build

public org.eclipse.paho.mqttv5.client.MqttAsyncClient build()
                                                     throws org.eclipse.paho.mqttv5.common.MqttException

Throws:

org.eclipse.paho.mqttv5.common.MqttException

build

public org.eclipse.paho.mqttv5.client.MqttAsyncClient build(org.eclipse.paho.mqttv5.client.MqttClientPersistence persistence,
 org.eclipse.paho.mqttv5.client.MqttPingSender pingSender,
 ScheduledExecutorService executorService)
                                                     throws org.eclipse.paho.mqttv5.common.MqttException

Throws:

org.eclipse.paho.mqttv5.common.MqttException

buildConnectionOptions

public org.eclipse.paho.mqttv5.client.MqttConnectionOptions buildConnectionOptions()

buildConnectionOptions

public org.eclipse.paho.mqttv5.client.MqttConnectionOptions buildConnectionOptions(String username,
 String password)

buildConnectionOptions

public org.eclipse.paho.mqttv5.client.MqttConnectionOptions buildConnectionOptions(String username,
 String password,
 SocketFactory socketFactory)

shutdown

public void shutdown(org.eclipse.paho.mqttv5.client.MqttAsyncClient asyncClient)
              throws org.eclipse.paho.mqttv5.common.MqttException

Throws:

org.eclipse.paho.mqttv5.common.MqttException

getServerURI

public String getServerURI()

getSslProtocol

public String getSslProtocol()

getKmf

public KeyManagerFactory getKmf()

getTmf

public TrustManagerFactory getTmf()

isVerifyHostname

public boolean isVerifyHostname()

getSocketFactory

public SocketFactory getSocketFactory()

getClientId

public String getClientId()

getUsername

public String getUsername()

getPassword

public String getPassword()

getDefaultQoS

public int getDefaultQoS()