org.apache.camel.builder.endpoint.dsl

Interface PahoEndpointBuilderFactory.PahoEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder, PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Enclosing interface:

PahoEndpointBuilderFactory

public static interface PahoEndpointBuilderFactory.PahoEndpointBuilder
extends PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder, PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Builder for endpoint for the Paho component.

Method Summary

Modifier and Type	Method and Description
default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder	advanced()
default PahoEndpointBuilderFactory.PahoEndpointBuilder	automaticReconnect(boolean automaticReconnect) Sets whether the client will automatically attempt to reconnect to the server if the connection is lost.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	automaticReconnect(String automaticReconnect) Sets whether the client will automatically attempt to reconnect to the server if the connection is lost.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	brokerUrl(String brokerUrl) The URL of the MQTT broker.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	cleanSession(boolean cleanSession) Sets whether the client and server should remember state across restarts and reconnects.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	cleanSession(String cleanSession) Sets whether the client and server should remember state across restarts and reconnects.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	clientId(String clientId) MQTT client identifier.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	connectionTimeout(int connectionTimeout) Sets the connection timeout value.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	connectionTimeout(String connectionTimeout) Sets the connection timeout value.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	filePersistenceDirectory(String filePersistenceDirectory) Base directory used by file persistence.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	httpsHostnameVerificationEnabled(boolean httpsHostnameVerificationEnabled) Whether SSL HostnameVerifier is enabled or not.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	httpsHostnameVerificationEnabled(String httpsHostnameVerificationEnabled) Whether SSL HostnameVerifier is enabled or not.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	keepAliveInterval(int keepAliveInterval) Sets the keep alive interval.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	keepAliveInterval(String keepAliveInterval) Sets the keep alive interval.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	maxInflight(int maxInflight) Sets the max inflight.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	maxInflight(String maxInflight) Sets the max inflight.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	maxReconnectDelay(int maxReconnectDelay) Get the maximum time (in millis) to wait between reconnects.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	maxReconnectDelay(String maxReconnectDelay) Get the maximum time (in millis) to wait between reconnects.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	mqttVersion(int mqttVersion) Sets the MQTT version.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	mqttVersion(String mqttVersion) Sets the MQTT version.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	password(String password) Password to be used for authentication against the MQTT broker.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	persistence(PahoEndpointBuilderFactory.PahoPersistence persistence) Client persistence to be used - memory or file.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	persistence(String persistence) Client persistence to be used - memory or file.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	qos(int qos) Client quality of service level (0-2).
default PahoEndpointBuilderFactory.PahoEndpointBuilder	qos(String qos) Client quality of service level (0-2).
default PahoEndpointBuilderFactory.PahoEndpointBuilder	retained(boolean retained) Retain option.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	retained(String retained) Retain option.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	serverURIs(String serverURIs) Set a list of one or more serverURIs the client may connect to.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	socketFactory(Object socketFactory) Sets the SocketFactory to use.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	socketFactory(String socketFactory) Sets the SocketFactory to use.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	sslClientProps(Properties sslClientProps) Sets the SSL properties for the connection.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	sslClientProps(String sslClientProps) Sets the SSL properties for the connection.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	sslHostnameVerifier(Object sslHostnameVerifier) Sets the HostnameVerifier for the SSL connection.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	sslHostnameVerifier(String sslHostnameVerifier) Sets the HostnameVerifier for the SSL connection.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	userName(String userName) Username to be used for authentication against the MQTT broker.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	willPayload(String willPayload) Sets the Last Will and Testament (LWT) for the connection.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	willQos(int willQos) Sets the Last Will and Testament (LWT) for the connection.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	willQos(String willQos) Sets the Last Will and Testament (LWT) for the connection.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	willRetained(boolean willRetained) Sets the Last Will and Testament (LWT) for the connection.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	willRetained(String willRetained) Sets the Last Will and Testament (LWT) for the connection.
default PahoEndpointBuilderFactory.PahoEndpointBuilder	willTopic(String willTopic) Sets the Last Will and Testament (LWT) for the connection.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default PahoEndpointBuilderFactory.AdvancedPahoEndpointBuilder advanced()

Specified by:

advanced in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

advanced in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

automaticReconnect

default PahoEndpointBuilderFactory.PahoEndpointBuilder automaticReconnect(boolean automaticReconnect)

Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will double until it is at 2 minutes at which point the delay will stay at 2 minutes. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

automaticReconnect in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

automaticReconnect in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

automaticReconnect - the value to set

Returns:

the dsl builder

automaticReconnect

default PahoEndpointBuilderFactory.PahoEndpointBuilder automaticReconnect(String automaticReconnect)

