Package de.smartsquare.starter.mqtt

Types

AnnotationCollector

class AnnotationCollector : BeanPostProcessor

Helper class to find all beans with methods annotated with MqttSubscribe.

BrokerConnectException

class BrokerConnectException(message: String, cause: Throwable?) : RuntimeException

Exception thrown when the connection to mqtt broker fails.

Mqtt3ClientConfigurer

interface Mqtt3ClientConfigurer

Interface to enable more advanced configuration for the Mqtt3ClientBuilder than what is possible with the properties.

Mqtt3Publisher

class Mqtt3Publisher(adapter: MqttMessageAdapter, client: Mqtt3Client)

Class with convenience methods for publishing a message on the mqtt broker.

Mqtt3Router

class Mqtt3Router(collector: AnnotationCollector, adapter: MqttMessageAdapter, config: MqttProperties, client: Mqtt3Client) : MqttRouter

Helper class that subscribes to the mqtt broker and routes received messages to the configured subscribers (methods annotated with MqttSubscribe).

Mqtt5ClientConfigurer

interface Mqtt5ClientConfigurer

Interface to enable more advanced configuration for the Mqtt5ClientBuilder than what is possible with the properties.

Mqtt5Publisher

class Mqtt5Publisher(adapter: MqttMessageAdapter, client: Mqtt5Client)

Class with convenience methods for publishing a message on the mqtt broker.

Mqtt5Router

class Mqtt5Router(collector: AnnotationCollector, adapter: MqttMessageAdapter, config: MqttProperties, client: Mqtt5Client) : MqttRouter

Helper class that subscribes to the mqtt broker and routes received messages to the configured subscribers (methods annotated with MqttSubscribe).

MqttAutoConfiguration

@Configuration()

@ConditionalOnClass(value = [MqttClient::class])

@EnableConfigurationProperties(value = [MqttProperties::class])

class MqttAutoConfiguration

Main entry point for the spring auto configuration.

MqttConfigurationException

class MqttConfigurationException(message: String) : RuntimeException

Exception thrown when invalid methods with MqttSubscribe are found.

MqttMessageAdapter

class MqttMessageAdapter(objectMapper: ObjectMapper)

Adapter class with methods for converting from and to mqtt payloads.

MqttProperties

@ConstructorBinding()

@ConfigurationProperties(prefix = mqtt)

data class MqttProperties(host: String, port: Int, clientId: String?, username: String?, password: String?, ssl: Boolean, clean: Boolean, group: String?, version: Int)

Properties for connection to the mqtt broker.

MqttRouter

abstract class MqttRouter(collector: AnnotationCollector, adapter: MqttMessageAdapter, config: MqttProperties) : InitializingBean

Abstract base class for all routers that handles the common implementation.

MqttSubscribe

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

annotation class MqttSubscribe(topic: String, qos: MqttQos, shared: Boolean)

Marker annotation for methods that should receive messages from the mqtt broker.

MqttVersion

@Constraint(validatedBy = [MqttVersionValidator::class])

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.FIELD])

annotation class MqttVersion(message: String, groups: Array<KClass<*>>, payload: Array<KClass<*>>)

Annotation to mark properties or fields to be validated as an mqtt version.

MqttVersionValidator

class MqttVersionValidator : ConstraintValidator<MqttVersion, Int>

Custom validator for the mqtt version, enabled by the MqttVersion annotation.

SpringAwareMqtt3Client

class SpringAwareMqtt3Client(delegate: Mqtt3Client, connectOptions: Mqtt3Connect) : Mqtt3Client, InitializingBean, DisposableBean

Subclass of the mqtt 3 client to expose with awareness of the Spring lifecycle.

SpringAwareMqtt5Client

class SpringAwareMqtt5Client(delegate: Mqtt5Client, connectOptions: Mqtt5Connect) : Mqtt5Client, InitializingBean, DisposableBean

Subclass of the mqtt 5 client to expose with awareness of the Spring lifecycle.