Package io.quarkus.smallrye.reactivemessaging.rabbitmq.deployment

Interface RabbitMQDevServicesBuildTimeConfig

public interface RabbitMQDevServicesBuildTimeConfig

  • Method Details

    • enabled

      Optional<Boolean> enabled()
      If Dev Services for RabbitMQ has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For RabbitMQ, Dev Services starts a broker unless rabbitmq-host or rabbitmq-port are set or if all the Reactive Messaging RabbitMQ 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.

    • httpPort

      OptionalInt httpPort()
      Optional fixed port for the RabbitMQ management plugin.

      If not defined, the port will be chosen randomly.

    • imageName

      @ConfigDocDefault(value="`{rabbitmq-image}`", escape=false) Optional<String> imageName()
      The image to use. Note that only official RabbitMQ images are supported. Specifically, the image repository must end with rabbitmq.

    • shared

      @WithDefault("true") boolean shared()
      Indicates if the RabbitMQ 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 RabbitMQ starts a new container.

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

      Container sharing is only used in dev mode.

    • serviceName

      @WithDefault("rabbitmq") String serviceName()
      The value of the quarkus-dev-service-rabbitmq 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 RabbitMQ looks for a container with the quarkus-dev-service-rabbitmq 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-rabbitmq label set to the specified value.

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

    • exchanges

      @ConfigDocMapKey("exchange-name") Map<String,RabbitMQDevServicesBuildTimeConfig.Exchange> exchanges()
      Exchanges that should be predefined after starting the RabbitMQ broker.

    • queues

      @ConfigDocMapKey("queue-name") Map<String,RabbitMQDevServicesBuildTimeConfig.Queue> queues()
      Queues that should be predefined after starting the RabbitMQ broker.

    • bindings

      @ConfigDocMapKey("binding-name") Map<String,RabbitMQDevServicesBuildTimeConfig.Binding> bindings()
      Bindings that should be predefined after starting the RabbitMQ broker.

    • vhosts

      Optional<List<String>> vhosts()
      Virtual hosts that should be predefined after starting the RabbitMQ broker.

    • containerEnv

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