Package io.quarkus.narayana.lra.deployment.devservice

Interface LRACoordinatorDevServicesBuildTimeConfig

public interface LRACoordinatorDevServicesBuildTimeConfig

  • Method Summary

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

  • Method Details

    • enabled

      @WithDefault("true") boolean enabled()
      If Dev Services for the LRA coordinator has been explicitly enabled or disabled. For the LRA coordinator, the Dev Services is disabled if this property is false or if the quarkus.lra.coordinator-url configuration property is defined.

    • port

      OptionalInt port()
      Optional fixed port the Dev Services will listen to.

      If not defined, the port will be chosen randomly.

    • imageName

      @ConfigDocDefault(value="`{narayana-lra-image}`", escape=false) Optional<String> imageName()
      Optional override of the LRA coordinator container image to use.

    • shared

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

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

      Container sharing is only used in dev mode.

    • serviceName

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

      This property is used when you need multiple shared LRA coordinators.

    • containerEnv

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

    • logWarning

      @WithDefault("true") boolean logWarning()
      Whether to log the warning messages about the LRA Dev Services.

      Defaults to true.