Package io.quarkus.infinispan.client.runtime

Interface InfinispanDevServicesConfig

public interface InfinispanDevServicesConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<List<String>>
    artifacts()
    List of the artifacts to automatically download and add to the Infinispan server libraries.
    Optional<List<String>>
    configFiles()
    Infinispan Server configuration chunks to be passed to the container.
    Map<String,String>
    containerEnv()
    Environment variables that are passed to the container.
    boolean
    createDefaultClient()
    When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service.
    boolean
    enabled()
    If DevServices has been explicitly enabled or disabled.
    Optional<String>
    exporterOtlpEndpoint()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Optional<String>
    imageName()
    The image to use.
    OptionalInt
    mcastPort()
    If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster.
    OptionalInt
    port()
    Optional fixed port the dev service will listen to.
    String
    serviceName()
    The value of the quarkus-dev-service-infinispan label attached to the started container.
    boolean
    shared()
    Indicates if the Infinispan server managed by Quarkus Dev Services is shared.
    Optional<String>
    site()
    Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon).
    String
    toString()
     
    Optional<Boolean>
    tracing()
    Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • enabled

      @WithDefault("true") 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.

    • createDefaultClient

      @WithDefault("true") boolean createDefaultClient()
      When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.

    • port

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

      If not defined, the port will be chosen randomly.

    • shared

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

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

      Container sharing is only used in dev mode.

    • serviceName

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

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

    • imageName

      @ConfigDocDefault(value="`{infinispan-image}`", escape=false) Optional<String> imageName()
      The image to use. Note that only official Infinispan images are supported.

    • artifacts

      Optional<List<String>> artifacts()
      List of the artifacts to automatically download and add to the Infinispan server libraries.

      For example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.

      If an invalid value is passed, the Infinispan server will throw an error when trying to start.

    • site

      Optional<String> site()
      Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure mcastPort() to avoid forming a cluster with any other running Infinispan Server container.

    • mcastPort

      OptionalInt mcastPort()
      If you are running an Infinispan Server already in docker, if the containers use the same mcastPort they will form a cluster. Set a different mcastPort to create a separate cluster in Docker (e. 46656). A common use case in a local Docker development mode, is the need of having two different Infinispan Clusters with Cross Site Replication enabled. see https://github.com/infinispan/infinispan-simple-tutorials/blob/main/infinispan-remote/cross-site-replication/docker-compose/

    • tracing

      @WithName("tracing.enabled") @WithDefault("false") @Deprecated(forRemoval=true) Optional<Boolean> tracing()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Runs the Infinispan Server container with tracing enabled. Traces are disabled by default

    • exporterOtlpEndpoint

      @WithName("tracing.exporter.otlp.endpoint") @WithDefault("http://localhost:4317") @Deprecated(forRemoval=true) Optional<String> exporterOtlpEndpoint()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317

    • containerEnv

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

    • configFiles

      Optional<List<String>> configFiles()
      Infinispan Server configuration chunks to be passed to the container.

    • toString

      String toString()
      Overrides:
      toString in class Object