Sets whether the client will automatically attempt to reconnect to the server if the connection is lost. If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost. If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will double until it is at 2 minutes at which point the delay will stay at 2 minutes. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

automaticReconnect in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

automaticReconnect in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

automaticReconnect - the value to set

Returns:

the dsl builder

brokerUrl

default PahoEndpointBuilderFactory.PahoEndpointBuilder brokerUrl(String brokerUrl)

The URL of the MQTT broker. The option is a: <code>java.lang.String</code> type. Default: tcp://localhost:1883 Group: common

Specified by:

brokerUrl in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

brokerUrl in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

brokerUrl - the value to set

Returns:

the dsl builder

cleanSession

default PahoEndpointBuilderFactory.PahoEndpointBuilder cleanSession(boolean cleanSession)

Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state across restarts of the client, the server or the connection. This means Message delivery to the specified QOS cannot be maintained if the client, server or connection are restarted The server will treat a subscription as non-durable. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

cleanSession in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

cleanSession in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

cleanSession - the value to set

Returns:

the dsl builder

cleanSession

default PahoEndpointBuilderFactory.PahoEndpointBuilder cleanSession(String cleanSession)

Sets whether the client and server should remember state across restarts and reconnects. If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained: Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted. The server will treat a subscription as durable. If set to true the client and server will not maintain state across restarts of the client, the server or the connection. This means Message delivery to the specified QOS cannot be maintained if the client, server or connection are restarted The server will treat a subscription as non-durable. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

cleanSession in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

cleanSession in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

cleanSession - the value to set

Returns:

the dsl builder

clientId

default PahoEndpointBuilderFactory.PahoEndpointBuilder clientId(String clientId)

MQTT client identifier. The identifier must be unique. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

clientId in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

clientId in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

clientId - the value to set

Returns:

the dsl builder

connectionTimeout

default PahoEndpointBuilderFactory.PahoEndpointBuilder connectionTimeout(int connectionTimeout)

Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails. The option is a: <code>int</code> type. Default: 30 Group: common

Specified by:

connectionTimeout in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

connectionTimeout in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

connectionTimeout - the value to set

Returns:

the dsl builder

connectionTimeout

default PahoEndpointBuilderFactory.PahoEndpointBuilder connectionTimeout(String connectionTimeout)

Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails. The option will be converted to a <code>int</code> type. Default: 30 Group: common

Specified by:

connectionTimeout in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

connectionTimeout in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

connectionTimeout - the value to set

Returns:

the dsl builder

filePersistenceDirectory

default PahoEndpointBuilderFactory.PahoEndpointBuilder filePersistenceDirectory(String filePersistenceDirectory)

Base directory used by file persistence. Will by default use user directory. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

filePersistenceDirectory in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

filePersistenceDirectory in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

filePersistenceDirectory - the value to set

Returns:

the dsl builder

keepAliveInterval

default PahoEndpointBuilderFactory.PahoEndpointBuilder keepAliveInterval(int keepAliveInterval)

Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping message, which the server will acknowledge. A value of 0 disables keepalive processing in the client. The default value is 60 seconds. The option is a: <code>int</code> type. Default: 60 Group: common

Specified by:

keepAliveInterval in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

keepAliveInterval in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

keepAliveInterval - the value to set

Returns:

the dsl builder

keepAliveInterval

default PahoEndpointBuilderFactory.PahoEndpointBuilder keepAliveInterval(String keepAliveInterval)

Sets the keep alive interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small ping message, which the server will acknowledge. A value of 0 disables keepalive processing in the client. The default value is 60 seconds. The option will be converted to a <code>int</code> type. Default: 60 Group: common

Specified by:

keepAliveInterval in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

keepAliveInterval in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

keepAliveInterval - the value to set

Returns:

the dsl builder

maxInflight

default PahoEndpointBuilderFactory.PahoEndpointBuilder maxInflight(int maxInflight)

Sets the max inflight. please increase this value in a high traffic environment. The default value is 10. The option is a: <code>int</code> type. Default: 10 Group: common

Specified by:

maxInflight in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

maxInflight in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

maxInflight - the value to set

Returns:

the dsl builder

maxInflight

default PahoEndpointBuilderFactory.PahoEndpointBuilder maxInflight(String maxInflight)

Sets the max inflight. please increase this value in a high traffic environment. The default value is 10. The option will be converted to a <code>int</code> type. Default: 10 Group: common

Specified by:

maxInflight in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

maxInflight in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

maxInflight - the value to set

Returns:

the dsl builder

maxReconnectDelay

default PahoEndpointBuilderFactory.PahoEndpointBuilder maxReconnectDelay(int maxReconnectDelay)

