Package io.quarkus.infinispan.client.runtime

Interface InfinispanClientRuntimeConfig

public interface InfinispanClientRuntimeConfig
Author:
Katia Aresti

  • Method Details

    • uri

      Optional<String> uri()
      Sets the URI of the running Infinispan server to connect to. hotrod://localhost:11222@admin:password If provided hosts(), username() and password() will be ignored.

    • hosts

      Optional<String> hosts()
      Sets the host name/port to connect to. Each one is separated by a semicolon (eg. host1:11222;host2:11222).

    • serverList

      @Deprecated Optional<String> serverList()
      Deprecated.
      hosts() should be used to configure the list or uri for an uri connection string.
      Sets the host name/port to connect to. Each one is separated by a semicolon (eg. host1:11222;host2:11222).

    • clientIntelligence

      @WithDefault("HASH_DISTRIBUTION_AWARE") Optional<String> clientIntelligence()
      Sets client intelligence used by authentication Available values: * `BASIC` - Means that the client doesn't handle server topology changes and therefore will only use the list of servers supplied at configuration time. * `TOPOLOGY_AWARE` - Use this provider if you don't want the client to present any certificates to the remote TLS host. * `HASH_DISTRIBUTION_AWARE` - Like `TOPOLOGY_AWARE` but with the additional advantage that each request involving keys will be routed to the server who is the primary owner which improves performance greatly. This is the default.

    • useAuth

      @WithDefault("true") Optional<Boolean> useAuth()
      Enables or disables authentication. Set it to false when connecting to an Infinispan Server without authentication. deployments. Default is 'true'.

    • username

      Optional<String> username()
      Sets username used by authentication.

    • authUsername

      @Deprecated Optional<String> authUsername()
      Deprecated.
      username() should be used to configure the credentials username.
      Sets username used by authentication.

    • password

      Optional<String> password()
      Sets password used by authentication.

    • authPassword

      @Deprecated Optional<String> authPassword()
      Deprecated.
      password() should be used to configure the credentials password.
      Sets password used by authentication

    • authRealm

      @WithDefault("default") Optional<String> authRealm()
      Sets realm used by authentication

    • authServerName

      @WithDefault("infinispan") Optional<String> authServerName()
      Sets server name used by authentication

    • saslMechanism

      @WithDefault("DIGEST-SHA-512") Optional<String> saslMechanism()
      Sets SASL mechanism used by authentication. Available values: * `DIGEST-SHA-512` - Uses the SHA-512 hashing algorithm to securely hash and verify credentials. This is the default. * `DIGEST-MD5` - Uses the MD5 hashing algorithm in addition to nonces to encrypt credentials. * `EXTERNAL` - Uses client certificates to provide valid identities to Infinispan Server and enable encryption. * `PLAIN` - Sends credentials in plain text (unencrypted) over the wire in a way that is similar to HTTP BASIC authentication. You should use `PLAIN` authentication only in combination with TLS encryption.

    • keyStore

      Optional<String> keyStore()
      Specifies the filename of a keystore to use to create the SSLContext. You also need to specify a keyStorePassword. Setting this property implicitly enables SSL/TLS.

    • keyStorePassword

      Optional<String> keyStorePassword()
      Specifies the password needed to open the keystore. You also need to specify a keyStore. Setting this property implicitly enables SSL/TLS.

    • keyStoreType

      Optional<String> keyStoreType()
      Specifies the type of the keyStore, such as PKCS12.

    • keyAlias

      Optional<String> keyAlias()
      Sets the unique name used to identify a specific key pair in a keystore for secure connections.

    • trustStore

      Optional<String> trustStore()
      Specifies the filename of a truststore to use to create the SSLContext. You also need to specify a trustStorePassword. Setting this property implicitly enables SSL/TLS.

    • trustStorePassword

      Optional<String> trustStorePassword()
      Specifies the password needed to open the truststore You also need to specify a trustStore. Setting this property implicitly enables SSL/TLS.

    • trustStoreType

      Optional<String> trustStoreType()
      Specifies the type of the truststore, such as JKS or JCEKS. Defaults to JKS if trustStore is enabled.

    • sslProtocol

      Optional<String> sslProtocol()
      Configures the secure socket protocol. Setting this property implicitly enables SSL/TLS.

    • sslProvider

      Optional<String> sslProvider()
      Sets the ssl provider. For example BCFIPS Setting this implicitly enables SSL/TLS.

    • sslCiphers

      Optional<List<String>> sslCiphers()
      Configures the ciphers. Setting this property implicitly enables SSL/TLS.

    • sslHostNameValidation

      Optional<Boolean> sslHostNameValidation()
      Do SSL hostname validation. Defaults to true.

    • sniHostName

      Optional<String> sniHostName()
      SNI host name. Mandatory when SSL is enabled and host name validation is true.

    • socketTimeout

      Optional<Integer> socketTimeout()
      Configures the socket timeout.

    • tracingPropagationEnabled

      @WithName("tracing.propagation.enabled") Optional<Boolean> tracingPropagationEnabled()
      Whether a tracing propagation is enabled in case the Opentelemetry extension is present. By default the propagation of the context is propagated from the client to the Infinispan Server.

    • cache

      Map<String,InfinispanClientRuntimeConfig.RemoteCacheConfig> cache()
      Configures caches from the client with the provided configuration.

    • backupCluster

      Map<String,InfinispanClientRuntimeConfig.BackupClusterConfig> backupCluster()
      // @formatter:off Configures cross site replication from the client with the provided configuration. This allows automatic failover when a site is down, as well as switching manual with methods like: cacheManager.switchToDefaultCluster(); cacheManager.switchToCluster('clusterName') // @formatter:on