interfaces
interface*
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
inet-address
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
global
link-local
loopback
non-loopback
site-local
match-interface
| Name | Type | Default | Description |
|---|---|---|---|
| value | FIXME |
match-address
| Name | Type | Default | Description |
|---|---|---|---|
| value | FIXME |
socket-bindings
| Name | Type | Default | Description |
|---|---|---|---|
| default-interface | string | ||
| port-offset | string |
socket-binding*
security
security-realms
security-realm+
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
server-identities?
ssl
keystore
| Name | Type | Default | Description |
|---|---|---|---|
| path | string | ||
| relative-to | string | ||
| keystore-password | string | ||
| alias | string | ||
| key-password | string | ||
| generate-self-signed-certificate-host | string |
engine?
| Name | Type | Default | Description |
|---|---|---|---|
| enabled-protocols | |||
| enabled-ciphersuites | string |
filesystem-realm?
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | filesystem | |
| path | string | ||
| relative-to | string | infinispan.server.data.path | |
| levels | int | 0 | |
| encoded | boolean | true |
kerberos-realm?
| Name | Type | Default | Description |
|---|---|---|---|
| keytab-path | string | ||
| relative-to | string |
ldap-realm?
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| url | string | ||
| principal | string | ||
| credential | string | ||
| direct-verification | boolean | ||
| page-size | int | ||
| search-dn | string | ||
| rdn-identifier | string |
identity-mapping?
| Name | Type | Default | Description |
|---|---|---|---|
| rdn-identifier | string | ||
| search-dn | string |
attribute-mapping?
attribute+
| Name | Type | Default | Description |
|---|---|---|---|
| filter | string | ||
| filter-dn | string | ||
| from | string | ||
| to | string |
user-password-mapper?
| Name | Type | Default | Description |
|---|---|---|---|
| from | string | ||
| verifiable | boolean | ||
| writable | boolean |
local-realm?
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | local |
properties-realm?
| Name | Type | Default | Description |
|---|---|---|---|
| groups-attribute | string |
user-properties
| Name | Type | Default | Description |
|---|---|---|---|
| path | string | ||
| relative-to | string | ||
| digest-realm-name | string | ||
| plain-text | boolean | false |
group-properties
| Name | Type | Default | Description |
|---|---|---|---|
| path | string | ||
| relative-to | string |
token-realm?
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | token | |
| principal-claim | string | username |
jwt
| Name | Type | Default | Description |
|---|---|---|---|
| issuer | |||
| audience | |||
| public-key | string | ||
| jku-timeout | long | ||
| client-ssl-context | string |
oauth2-introspection
| Name | Type | Default | Description |
|---|---|---|---|
| client-id | string | ||
| client-secret | string | ||
| introspection-url | string | ||
| client-ssl-context | string | ||
| host-name-verification-policy | string |
truststore-realm?
| Name | Type | Default | Description |
|---|---|---|---|
| path | string | ||
| provider | string | ||
| keystore-password | string | ||
| relative-to | string | infinispan.server.data.path |
endpoints
| Name | Type | Default | Description |
|---|---|---|---|
| socket-binding | string | The socket on which the endpoint connector will bind itself | |
| security-realm | string | The name of the security realm to use for authentication/authorization/encryption |
hotrod-connector?
| Name | Type | Default | Description |
|---|---|---|---|
| external-host | string | Sets the external address of this node, i.e. the address which clients will connect to. Defaults to the server's socket-binding address | |
| external-port | int | Sets the external port of this node, i.e. the port which clients will connect to. Defaults to the server's socket-binding port |
topology-state-transfer?
| Name | Type | Default | Description |
|---|---|---|---|
| lock-timeout | int | Configures the lock acquisition timeout for the topology cache. Defaults to 10 seconds | |
| replication-timeout | int | Configures the replication timeout for the topology cache. Defaults to 10 seconds | |
| lazy-retrieval | boolean | false | Configures whether to enable state transfer for the topology cache. If enabled, a ClusterCacheLoader will be used to lazily retrieve topology information from the other nodes. Defaults to false. |
| await-initial-retrieval | boolean | ${Server.TopologyStateTransfer.await-initial-retrieval} | Configures whether to initial state retrieval should happen immediately at startup. Only applies when lazy-retrieval is false. Defaults to true. |
authentication?
| Name | Type | Default | Description |
|---|---|---|---|
| security-realm | string | The name of the security realm to use for authentication/authorization. |
sasl?
| Name | Type | Default | Description |
|---|---|---|---|
| server-context-name | string | The name of the login context to be used to retrieve a server subject for certain SASL mechs (i.e. GSSAPI) | |
| server-name | string | The name the server which is exposed to clients | |
| mechanisms | |||
| qop | |||
| strength |
policy?
forward-secrecy?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
no-active?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
no-anonymous?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
no-dictionary?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
no-plain-text?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
pass-credentials?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
property*
encryption?
| Name | Type | Default | Description |
|---|---|---|---|
| require-ssl-client-auth | boolean | ${Server.Encryption.require-ssl-client-auth} | Whether to require client certificate authentication. Defaults to false. |
| security-realm | string | The name of the security realm to use for obtaining the SSL keystore |
sni*
| Name | Type | Default | Description |
|---|---|---|---|
| host-name | string | TLS SNI host name | |
| security-realm | string | A corresponding security realm. If none is specified, the default will be used. |
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | The logical name to give to this connector. This attribute is required when there are more connectors of the same type defined. |
| Name | Type | Default | Description |
|---|---|---|---|
| socket-binding | string | The socket on which this connector will bind itself. If missing, the server will not listen to TCP connections | |
| cache-container | string | The name of the cache container which will be exposed by this connector | |
| io-threads | int | Sets the number of I/O threads. Defaults to 2 * cpu cores | |
| worker-threads | int | Sets the number of worker threads. Defaults to 160 | |
| idle-timeout | int | Specifies the maximum time in seconds that connections from clients will be kept open without activity. Defaults to 0 (no timeout) | |
| tcp-nodelay | boolean | Affects TCP NODELAY on the TCP stack. Defaults to enabled | |
| tcp-keepalive | boolean | Affects TCP KEEPALIVE on the TCP stack. Defaults to disabled | |
| send-buffer-size | int | Sets the size of the send buffer. | |
| receive-buffer-size | int | Sets the size of the receive buffer. |
rest-connector
| Name | Type | Default | Description | ||||
|---|---|---|---|---|---|---|---|
| context-path | string | The context path on which to register the REST connector. Defaults to '' (the root context) | |||||
| extended-headers |
| ON_DEMAND | Whether to enable extended headers. Can be NEVER or ON_DEMAND. Defaults to ON_DEMAND | ||||
| max-content-length | int | Sets the maximum allowed content length. | |||||
| compression-level | int | Sets the compression level when using compressed requests and responses. |
authentication?
| Name | Type | Default | Description |
|---|---|---|---|
| security-realm | string | The security realm to use for authentication/authorization purposes. Defaults to none (no authentication) | |
| mechanisms | NONE | The authentication method to require. Can be NONE, BASIC, DIGEST, CLIENT_CERT, SPNEGO. Defaults to NONE. Setting it to a different value requires enabling a security-realm. |
cors-rules?
cors-rule+
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | The rule name | |
| allow-credentials | boolean | false | Sets the CORS 'Access-Control-Allow-Credentials' response header to true. Enable CORS requests to use credentials |
| max-age-seconds | int | 0 | Sets the CORS 'Access-Control-Max-Age' response header with the amount of time CORS preflight request headers can be cached |
allowed-origins
A comma separated list used to set the CORS 'Access-Control-Allow-Origin' to indicate the response can be shared with a certain origin
allowed-methods
A comma separated list used to set the CORS 'Access-Control-Allow-Methods' in the preflight response to specify the methods allowed for the configured origin(s)
allowed-headers?
A comma separated list used to set the CORS 'Access-Control-Allow-Headers' in the preflight response to specify which headers can be used by the configured origin(s)
expose-headers?
A comma separated list used to set the CORS 'Access-Control-Expose-Headers' in the preflight response to specify which headers can be exposed to the configured origin(s)
encryption?
| Name | Type | Default | Description |
|---|---|---|---|
| require-ssl-client-auth | boolean | ${Server.Encryption.require-ssl-client-auth} | Whether to require client certificate authentication. Defaults to false. |
| security-realm | string | The name of the security realm to use for obtaining the SSL keystore |
sni*
| Name | Type | Default | Description |
|---|---|---|---|
| host-name | string | TLS SNI host name | |
| security-realm | string | A corresponding security realm. If none is specified, the default will be used. |
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | The logical name to give to this connector. This attribute is required when there are more connectors of the same type defined. |
| Name | Type | Default | Description |
|---|---|---|---|
| socket-binding | string | The socket on which this connector will bind itself. If missing, the server will not listen to TCP connections | |
| cache-container | string | The name of the cache container which will be exposed by this connector | |
| io-threads | int | Sets the number of I/O threads. Defaults to 2 * cpu cores | |
| worker-threads | int | Sets the number of worker threads. Defaults to 160 | |
| idle-timeout | int | Specifies the maximum time in seconds that connections from clients will be kept open without activity. Defaults to 0 (no timeout) | |
| tcp-nodelay | boolean | Affects TCP NODELAY on the TCP stack. Defaults to enabled | |
| tcp-keepalive | boolean | Affects TCP KEEPALIVE on the TCP stack. Defaults to disabled | |
| send-buffer-size | int | Sets the size of the send buffer. | |
| receive-buffer-size | int | Sets the size of the receive buffer. |
memcached-connector?
| Name | Type | Default | Description |
|---|---|---|---|
| cache | string | The name of the cache to use for the Memcached connector. Defaults to memcachedCache | |
| client-encoding | string | The client encoding for the values, only applicable to the memcached text protocol. |
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | The logical name to give to this connector. This attribute is required when there are more connectors of the same type defined. |
| Name | Type | Default | Description |
|---|---|---|---|
| socket-binding | string | The socket on which this connector will bind itself. If missing, the server will not listen to TCP connections | |
| cache-container | string | The name of the cache container which will be exposed by this connector | |
| io-threads | int | Sets the number of I/O threads. Defaults to 2 * cpu cores | |
| worker-threads | int | Sets the number of worker threads. Defaults to 160 | |
| idle-timeout | int | Specifies the maximum time in seconds that connections from clients will be kept open without activity. Defaults to 0 (no timeout) | |
| tcp-nodelay | boolean | Affects TCP NODELAY on the TCP stack. Defaults to enabled | |
| tcp-keepalive | boolean | Affects TCP KEEPALIVE on the TCP stack. Defaults to disabled | |
| send-buffer-size | int | Sets the size of the send buffer. | |
| receive-buffer-size | int | Sets the size of the receive buffer. |
| Name | Type | Default | Description |
|---|---|---|---|
| socket-binding | string | The socket on which this connector will bind itself. If missing, the server will not listen to TCP connections | |
| cache-container | string | The name of the cache container which will be exposed by this connector | |
| io-threads | int | Sets the number of I/O threads. Defaults to 2 * cpu cores | |
| worker-threads | int | Sets the number of worker threads. Defaults to 160 | |
| idle-timeout | int | Specifies the maximum time in seconds that connections from clients will be kept open without activity. Defaults to 0 (no timeout) | |
| tcp-nodelay | boolean | Affects TCP NODELAY on the TCP stack. Defaults to enabled | |
| tcp-keepalive | boolean | Affects TCP KEEPALIVE on the TCP stack. Defaults to disabled | |
| send-buffer-size | int | Sets the size of the send buffer. | |
| receive-buffer-size | int | Sets the size of the receive buffer. |