Get the maximum time (in millis) to wait between reconnects. The option is a: <code>int</code> type. Default: 128000 Group: common

Specified by:

maxReconnectDelay in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

maxReconnectDelay in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

maxReconnectDelay - the value to set

Returns:

the dsl builder

maxReconnectDelay

default PahoEndpointBuilderFactory.PahoEndpointBuilder maxReconnectDelay(String maxReconnectDelay)

Get the maximum time (in millis) to wait between reconnects. The option will be converted to a <code>int</code> type. Default: 128000 Group: common

Specified by:

maxReconnectDelay in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

maxReconnectDelay in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

maxReconnectDelay - the value to set

Returns:

the dsl builder

mqttVersion

default PahoEndpointBuilderFactory.PahoEndpointBuilder mqttVersion(int mqttVersion)

Sets the MQTT version. The default action is to connect with version 3.1.1, and to fall back to 3.1 if that fails. Version 3.1.1 or 3.1 can be selected specifically, with no fall back, by using the MQTT_VERSION_3_1_1 or MQTT_VERSION_3_1 options respectively. The option is a: <code>int</code> type. Group: common

Specified by:

mqttVersion in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

mqttVersion in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

mqttVersion - the value to set

Returns:

the dsl builder

mqttVersion

default PahoEndpointBuilderFactory.PahoEndpointBuilder mqttVersion(String mqttVersion)

Sets the MQTT version. The default action is to connect with version 3.1.1, and to fall back to 3.1 if that fails. Version 3.1.1 or 3.1 can be selected specifically, with no fall back, by using the MQTT_VERSION_3_1_1 or MQTT_VERSION_3_1 options respectively. The option will be converted to a <code>int</code> type. Group: common

Specified by:

mqttVersion in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

mqttVersion in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

mqttVersion - the value to set

Returns:

the dsl builder

persistence

default PahoEndpointBuilderFactory.PahoEndpointBuilder persistence(PahoEndpointBuilderFactory.PahoPersistence persistence)

Client persistence to be used - memory or file. The option is a: <code>org.apache.camel.component.paho.PahoPersistence</code> type. Default: MEMORY Group: common

Specified by:

persistence in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

persistence in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

persistence - the value to set

Returns:

the dsl builder

persistence

default PahoEndpointBuilderFactory.PahoEndpointBuilder persistence(String persistence)

Client persistence to be used - memory or file. The option will be converted to a <code>org.apache.camel.component.paho.PahoPersistence</code> type. Default: MEMORY Group: common

Specified by:

persistence in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

persistence in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

persistence - the value to set

Returns:

the dsl builder

qos

default PahoEndpointBuilderFactory.PahoEndpointBuilder qos(int qos)

Client quality of service level (0-2). The option is a: <code>int</code> type. Default: 2 Group: common

Specified by:

qos in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

qos in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

qos - the value to set

Returns:

the dsl builder

qos

default PahoEndpointBuilderFactory.PahoEndpointBuilder qos(String qos)

Client quality of service level (0-2). The option will be converted to a <code>int</code> type. Default: 2 Group: common

Specified by:

qos in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

qos in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

qos - the value to set

Returns:

the dsl builder

retained

default PahoEndpointBuilderFactory.PahoEndpointBuilder retained(boolean retained)

Retain option. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

retained in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

retained in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

retained - the value to set

Returns:

the dsl builder

retained

default PahoEndpointBuilderFactory.PahoEndpointBuilder retained(String retained)

Retain option. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

retained in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

retained in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

retained - the value to set

Returns:

the dsl builder

serverURIs

default PahoEndpointBuilderFactory.PahoEndpointBuilder serverURIs(String serverURIs)

Set a list of one or more serverURIs the client may connect to. Multiple servers can be separated by comma. Each serverURI specifies the address of a server that the client may connect to. Two types of connection are supported tcp:// for a TCP connection and ssl:// for a TCP connection secured by SSL/TLS. For example: tcp://localhost:1883 ssl://localhost:8883 If the port is not specified, it will default to 1883 for tcp:// URIs, and 8883 for ssl:// URIs. If serverURIs is set then it overrides the serverURI parameter passed in on the constructor of the MQTT client. When an attempt to connect is initiated the client will start with the first serverURI in the list and work through the list until a connection is established with a server. If a connection cannot be made to any of the servers then the connect attempt fails. Specifying a list of servers that a client may connect to has several uses: High Availability and reliable message delivery Some MQTT servers support a high availability feature where two or more equal MQTT servers share state. An MQTT client can connect to any of the equal servers and be assured that messages are reliably delivered and durable subscriptions are maintained no matter which server the client connects to. The cleansession flag must be set to false if durable subscriptions and/or reliable message delivery is required. Hunt List A set of servers may be specified that are not equal (as in the high availability option). As no state is shared across the servers reliable message delivery and durable subscriptions are not valid. The cleansession flag must be set to true if the hunt list mode is used. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

