Package io.quarkus.smallrye.reactivemessaging.mqtt.deployment

Interface MqttDevServicesBuildTimeConfig

public interface MqttDevServicesBuildTimeConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    containerEnv()
    Environment variables that are passed to the container.
    Optional<Boolean>
    enabled()
    If Dev Services for MQTT has been explicitly enabled or disabled.
    String
    imageName()
    The image to use.
    OptionalInt
    port()
    Optional fixed port the dev service will listen to.
    String
    serviceName()
    The value of the quarkus-dev-service-mqtt label attached to the started container.
    boolean
    shared()
    Indicates if the MQTT broker managed by Quarkus Dev Services is shared.

  • Method Details

    • enabled

      Optional<Boolean> enabled()
      If Dev Services for MQTT has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For MQTT, Dev Services starts a broker unless *.host or *.port are set for one of the connectors or if all the Reactive Messaging MQTT channel are configured with host or port.

    • port

      OptionalInt port()
      Optional fixed port the dev service will listen to.

      If not defined, the port will be chosen randomly.

    • imageName

      @WithDefault("eclipse-mosquitto:2.0.15") String imageName()
      The image to use.

    • shared

      @WithDefault("true") boolean shared()
      Indicates if the MQTT broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for MQTT starts a new container.

      The discovery uses the quarkus-dev-service-mqtt label. The value is configured using the service-name property.

      Container sharing is only used in dev mode.

    • serviceName

      @WithDefault("mqtt") String serviceName()
      The value of the quarkus-dev-service-mqtt label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, Dev Services for MQTT looks for a container with the quarkus-dev-service-mqtt label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the quarkus-dev-service-mqtt label set to the specified value.

      This property is used when you need multiple shared MQTT brokers.

    • containerEnv

      @ConfigDocMapKey("environment-variable-name") Map<String,String> containerEnv()
      Environment variables that are passed to the container.