Package io.quarkus.infinispan.client.runtime

Class InfinispanDevServicesConfig

java.lang.Object

io.quarkus.infinispan.client.runtime.InfinispanDevServicesConfig

public class InfinispanDevServicesConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Optional<List<String>>	artifacts	List of the artifacts to automatically download and add to the Infinispan server libraries.
Map<String,String>	containerEnv	Environment variables that are passed to the container.
boolean	enabled	If DevServices has been explicitly enabled or disabled.
Optional<String>	exporterOtlpEndpoint	Sets Infinispan Server otlp endpoint.
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.
Optional<Boolean>	tracing	Runs the Infinispan Server container with tracing enabled.

Constructor Summary

Constructors

Constructor	Description
InfinispanDevServicesConfig()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

enabled

@ConfigItem(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
public OptionalInt port

Optional fixed port the dev service will listen to.

If not defined, the port will be chosen randomly.

shared

@ConfigItem(defaultValue="true")
public 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

@ConfigItem(defaultValue="infinispan")
public 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

@ConfigItem
public Optional<String> imageName

The image to use. Note that only official Infinispan images are supported.

artifacts

@ConfigItem
public 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

@ConfigItem
public 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

@ConfigItem
public 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

@ConfigItem(name="tracing.enabled",
            defaultValue="false")
public Optional<Boolean> tracing

Runs the Infinispan Server container with tracing enabled. Traces are disabled by default

exporterOtlpEndpoint

@ConfigItem(name="tracing.exporter.otlp.endpoint",
            defaultValue="http://localhost:4317")
public Optional<String> exporterOtlpEndpoint

Sets Infinispan Server otlp endpoint. Default value is http://localhost:4317

containerEnv

@ConfigItem
public Map<String,String> containerEnv

Environment variables that are passed to the container.

Constructor Detail

InfinispanDevServicesConfig

public InfinispanDevServicesConfig()

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object