serverURIs in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

serverURIs in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

serverURIs - the value to set

Returns:

the dsl builder

willPayload

default PahoEndpointBuilderFactory.PahoEndpointBuilder willPayload(String willPayload)

Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

willPayload in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

willPayload in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

willPayload - the value to set

Returns:

the dsl builder

willQos

default PahoEndpointBuilderFactory.PahoEndpointBuilder willQos(int willQos)

Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. The option is a: <code>int</code> type. Group: common

Specified by:

willQos in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

willQos in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

willQos - the value to set

Returns:

the dsl builder

willQos

default PahoEndpointBuilderFactory.PahoEndpointBuilder willQos(String willQos)

Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. The option will be converted to a <code>int</code> type. Group: common

Specified by:

willQos in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

willQos in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

willQos - the value to set

Returns:

the dsl builder

willRetained

default PahoEndpointBuilderFactory.PahoEndpointBuilder willRetained(boolean willRetained)

Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

willRetained in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

willRetained in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

willRetained - the value to set

Returns:

the dsl builder

willRetained

default PahoEndpointBuilderFactory.PahoEndpointBuilder willRetained(String willRetained)

Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

willRetained in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

willRetained in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

willRetained - the value to set

Returns:

the dsl builder

willTopic

default PahoEndpointBuilderFactory.PahoEndpointBuilder willTopic(String willTopic)

