Package io.quarkiverse.unleash.devservices

Class UnleashDevServicesConfig

java.lang.Object
io.quarkiverse.unleash.devservices.UnleashDevServicesConfig
public class UnleashDevServicesConfig extends Object

  • Field Details

    • enabled

      @ConfigItem(name="enabled", defaultValue="true") public boolean enabled
      If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.

      When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.

    • port

      @ConfigItem(name="port") public OptionalInt port
      Optional fixed port the dev service will listen to.

      If not defined, the port will be chosen randomly.

    • shared

      @ConfigItem(name="shared", defaultValue="true") public boolean shared
      Indicates if the Unleash server 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 Unleash starts a new container.

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

      Container sharing is only used in dev mode.

    • serviceName

      @ConfigItem(name="service-name", defaultValue="unleash") public String serviceName
      The value of the quarkus-dev-service-unleash 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 Unleash looks for a container with the quarkus-dev-service-unleash 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-unleash label set to the specified value.

      This property is used when you need multiple shared Unleash servers.

    • imageName

      @ConfigItem(name="image-name") public Optional<String> imageName
      The container image name to use, for container based DevServices providers.

    • log

      @ConfigItem(name="log", defaultValue="false") public boolean log
      Enabled or disable log of the mock-server

    • reuse

      @ConfigItem(name="reuse", defaultValue="false") public boolean reuse
      Helper to define the stop strategy for containers created by DevServices. In particular, we don't want to actually stop the containers when they have been flagged for reuse, and when the Testcontainers configuration has been explicitly set to allow container reuse. To enable reuse, ass testcontainers.reuse.enable=true in your .testcontainers.properties file, to be stored in your home.
      See Also:

    • importFile

      @ConfigItem(name="import-file") public Optional<String> importFile
      The import data from file during the start.

    • db

      @ConfigItem(name="db") public UnleashDevServicesConfig.UnleashDatabaseConfig db
      Unleash database dev service

  • Constructor Details

    • UnleashDevServicesConfig

      public UnleashDevServicesConfig()