Sets the Last Will and Testament (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details. The topic to publish to The byte payload for the message. The quality of service to publish the message at (0, 1 or 2). Whether or not the message should be retained. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

willTopic in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

willTopic in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

willTopic - the value to set

Returns:

the dsl builder

httpsHostnameVerificationEnabled

default PahoEndpointBuilderFactory.PahoEndpointBuilder httpsHostnameVerificationEnabled(boolean httpsHostnameVerificationEnabled)

Whether SSL HostnameVerifier is enabled or not. The default value is true. The option is a: <code>boolean</code> type. Default: true Group: security

Specified by:

httpsHostnameVerificationEnabled in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

httpsHostnameVerificationEnabled in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

httpsHostnameVerificationEnabled - the value to set

Returns:

the dsl builder

httpsHostnameVerificationEnabled

default PahoEndpointBuilderFactory.PahoEndpointBuilder httpsHostnameVerificationEnabled(String httpsHostnameVerificationEnabled)

Whether SSL HostnameVerifier is enabled or not. The default value is true. The option will be converted to a <code>boolean</code> type. Default: true Group: security

Specified by:

httpsHostnameVerificationEnabled in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

httpsHostnameVerificationEnabled in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

httpsHostnameVerificationEnabled - the value to set

Returns:

the dsl builder

password

default PahoEndpointBuilderFactory.PahoEndpointBuilder password(String password)

Password to be used for authentication against the MQTT broker. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

password in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

password in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

password - the value to set

Returns:

the dsl builder

socketFactory

default PahoEndpointBuilderFactory.PahoEndpointBuilder socketFactory(Object socketFactory)

Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings. The option is a: <code>javax.net.SocketFactory</code> type. Group: security

Specified by:

socketFactory in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

socketFactory in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

socketFactory - the value to set

Returns:

the dsl builder

socketFactory

default PahoEndpointBuilderFactory.PahoEndpointBuilder socketFactory(String socketFactory)

Sets the SocketFactory to use. This allows an application to apply its own policies around the creation of network sockets. If using an SSL connection, an SSLSocketFactory can be used to supply application-specific security settings. The option will be converted to a <code>javax.net.SocketFactory</code> type. Group: security

Specified by:

socketFactory in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

socketFactory in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

socketFactory - the value to set

Returns:

the dsl builder

sslClientProps

default PahoEndpointBuilderFactory.PahoEndpointBuilder sslClientProps(Properties sslClientProps)

Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the file that contains the KeyStore object that you want the KeyManager to use. For example /mydir/etc/key.p12 com.ibm.ssl.keyStorePassword The password for the KeyStore object that you want the KeyManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.keyStoreType Type of key store, for example PKCS12, JKS, or JCEKS. com.ibm.ssl.keyStoreProvider Key store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.trustStore The name of the file that contains the KeyStore object that you want the TrustManager to use. com.ibm.ssl.trustStorePassword The password for the TrustStore object that you want the TrustManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.trustStoreType The type of KeyStore object that you want the default TrustManager to use. Same possible values as keyStoreType. com.ibm.ssl.trustStoreProvider Trust store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.enabledCipherSuites A list of which ciphers are enabled. Values are dependent on the provider, for example: SSL_RSA_WITH_AES_128_CBC_SHA;SSL_RSA_WITH_3DES_EDE_CBC_SHA. com.ibm.ssl.keyManager Sets the algorithm that will be used to instantiate a KeyManagerFactory object instead of using the default algorithm available in the platform. Example values: IbmX509 or IBMJ9X509. com.ibm.ssl.trustManager Sets the algorithm that will be used to instantiate a TrustManagerFactory object instead of using the default algorithm available in the platform. Example values: PKIX or IBMJ9X509. The option is a: <code>java.util.Properties</code> type. Group: security

Specified by:

sslClientProps in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

sslClientProps in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

sslClientProps - the value to set

Returns:

the dsl builder

sslClientProps

default PahoEndpointBuilderFactory.PahoEndpointBuilder sslClientProps(String sslClientProps)

Sets the SSL properties for the connection. Note that these properties are only valid if an implementation of the Java Secure Socket Extensions (JSSE) is available. These properties are not used if a custom SocketFactory has been set. The following properties can be used: com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider. For example IBMJSSE2 or SunJSSE com.ibm.ssl.keyStore The name of the file that contains the KeyStore object that you want the KeyManager to use. For example /mydir/etc/key.p12 com.ibm.ssl.keyStorePassword The password for the KeyStore object that you want the KeyManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.keyStoreType Type of key store, for example PKCS12, JKS, or JCEKS. com.ibm.ssl.keyStoreProvider Key store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.trustStore The name of the file that contains the KeyStore object that you want the TrustManager to use. com.ibm.ssl.trustStorePassword The password for the TrustStore object that you want the TrustManager to use. The password can either be in plain-text, or may be obfuscated using the static method: com.ibm.micro.security.Password.obfuscate(char password). This obfuscates the password using a simple and insecure XOR and Base64 encoding mechanism. Note that this is only a simple scrambler to obfuscate clear-text passwords. com.ibm.ssl.trustStoreType The type of KeyStore object that you want the default TrustManager to use. Same possible values as keyStoreType. com.ibm.ssl.trustStoreProvider Trust store provider, for example IBMJCE or IBMJCEFIPS. com.ibm.ssl.enabledCipherSuites A list of which ciphers are enabled. Values are dependent on the provider, for example: SSL_RSA_WITH_AES_128_CBC_SHA;SSL_RSA_WITH_3DES_EDE_CBC_SHA. com.ibm.ssl.keyManager Sets the algorithm that will be used to instantiate a KeyManagerFactory object instead of using the default algorithm available in the platform. Example values: IbmX509 or IBMJ9X509. com.ibm.ssl.trustManager Sets the algorithm that will be used to instantiate a TrustManagerFactory object instead of using the default algorithm available in the platform. Example values: PKIX or IBMJ9X509. The option will be converted to a <code>java.util.Properties</code> type. Group: security

Specified by:

sslClientProps in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

sslClientProps in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

sslClientProps - the value to set

Returns:

the dsl builder

sslHostnameVerifier

default PahoEndpointBuilderFactory.PahoEndpointBuilder sslHostnameVerifier(Object sslHostnameVerifier)

Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier. The option is a: <code>javax.net.ssl.HostnameVerifier</code> type. Group: security

Specified by:

sslHostnameVerifier in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

sslHostnameVerifier in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

sslHostnameVerifier - the value to set

Returns:

the dsl builder

sslHostnameVerifier

default PahoEndpointBuilderFactory.PahoEndpointBuilder sslHostnameVerifier(String sslHostnameVerifier)

Sets the HostnameVerifier for the SSL connection. Note that it will be used after handshake on a connection and you should do actions by yourself when hostname is verified error. There is no default HostnameVerifier. The option will be converted to a <code>javax.net.ssl.HostnameVerifier</code> type. Group: security

Specified by:

sslHostnameVerifier in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

sslHostnameVerifier in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

sslHostnameVerifier - the value to set

Returns:

the dsl builder

userName

default PahoEndpointBuilderFactory.PahoEndpointBuilder userName(String userName)

Username to be used for authentication against the MQTT broker. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

userName in interface PahoEndpointBuilderFactory.PahoEndpointConsumerBuilder

Specified by:

userName in interface PahoEndpointBuilderFactory.PahoEndpointProducerBuilder

Parameters:

userName - the value to set

Returns:

the dsl builder