Appendix D. Thorntail fractions reference

For information about using the configuration properties provided in Thorntail fractions, see Section 4.7, “Configuring a Thorntail application”.

D.1. Archaius

Warning

This fraction is deprecated.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>archaius</artifactId>
</dependency>

D.2. Bean Validation

Provides class-level constraint and validation according to JSR 303.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>bean-validation</artifactId>
</dependency>

D.3. CDI

Provides context and dependency-injection support according to JSR-299.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>cdi</artifactId>
</dependency>

Configuration

swarm.cdi.development-mode: Weld comes with a special mode for application development. When the development mode is enabled, certain built-in tools, which facilitate the development of CDI applications, are available. Setting this attribute to true activates the development mode.
swarm.cdi.non-portable-mode: If true then the non-portable mode is enabled. The non-portable mode is suggested by the specification to overcome problems with legacy applications that do not use CDI SPI properly and may be rejected by more strict validation in CDI 1.1.
swarm.cdi.require-bean-descriptor: If true then implicit bean archives without bean descriptor file (beans.xml) are ignored by Weld
swarm.cdi.thread-pool-size: The number of threads to be used by the Weld thread pool. The pool is shared across all CDI-enabled deployments and used primarily for parallel Weld bootstrap.

D.3.1. CDI Configuration

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>cdi-config</artifactId>
</dependency>

D.4. Connector

Primarily an internal fraction used to provide support for higher-level fractions such as JCA (JSR-322).

If you require JCA support, please see the JCA fraction documentation.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>connector</artifactId>
</dependency>

D.5. Container

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>container</artifactId>
</dependency>

D.6. Datasources

Provides support for container-managed database connections.

D.6.1. Autodetectable drivers

If your application includes the appropriate vendor JDBC library in its normal dependencies, these drivers will be detected and installed by Thorntail without any additional effort.

The list of detectable drivers and their driver-name which may be used when defining a datasource is as follows:

Database	`driver-name`
MySQL	`mysql`
PostgreSQL	`postgresql`
H2	`h2`
EnterpriseDB	`edb`
IBM DB2	`ibmdb2`
Oracle DB	`oracle`
Microsoft SQLServer	`sqlserver`
Sybase	`sybase`
Teiid	`teiid`
MariaDB	`mariadb`
Derby	`derby`
Hive2	`hive2`
PrestoDB	`prestodb`

D.6.2. Example datasource definitions

D.6.2.1. MySQL

An example of a MySQL datasource configuration with connection information, basic security, and validation options:

swarm:
  datasources:
    data-sources:
      MyDS:
        driver-name: mysql
        connection-url: jdbc:mysql://localhost:3306/jbossdb
        user-name: admin
        password: admin
        valid-connection-checker-class-name: org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLValidConnectionChecker
        validate-on-match: true
        background-validation: false
        exception-sorter-class-name: org.jboss.jca.adapters.jdbc.extensions.mysql.MySQLExceptionSorter

D.6.2.2. PostgreSQL

An example of a PostgreSQL datasource configuration with connection information, basic security, and validation options:

swarm:
  datasources:
    data-sources:
      MyDS:
        driver-name: postgresql
        connection-url: jdbc:postgresql://localhost:5432/postgresdb
        user-name: admin
        password: admin
        valid-connection-checker-class-name: org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLValidConnectionChecker
        validate-on-match: true
        background-validation: false
        exception-sorter-class-name: org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLExceptionSorter

D.6.2.3. Oracle

An example of an Oracle datasource configuration with connection information, basic security, and validation options:

swarm:
  datasources:
    data-sources:
      MyDS:
        driver-name: oracle
        connection-url: jdbc:oracle:thin:@localhost:1521:XE
        user-name: admin
        password: admin
        valid-connection-checker-class-name: org.jboss.jca.adapters.jdbc.extensions.oracle.OracleValidConnectionChecker
        validate-on-match: true
        background-validation: false
        stale-connection-checker-class-name: org.jboss.jca.adapters.jdbc.extensions.oracle.OracleStaleConnectionChecker
        exception-sorter-class-name: org.jboss.jca.adapters.jdbc.extensions.oracle.OracleExceptionSorter

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>datasources</artifactId>
</dependency>

Configuration

swarm.datasources.data-sources.KEY.allocation-retry: The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception
swarm.datasources.data-sources.KEY.allocation-retry-wait-millis: The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection
swarm.datasources.data-sources.KEY.allow-multiple-users: Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that
swarm.datasources.data-sources.KEY.authentication-context: The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
swarm.datasources.data-sources.KEY.background-validation: An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
swarm.datasources.data-sources.KEY.background-validation-millis: The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value can be done only on disabled datasource, requires a server restart otherwise
swarm.datasources.data-sources.KEY.blocking-timeout-wait-millis: The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time
swarm.datasources.data-sources.KEY.capacity-decrementer-class: Class defining the policy for decrementing connections in the pool
swarm.datasources.data-sources.KEY.capacity-decrementer-properties: Properties to be injected in class defining the policy for decrementing connections in the pool
swarm.datasources.data-sources.KEY.capacity-incrementer-class: Class defining the policy for incrementing connections in the pool
swarm.datasources.data-sources.KEY.capacity-incrementer-properties: Properties to be injected in class defining the policy for incrementing connections in the pool
swarm.datasources.data-sources.KEY.check-valid-connection-sql: Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool
swarm.datasources.data-sources.KEY.connectable: Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.
swarm.datasources.data-sources.KEY.connection-listener-class: Speciefies class name extending org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool.
swarm.datasources.data-sources.KEY.connection-listener-property: Properties to be injected in class specidied in connection-listener-class
swarm.datasources.data-sources.KEY.connection-properties.KEY.value: Each connection-property specifies a string name/value pair with the property name coming from the name attribute and the value coming from the element content
swarm.datasources.data-sources.KEY.connection-url: The JDBC driver connection URL
swarm.datasources.data-sources.KEY.credential-reference: Credential (from Credential Store) to authenticate on data source
swarm.datasources.data-sources.KEY.datasource-class: The fully qualified name of the JDBC datasource class
swarm.datasources.data-sources.KEY.driver-class: The fully qualified name of the JDBC driver class
swarm.datasources.data-sources.KEY.driver-name: Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit
swarm.datasources.data-sources.KEY.elytron-enabled: Enables Elytron security for handling authentication of connections. The Elytron authentication-context to be used will be current context if no context is specified (see authentication-context).
swarm.datasources.data-sources.KEY.enlistment-trace: Defines if WildFly/IronJacamar should record enlistment traces
swarm.datasources.data-sources.KEY.exception-sorter-class-name: An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error
swarm.datasources.data-sources.KEY.exception-sorter-properties: The exception sorter properties
swarm.datasources.data-sources.KEY.flush-strategy: Specifies how the pool should be flush in case of an error.
swarm.datasources.data-sources.KEY.idle-timeout-minutes: The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
swarm.datasources.data-sources.KEY.initial-pool-size: The initial-pool-size element indicates the initial number of connections a pool should hold.
swarm.datasources.data-sources.KEY.jndi-name: Specifies the JNDI name for the datasource
swarm.datasources.data-sources.KEY.jta: Enable JTA integration
swarm.datasources.data-sources.KEY.max-pool-size: The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool
swarm.datasources.data-sources.KEY.mcp: Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool
swarm.datasources.data-sources.KEY.min-pool-size: The min-pool-size element specifies the minimum number of connections for a pool
swarm.datasources.data-sources.KEY.new-connection-sql: Specifies an SQL statement to execute whenever a connection is added to the connection pool
swarm.datasources.data-sources.KEY.password: Specifies the password used when creating a new connection
swarm.datasources.data-sources.KEY.pool-fair: Defines if pool use should be fair
swarm.datasources.data-sources.KEY.pool-prefill: Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
swarm.datasources.data-sources.KEY.pool-use-strict-min: Specifies if the min-pool-size should be considered strictly
swarm.datasources.data-sources.KEY.prepared-statements-cache-size: The number of prepared statements per connection in an LRU cache
swarm.datasources.data-sources.KEY.query-timeout: Any configured query timeout in seconds. If not provided no timeout will be set
swarm.datasources.data-sources.KEY.reauth-plugin-class-name: The fully qualified class name of the reauthentication plugin implementation
swarm.datasources.data-sources.KEY.reauth-plugin-properties: The properties for the reauthentication plugin
swarm.datasources.data-sources.KEY.security-domain: Specifies the PicketBox security domain which defines the PicketBox javax.security.auth.Subject that are used to distinguish connections in the pool
swarm.datasources.data-sources.KEY.set-tx-query-timeout: Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction
swarm.datasources.data-sources.KEY.share-prepared-statements: Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement
swarm.datasources.data-sources.KEY.spy: Enable spying of SQL statements
swarm.datasources.data-sources.KEY.stale-connection-checker-class-name: An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
swarm.datasources.data-sources.KEY.stale-connection-checker-properties: The stale connection checker properties
swarm.datasources.data-sources.KEY.statistics-enabled: Define whether runtime statistics are enabled or not.
swarm.datasources.data-sources.KEY.track-statements: Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed
swarm.datasources.data-sources.KEY.tracking: Defines if IronJacamar should track connection handles across transaction boundaries
swarm.datasources.data-sources.KEY.transaction-isolation: Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE. Different values are used to set customLevel using TransactionIsolation#customLevel
swarm.datasources.data-sources.KEY.url-delimiter: Specifies the delimiter for URLs in connection-url for HA datasources
swarm.datasources.data-sources.KEY.url-selector-strategy-class-name: A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy
swarm.datasources.data-sources.KEY.use-ccm: Enable the use of a cached connection manager
swarm.datasources.data-sources.KEY.use-fast-fail: Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)
swarm.datasources.data-sources.KEY.use-java-context: Setting this to false will bind the datasource into global JNDI
swarm.datasources.data-sources.KEY.use-try-lock: Any configured timeout for internal locks on the resource adapter objects in seconds
swarm.datasources.data-sources.KEY.user-name: Specify the user name used when creating a new connection
swarm.datasources.data-sources.KEY.valid-connection-checker-class-name: An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element
swarm.datasources.data-sources.KEY.valid-connection-checker-properties: The valid connection checker properties
swarm.datasources.data-sources.KEY.validate-on-match: The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation
swarm.datasources.installed-drivers: List of JDBC drivers that have been installed in the runtime
swarm.datasources.jdbc-drivers.KEY.deployment-name: The name of the deployment unit from which the driver was loaded
swarm.datasources.jdbc-drivers.KEY.driver-class-name: The fully qualified class name of the java.sql.Driver implementation
swarm.datasources.jdbc-drivers.KEY.driver-datasource-class-name: The fully qualified class name of the javax.sql.DataSource implementation
swarm.datasources.jdbc-drivers.KEY.driver-major-version: The driver’s major version number
swarm.datasources.jdbc-drivers.KEY.driver-minor-version: The driver’s minor version number
swarm.datasources.jdbc-drivers.KEY.driver-module-name: The name of the module from which the driver was loaded, if it was loaded from the module path
swarm.datasources.jdbc-drivers.KEY.driver-name: Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit
swarm.datasources.jdbc-drivers.KEY.driver-xa-datasource-class-name: The fully qualified class name of the javax.sql.XADataSource implementation
swarm.datasources.jdbc-drivers.KEY.jdbc-compliant: Whether or not the driver is JDBC compliant
swarm.datasources.jdbc-drivers.KEY.module-slot: The slot of the module from which the driver was loaded, if it was loaded from the module path
swarm.datasources.jdbc-drivers.KEY.profile: Domain Profile in which driver is defined. Null in case of standalone server
swarm.datasources.jdbc-drivers.KEY.xa-datasource-class: XA datasource class
swarm.datasources.xa-data-sources.KEY.allocation-retry: The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception
swarm.datasources.xa-data-sources.KEY.allocation-retry-wait-millis: The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection
swarm.datasources.xa-data-sources.KEY.allow-multiple-users: Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that
swarm.datasources.xa-data-sources.KEY.authentication-context: The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
swarm.datasources.xa-data-sources.KEY.background-validation: An element to specify that connections should be validated on a background thread versus being validated prior to use.
swarm.datasources.xa-data-sources.KEY.background-validation-millis: The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run.
swarm.datasources.xa-data-sources.KEY.blocking-timeout-wait-millis: The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time
swarm.datasources.xa-data-sources.KEY.capacity-decrementer-class: Class defining the policy for decrementing connections in the pool
swarm.datasources.xa-data-sources.KEY.capacity-decrementer-properties: Properties to inject in class defining the policy for decrementing connections in the pool
swarm.datasources.xa-data-sources.KEY.capacity-incrementer-class: Class defining the policy for incrementing connections in the pool
swarm.datasources.xa-data-sources.KEY.capacity-incrementer-properties: Properties to inject in class defining the policy for incrementing connections in the pool
swarm.datasources.xa-data-sources.KEY.check-valid-connection-sql: Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool
swarm.datasources.xa-data-sources.KEY.connectable: Enable the use of CMR for this datasource. This feature means that a local resource can reliably participate in an XA transaction.
swarm.datasources.xa-data-sources.KEY.connection-listener-class: Speciefies class name extending org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener that provides a possible to listen for connection activation and passivation in order to perform actions before the connection is returned to the application or returned to the pool.
swarm.datasources.xa-data-sources.KEY.connection-listener-property: Properties to be injected in class specified in connection-listener-class
swarm.datasources.xa-data-sources.KEY.credential-reference: Credential (from Credential Store) to authenticate on data source
swarm.datasources.xa-data-sources.KEY.driver-name: Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit
swarm.datasources.xa-data-sources.KEY.elytron-enabled: Enables Elytron security for handling authentication of connections for recovery. The Elytron authentication-context to be used will be current context if no context is specified (see authentication-context).
swarm.datasources.xa-data-sources.KEY.enlistment-trace: Defines if WildFly/IronJacamar should record enlistment traces
swarm.datasources.xa-data-sources.KEY.exception-sorter-class-name: An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error
swarm.datasources.xa-data-sources.KEY.exception-sorter-properties: The exception sorter properties
swarm.datasources.xa-data-sources.KEY.flush-strategy: Specifies how the pool should be flush in case of an error.
swarm.datasources.xa-data-sources.KEY.idle-timeout-minutes: The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
swarm.datasources.xa-data-sources.KEY.initial-pool-size: The initial-pool-size element indicates the initial number of connections a pool should hold.
swarm.datasources.xa-data-sources.KEY.interleaving: An element to enable interleaving for XA connections
swarm.datasources.xa-data-sources.KEY.jndi-name: Specifies the JNDI name for the datasource
swarm.datasources.xa-data-sources.KEY.max-pool-size: The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool
swarm.datasources.xa-data-sources.KEY.mcp: Defines the ManagedConnectionPool implementation, f.ex. org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool
swarm.datasources.xa-data-sources.KEY.min-pool-size: The min-pool-size element specifies the minimum number of connections for a pool
swarm.datasources.xa-data-sources.KEY.new-connection-sql: Specifies an SQL statement to execute whenever a connection is added to the connection pool
swarm.datasources.xa-data-sources.KEY.no-recovery: Specifies if the connection pool should be excluded from recovery
swarm.datasources.xa-data-sources.KEY.no-tx-separate-pool: Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts
swarm.datasources.xa-data-sources.KEY.pad-xid: Should the Xid be padded
swarm.datasources.xa-data-sources.KEY.password: Specifies the password used when creating a new connection
swarm.datasources.xa-data-sources.KEY.pool-fair: Defines if pool use should be fair
swarm.datasources.xa-data-sources.KEY.pool-prefill: Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise.
swarm.datasources.xa-data-sources.KEY.pool-use-strict-min: Specifies if the min-pool-size should be considered strictly
swarm.datasources.xa-data-sources.KEY.prepared-statements-cache-size: The number of prepared statements per connection in an LRU cache
swarm.datasources.xa-data-sources.KEY.query-timeout: Any configured query timeout in seconds. If not provided no timeout will be set
swarm.datasources.xa-data-sources.KEY.reauth-plugin-class-name: The fully qualified class name of the reauthentication plugin implementation
swarm.datasources.xa-data-sources.KEY.reauth-plugin-properties: The properties for the reauthentication plugin
swarm.datasources.xa-data-sources.KEY.recovery-authentication-context: The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
swarm.datasources.xa-data-sources.KEY.recovery-credential-reference: Credential (from Credential Store) to authenticate on data source
swarm.datasources.xa-data-sources.KEY.recovery-elytron-enabled: Enables Elytron security for handling authentication of connections for recovery. The Elytron authentication-context to be used will be current context if no context is specified (see authentication-context).
swarm.datasources.xa-data-sources.KEY.recovery-password: The password used for recovery
swarm.datasources.xa-data-sources.KEY.recovery-plugin-class-name: The fully qualified class name of the recovery plugin implementation
swarm.datasources.xa-data-sources.KEY.recovery-plugin-properties: The properties for the recovery plugin
swarm.datasources.xa-data-sources.KEY.recovery-security-domain: The security domain used for recovery
swarm.datasources.xa-data-sources.KEY.recovery-username: The user name used for recovery
swarm.datasources.xa-data-sources.KEY.same-rm-override: The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false
swarm.datasources.xa-data-sources.KEY.security-domain: Specifies the PicketBox security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool
swarm.datasources.xa-data-sources.KEY.set-tx-query-timeout: Whether to set the query timeout based on the time remaining until transaction timeout. Any configured query timeout will be used if there is no transaction
swarm.datasources.xa-data-sources.KEY.share-prepared-statements: Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement
swarm.datasources.xa-data-sources.KEY.spy: Enable spying of SQL statements
swarm.datasources.xa-data-sources.KEY.stale-connection-checker-class-name: An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException
swarm.datasources.xa-data-sources.KEY.stale-connection-checker-properties: The stale connection checker properties
swarm.datasources.xa-data-sources.KEY.statistics-enabled: Define whether runtime statistics are enabled or not.
swarm.datasources.xa-data-sources.KEY.track-statements: Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: "false" - do not track statements, "true" - track statements and result sets and warn when they are not closed, "nowarn" - track statements but do not warn about them being unclosed
swarm.datasources.xa-data-sources.KEY.tracking: Defines if IronJacamar should track connection handles across transaction boundaries
swarm.datasources.xa-data-sources.KEY.transaction-isolation: Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE. Different values are used to set customLevel using TransactionIsolation#customLevel.
swarm.datasources.xa-data-sources.KEY.url-delimiter: Specifies the delimiter for URLs in connection-url for HA datasources
swarm.datasources.xa-data-sources.KEY.url-property: Specifies the property for the URL property in the xa-datasource-property values
swarm.datasources.xa-data-sources.KEY.url-selector-strategy-class-name: A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy
swarm.datasources.xa-data-sources.KEY.use-ccm: Enable the use of a cached connection manager
swarm.datasources.xa-data-sources.KEY.use-fast-fail: Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false)
swarm.datasources.xa-data-sources.KEY.use-java-context: Setting this to false will bind the datasource into global JNDI
swarm.datasources.xa-data-sources.KEY.use-try-lock: Any configured timeout for internal locks on the resource adapter objects in seconds
swarm.datasources.xa-data-sources.KEY.user-name: Specify the user name used when creating a new connection
swarm.datasources.xa-data-sources.KEY.valid-connection-checker-class-name: An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element
swarm.datasources.xa-data-sources.KEY.valid-connection-checker-properties: The valid connection checker properties
swarm.datasources.xa-data-sources.KEY.validate-on-match: The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation
swarm.datasources.xa-data-sources.KEY.wrap-xa-resource: Should the XAResource instances be wrapped in an org.jboss.tm.XAResourceWrapper instance
swarm.datasources.xa-data-sources.KEY.xa-datasource-class: The fully qualified name of the javax.sql.XADataSource implementation
swarm.datasources.xa-data-sources.KEY.xa-datasource-properties.KEY.value: Specifies a property value to assign to the XADataSource implementation class. Each property is identified by the name attribute and the property value is given by the xa-datasource-property element content. The property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor
swarm.datasources.xa-data-sources.KEY.xa-resource-timeout: The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero
swarm.ds.connection.url: Default datasource connection URL
swarm.ds.name: Name of the default datasource
swarm.ds.password: Defatul datasource connection password
swarm.ds.username: Default datasource connection user name
swarm.jdbc.driver: Defatul datasource JDBC driver name

D.7. EE

An internal fraction used to support other higher-level fractions.

The EE fraction does not imply the totality of Java EE support.

If you require specific Java EE technologies, address them individually, for example jaxrs, cdi, datasources, or ejb.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>ee</artifactId>
</dependency>

Configuration

swarm.ee.annotation-property-replacement: Flag indicating whether Java EE annotations will have property replacements applied
swarm.ee.context-services.KEY.jndi-name: The JNDI Name to lookup the context service.
swarm.ee.context-services.KEY.use-transaction-setup-provider: Flag which indicates if the transaction setup provider should be used
swarm.ee.default-bindings-service.context-service: The JNDI name where the default EE Context Service can be found
swarm.ee.default-bindings-service.datasource: The JNDI name where the default EE Datasource can be found
swarm.ee.default-bindings-service.jms-connection-factory: The JNDI name where the default EE JMS Connection Factory can be found
swarm.ee.default-bindings-service.managed-executor-service: The JNDI name where the default EE Managed Executor Service can be found
swarm.ee.default-bindings-service.managed-scheduled-executor-service: The JNDI name where the default EE Managed Scheduled Executor Service can be found
swarm.ee.default-bindings-service.managed-thread-factory: The JNDI name where the default EE Managed Thread Factory can be found
swarm.ee.ear-subdeployments-isolated: Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear.
swarm.ee.global-modules: A list of modules that should be made available to all deployments.
swarm.ee.jboss-descriptor-property-replacement: Flag indicating whether JBoss specific deployment descriptors will have property replacements applied
swarm.ee.managed-executor-services.KEY.context-service: The name of the context service to be used by the executor.
swarm.ee.managed-executor-services.KEY.core-threads: The minimum number of threads to be used by the executor. If left undefined the default core-size is calculated based on the number of processors. A value of zero is not advised and in some cases invalid. See the queue-length attribute for details on how this value is used to determine the queuing strategy.
swarm.ee.managed-executor-services.KEY.hung-task-threshold: The runtime, in milliseconds, for tasks to be considered hung by the managed executor service. If value is 0 tasks are never considered hung.
swarm.ee.managed-executor-services.KEY.jndi-name: The JNDI Name to lookup the managed executor service.
swarm.ee.managed-executor-services.KEY.keepalive-time: When the number of threads is greater than the core, this is the maximum time, in milliseconds, that excess idle threads will wait for new tasks before terminating.
swarm.ee.managed-executor-services.KEY.long-running-tasks: Flag which hints the duration of tasks executed by the executor.
swarm.ee.managed-executor-services.KEY.max-threads: The maximum number of threads to be used by the executor. If left undefined the value from core-size will be used. This value is ignored if an unbounded queue is used (only core-threads will be used in that case).
swarm.ee.managed-executor-services.KEY.queue-length: The executors task queue capacity. A length of 0 means direct hand-off and possible rejection will occur. An undefined length (the default), or Integer.MAX_VALUE, indicates that an unbounded queue should be used. All other values specify an exact queue size. If an unbounded queue or direct hand-off is used, a core-threads value greater than zero is required.
swarm.ee.managed-executor-services.KEY.reject-policy: The policy to be applied to aborted tasks.
swarm.ee.managed-executor-services.KEY.thread-factory: The name of the thread factory to be used by the executor.
swarm.ee.managed-scheduled-executor-services.KEY.context-service: The name of the context service to be used by the scheduled executor.
swarm.ee.managed-scheduled-executor-services.KEY.core-threads: The minimum number of threads to be used by the scheduled executor.
swarm.ee.managed-scheduled-executor-services.KEY.hung-task-threshold: The runtime, in milliseconds, for tasks to be considered hung by the scheduled executor. If 0 tasks are never considered hung.
swarm.ee.managed-scheduled-executor-services.KEY.jndi-name: The JNDI Name to lookup the managed scheduled executor service.
swarm.ee.managed-scheduled-executor-services.KEY.keepalive-time: When the number of threads is greater than the core, this is the maximum time, in milliseconds, that excess idle threads will wait for new tasks before terminating.
swarm.ee.managed-scheduled-executor-services.KEY.long-running-tasks: Flag which hints the duration of tasks executed by the scheduled executor.
swarm.ee.managed-scheduled-executor-services.KEY.reject-policy: The policy to be applied to aborted tasks.
swarm.ee.managed-scheduled-executor-services.KEY.thread-factory: The name of the thread factory to be used by the scheduled executor.
swarm.ee.managed-thread-factories.KEY.context-service: The name of the context service to be used by the managed thread factory
swarm.ee.managed-thread-factories.KEY.jndi-name: The JNDI Name to lookup the managed thread factory.
swarm.ee.managed-thread-factories.KEY.priority: The priority applied to threads created by the factory
swarm.ee.spec-descriptor-property-replacement: Flag indicating whether descriptors defined by the Java EE specification will have property replacements applied

D.8. EJB

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>ejb</artifactId>
</dependency>

Configuration

swarm.ejb3.allow-ejb-name-regex: If this is true then regular expressions can be used in interceptor bindings to allow interceptors to be mapped to all beans that match the regular expression
swarm.ejb3.application-security-domains.KEY.enable-jacc: Enable authorization using JACC
swarm.ejb3.application-security-domains.KEY.referencing-deployments: The deployments currently referencing this mapping
swarm.ejb3.application-security-domains.KEY.security-domain: The Elytron security domain to be used by deployments that reference the mapped security domain
swarm.ejb3.async-service.thread-pool-name: The name of the thread pool which handles asynchronous invocations
swarm.ejb3.caches.KEY.aliases: The aliases by which this cache may also be referenced
swarm.ejb3.caches.KEY.passivation-store: The passivation store used by this cache
swarm.ejb3.cluster-passivation-stores.KEY.bean-cache: The name of the cache used to store bean instances.
swarm.ejb3.cluster-passivation-stores.KEY.cache-container: The name of the cache container used for the bean and client-mappings caches
swarm.ejb3.cluster-passivation-stores.KEY.idle-timeout: The timeout in units specified by idle-timeout-unit, after which a bean will passivate
swarm.ejb3.cluster-passivation-stores.KEY.max-size: The maximum number of beans this cache should store before forcing old beans to passivate
swarm.ejb3.default-clustered-sfsb-cache: Name of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level
swarm.ejb3.default-distinct-name: The default distinct name that is applied to every EJB deployed on this server
swarm.ejb3.default-entity-bean-instance-pool: Name of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level
swarm.ejb3.default-entity-bean-optimistic-locking: If set to true entity beans will use optimistic locking by default
swarm.ejb3.default-mdb-instance-pool: Name of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level
swarm.ejb3.default-missing-method-permissions-deny-access: If this is set to true then methods on an EJB with a security domain specified or with other methods with security metadata will have an implicit @DenyAll unless other security metadata is present
swarm.ejb3.default-resource-adapter-name: Name of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level
swarm.ejb3.default-security-domain: The default security domain that will be used for EJBs if the bean doesn’t explicitly specify one
swarm.ejb3.default-sfsb-cache: Name of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level
swarm.ejb3.default-sfsb-passivation-disabled-cache: Name of the default stateful bean cache, which will be applicable to all stateful EJBs which have passivation disabled. Each deployment or EJB can optionally override this cache name.
swarm.ejb3.default-singleton-bean-access-timeout: The default access timeout for singleton beans
swarm.ejb3.default-slsb-instance-pool: Name of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level
swarm.ejb3.default-stateful-bean-access-timeout: The default access timeout for stateful beans
swarm.ejb3.disable-default-ejb-permissions: This deprecated attribute has no effect and will be removed in a future release; it may never be set to a "false" value
swarm.ejb3.enable-graceful-txn-shutdown: Enabling txn graceful shutdown will make the server wait for active EJB-related transactions to complete before suspending. For that reason, if the server is running on a cluster, the suspending cluster node may receive ejb requests until all active transactions are complete. To avoid this behavior, omit this tag.
swarm.ejb3.enable-statistics: If set to true, enable the collection of invocation statistics. Deprecated in favour of "statistics-enabled"
swarm.ejb3.file-passivation-stores.KEY.idle-timeout: The timeout in units specified by idle-timeout-unit, after which a bean will passivate
swarm.ejb3.file-passivation-stores.KEY.max-size: The maximum number of beans this cache should store before forcing old beans to passivate
swarm.ejb3.identity-service.outflow-security-domains: References to security domains to attempt to outflow any established identity to
swarm.ejb3.iiop-service.enable-by-default: If this is true EJB’s will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor
swarm.ejb3.iiop-service.use-qualified-name: If true EJB names will be bound into the naming service with the application and module name prepended to the name (e.g. myapp/mymodule/MyEjb)
swarm.ejb3.in-vm-remote-interface-invocation-pass-by-value: If set to false, the parameters to invocations on remote interface of an EJB, will be passed by reference. Else, the parameters will be passed by value.
swarm.ejb3.log-system-exceptions: If this is true then all EJB system (not application) exceptions will be logged. The EJB spec mandates this behaviour, however it is not recommended as it will often result in exceptions being logged twice (once by the EJB and once by the calling code)
swarm.ejb3.mdb-delivery-groups.KEY.active: Indicates if delivery for all MDBs belonging to this group is active
swarm.ejb3.passivation-stores.KEY.bean-cache: The name of the cache used to store bean instances.
swarm.ejb3.passivation-stores.KEY.cache-container: The name of the cache container used for the bean and client-mappings caches
swarm.ejb3.passivation-stores.KEY.max-size: The maximum number of beans this cache should store before forcing old beans to passivate
swarm.ejb3.remote-service.channel-creation-options.KEY.type: The type of the channel creation option
swarm.ejb3.remote-service.channel-creation-options.KEY.value: The value for the EJB remote channel creation option
swarm.ejb3.remote-service.cluster: The name of the clustered cache container which will be used to store/access the client-mappings of the EJB remoting connector’s socket-binding on each node, in the cluster
swarm.ejb3.remote-service.connector-ref: The name of the connector on which the EJB3 remoting channel is registered
swarm.ejb3.remote-service.execute-in-worker: If this is true the EJB request will be executed in the IO subsystems worker, otherwise it will dispatch to the EJB thread pool
swarm.ejb3.remote-service.thread-pool-name: The name of the thread pool that handles remote invocations
swarm.ejb3.remoting-profiles.KEY.exclude-local-receiver: If set no local receiver is used in this profile
swarm.ejb3.remoting-profiles.KEY.local-receiver-pass-by-value: If set local receiver will pass ejb beans by value
swarm.ejb3.remoting-profiles.KEY.remoting-ejb-receivers.KEY.channel-creation-options.KEY.type: The type of the channel creation option
swarm.ejb3.remoting-profiles.KEY.remoting-ejb-receivers.KEY.channel-creation-options.KEY.value: The value for the EJB remote channel creation option
swarm.ejb3.remoting-profiles.KEY.remoting-ejb-receivers.KEY.connect-timeout: Remoting ejb receiver connect timeout
swarm.ejb3.remoting-profiles.KEY.remoting-ejb-receivers.KEY.outbound-connection-ref: Name of outbound connection that will be used by the ejb receiver
swarm.ejb3.remoting-profiles.KEY.static-ejb-discovery: Describes static discovery config for EJB’s
swarm.ejb3.statistics-enabled: If set to true, enable the collection of invocation statistics.
swarm.ejb3.strict-max-bean-instance-pools.KEY.derive-size: Specifies if and what the max pool size should be derived from. An undefined value (or the deprecated value 'none' which is converted to undefined) indicates that the explicit value of max-pool-size should be used. A value of 'from-worker-pools' indicates that the max pool size should be derived from the size of the total threads for all worker pools configured on the system. A value of 'from-cpu-count' indicates that the max pool size should be derived from the total number of processors available on the system. Note that the computation isn’t a 1:1 mapping, the values may or may not be augmented by other factors.
swarm.ejb3.strict-max-bean-instance-pools.KEY.max-pool-size: The maximum number of bean instances that the pool can hold at a given point in time
swarm.ejb3.strict-max-bean-instance-pools.KEY.timeout: The maximum amount of time to wait for a bean instance to be available from the pool
swarm.ejb3.strict-max-bean-instance-pools.KEY.timeout-unit: The instance acquisition timeout unit
swarm.ejb3.thread-pools.KEY.active-count: The approximate number of threads that are actively executing tasks.
swarm.ejb3.thread-pools.KEY.completed-task-count: The approximate total number of tasks that have completed execution.
swarm.ejb3.thread-pools.KEY.current-thread-count: The current number of threads in the pool.
swarm.ejb3.thread-pools.KEY.keepalive-time: Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.
swarm.ejb3.thread-pools.KEY.largest-thread-count: The largest number of threads that have ever simultaneously been in the pool.
swarm.ejb3.thread-pools.KEY.max-threads: The maximum thread pool size.
swarm.ejb3.thread-pools.KEY.name: The name of the thread pool.
swarm.ejb3.thread-pools.KEY.queue-size: The queue size.
swarm.ejb3.thread-pools.KEY.rejected-count: The number of tasks that have been rejected.
swarm.ejb3.thread-pools.KEY.task-count: The approximate total number of tasks that have ever been scheduled for execution.
swarm.ejb3.thread-pools.KEY.thread-factory: Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.
swarm.ejb3.timer-service.database-data-stores.KEY.allow-execution: If this node is allowed to execute timers. If this is false then the timers will be added to the database, and another node may execute them. Note that depending on your refresh interval if you add timers with a very short delay they will not be executed until another node refreshes.
swarm.ejb3.timer-service.database-data-stores.KEY.database: The type of database that is in use. SQL can be customised per database type.
swarm.ejb3.timer-service.database-data-stores.KEY.datasource-jndi-name: The datasource that is used to persist the timers
swarm.ejb3.timer-service.database-data-stores.KEY.partition: The partition name. This should be set to a different value for every node that is sharing a database to prevent the same timer being loaded by multiple noded.
swarm.ejb3.timer-service.database-data-stores.KEY.refresh-interval: Interval between refreshing the current timer set against the underlying database. A low value means timers get picked up more quickly, but increase load on the database.
swarm.ejb3.timer-service.default-data-store: The default data store used for persistent timers
swarm.ejb3.timer-service.file-data-stores.KEY.path: The directory to store persistent timer information in
swarm.ejb3.timer-service.file-data-stores.KEY.relative-to: The relative path that is used to resolve the timer data store location
swarm.ejb3.timer-service.thread-pool-name: The name of the thread pool used to run timer service invocations

D.9. Elytron

Elytron can generate the audit log to the same directory where the Thorntail application is executed. Include the following section in the project-defaults.yml file in your application:

swarm:
  elytron:
    file-audit-logs:
      local-audit:
        path: audit.log

In some environments, for example cloud, you might have to relocate the audit file to a globally writable directory, for example:

swarm:
  elytron:
    file-audit-logs:
      local-audit:
        path: /tmp/audit.log

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>elytron</artifactId>
</dependency>

Configuration

swarm.elytron.add-prefix-role-mappers.KEY.prefix: The prefix to add to each role.
swarm.elytron.add-suffix-role-mappers.KEY.suffix: The suffix to add to each role.
swarm.elytron.aggregate-http-server-mechanism-factories.KEY.available-mechanisms: The HTTP mechanisms available from this factory instance.
swarm.elytron.aggregate-http-server-mechanism-factories.KEY.http-server-mechanism-factories: The referenced http server factories to aggregate.
swarm.elytron.aggregate-principal-decoders.KEY.principal-decoders: The referenced principal decoders to aggregate.
swarm.elytron.aggregate-principal-transformers.KEY.principal-transformers: The referenced principal transformers to aggregate.
swarm.elytron.aggregate-providers.KEY.providers: The referenced Provider[] resources to aggregate.
swarm.elytron.aggregate-realms.KEY.authentication-realm: Reference to the security realm to use for authentication steps (obtaining or validating credentials).
swarm.elytron.aggregate-realms.KEY.authorization-realm: Reference to the security realm to use for loading the identity for authorization steps (loading of the identity).
swarm.elytron.aggregate-role-mappers.KEY.role-mappers: The referenced role mappers to aggregate.
swarm.elytron.aggregate-sasl-server-factories.KEY.available-mechanisms: The SASL mechanisms available from this factory after all filtering has been applied.
swarm.elytron.aggregate-sasl-server-factories.KEY.sasl-server-factories: The referenced sasl server factories to aggregate.
swarm.elytron.aggregate-security-event-listeners.KEY.security-event-listeners: The referenced security event listener resources to aggregate.
swarm.elytron.authentication-configurations.KEY.anonymous: Enables anonymous authentication.
swarm.elytron.authentication-configurations.KEY.attribute-extends: A previously defined authentication configuration to extend.
swarm.elytron.authentication-configurations.KEY.authentication-name: The authentication name to use.
swarm.elytron.authentication-configurations.KEY.authorization-name: The authorization name to use.
swarm.elytron.authentication-configurations.KEY.credential-reference: The reference to credential stored in CredentialStore under defined alias or clear text password.
swarm.elytron.authentication-configurations.KEY.forwarding-mode: The type of security identity forwarding to use. A mode of 'authentication' forwarding forwards the principal and credential. A mode of 'authorization' forwards the authorization id, allowing for a different authentication identity.
swarm.elytron.authentication-configurations.KEY.host: The host to use.
swarm.elytron.authentication-configurations.KEY.kerberos-security-factory: Reference to a kerberos security factory used to obtain a GSS kerberos credential
swarm.elytron.authentication-configurations.KEY.mechanism-properties: Configuration properties for the SASL authentication mechanism.
swarm.elytron.authentication-configurations.KEY.port: The port to use.
swarm.elytron.authentication-configurations.KEY.protocol: The protocol to use.
swarm.elytron.authentication-configurations.KEY.realm: The realm to use.
swarm.elytron.authentication-configurations.KEY.sasl-mechanism-selector: The SASL mechanism selector string.
swarm.elytron.authentication-configurations.KEY.security-domain: Reference to a security domain to obtain a forwarded identity.
swarm.elytron.authentication-contexts.KEY.attribute-extends: A previously defined authentication context to extend.
swarm.elytron.authentication-contexts.KEY.match-rules: The match-rules for this authentication context.
swarm.elytron.caching-realms.KEY.maximum-age: The time in milliseconds that an item can stay in the cache.
swarm.elytron.caching-realms.KEY.maximum-entries: The maximum number of entries to keep in the cache.
swarm.elytron.caching-realms.KEY.realm: A reference to a cacheable security realm.
swarm.elytron.chained-principal-transformers.KEY.principal-transformers: The referenced principal transformers to chain.
swarm.elytron.client-ssl-contexts.KEY.active-session-count: The count of current active sessions.
swarm.elytron.client-ssl-contexts.KEY.cipher-suite-filter: The filter to apply to specify the enabled cipher suites.
swarm.elytron.client-ssl-contexts.KEY.key-manager: Reference to the key manager to use within the SSLContext.
swarm.elytron.client-ssl-contexts.KEY.protocols: The enabled protocols.
swarm.elytron.client-ssl-contexts.KEY.provider-name: The name of the provider to use. If not specified, all providers from providers will be passed to the SSLContext.
swarm.elytron.client-ssl-contexts.KEY.providers: The name of the providers to obtain the Provider[] to use to load the SSLContext.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.application-buffer-size: The application buffer size as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.cipher-suite: The selected cipher suite as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.creation-time: The creation time as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.last-accessed-time: The last accessed time as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.local-certificates: The local certificates from the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.local-principal: The local principal as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.packet-buffer-size: The packet buffer size as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.peer-certificates: The peer certificates from the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.peer-host: The peer host as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.peer-port: The peer port as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.peer-principal: The peer principal as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.protocol: The protocol as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.ssl-sessions.KEY.valid: The validity of the session as reported by the SSLSession.
swarm.elytron.client-ssl-contexts.KEY.trust-manager: Reference to the trust manager to use within the SSLContext.
swarm.elytron.concatenating-principal-decoders.KEY.joiner: The string to use to join the results of the referenced principal decoders.
swarm.elytron.concatenating-principal-decoders.KEY.principal-decoders: The referenced principal decoders to concatenate.
swarm.elytron.configurable-http-server-mechanism-factories.KEY.available-mechanisms: The HTTP mechanisms available from this factory instance.
swarm.elytron.configurable-http-server-mechanism-factories.KEY.filters: Filtering to be applied to enable / disable mechanisms based on the name.
swarm.elytron.configurable-http-server-mechanism-factories.KEY.http-server-mechanism-factory: The http server factory to be wrapped.
swarm.elytron.configurable-http-server-mechanism-factories.KEY.properties: Custom properties to be passed in to the http server factory calls.
swarm.elytron.configurable-sasl-server-factories.KEY.available-mechanisms: The SASL mechanisms available from this factory after all filtering has been applied.
swarm.elytron.configurable-sasl-server-factories.KEY.filters: List of filters to be evaluated sequentially combining the results using 'or'.
swarm.elytron.configurable-sasl-server-factories.KEY.properties: Custom properties to be passed in to the sasl server factory calls.
swarm.elytron.configurable-sasl-server-factories.KEY.protocol: The protocol that should be passed into factory when creating the mechanism.
swarm.elytron.configurable-sasl-server-factories.KEY.sasl-server-factory: The sasl server factory to be wrapped.
swarm.elytron.configurable-sasl-server-factories.KEY.server-name: The server name that should be passed into factory when creating the mechanism.
swarm.elytron.constant-permission-mappers.KEY.permissions: The permissions to assign.
swarm.elytron.constant-principal-decoders.KEY.constant: The constant value the principal decoder will always return.
swarm.elytron.constant-principal-transformers.KEY.constant: The constant value this PrincipalTransformer will always return.
swarm.elytron.constant-realm-mappers.KEY.realm-name: The name of the constant realm to return.
swarm.elytron.constant-role-mappers.KEY.roles: The constant roles to be returned by this role mapper.
swarm.elytron.credential-stores.KEY.create: Specifies whether credential store should create storage when it doesn’t exist.
swarm.elytron.credential-stores.KEY.credential-reference: Credential reference to be used to create protection parameter.
swarm.elytron.credential-stores.KEY.implementation-properties: Map of credentials store implementation specific properties.
swarm.elytron.credential-stores.KEY.location: File name of credential store storage.
swarm.elytron.credential-stores.KEY.modifiable: Specifies whether credential store is modifiable.
swarm.elytron.credential-stores.KEY.other-providers: The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required JCA objects within credential store. This is valid only for key-store based CredentialStore. If this is not specified then the global list of Providers is used instead.
swarm.elytron.credential-stores.KEY.provider-name: The name of the provider to use to instantiate the CredentialStoreSpi. If the provider is not specified then the first provider found that can create an instance of the specified 'type' will be used.
swarm.elytron.credential-stores.KEY.providers: The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required CredentialStore type. If this is not specified then the global list of Providers is used instead.
swarm.elytron.credential-stores.KEY.relative-to: A reference to a previously defined path that the file name is relative to.
swarm.elytron.credential-stores.KEY.state: The state of the underlying service that represents this credential store at runtime.
swarm.elytron.credential-stores.KEY.type: The credential store type, e.g. KeyStoreCredentialStore.
swarm.elytron.custom-credential-security-factories.KEY.class-name: The class name of the implementation of the custom security factory.
swarm.elytron.custom-credential-security-factories.KEY.configuration: The optional key/value configuration for the custom security factory.
swarm.elytron.custom-credential-security-factories.KEY.module: The module to use to load the custom security factory.
swarm.elytron.custom-modifiable-realms.KEY.class-name: The class name of the implementation of the custom realm.
swarm.elytron.custom-modifiable-realms.KEY.configuration: The optional key/value configuration for the custom realm.
swarm.elytron.custom-modifiable-realms.KEY.module: The module to use to load the custom realm.
swarm.elytron.custom-permission-mappers.KEY.class-name: Fully qualified class name of the permission mapper
swarm.elytron.custom-permission-mappers.KEY.configuration: The optional kay/value configuration for the permission mapper
swarm.elytron.custom-permission-mappers.KEY.module: Name of the module to use to load the permission mapper
swarm.elytron.custom-principal-decoders.KEY.class-name: Fully qualified class name of the principal decoder
swarm.elytron.custom-principal-decoders.KEY.configuration: The optional kay/value configuration for the principal decoder
swarm.elytron.custom-principal-decoders.KEY.module: Name of the module to use to load the principal decoder
swarm.elytron.custom-principal-transformers.KEY.class-name: The class name of the implementation of the custom principal transformer.
swarm.elytron.custom-principal-transformers.KEY.configuration: The optional key/value configuration for the custom principal transformer.
swarm.elytron.custom-principal-transformers.KEY.module: The module to use to load the custom principal transformer.
swarm.elytron.custom-realm-mappers.KEY.class-name: Fully qualified class name of the RealmMapper
swarm.elytron.custom-realm-mappers.KEY.configuration: The optional kay/value configuration for the RealmMapper
swarm.elytron.custom-realm-mappers.KEY.module: Name of the module to use to load the RealmMapper
swarm.elytron.custom-realms.KEY.class-name: The class name of the implementation of the custom realm.
swarm.elytron.custom-realms.KEY.configuration: The optional key/value configuration for the custom realm.
swarm.elytron.custom-realms.KEY.module: The module to use to load the custom realm.
swarm.elytron.custom-role-decoders.KEY.class-name: Fully qualified class name of the RoleDecoder
swarm.elytron.custom-role-decoders.KEY.configuration: The optional kay/value configuration for the RoleDecoder
swarm.elytron.custom-role-decoders.KEY.module: Name of the module to use to load the RoleDecoder
swarm.elytron.custom-role-mappers.KEY.class-name: Fully qualified class name of the RoleMapper
swarm.elytron.custom-role-mappers.KEY.configuration: The optional key/value configuration for the RoleMapper
swarm.elytron.custom-role-mappers.KEY.module: Name of the module to use to load the RoleMapper
swarm.elytron.default-authentication-context: The default authentication context to be associated with all deployments.
swarm.elytron.dir-contexts.KEY.authentication-context: The authentication context to obtain login credentials to connect to the LDAP server. Can be omitted if authentication-level is "none" (anonymous).
swarm.elytron.dir-contexts.KEY.authentication-level: The authentication level (security level/authentication mechanism) to use. Corresponds to SECURITY_AUTHENTICATION ("java.naming.security.authentication") environment property. Allowed values: "none", "simple", sasl_mech, where sasl_mech is a space-separated list of SASL mechanism names.
swarm.elytron.dir-contexts.KEY.connection-timeout: The timeout for connecting to the LDAP server in milliseconds.
swarm.elytron.dir-contexts.KEY.credential-reference: The credential reference to authenticate and connect to the LDAP server. Can be omitted if authentication-level is "none" (anonymous).
swarm.elytron.dir-contexts.KEY.enable-connection-pooling: Indicates if connection pooling is enabled.
swarm.elytron.dir-contexts.KEY.module: Name of module that will be used as class loading base.
swarm.elytron.dir-contexts.KEY.principal: The principal to authenticate and connect to the LDAP server. Can be omitted if authentication-level is "none" (anonymous).
swarm.elytron.dir-contexts.KEY.properties: The additional connection properties for the DirContext.
swarm.elytron.dir-contexts.KEY.read-timeout: The read timeout for an LDAP operation in milliseconds.
swarm.elytron.dir-contexts.KEY.referral-mode: If referrals should be followed.
swarm.elytron.dir-contexts.KEY.ssl-context: The name of ssl-context used to secure connection to the LDAP server.
swarm.elytron.dir-contexts.KEY.url: The connection url.
swarm.elytron.disallowed-providers: A list of providers that are not allowed, and will be removed from the providers list.
swarm.elytron.file-audit-logs.KEY.attribute-synchronized: Whether every event should be immediately synchronised to disk.
swarm.elytron.file-audit-logs.KEY.format: The format to use to record the audit event.
swarm.elytron.file-audit-logs.KEY.path: Path of the file to be written.
swarm.elytron.file-audit-logs.KEY.relative-to: The relative path to the audit log.
swarm.elytron.filesystem-realms.KEY.encoded: Whether the identity names should be stored encoded (Base32) in file names.
swarm.elytron.filesystem-realms.KEY.levels: The number of levels of directory hashing to apply.
swarm.elytron.filesystem-realms.KEY.path: The path to the file containing the realm.
swarm.elytron.filesystem-realms.KEY.relative-to: The pre-defined path the path is relative to.
swarm.elytron.filtering-key-stores.KEY.alias-filter: A filter to apply to the aliases returned from the KeyStore, can either be a comma separated list of aliases to return or one of the following formats ALL:-alias1:-alias2, NONE:+alias1:+alias2
swarm.elytron.filtering-key-stores.KEY.key-store: Name of filtered KeyStore.
swarm.elytron.filtering-key-stores.KEY.state: The state of the underlying service that represents this KeyStore at runtime, if it is anything other than UP runtime operations will not be available.
swarm.elytron.final-providers: Reference to the Providers that should be registered after all existing Providers.
swarm.elytron.http-authentication-factories.KEY.available-mechanisms: The HTTP mechanisms available from this configuration after all filtering has been applied.
swarm.elytron.http-authentication-factories.KEY.http-server-mechanism-factory: The HttpServerAuthenticationMechanismFactory to associate with this resource
swarm.elytron.http-authentication-factories.KEY.mechanism-configurations: Mechanism specific configuration
swarm.elytron.http-authentication-factories.KEY.security-domain: The SecurityDomain to associate with this resource
swarm.elytron.identity-realms.KEY.attribute-name: The name of the attribute associated with this identity.
swarm.elytron.identity-realms.KEY.attribute-values: The values associated with the identities attribute.
swarm.elytron.identity-realms.KEY.identity: The identity available from the security realm.
swarm.elytron.initial-providers: Reference to the Providers that should be registered ahead of all existing Providers.
swarm.elytron.jdbc-realms.KEY.principal-query: The authentication query used to authenticate users based on specific key types.
swarm.elytron.kerberos-security-factories.KEY.debug: Should the JAAS step of obtaining the credential have debug logging enabled.
swarm.elytron.kerberos-security-factories.KEY.mechanism-names: The mechanism names the credential should be usable with. Names will be converted to OIDs and used together with OIDs from mechanism-oids attribute.
swarm.elytron.kerberos-security-factories.KEY.mechanism-oids: The mechanism OIDs the credential should be usable with. Will be used together with OIDs derived from names from mechanism-names attribute.
swarm.elytron.kerberos-security-factories.KEY.minimum-remaining-lifetime: How much lifetime (in seconds) should a cached credential have remaining before it is recreated.
swarm.elytron.kerberos-security-factories.KEY.obtain-kerberos-ticket: Should the KerberosTicket also be obtained and associated with the credential. This is required to be true where credentials are delegated to the server.
swarm.elytron.kerberos-security-factories.KEY.options: The Krb5LoginModule additional options.
swarm.elytron.kerberos-security-factories.KEY.path: The path of the KeyTab to load to obtain the credential.
swarm.elytron.kerberos-security-factories.KEY.principal: The principal represented by the KeyTab
swarm.elytron.kerberos-security-factories.KEY.relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
swarm.elytron.kerberos-security-factories.KEY.request-lifetime: How much lifetime (in seconds) should be requested for newly created credentials.
swarm.elytron.kerberos-security-factories.KEY.required: Is the keytab file with adequate principal required to exist at the time the service starts?
swarm.elytron.kerberos-security-factories.KEY.server: If this for use server side or client side?
swarm.elytron.kerberos-security-factories.KEY.wrap-gss-credential: Should generated GSS credentials be wrapped to prevent improper disposal or not?
swarm.elytron.key-managers.KEY.algorithm: The name of the algorithm to use to create the underlying KeyManagerFactory.
swarm.elytron.key-managers.KEY.alias-filter: A filter to apply to the aliases returned from the KeyStore, can either be a comma separated list of aliases to return or one of the following formats ALL:-alias1:-alias2, NONE:+alias1:+alias2
swarm.elytron.key-managers.KEY.credential-reference: The credential reference to decrypt KeyStore item. (Not a password of the KeyStore.)
swarm.elytron.key-managers.KEY.key-store: Reference to the KeyStore to use to initialise the underlying KeyManagerFactory.
swarm.elytron.key-managers.KEY.provider-name: The name of the provider to use to create the underlying KeyManagerFactory.
swarm.elytron.key-managers.KEY.providers: Reference to obtain the Provider[] to use when creating the underlying KeyManagerFactory.
swarm.elytron.key-store-realms.KEY.key-store: Reference to the KeyStore that should be used to back this security realm.
swarm.elytron.key-stores.KEY.alias-filter: A filter to apply to the aliases returned from the KeyStore, can either be a comma separated list of aliases to return or one of the following formats ALL:-alias1:-alias2, NONE:+alias1:+alias2
swarm.elytron.key-stores.KEY.attribute-synchronized: The time this KeyStore was last loaded or saved. Note: Some providers may continue to apply updates after the KeyStore was loaded within the application server.
swarm.elytron.key-stores.KEY.credential-reference: The reference to credential stored in CredentialStore under defined alias or clear text password.
swarm.elytron.key-stores.KEY.loaded-provider: Information about the provider that was used for this KeyStore.
swarm.elytron.key-stores.KEY.modified: Indicates if the in-memory representation of the KeyStore has been changed since it was last loaded or stored. Note: For some providers updates may be immediate without further load or store calls.
swarm.elytron.key-stores.KEY.path: The path to the KeyStore file.
swarm.elytron.key-stores.KEY.provider-name: The name of the provider to use to load the KeyStore, disables searching for the first Provider that can create a KeyStore of the specified type.
swarm.elytron.key-stores.KEY.providers: A reference to the providers that should be used to obtain the list of Provider instances to search, if not specified the global list of providers will be used instead.
swarm.elytron.key-stores.KEY.relative-to: The base path this store is relative to.
swarm.elytron.key-stores.KEY.required: Is the file required to exist at the time the KeyStore service starts?
swarm.elytron.key-stores.KEY.size: The number of entries in the KeyStore.
swarm.elytron.key-stores.KEY.state: The state of the underlying service that represents this KeyStore at runtime, if it is anything other than UP runtime operations will not be available.
swarm.elytron.key-stores.KEY.type: The type of the KeyStore, used when creating the new KeyStore instance.
swarm.elytron.ldap-key-stores.KEY.alias-attribute: The name of LDAP attribute, where will be item alias stored.
swarm.elytron.ldap-key-stores.KEY.certificate-attribute: The name of LDAP attribute, where will be certificate stored.
swarm.elytron.ldap-key-stores.KEY.certificate-chain-attribute: The name of LDAP attribute, where will be certificate chain stored.
swarm.elytron.ldap-key-stores.KEY.certificate-chain-encoding: The encoding of the certificate chain.
swarm.elytron.ldap-key-stores.KEY.certificate-type: The type of the Certificate.
swarm.elytron.ldap-key-stores.KEY.dir-context: The name of DirContext, which will be used to communication with LDAP server.
swarm.elytron.ldap-key-stores.KEY.filter-alias: The LDAP filter for obtaining an item of the KeyStore by alias. If this is not specified then the default value will be (alias_attribute={0}). The string '{0}' will be replaced by the searched alias and the 'alias_attribute' value will be the value of the attribute 'alias-attribute'.
swarm.elytron.ldap-key-stores.KEY.filter-certificate: The LDAP filter for obtaining an item of the KeyStore by certificate. If this is not specified then the default value will be (certificate_attribute={0}). The string '{0}' will be replaced by searched encoded certificate and the 'certificate_attribute' will be the value of the attribute 'certificate-attribute'.
swarm.elytron.ldap-key-stores.KEY.filter-iterate: The LDAP filter for iterating over all items of the KeyStore. If this is not specified then the default value will be (alias_attribute=*). The 'alias_attribute' will be the value of the attribute 'alias-attribute'.
swarm.elytron.ldap-key-stores.KEY.key-attribute: The name of LDAP attribute, where will be key stored.
swarm.elytron.ldap-key-stores.KEY.key-type: The type of KeyStore, in which will be key serialized to LDAP attribute.
swarm.elytron.ldap-key-stores.KEY.new-item-template: Configuration for item creation. Define how will look LDAP entry of newly created keystore item.
swarm.elytron.ldap-key-stores.KEY.search-path: The path in LDAP, where will be KeyStore items searched.
swarm.elytron.ldap-key-stores.KEY.search-recursive: If the LDAP search should be recursive.
swarm.elytron.ldap-key-stores.KEY.search-time-limit: The time limit for obtaining keystore items from LDAP.
swarm.elytron.ldap-key-stores.KEY.size: The size of LDAP KeyStore in amount of items/aliases.
swarm.elytron.ldap-key-stores.KEY.state: The state of the underlying service that represents this KeyStore at runtime, if it is anything other than UP runtime operations will not be available.
swarm.elytron.ldap-realms.KEY.allow-blank-password: Does this realm support blank password direct verification? Blank password attempt will be rejected otherwise.
swarm.elytron.ldap-realms.KEY.dir-context: The configuration to connect to a LDAP server.
swarm.elytron.ldap-realms.KEY.direct-verification: Does this realm support verification of credentials by directly connecting to LDAP as the account being authenticated?
swarm.elytron.ldap-realms.KEY.identity-mapping: The configuration options that define how principals are mapped to their corresponding entries in the underlying LDAP server.
swarm.elytron.logical-permission-mappers.KEY.left: Reference to the permission mapper to use to the left of the operation.
swarm.elytron.logical-permission-mappers.KEY.logical-operation: The logical operation to use to combine the permission mappers.
swarm.elytron.logical-permission-mappers.KEY.right: Reference to the permission mapper to use to the right of the operation.
swarm.elytron.logical-role-mappers.KEY.left: Reference to a role mapper to be used on the left side of the operation.
swarm.elytron.logical-role-mappers.KEY.logical-operation: The logical operation to be performed on the role mapper mappings.
swarm.elytron.logical-role-mappers.KEY.right: Reference to a role mapper to be used on the right side of the operation.
swarm.elytron.mapped-regex-realm-mappers.KEY.delegate-realm-mapper: The RealmMapper to delegate to if the pattern does not match. If no delegate is specified then the default realm on the domain will be used instead. If the username does not match the pattern and a delegate realm-mapper is present, the result of delegate-realm-mapper is mapped via the realm-map.
swarm.elytron.mapped-regex-realm-mappers.KEY.pattern: The regular expression which must contain at least one capture group to extract the realm from the name. If the regular expression matches more than one capture group, the first capture group is used.
swarm.elytron.mapped-regex-realm-mappers.KEY.realm-map: Mapping of realm name extracted using the regular expression to a defined realm name. If the value for the mapping is not in the map or the realm whose name is the result of the mapping does not exist in the given security domain, the default realm is used.
swarm.elytron.mechanism-provider-filtering-sasl-server-factories.KEY.available-mechanisms: The SASL mechanisms available from this factory after all filtering has been applied.
swarm.elytron.mechanism-provider-filtering-sasl-server-factories.KEY.enabling: When set to 'true' no provider loaded mechanisms are enabled unless matched by one of the filters, setting to 'false' has the inverse effect.
swarm.elytron.mechanism-provider-filtering-sasl-server-factories.KEY.filters: The filters to apply when comparing the mechanisms from the providers, a filter matches when all of the specified values match the mechanism / provider pair.
swarm.elytron.mechanism-provider-filtering-sasl-server-factories.KEY.sasl-server-factory: Reference to a sasl server factory to be wrapped by this definition.
swarm.elytron.periodic-rotating-file-audit-logs.KEY.attribute-synchronized: Whether every event should be immediately synchronised to disk.
swarm.elytron.periodic-rotating-file-audit-logs.KEY.format: The format to use to record the audit event.
swarm.elytron.periodic-rotating-file-audit-logs.KEY.path: Path of the file to be written.
swarm.elytron.periodic-rotating-file-audit-logs.KEY.relative-to: The relative path to the audit log.
swarm.elytron.periodic-rotating-file-audit-logs.KEY.suffix: The suffix string in a format which can be understood by java.time.format.DateTimeFormatter. The period of the rotation is automatically calculated based on the suffix.
swarm.elytron.policies.KEY.custom-policy: A custom policy provider definition.
swarm.elytron.policies.KEY.jacc-policy: A policy provider definition that sets up JACC and related services.
swarm.elytron.properties-realms.KEY.attribute-synchronized: The time the properties files that back this realm were last loaded.
swarm.elytron.properties-realms.KEY.groups-attribute: The name of the attribute in the returned AuthorizationIdentity that should contain the group membership information for the identity.
swarm.elytron.properties-realms.KEY.groups-properties: The properties file containing the users and their groups.
swarm.elytron.properties-realms.KEY.users-properties: The properties file containing the users and their passwords.
swarm.elytron.provider-http-server-mechanism-factories.KEY.available-mechanisms: The HTTP mechanisms available from this factory instance.
swarm.elytron.provider-http-server-mechanism-factories.KEY.providers: The providers to use to locate the factories, if not specified the globally registered list of Providers will be used.
swarm.elytron.provider-loaders.KEY.argument: An argument to be passed into the constructor as the Provider is instantiated.
swarm.elytron.provider-loaders.KEY.class-names: The fully qualified class names of the providers to load, these are loaded after the service-loader discovered providers and duplicates will be skipped.
swarm.elytron.provider-loaders.KEY.configuration: The key/value configuration to be passed to the Provider to initialise it.
swarm.elytron.provider-loaders.KEY.loaded-providers: The list of providers loaded by this provider loader.
swarm.elytron.provider-loaders.KEY.module: The name of the module to load the provider from.
swarm.elytron.provider-loaders.KEY.path: The path of the file to use to initialise the providers.
swarm.elytron.provider-loaders.KEY.relative-to: The base path of the configuration file.
swarm.elytron.provider-sasl-server-factories.KEY.available-mechanisms: The SASL mechanisms available from this factory after all filtering has been applied.
swarm.elytron.provider-sasl-server-factories.KEY.providers: The providers to use to locate the factories, if not specified the globally registered list of Providers will be used.
swarm.elytron.regex-principal-transformers.KEY.pattern: The regular expression to use to locate the portion of the name to be replaced.
swarm.elytron.regex-principal-transformers.KEY.replace-all: Should all occurrences of the pattern matched be replaced or only the first occurrence.
swarm.elytron.regex-principal-transformers.KEY.replacement: The value to be used as the replacement.
swarm.elytron.regex-validating-principal-transformers.KEY.match: If set to true, the name must match the given pattern to make validation successful. If set to false, the name must not match the given pattern to make validation successful.
swarm.elytron.regex-validating-principal-transformers.KEY.pattern: The regular expression to use for the principal transformer.
swarm.elytron.sasl-authentication-factories.KEY.available-mechanisms: The SASL mechanisms available from this configuration after all filtering has been applied.
swarm.elytron.sasl-authentication-factories.KEY.mechanism-configurations: Mechanism specific configuration
swarm.elytron.sasl-authentication-factories.KEY.sasl-server-factory: The SaslServerFactory to associate with this resource
swarm.elytron.sasl-authentication-factories.KEY.security-domain: The SecurityDomain to associate with this resource
swarm.elytron.security-domains.KEY.default-realm: The default realm contained by this security domain.
swarm.elytron.security-domains.KEY.outflow-anonymous: When outflowing to a security domain if outflow is not possible should the anonymous identity be used? Outflowing anonymous has the effect of clearing any identity already established for that domain.
swarm.elytron.security-domains.KEY.outflow-security-domains: The list of security domains that the security identity from this domain should automatically outflow to.
swarm.elytron.security-domains.KEY.permission-mapper: A reference to a PermissionMapper to be used by this domain.
swarm.elytron.security-domains.KEY.post-realm-principal-transformer: A reference to a principal transformer to be applied after the realm has operated on the supplied identity name.
swarm.elytron.security-domains.KEY.pre-realm-principal-transformer: A reference to a principal transformer to be applied before the realm is selected.
swarm.elytron.security-domains.KEY.principal-decoder: A reference to a PrincipalDecoder to be used by this domain.
swarm.elytron.security-domains.KEY.realm-mapper: Reference to the RealmMapper to be used by this domain.
swarm.elytron.security-domains.KEY.realms: The list of realms contained by this security domain.
swarm.elytron.security-domains.KEY.role-mapper: Reference to the RoleMapper to be used by this domain.
swarm.elytron.security-domains.KEY.security-event-listener: Reference to a listener for security events.
swarm.elytron.security-domains.KEY.trusted-security-domains: The list of security domains that are trusted by this security domain.
swarm.elytron.security-properties: Security properties to be set.
swarm.elytron.server-ssl-contexts.KEY.active-session-count: The count of current active sessions.
swarm.elytron.server-ssl-contexts.KEY.authentication-optional: Rejecting of the client certificate by the security domain will not prevent the connection. Allows a fall through to use other authentication mechanisms (like form login) when the client certificate is rejected by security domain. Has an effect only when the security domain is set.
swarm.elytron.server-ssl-contexts.KEY.cipher-suite-filter: The filter to apply to specify the enabled cipher suites.
swarm.elytron.server-ssl-contexts.KEY.final-principal-transformer: A final principal transformer to apply for this mechanism realm.
swarm.elytron.server-ssl-contexts.KEY.key-manager: Reference to the key manager to use within the SSLContext.
swarm.elytron.server-ssl-contexts.KEY.maximum-session-cache-size: The maximum number of SSL sessions in the cache. The default value -1 means use the JVM default value. Value zero means there is no limit.
swarm.elytron.server-ssl-contexts.KEY.need-client-auth: To require a client certificate on SSL handshake. Connection without trusted client certificate (see trust-manager) will be rejected.
swarm.elytron.server-ssl-contexts.KEY.post-realm-principal-transformer: A principal transformer to apply after the realm is selected.
swarm.elytron.server-ssl-contexts.KEY.pre-realm-principal-transformer: A principal transformer to apply before the realm is selected.
swarm.elytron.server-ssl-contexts.KEY.protocols: The enabled protocols.
swarm.elytron.server-ssl-contexts.KEY.provider-name: The name of the provider to use. If not specified, all providers from providers will be passed to the SSLContext.
swarm.elytron.server-ssl-contexts.KEY.providers: The name of the providers to obtain the Provider[] to use to load the SSLContext.
swarm.elytron.server-ssl-contexts.KEY.realm-mapper: The realm mapper to be used for SSL authentication.
swarm.elytron.server-ssl-contexts.KEY.security-domain: The security domain to use for authentication during SSL session establishment.
swarm.elytron.server-ssl-contexts.KEY.session-timeout: The timeout for SSL sessions, in seconds. The default value -1 means use the JVM default value. Value zero means there is no limit.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.application-buffer-size: The application buffer size as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.cipher-suite: The selected cipher suite as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.creation-time: The creation time as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.last-accessed-time: The last accessed time as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.local-certificates: The local certificates from the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.local-principal: The local principal as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.packet-buffer-size: The packet buffer size as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.peer-certificates: The peer certificates from the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.peer-host: The peer host as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.peer-port: The peer port as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.peer-principal: The peer principal as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.protocol: The protocol as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.ssl-sessions.KEY.valid: The validity of the session as reported by the SSLSession.
swarm.elytron.server-ssl-contexts.KEY.trust-manager: Reference to the trust manager to use within the SSLContext.
swarm.elytron.server-ssl-contexts.KEY.use-cipher-suites-order: To honor local cipher suites preference.
swarm.elytron.server-ssl-contexts.KEY.want-client-auth: To request (but not to require) a client certificate on SSL handshake. If a security domain is referenced and supports X509 evidence, this will be set to true automatically. Ignored when need-client-auth is set.
swarm.elytron.server-ssl-contexts.KEY.wrap: Should the SSLEngine, SSLSocket, and SSLServerSocket instances returned be wrapped to protect against further modification.
swarm.elytron.service-loader-http-server-mechanism-factories.KEY.available-mechanisms: The HTTP mechanisms available from this factory instance.
swarm.elytron.service-loader-http-server-mechanism-factories.KEY.module: The module to use to obtain the classloader to load the factories, if not specified the classloader to load the resource will be used instead.
swarm.elytron.service-loader-sasl-server-factories.KEY.available-mechanisms: The SASL mechanisms available from this factory after all filtering has been applied.
swarm.elytron.service-loader-sasl-server-factories.KEY.module: The module to use to obtain the classloader to load the factories, if not specified the classloader to load the resource will be used instead.
swarm.elytron.simple-permission-mappers.KEY.mapping-mode: The mapping mode that should be used in the event of multiple matches.
swarm.elytron.simple-permission-mappers.KEY.permission-mappings: The defined permission mappings.
swarm.elytron.simple-regex-realm-mappers.KEY.delegate-realm-mapper: The RealmMapper to delegate to if there is no match using the pattern.
swarm.elytron.simple-regex-realm-mappers.KEY.pattern: The regular expression which must contain at least one capture group to extract the realm from the name. If the regular expression matches more than one capture group, the first capture group is used.
swarm.elytron.simple-role-decoders.KEY.attribute: The name of the attribute from the identity to map directly to roles.
swarm.elytron.size-rotating-file-audit-logs.KEY.attribute-synchronized: Whether every event should be immediately synchronised to disk.
swarm.elytron.size-rotating-file-audit-logs.KEY.format: The format to use to record the audit event.
swarm.elytron.size-rotating-file-audit-logs.KEY.max-backup-index: The maximum number of files to backup when rotating.
swarm.elytron.size-rotating-file-audit-logs.KEY.path: Path of the file to be written.
swarm.elytron.size-rotating-file-audit-logs.KEY.relative-to: The relative path to the audit log.
swarm.elytron.size-rotating-file-audit-logs.KEY.rotate-on-boot: Whether the file should be rotated before the a new file is set.
swarm.elytron.size-rotating-file-audit-logs.KEY.rotate-size: The log file size the file should rotate at.
swarm.elytron.size-rotating-file-audit-logs.KEY.suffix: Format of date used as suffix of log file names in java.time.format.DateTimeFormatter. The suffix does not play a role in determining when the file should be rotated.
swarm.elytron.syslog-audit-logs.KEY.format: The format to use to record the audit event.
swarm.elytron.syslog-audit-logs.KEY.host-name: The host name to embed withing all events sent to the remote syslog server.
swarm.elytron.syslog-audit-logs.KEY.port: The listening port on the syslog server.
swarm.elytron.syslog-audit-logs.KEY.server-address: The server address of the syslog server the events should be sent to.
swarm.elytron.syslog-audit-logs.KEY.ssl-context: The SSLContext to use to connect to the syslog server when SSL_TCP transport is used.
swarm.elytron.syslog-audit-logs.KEY.transport: The transport to use to connect to the syslog server.
swarm.elytron.token-realms.KEY.jwt: A token validator to be used in conjunction with a token-based realm that handles security tokens based on the JWT/JWS standard.
swarm.elytron.token-realms.KEY.oauth2-introspection: A token validator to be used in conjunction with a token-based realm that handles OAuth2 Access Tokens and validates them using an endpoint compliant with OAuth2 Token Introspection specification(RFC-7662).
swarm.elytron.token-realms.KEY.principal-claim: The name of the claim that should be used to obtain the principal’s name.
swarm.elytron.trust-managers.KEY.algorithm: The name of the algorithm to use to create the underlying TrustManagerFactory.
swarm.elytron.trust-managers.KEY.alias-filter: A filter to apply to the aliases returned from the KeyStore, can either be a comma separated list of aliases to return or one of the following formats ALL:-alias1:-alias2, NONE:+alias1:+alias2
swarm.elytron.trust-managers.KEY.certificate-revocation-list: Enables certificate revocation list checks to a trust manager.
swarm.elytron.trust-managers.KEY.key-store: Reference to the KeyStore to use to initialise the underlying TrustManagerFactory.
swarm.elytron.trust-managers.KEY.provider-name: The name of the provider to use to create the underlying TrustManagerFactory.
swarm.elytron.trust-managers.KEY.providers: Reference to obtain the Provider[] to use when creating the underlying TrustManagerFactory.
swarm.elytron.x500-attribute-principal-decoders.KEY.attribute-name: The name of the X.500 attribute to map (can be defined using OID instead)
swarm.elytron.x500-attribute-principal-decoders.KEY.convert: When set to 'true', if the Principal is not already an X500Principal conversion will be attempted
swarm.elytron.x500-attribute-principal-decoders.KEY.joiner: The joining string
swarm.elytron.x500-attribute-principal-decoders.KEY.maximum-segments: The maximum number of occurrences of the attribute to map
swarm.elytron.x500-attribute-principal-decoders.KEY.oid: The OID of the X.500 attribute to map (can be defined using attribute name instead)
swarm.elytron.x500-attribute-principal-decoders.KEY.required-attributes: The attributes names of the attributes that must be present in the principal
swarm.elytron.x500-attribute-principal-decoders.KEY.required-oids: The OIDs of the attributes that must be present in the principal
swarm.elytron.x500-attribute-principal-decoders.KEY.reverse: When set to 'true', the attribute values will be processed and returned in reverse order
swarm.elytron.x500-attribute-principal-decoders.KEY.start-segment: The 0-based starting occurrence of the attribute to map

D.10. Hibernate Validator

Provides support and integration for applications using Hibernate Validator.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>hibernate-validator</artifactId>
</dependency>

D.11. Hystrix

Warning

This fraction is deprecated.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>hystrix</artifactId>
</dependency>

Configuration

swarm.hystrix.collapser.default.maxRequestsInBatch: The maximum number of requests allowed in a batch before this triggers a batch execution
swarm.hystrix.collapser.default.requestCache.enabled: Indicates whether request caching is enabled for HystrixCollapser.execute() and HystrixCollapser.queue() invocations
swarm.hystrix.collapser.default.timerDelayInMilliseconds: The number of milliseconds after the creation of the batch that its execution is triggered
swarm.hystrix.command.default.circuitBreaker.enabled: Determines whether a circuit breaker will be used to track health and to short-circuit requests if it trips
swarm.hystrix.command.default.circuitBreaker.errorThresholdPercentage: The error percentage at or above which the circuit should trip open and start short-circuiting requests to fallback logic
swarm.hystrix.command.default.circuitBreaker.forceClosed: If true, forces the circuit breaker into a closed state in which it will allow requests regardless of the error percentage
swarm.hystrix.command.default.circuitBreaker.forceOpen: If true, forces the circuit breaker into an open (tripped) state in which it will reject all requests
swarm.hystrix.command.default.circuitBreaker.requestVolumeThreshold: The minimum number of requests in a rolling window that will trip the circuit
swarm.hystrix.command.default.circuitBreaker.sleepWindowInMilliseconds: The amount of time, after tripping the circuit, to reject requests before allowing attempts again to determine if the circuit should again be closed
swarm.hystrix.command.default.execution.isolation.semaphore.maxConcurrentRequests: The maximum number of requests allowed to a HystrixCommand.run() method when you are using ExecutionIsolationStrategy.SEMAPHORE
swarm.hystrix.command.default.execution.isolation.strategy: Isolation strategy (THREAD or SEMAPHORE)
swarm.hystrix.command.default.execution.isolation.thread.interruptOnCancel: Indicates whether the HystrixCommand.run() execution should be interrupted when a cancellation occurs
swarm.hystrix.command.default.execution.isolation.thread.interruptOnTimeout: Indicates whether the HystrixCommand.run() execution should be interrupted when a timeout occurs
swarm.hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: The time in milliseconds after which the caller will observe a timeout and walk away from the command execution
swarm.hystrix.command.default.execution.timeout.enabled: Indicates whether the HystrixCommand.run() execution should have a timeout
swarm.hystrix.command.default.fallback.enabled: Determines whether a call to HystrixCommand.getFallback() will be attempted when failure or rejection occurs
swarm.hystrix.command.default.fallback.isolation.semaphore.maxConcurrentRequests: The maximum number of requests allowed to a HystrixCommand.getFallback() method when you are using ExecutionIsolationStrategy.SEMAPHORE
swarm.hystrix.command.default.metrics.healthSnapshot.intervalInMilliseconds: The time to wait, in milliseconds, between allowing health snapshots to be taken that calculate success and error percentages and affect circuit breaker status
swarm.hystrix.command.default.metrics.rollingPercentile.bucketSize: The maximum number of execution times that are kept per bucket
swarm.hystrix.command.default.metrics.rollingPercentile.enabled: Indicates whether execution latencies should be tracked and calculated as percentiles
swarm.hystrix.command.default.metrics.rollingPercentile.numBuckets: The number of buckets the rollingPercentile window will be divided into
swarm.hystrix.command.default.metrics.rollingPercentile.timeInMilliseconds: The duration of the rolling window in which execution times are kept to allow for percentile calculations, in milliseconds
swarm.hystrix.command.default.metrics.rollingStats.numBuckets: The number of buckets the rolling statistical window is divided into
swarm.hystrix.command.default.metrics.rollingStats.timeInMilliseconds: The duration of the statistical rolling window, in milliseconds. This is how long Hystrix keeps metrics for the circuit breaker to use and for publishing
swarm.hystrix.command.default.requestCache.enabled: Indicates whether HystrixCommand.getCacheKey() should be used with HystrixRequestCache to provide de-duplication functionality via request-scoped caching
swarm.hystrix.command.default.requestLog.enabled: Indicates whether HystrixCommand execution and events should be logged to HystrixRequestLog
swarm.hystrix.stream.path: Context path for the stream
swarm.hystrix.threadpool.default.allowMaximumSizeToDivergeFromCoreSize: Allows the configuration for maximumSize to take effect
swarm.hystrix.threadpool.default.coreSize: The core thread-pool size
swarm.hystrix.threadpool.default.keepAliveTimeMinutes: The keep-alive time, in minutes
swarm.hystrix.threadpool.default.maxQueueSize: The maximum queue size of the BlockingQueue implementation
swarm.hystrix.threadpool.default.maximumSize: The maximum thread-pool size
swarm.hystrix.threadpool.default.metrics.rollingPercentile.numBuckets: The number of buckets the rolling statistical window is divided into
swarm.hystrix.threadpool.default.metrics.rollingStats.timeInMilliseconds: The duration of the statistical rolling window, in milliseconds
swarm.hystrix.threadpool.default.queueSizeRejectionThreshold: The queue size rejection threshold - an artificial maximum queue size at which rejections will occur even if maxQueueSize has not been reached

D.12. IO

Primarily an internal fraction supporting I/O activities for higher-level fractions.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>io</artifactId>
</dependency>

Configuration

swarm.io.buffer-pools.KEY.buffer-size: The size of each buffer slice in bytes, if not set optimal value is calculated based on available RAM resources in your system.
swarm.io.buffer-pools.KEY.buffers-per-slice: How many buffers per slice, if not set optimal value is calculated based on available RAM resources in your system.
swarm.io.buffer-pools.KEY.direct-buffers: Does the buffer pool use direct buffers, some platforms don’t support direct buffers
swarm.io.workers.KEY.core-pool-size: Minimum number of threads to keep in the underlying java.util.concurrent.ThreadPoolExecutor even if they are idle. Threads over this limit will be terminated over time specified by task-keepalive attribute.
swarm.io.workers.KEY.io-thread-count: I/O thread count
swarm.io.workers.KEY.io-threads: Specify the number of I/O threads to create for the worker. If not specified, a default will be chosen, which is calculated by cpuCount * 2
swarm.io.workers.KEY.max-pool-size: The maximum number of threads to allow in the thread pool. Depending on implementation, when this limit is reached, tasks which cannot be queued may be rejected.
swarm.io.workers.KEY.outbound-bind-address.KEY.bind-address: The address to bind to when the destination address matches
swarm.io.workers.KEY.outbound-bind-address.KEY.bind-port: The port number to bind to when the destination address matches
swarm.io.workers.KEY.outbound-bind-address.KEY.match: The destination address range to match
swarm.io.workers.KEY.queue-size: An estimate of the number of tasks in the worker queue.
swarm.io.workers.KEY.servers.KEY.connection-count: Estimate of the current connection count
swarm.io.workers.KEY.servers.KEY.connection-limit-high-water-mark: If the connection count hits this number, no new connections will be accepted until the count drops below the low-water mark.
swarm.io.workers.KEY.servers.KEY.connection-limit-low-water-mark: If the connection count has previously hit the high water mark, once it drops back down below this count, connections will be accepted again.
swarm.io.workers.KEY.shutdown-requested: True is shutdown of the pool was requested
swarm.io.workers.KEY.stack-size: The stack size (in bytes) to attempt to use for worker threads.
swarm.io.workers.KEY.task-keepalive: Specify the number of milliseconds to keep non-core task threads alive.
swarm.io.workers.KEY.task-max-threads: Specify the maximum number of threads for the worker task thread pool.If not set, default value used which is calculated by formula cpuCount * 16,as long as MaxFileDescriptorCount jmx property allows that number, otherwise calculation takes max into account to adjust it accordingly.

D.13. Jaeger

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jaeger</artifactId>
</dependency>

Configuration

swarm.jaeger.agent-host: The hostname for communicating with agent via UDP
swarm.jaeger.agent-port: The port for communicating with agent via UDP
swarm.jaeger.enable-b3-header-propagation: Whether to enable propagation of B3 headers in the configured Tracer. By default this is false.
swarm.jaeger.password: Password to send as part of "Basic" authentication to the endpoint
swarm.jaeger.remote-reporter-http-endpoint: Remote Reporter HTTP endpoint for Jaeger collector, such as http://jaeger-collector.istio-system:14268/api/traces
swarm.jaeger.reporter-flush-interval: The reporter’s flush interval (ms)
swarm.jaeger.reporter-log-spans: Whether the reporter should also log the spans
swarm.jaeger.reporter-max-queue-size: The reporter’s maximum queue size
swarm.jaeger.sampler-manager-host: The host name and port when using the remote controlled sampler
swarm.jaeger.sampler-parameter: The sampler parameter (number). Ex.: 1
swarm.jaeger.sampler-type: The sampler type. Ex.: const
swarm.jaeger.service-name: The service name. Required (via this parameter, system property or env var). Ex.: order-manager
swarm.jaeger.user: Username to send as part of "Basic" authentication to the endpoint

D.14. JAX-RS

Provides support for building RESTful web services according to JSR-311.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jaxrs</artifactId>
</dependency>

Configuration

swarm.deployment.KEY.jaxrs.application-path: Set the JAX-RS application path. If set, Thorntail will automatically generate a JAX-RS Application class and use this value as the @ApplicationPath

D.14.1. JAX-RS + CDI

An internal fraction providing integration between JAX-RS and CDI.

For more information, see the JAX-RS and CDI fraction documentation.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jaxrs-cdi</artifactId>
</dependency>

D.14.2. JAX-RS + JAXB

Provides support within JAX-RS applications for the XML binding framework according to JSR-31 and JSR-222.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jaxrs-jaxb</artifactId>
</dependency>

D.14.3. JAX-RS + JSON-P

Provides support within JAX-RS application for JSON processing according to JSR-374.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jaxrs-jsonp</artifactId>
</dependency>

D.14.4. JAX-RS + Multipart

Provides support within JAX-RS application for MIME multipart form processing.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jaxrs-multipart</artifactId>
</dependency>

D.14.5. JAX-RS + Validator

Provides integration and support between JAX-RS applications and Hibernate Validator.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jaxrs-validator</artifactId>
</dependency>

D.15. JCA

Provides support for the Java Connector Architecture (JCA) according to JSR 322.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jca</artifactId>
</dependency>

Configuration

swarm.jca.archive-validation.enabled: Specify whether archive validation is enabled
swarm.jca.archive-validation.fail-on-error: Should an archive validation error report fail the deployment
swarm.jca.archive-validation.fail-on-warn: Should an archive validation warning report fail the deployment
swarm.jca.bean-validation.enabled: Specify whether bean validation is enabled
swarm.jca.bootstrap-contexts.KEY.name: The name of the BootstrapContext
swarm.jca.bootstrap-contexts.KEY.workmanager: The WorkManager instance for the BootstrapContext
swarm.jca.cached-connection-manager.debug: Enable/disable debug information logging
swarm.jca.cached-connection-manager.error: Enable/disable error information logging
swarm.jca.cached-connection-manager.ignore-unknown-connections: Do not cache unknown connections
swarm.jca.cached-connection-manager.install: Enable/disable the cached connection manager valve and interceptor
swarm.jca.distributed-workmanagers.KEY.elytron-enabled: Enables Elytron security for this workmanager.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.allow-core-timeout: Whether core threads may time out.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.core-threads: The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.current-thread-count: The current number of threads in the pool.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.handoff-executor: An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.keepalive-time: Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.largest-thread-count: The largest number of threads that have ever simultaneously been in the pool.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.max-threads: The maximum thread pool size.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.name: The name of the thread pool.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.queue-length: The queue length.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.queue-size: The queue size.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.rejected-count: The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.
swarm.jca.distributed-workmanagers.KEY.long-running-threads.KEY.thread-factory: Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.
swarm.jca.distributed-workmanagers.KEY.name: The name of the DistributedWorkManager
swarm.jca.distributed-workmanagers.KEY.policy: The policy decides when to redistribute a Work instance
swarm.jca.distributed-workmanagers.KEY.policy-options: List of policy’s options key/value pairs
swarm.jca.distributed-workmanagers.KEY.selector: The selector decides to which nodes in the network to redistribute the Work instance to
swarm.jca.distributed-workmanagers.KEY.selector-options: List of selector’s options key/value pairs
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.allow-core-timeout: Whether core threads may time out.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.core-threads: The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.current-thread-count: The current number of threads in the pool.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.handoff-executor: An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.keepalive-time: Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.largest-thread-count: The largest number of threads that have ever simultaneously been in the pool.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.max-threads: The maximum thread pool size.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.name: The name of the thread pool.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.queue-length: The queue length.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.queue-size: The queue size.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.rejected-count: The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.
swarm.jca.distributed-workmanagers.KEY.short-running-threads.KEY.thread-factory: Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.
swarm.jca.tracer.enabled: Specify whether tracer is enabled
swarm.jca.workmanagers.KEY.elytron-enabled: Enables Elytron security for this workmanager.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.allow-core-timeout: Whether core threads may time out.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.core-threads: The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.current-thread-count: The current number of threads in the pool.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.handoff-executor: An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.keepalive-time: Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.largest-thread-count: The largest number of threads that have ever simultaneously been in the pool.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.max-threads: The maximum thread pool size.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.name: The name of the thread pool.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.queue-length: The queue length.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.queue-size: The queue size.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.rejected-count: The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.
swarm.jca.workmanagers.KEY.long-running-threads.KEY.thread-factory: Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.
swarm.jca.workmanagers.KEY.name: The name of the WorkManager
swarm.jca.workmanagers.KEY.short-running-threads.KEY.allow-core-timeout: Whether core threads may time out.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.core-threads: The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.current-thread-count: The current number of threads in the pool.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.handoff-executor: An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.keepalive-time: Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.largest-thread-count: The largest number of threads that have ever simultaneously been in the pool.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.max-threads: The maximum thread pool size.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.name: The name of the thread pool.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.queue-length: The queue length.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.queue-size: The queue size.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.rejected-count: The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.
swarm.jca.workmanagers.KEY.short-running-threads.KEY.thread-factory: Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used.

D.16. JMX

Provides support for Java Management Extensions (JMX) according to JSR-3.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jmx</artifactId>
</dependency>

Configuration

swarm.jmx.audit-log-configuration.enabled: Whether audit logging is enabled.
swarm.jmx.audit-log-configuration.log-boot: Whether operations should be logged on server boot.
swarm.jmx.audit-log-configuration.log-read-only: Whether operations that do not modify the configuration or any runtime services should be logged.
swarm.jmx.expression-expose-model.domain-name: The domain name to use for the 'expression' model controller JMX facade in the MBeanServer.
swarm.jmx.jmx-remoting-connector.use-management-endpoint: If true the connector will use the management endpoint, otherwise it will use the remoting subsystem one
swarm.jmx.non-core-mbean-sensitivity: Whether or not core MBeans, i.e. mbeans not coming from the model controller, should be considered sensitive.
swarm.jmx.resolved-expose-model.domain-name: The domain name to use for the 'resolved' model controller JMX facade in the MBeanServer.
swarm.jmx.resolved-expose-model.proper-property-format: If false, PROPERTY type attributes are represented as a DMR string, this is the legacy behaviour. If true, PROPERTY type attributes are represented by a composite type where the key is a string, and the value has the same type as the property in the underlying model.
swarm.jmx.show-model: Alias for the existence of the 'resolved' model controller jmx facade. When writing, if set to 'true' it will add the 'resolved' model controller jmx facade resource with the default domain name.

D.17. JPA

Provides support for the Java Persistence API according to JSR-220.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jpa</artifactId>
</dependency>

Configuration

swarm.jpa.default-datasource: The name of the default global datasource.
swarm.jpa.default-extended-persistence-inheritance: Controls how JPA extended persistence context (XPC) inheritance is performed. 'DEEP' shares the extended persistence context at top bean level. 'SHALLOW' the extended persistece context is only shared with the parent bean (never with sibling beans).

D.18. JSF

Provides support for JavaServer Faces according to JSR-344.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jsf</artifactId>
</dependency>

Configuration

swarm.jsf.default-jsf-impl-slot: Default JSF implementation slot

D.19. JSON-P

Provides support for JSON Processing according to JSR-353.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>jsonp</artifactId>
</dependency>

D.20. Keycloak

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>keycloak</artifactId>
</dependency>

Configuration

swarm.keycloak.json.path: Path to Keycloak adapter configuration
swarm.keycloak.multitenancy.paths: Map of the relative request paths to Keycloak adapter configuration locations
swarm.keycloak.realms.KEY.allow-any-hostname: SSL Setting
swarm.keycloak.realms.KEY.always-refresh-token: Refresh token on every single web request
swarm.keycloak.realms.KEY.auth-server-url: Base URL of the Realm Auth Server
swarm.keycloak.realms.KEY.auth-server-url-for-backend-requests: URL to use to make background calls to auth server
swarm.keycloak.realms.KEY.autodetect-bearer-only: autodetect bearer-only requests
swarm.keycloak.realms.KEY.client-key-password: n/a
swarm.keycloak.realms.KEY.client-keystore: n/a
swarm.keycloak.realms.KEY.client-keystore-password: n/a
swarm.keycloak.realms.KEY.connection-pool-size: Connection pool size for the client used by the adapter
swarm.keycloak.realms.KEY.cors-allowed-headers: CORS allowed headers
swarm.keycloak.realms.KEY.cors-allowed-methods: CORS allowed methods
swarm.keycloak.realms.KEY.cors-exposed-headers: CORS exposed headers
swarm.keycloak.realms.KEY.cors-max-age: CORS max-age header
swarm.keycloak.realms.KEY.disable-trust-manager: Adapter will not use a trust manager when making adapter HTTPS requests
swarm.keycloak.realms.KEY.enable-cors: Enable Keycloak CORS support
swarm.keycloak.realms.KEY.expose-token: Enable secure URL that exposes access token
swarm.keycloak.realms.KEY.ignore-oauth-query-parameter: disable query parameter parsing for access_token
swarm.keycloak.realms.KEY.principal-attribute: token attribute to use to set Principal name
swarm.keycloak.realms.KEY.realm-public-key: Public key of the realm
swarm.keycloak.realms.KEY.register-node-at-startup: Cluster setting
swarm.keycloak.realms.KEY.register-node-period: how often to re-register node
swarm.keycloak.realms.KEY.ssl-required: Specify if SSL is required (valid values are all, external and none)
swarm.keycloak.realms.KEY.token-store: cookie or session storage for auth session data
swarm.keycloak.realms.KEY.truststore: Truststore used for adapter client HTTPS requests
swarm.keycloak.realms.KEY.truststore-password: Password of the Truststore
swarm.keycloak.secure-deployments.KEY.allow-any-hostname: SSL Setting
swarm.keycloak.secure-deployments.KEY.always-refresh-token: Refresh token on every single web request
swarm.keycloak.secure-deployments.KEY.auth-server-url: Base URL of the Realm Auth Server
swarm.keycloak.secure-deployments.KEY.auth-server-url-for-backend-requests: URL to use to make background calls to auth server
swarm.keycloak.secure-deployments.KEY.autodetect-bearer-only: autodetect bearer-only requests
swarm.keycloak.secure-deployments.KEY.bearer-only: Bearer Token Auth only
swarm.keycloak.secure-deployments.KEY.client-key-password: n/a
swarm.keycloak.secure-deployments.KEY.client-keystore: n/a
swarm.keycloak.secure-deployments.KEY.client-keystore-password: n/a
swarm.keycloak.secure-deployments.KEY.connection-pool-size: Connection pool size for the client used by the adapter
swarm.keycloak.secure-deployments.KEY.cors-allowed-headers: CORS allowed headers
swarm.keycloak.secure-deployments.KEY.cors-allowed-methods: CORS allowed methods
swarm.keycloak.secure-deployments.KEY.cors-exposed-headers: CORS exposed headers
swarm.keycloak.secure-deployments.KEY.cors-max-age: CORS max-age header
swarm.keycloak.secure-deployments.KEY.credentials.KEY.value: Credential value
swarm.keycloak.secure-deployments.KEY.disable-trust-manager: Adapter will not use a trust manager when making adapter HTTPS requests
swarm.keycloak.secure-deployments.KEY.enable-basic-auth: Enable Basic Authentication
swarm.keycloak.secure-deployments.KEY.enable-cors: Enable Keycloak CORS support
swarm.keycloak.secure-deployments.KEY.expose-token: Enable secure URL that exposes access token
swarm.keycloak.secure-deployments.KEY.ignore-oauth-query-parameter: disable query parameter parsing for access_token
swarm.keycloak.secure-deployments.KEY.min-time-between-jwks-requests: If adapter recognize token signed by unknown public key, it will try to download new public key from keycloak server. However it won’t try to download if already tried it in less than 'min-time-between-jwks-requests' seconds
swarm.keycloak.secure-deployments.KEY.principal-attribute: token attribute to use to set Principal name
swarm.keycloak.secure-deployments.KEY.public-client: Public client
swarm.keycloak.secure-deployments.KEY.realm: Keycloak realm
swarm.keycloak.secure-deployments.KEY.realm-public-key: Public key of the realm
swarm.keycloak.secure-deployments.KEY.redirect-rewrite-rules.KEY.value: redirect-rewrite-rule value
swarm.keycloak.secure-deployments.KEY.register-node-at-startup: Cluster setting
swarm.keycloak.secure-deployments.KEY.register-node-period: how often to re-register node
swarm.keycloak.secure-deployments.KEY.resource: Application name
swarm.keycloak.secure-deployments.KEY.ssl-required: Specify if SSL is required (valid values are all, external and none)
swarm.keycloak.secure-deployments.KEY.token-minimum-time-to-live: The adapter will refresh the token if the current token is expired OR will expire in 'token-minimum-time-to-live' seconds or less
swarm.keycloak.secure-deployments.KEY.token-store: cookie or session storage for auth session data
swarm.keycloak.secure-deployments.KEY.truststore: Truststore used for adapter client HTTPS requests
swarm.keycloak.secure-deployments.KEY.truststore-password: Password of the Truststore
swarm.keycloak.secure-deployments.KEY.turn-off-change-session-id-on-login: The session id is changed by default on a successful login. Change this to true if you want to turn this off
swarm.keycloak.secure-deployments.KEY.use-resource-role-mappings: Use resource level permissions from token
swarm.keycloak.secure-servers.KEY.allow-any-hostname: SSL Setting
swarm.keycloak.secure-servers.KEY.always-refresh-token: Refresh token on every single web request
swarm.keycloak.secure-servers.KEY.auth-server-url: Base URL of the Realm Auth Server
swarm.keycloak.secure-servers.KEY.auth-server-url-for-backend-requests: URL to use to make background calls to auth server
swarm.keycloak.secure-servers.KEY.autodetect-bearer-only: autodetect bearer-only requests
swarm.keycloak.secure-servers.KEY.bearer-only: Bearer Token Auth only
swarm.keycloak.secure-servers.KEY.client-key-password: n/a
swarm.keycloak.secure-servers.KEY.client-keystore: n/a
swarm.keycloak.secure-servers.KEY.client-keystore-password: n/a
swarm.keycloak.secure-servers.KEY.connection-pool-size: Connection pool size for the client used by the adapter
swarm.keycloak.secure-servers.KEY.cors-allowed-headers: CORS allowed headers
swarm.keycloak.secure-servers.KEY.cors-allowed-methods: CORS allowed methods
swarm.keycloak.secure-servers.KEY.cors-exposed-headers: CORS exposed headers
swarm.keycloak.secure-servers.KEY.cors-max-age: CORS max-age header
swarm.keycloak.secure-servers.KEY.credentials.KEY.value: Credential value
swarm.keycloak.secure-servers.KEY.disable-trust-manager: Adapter will not use a trust manager when making adapter HTTPS requests
swarm.keycloak.secure-servers.KEY.enable-basic-auth: Enable Basic Authentication
swarm.keycloak.secure-servers.KEY.enable-cors: Enable Keycloak CORS support
swarm.keycloak.secure-servers.KEY.expose-token: Enable secure URL that exposes access token
swarm.keycloak.secure-servers.KEY.ignore-oauth-query-parameter: disable query parameter parsing for access_token
swarm.keycloak.secure-servers.KEY.min-time-between-jwks-requests: If adapter recognize token signed by unknown public key, it will try to download new public key from keycloak server. However it won’t try to download if already tried it in less than 'min-time-between-jwks-requests' seconds
swarm.keycloak.secure-servers.KEY.principal-attribute: token attribute to use to set Principal name
swarm.keycloak.secure-servers.KEY.public-client: Public client
swarm.keycloak.secure-servers.KEY.realm: Keycloak realm
swarm.keycloak.secure-servers.KEY.realm-public-key: Public key of the realm
swarm.keycloak.secure-servers.KEY.redirect-rewrite-rules.KEY.value: redirect-rewrite-rule value
swarm.keycloak.secure-servers.KEY.register-node-at-startup: Cluster setting
swarm.keycloak.secure-servers.KEY.register-node-period: how often to re-register node
swarm.keycloak.secure-servers.KEY.resource: Application name
swarm.keycloak.secure-servers.KEY.ssl-required: Specify if SSL is required (valid values are all, external and none)
swarm.keycloak.secure-servers.KEY.token-minimum-time-to-live: The adapter will refresh the token if the current token is expired OR will expire in 'token-minimum-time-to-live' seconds or less
swarm.keycloak.secure-servers.KEY.token-store: cookie or session storage for auth session data
swarm.keycloak.secure-servers.KEY.truststore: Truststore used for adapter client HTTPS requests
swarm.keycloak.secure-servers.KEY.truststore-password: Password of the Truststore
swarm.keycloak.secure-servers.KEY.turn-off-change-session-id-on-login: The session id is changed by default on a successful login. Change this to true if you want to turn this off
swarm.keycloak.secure-servers.KEY.use-resource-role-mappings: Use resource level permissions from token

D.21. Logging

Provides facilities to configure logging categories, levels and handlers.

When specifying log-levels through properties, since they include dots, they should be placed between square brackets, such as swarm.logging.loggers.[com.mycorp.logger].level.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>logging</artifactId>
</dependency>

Configuration

swarm.logging.add-logging-api-dependencies: Indicates whether or not logging API dependencies should be added to deployments during the deployment process. A value of true will add the dependencies to the deployment. A value of false will skip the deployment from being processed for logging API dependencies.
swarm.logging.async-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.async-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.async-handlers.KEY.level: The log level specifying which message levels will be logged by this handler. Message levels lower than this value will be discarded.
swarm.logging.async-handlers.KEY.name: The name of the handler.
swarm.logging.async-handlers.KEY.overflow-action: Specify what action to take when the overflowing. The valid options are 'block' and 'discard'
swarm.logging.async-handlers.KEY.queue-length: The queue length to use before flushing writing
swarm.logging.async-handlers.KEY.subhandlers: The Handlers associated with this async handler.
swarm.logging.console-handlers.KEY.autoflush: Automatically flush after each write.
swarm.logging.console-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.console-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.console-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.console-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.console-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.console-handlers.KEY.name: The name of the handler.
swarm.logging.console-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.console-handlers.KEY.target: Defines the target of the console handler. The value can be System.out, System.err or console.
swarm.logging.custom-formatters.KEY.attribute-class: The logging handler class to be used.
swarm.logging.custom-formatters.KEY.module: The module that the logging handler depends on.
swarm.logging.custom-formatters.KEY.properties: Defines the properties used for the logging handler. All properties must be accessible via a setter method.
swarm.logging.custom-handlers.KEY.attribute-class: The logging handler class to be used.
swarm.logging.custom-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.custom-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.custom-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.custom-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.custom-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.custom-handlers.KEY.module: The module that the logging handler depends on.
swarm.logging.custom-handlers.KEY.name: The name of the handler.
swarm.logging.custom-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.custom-handlers.KEY.properties: Defines the properties used for the logging handler. All properties must be accessible via a setter method.
swarm.logging.file-handlers.KEY.append: Specify whether to append to the target file.
swarm.logging.file-handlers.KEY.autoflush: Automatically flush after each write.
swarm.logging.file-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.file-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.file-handlers.KEY.file: The file description consisting of the path and optional relative to path.
swarm.logging.file-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.file-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.file-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.file-handlers.KEY.name: The name of the handler.
swarm.logging.file-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.log-files.KEY.file-size: The size of the log file in bytes.
swarm.logging.log-files.KEY.last-modified-time: The date, in milliseconds, the file was last modified.
swarm.logging.log-files.KEY.last-modified-timestamp: The date, in ISO 8601 format, the file was last modified.
swarm.logging.log-files.KEY.stream: Provides the server log as a response attachment. The response result value is the unique id of the attachment.
swarm.logging.loggers.KEY.category: Specifies the category for the logger.
swarm.logging.loggers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.loggers.KEY.handlers: The handlers associated with the logger.
swarm.logging.loggers.KEY.level: The log level specifying which message levels will be logged by the logger. Message levels lower than this value will be discarded.
swarm.logging.loggers.KEY.use-parent-handlers: Specifies whether or not this logger should send its output to its parent Logger.
swarm.logging.logging-profiles.KEY.async-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.logging-profiles.KEY.async-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.logging-profiles.KEY.async-handlers.KEY.level: The log level specifying which message levels will be logged by this handler. Message levels lower than this value will be discarded.
swarm.logging.logging-profiles.KEY.async-handlers.KEY.name: The name of the handler.
swarm.logging.logging-profiles.KEY.async-handlers.KEY.overflow-action: Specify what action to take when the overflowing. The valid options are 'block' and 'discard'
swarm.logging.logging-profiles.KEY.async-handlers.KEY.queue-length: The queue length to use before flushing writing
swarm.logging.logging-profiles.KEY.async-handlers.KEY.subhandlers: The Handlers associated with this async handler.
swarm.logging.logging-profiles.KEY.console-handlers.KEY.autoflush: Automatically flush after each write.
swarm.logging.logging-profiles.KEY.console-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.logging-profiles.KEY.console-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.logging-profiles.KEY.console-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.logging-profiles.KEY.console-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.logging-profiles.KEY.console-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.logging-profiles.KEY.console-handlers.KEY.name: The name of the handler.
swarm.logging.logging-profiles.KEY.console-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.logging-profiles.KEY.console-handlers.KEY.target: Defines the target of the console handler. The value can be System.out, System.err or console.
swarm.logging.logging-profiles.KEY.custom-formatters.KEY.attribute-class: The logging handler class to be used.
swarm.logging.logging-profiles.KEY.custom-formatters.KEY.module: The module that the logging handler depends on.
swarm.logging.logging-profiles.KEY.custom-formatters.KEY.properties: Defines the properties used for the logging handler. All properties must be accessible via a setter method.
swarm.logging.logging-profiles.KEY.custom-handlers.KEY.attribute-class: The logging handler class to be used.
swarm.logging.logging-profiles.KEY.custom-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.logging-profiles.KEY.custom-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.logging-profiles.KEY.custom-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.logging-profiles.KEY.custom-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.logging-profiles.KEY.custom-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.logging-profiles.KEY.custom-handlers.KEY.module: The module that the logging handler depends on.
swarm.logging.logging-profiles.KEY.custom-handlers.KEY.name: The name of the handler.
swarm.logging.logging-profiles.KEY.custom-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.logging-profiles.KEY.custom-handlers.KEY.properties: Defines the properties used for the logging handler. All properties must be accessible via a setter method.
swarm.logging.logging-profiles.KEY.file-handlers.KEY.append: Specify whether to append to the target file.
swarm.logging.logging-profiles.KEY.file-handlers.KEY.autoflush: Automatically flush after each write.
swarm.logging.logging-profiles.KEY.file-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.logging-profiles.KEY.file-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.logging-profiles.KEY.file-handlers.KEY.file: The file description consisting of the path and optional relative to path.
swarm.logging.logging-profiles.KEY.file-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.logging-profiles.KEY.file-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.logging-profiles.KEY.file-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.logging-profiles.KEY.file-handlers.KEY.name: The name of the handler.
swarm.logging.logging-profiles.KEY.file-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.logging-profiles.KEY.log-files.KEY.file-size: The size of the log file in bytes.
swarm.logging.logging-profiles.KEY.log-files.KEY.last-modified-time: The date, in milliseconds, the file was last modified.
swarm.logging.logging-profiles.KEY.log-files.KEY.last-modified-timestamp: The date, in ISO 8601 format, the file was last modified.
swarm.logging.logging-profiles.KEY.log-files.KEY.stream: Provides the server log as a response attachment. The response result value is the unique id of the attachment.
swarm.logging.logging-profiles.KEY.loggers.KEY.category: Specifies the category for the logger.
swarm.logging.logging-profiles.KEY.loggers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.logging-profiles.KEY.loggers.KEY.handlers: The handlers associated with the logger.
swarm.logging.logging-profiles.KEY.loggers.KEY.level: The log level specifying which message levels will be logged by the logger. Message levels lower than this value will be discarded.
swarm.logging.logging-profiles.KEY.loggers.KEY.use-parent-handlers: Specifies whether or not this logger should send its output to its parent Logger.
swarm.logging.logging-profiles.KEY.pattern-formatters.KEY.color-map: The color-map attribute allows for a comma delimited list of colors to be used for different levels with a pattern formatter. The format for the color mapping pattern is level-name:color-name.Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite
swarm.logging.logging-profiles.KEY.pattern-formatters.KEY.pattern: Defines a pattern for the formatter.
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.append: Specify whether to append to the target file.
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.autoflush: Automatically flush after each write.
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.file: The file description consisting of the path and optional relative to path.
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.name: The name of the handler.
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.logging-profiles.KEY.periodic-rotating-file-handlers.KEY.suffix: Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.append: Specify whether to append to the target file.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.autoflush: Automatically flush after each write.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.file: The file description consisting of the path and optional relative to path.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.max-backup-index: The maximum number of backups to keep.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.name: The name of the handler.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.rotate-on-boot: Indicates the file should be rotated each time the file attribute is changed. This always happens when at initialization time.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.rotate-size: The size at which to rotate the log file.
swarm.logging.logging-profiles.KEY.periodic-size-rotating-file-handlers.KEY.suffix: Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.
swarm.logging.logging-profiles.KEY.root-logger.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.logging-profiles.KEY.root-logger.handlers: The handlers associated with the root logger.
swarm.logging.logging-profiles.KEY.root-logger.level: The log level specifying which message levels will be logged by the root logger. Message levels lower than this value will be discarded.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.append: Specify whether to append to the target file.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.autoflush: Automatically flush after each write.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.file: The file description consisting of the path and optional relative to path.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.max-backup-index: The maximum number of backups to keep.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.name: The name of the handler.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.rotate-on-boot: Indicates the file should be rotated each time the file attribute is changed. This always happens when at initialization time.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.rotate-size: The size at which to rotate the log file.
swarm.logging.logging-profiles.KEY.size-rotating-file-handlers.KEY.suffix: Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The suffix does not determine when the file should be rotated.
swarm.logging.logging-profiles.KEY.syslog-handlers.KEY.app-name: The app name used when formatting the message in RFC5424 format. By default the app name is "java".
swarm.logging.logging-profiles.KEY.syslog-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.logging-profiles.KEY.syslog-handlers.KEY.facility: Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164 (http://tools.ietf.org/html/rfc3164).
swarm.logging.logging-profiles.KEY.syslog-handlers.KEY.hostname: The name of the host the messages are being sent from. For example the name of the host the application server is running on.
swarm.logging.logging-profiles.KEY.syslog-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.logging-profiles.KEY.syslog-handlers.KEY.port: The port the syslog server is listening on.
swarm.logging.logging-profiles.KEY.syslog-handlers.KEY.server-address: The address of the syslog server.
swarm.logging.logging-profiles.KEY.syslog-handlers.KEY.syslog-format: Formats the log message according to the RFC specification.
swarm.logging.pattern-formatters.KEY.color-map: The color-map attribute allows for a comma delimited list of colors to be used for different levels with a pattern formatter. The format for the color mapping pattern is level-name:color-name.Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite
swarm.logging.pattern-formatters.KEY.pattern: Defines a pattern for the formatter.
swarm.logging.periodic-rotating-file-handlers.KEY.append: Specify whether to append to the target file.
swarm.logging.periodic-rotating-file-handlers.KEY.autoflush: Automatically flush after each write.
swarm.logging.periodic-rotating-file-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.periodic-rotating-file-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.periodic-rotating-file-handlers.KEY.file: The file description consisting of the path and optional relative to path.
swarm.logging.periodic-rotating-file-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.periodic-rotating-file-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.periodic-rotating-file-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.periodic-rotating-file-handlers.KEY.name: The name of the handler.
swarm.logging.periodic-rotating-file-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.periodic-rotating-file-handlers.KEY.suffix: Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.
swarm.logging.periodic-size-rotating-file-handlers.KEY.append: Specify whether to append to the target file.
swarm.logging.periodic-size-rotating-file-handlers.KEY.autoflush: Automatically flush after each write.
swarm.logging.periodic-size-rotating-file-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.periodic-size-rotating-file-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.periodic-size-rotating-file-handlers.KEY.file: The file description consisting of the path and optional relative to path.
swarm.logging.periodic-size-rotating-file-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.periodic-size-rotating-file-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.periodic-size-rotating-file-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.periodic-size-rotating-file-handlers.KEY.max-backup-index: The maximum number of backups to keep.
swarm.logging.periodic-size-rotating-file-handlers.KEY.name: The name of the handler.
swarm.logging.periodic-size-rotating-file-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.periodic-size-rotating-file-handlers.KEY.rotate-on-boot: Indicates the file should be rotated each time the file attribute is changed. This always happens when at initialization time.
swarm.logging.periodic-size-rotating-file-handlers.KEY.rotate-size: The size at which to rotate the log file.
swarm.logging.periodic-size-rotating-file-handlers.KEY.suffix: Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.
swarm.logging.root-logger.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.root-logger.handlers: The handlers associated with the root logger.
swarm.logging.root-logger.level: The log level specifying which message levels will be logged by the root logger. Message levels lower than this value will be discarded.
swarm.logging.size-rotating-file-handlers.KEY.append: Specify whether to append to the target file.
swarm.logging.size-rotating-file-handlers.KEY.autoflush: Automatically flush after each write.
swarm.logging.size-rotating-file-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.size-rotating-file-handlers.KEY.encoding: The character encoding used by this Handler.
swarm.logging.size-rotating-file-handlers.KEY.file: The file description consisting of the path and optional relative to path.
swarm.logging.size-rotating-file-handlers.KEY.filter-spec: A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
swarm.logging.size-rotating-file-handlers.KEY.formatter: Defines a pattern for the formatter.
swarm.logging.size-rotating-file-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.size-rotating-file-handlers.KEY.max-backup-index: The maximum number of backups to keep.
swarm.logging.size-rotating-file-handlers.KEY.name: The name of the handler.
swarm.logging.size-rotating-file-handlers.KEY.named-formatter: The name of the defined formatter to be used on the handler.
swarm.logging.size-rotating-file-handlers.KEY.rotate-on-boot: Indicates the file should be rotated each time the file attribute is changed. This always happens when at initialization time.
swarm.logging.size-rotating-file-handlers.KEY.rotate-size: The size at which to rotate the log file.
swarm.logging.size-rotating-file-handlers.KEY.suffix: Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The suffix does not determine when the file should be rotated.
swarm.logging.syslog-handlers.KEY.app-name: The app name used when formatting the message in RFC5424 format. By default the app name is "java".
swarm.logging.syslog-handlers.KEY.enabled: If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
swarm.logging.syslog-handlers.KEY.facility: Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164 (http://tools.ietf.org/html/rfc3164).
swarm.logging.syslog-handlers.KEY.hostname: The name of the host the messages are being sent from. For example the name of the host the application server is running on.
swarm.logging.syslog-handlers.KEY.level: The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
swarm.logging.syslog-handlers.KEY.port: The port the syslog server is listening on.
swarm.logging.syslog-handlers.KEY.server-address: The address of the syslog server.
swarm.logging.syslog-handlers.KEY.syslog-format: Formats the log message according to the RFC specification.
swarm.logging.use-deployment-logging-config: Indicates whether or not deployments should use a logging configuration file found in the deployment to configure the log manager. If set to true and a logging configuration file was found in the deployments META-INF or WEB-INF/classes directory, then a log manager will be configured with those settings. If set false the servers logging configuration will be used regardless of any logging configuration files supplied in the deployment.

D.22. Management

Provides the JBoss EAP management API.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>management</artifactId>
</dependency>

Configuration

swarm.management.audit-access.audit-log-logger.enabled: Whether audit logging is enabled.
swarm.management.audit-access.audit-log-logger.log-boot: Whether operations should be logged on server boot.
swarm.management.audit-access.audit-log-logger.log-read-only: Whether operations that do not modify the configuration or any runtime services should be logged.
swarm.management.audit-access.file-handlers.KEY.disabled-due-to-failure: Whether this handler has been disabled due to logging failures.
swarm.management.audit-access.file-handlers.KEY.failure-count: The number of logging failures since the handler was initialized.
swarm.management.audit-access.file-handlers.KEY.formatter: The formatter used to format the log messages.
swarm.management.audit-access.file-handlers.KEY.max-failure-count: The maximum number of logging failures before disabling this handler.
swarm.management.audit-access.file-handlers.KEY.path: The path of the audit log file.
swarm.management.audit-access.file-handlers.KEY.relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
swarm.management.audit-access.file-handlers.KEY.rotate-at-startup: Whether the old log file should be rotated at server startup.
swarm.management.audit-access.in-memory-handlers.KEY.max-history: The maximum number of operation stored in history for this handler.
swarm.management.audit-access.json-formatters.KEY.compact: If true will format the JSON on one line. There may still be values containing new lines, so if having the whole record on one line is important, set escape-new-line or escape-control-characters to true.
swarm.management.audit-access.json-formatters.KEY.date-format: The date format to use as understood by java.text.SimpleDateFormat. Will be ignored if include-date="false".
swarm.management.audit-access.json-formatters.KEY.date-separator: The separator between the date and the rest of the formatted log message. Will be ignored if include-date="false".
swarm.management.audit-access.json-formatters.KEY.escape-control-characters: If true will escape all control characters (ascii entries with a decimal value < 32) with the ascii code in octal, e.g.' becomes '#012'. If this is true, it will override escape-new-line="false".
swarm.management.audit-access.json-formatters.KEY.escape-new-line: If true will escape all new lines with the ascii code in octal, e.g. "#012".
swarm.management.audit-access.json-formatters.KEY.include-date: Whether or not to include the date in the formatted log record.
swarm.management.audit-access.periodic-rotating-file-handlers.KEY.disabled-due-to-failure: Whether this handler has been disabled due to logging failures.
swarm.management.audit-access.periodic-rotating-file-handlers.KEY.failure-count: The number of logging failures since the handler was initialized.
swarm.management.audit-access.periodic-rotating-file-handlers.KEY.formatter: The formatter used to format the log messages.
swarm.management.audit-access.periodic-rotating-file-handlers.KEY.max-failure-count: The maximum number of logging failures before disabling this handler.
swarm.management.audit-access.periodic-rotating-file-handlers.KEY.path: The path of the audit log file.
swarm.management.audit-access.periodic-rotating-file-handlers.KEY.relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
swarm.management.audit-access.periodic-rotating-file-handlers.KEY.suffix: The suffix string in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix.
swarm.management.audit-access.size-rotating-file-handlers.KEY.disabled-due-to-failure: Whether this handler has been disabled due to logging failures.
swarm.management.audit-access.size-rotating-file-handlers.KEY.failure-count: The number of logging failures since the handler was initialized.
swarm.management.audit-access.size-rotating-file-handlers.KEY.formatter: The formatter used to format the log messages.
swarm.management.audit-access.size-rotating-file-handlers.KEY.max-backup-index: The maximum number of backups to keep.
swarm.management.audit-access.size-rotating-file-handlers.KEY.max-failure-count: The maximum number of logging failures before disabling this handler.
swarm.management.audit-access.size-rotating-file-handlers.KEY.path: The path of the audit log file.
swarm.management.audit-access.size-rotating-file-handlers.KEY.relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
swarm.management.audit-access.size-rotating-file-handlers.KEY.rotate-size: The size at which to rotate the log file.
swarm.management.audit-access.syslog-handlers.KEY.app-name: The application name to add to the syslog records as defined in section 6.2.5 of RFC-5424. If not specified it will default to the name of the product.
swarm.management.audit-access.syslog-handlers.KEY.disabled-due-to-failure: Whether this handler has been disabled due to logging failures.
swarm.management.audit-access.syslog-handlers.KEY.facility: The facility to use for syslog logging as defined in section 6.2.1 of RFC-5424, and section 4.1.1 of RFC-3164.
swarm.management.audit-access.syslog-handlers.KEY.failure-count: The number of logging failures since the handler was initialized.
swarm.management.audit-access.syslog-handlers.KEY.formatter: The formatter used to format the log messages.
swarm.management.audit-access.syslog-handlers.KEY.max-failure-count: The maximum number of logging failures before disabling this handler.
swarm.management.audit-access.syslog-handlers.KEY.max-length: The maximum length in bytes a log message, including the header, is allowed to be. If undefined, it will default to 1024 bytes if the syslog-format is RFC3164, or 2048 bytes if the syslog-format is RFC5424.
swarm.management.audit-access.syslog-handlers.KEY.syslog-format: Whether to set the syslog format to the one specified in RFC-5424 or RFC-3164.
swarm.management.audit-access.syslog-handlers.KEY.tcp-protocol.host: The host of the syslog server for the tcp requests.
swarm.management.audit-access.syslog-handlers.KEY.tcp-protocol.message-transfer: The message transfer setting as described in section 3.4 of RFC-6587. This can either be OCTET_COUNTING as described in section 3.4.1 of RFC-6587, or NON_TRANSPARENT_FRAMING as described in section 3.4.1 of RFC-6587. See your syslog provider’s documentation for what is supported.
swarm.management.audit-access.syslog-handlers.KEY.tcp-protocol.port: The port of the syslog server for the tcp requests.
swarm.management.audit-access.syslog-handlers.KEY.tcp-protocol.reconnect-timeout: If a connection drop is detected, the number of seconds to wait before reconnecting. A negative number means don’t reconnect automatically.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.client-certificate-store-authentication.key-password: The password for the keystore key.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.client-certificate-store-authentication.key-password-credential-reference: The reference to credential for the keystore key stored in CredentialStore under defined alias or clear text password.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.client-certificate-store-authentication.keystore-password: The password for the keystore.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.client-certificate-store-authentication.keystore-password-credential-reference: The reference to credential for the keystore password stored in CredentialStore under defined alias or clear text password.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.client-certificate-store-authentication.keystore-path: The path of the keystore.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.client-certificate-store-authentication.keystore-relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'keystore-relative-to' is provided, the value of the 'keystore-path' attribute is treated as relative to the path specified by this attribute.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.host: The host of the syslog server for the tls over tcp requests.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.message-transfer: The message transfer setting as described in section 3.4 of RFC-6587. This can either be OCTET_COUNTING as described in section 3.4.1 of RFC-6587, or NON_TRANSPARENT_FRAMING as described in section 3.4.1 of RFC-6587. See your syslog provider’s documentation for what is supported.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.port: The port of the syslog server for the tls over tcp requests.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.reconnect-timeout: If a connection drop is detected, the number of seconds to wait before reconnecting. A negative number means don’t reconnect automatically.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.truststore-authentication.keystore-password: The password for the truststore.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.truststore-authentication.keystore-password-credential-reference: The reference to credential for the truststore password stored in CredentialStore under defined alias or clear text password.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.truststore-authentication.keystore-path: The path of the truststore.
swarm.management.audit-access.syslog-handlers.KEY.tls-protocol.truststore-authentication.keystore-relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'keystore-relative-to' is provided, the value of the 'keystore-path' attribute is treated as relative to the path specified by this attribute.
swarm.management.audit-access.syslog-handlers.KEY.truncate: Whether or not a message, including the header, should truncate the message if the length in bytes is greater than the maximum length. If set to false messages will be split and sent with the same header values.
swarm.management.audit-access.syslog-handlers.KEY.udp-protocol.host: The host of the syslog server for the udp requests.
swarm.management.audit-access.syslog-handlers.KEY.udp-protocol.port: The port of the syslog server for the udp requests.
swarm.management.authorization-access.all-role-names: The official names of all roles supported by the current management access control provider. This includes any standard roles as well as any user-defined roles.
swarm.management.authorization-access.application-classification-constraint.types.KEY.classifications.KEY.applies-tos.KEY.address: Address pattern describing a resource or resources to which the constraint applies.
swarm.management.authorization-access.application-classification-constraint.types.KEY.classifications.KEY.applies-tos.KEY.attributes: List of the names of attributes to which the constraint specifically applies.
swarm.management.authorization-access.application-classification-constraint.types.KEY.classifications.KEY.applies-tos.KEY.entire-resource: True if the constraint applies to the resource as a whole; false if it only applies to one or more attributes or operations.
swarm.management.authorization-access.application-classification-constraint.types.KEY.classifications.KEY.applies-tos.KEY.operations: List of the names of operations to which the constraint specifically applies.
swarm.management.authorization-access.application-classification-constraint.types.KEY.classifications.KEY.configured-application: Set to override the default as to whether the constraint is considered an application resource.
swarm.management.authorization-access.application-classification-constraint.types.KEY.classifications.KEY.default-application: Whether targets having this application type constraint are considered application resources.
swarm.management.authorization-access.permission-combination-policy: The policy for combining access control permissions when the authorization policy grants the user more than one type of permission for a given action. In the standard role based authorization policy, this would occur when a user maps to multiple roles. The 'permissive' policy means if any of the permissions allow the action, the action is allowed. The 'rejecting' policy means the existence of multiple permissions should result in an error.
swarm.management.authorization-access.provider: The provider to use for management access control decisions.
swarm.management.authorization-access.role-mappings.KEY.excludes.KEY.name: The name of the user or group being mapped.
swarm.management.authorization-access.role-mappings.KEY.excludes.KEY.realm: An optional attribute to map based on the realm used for authentication.
swarm.management.authorization-access.role-mappings.KEY.excludes.KEY.type: The type of the Principal being mapped, either 'group' or 'user'.
swarm.management.authorization-access.role-mappings.KEY.include-all: Configure if all authenticated users should be automatically assigned this role.
swarm.management.authorization-access.role-mappings.KEY.includes.KEY.name: The name of the user or group being mapped.
swarm.management.authorization-access.role-mappings.KEY.includes.KEY.realm: An optional attribute to map based on the realm used for authentication.
swarm.management.authorization-access.role-mappings.KEY.includes.KEY.type: The type of the Principal being mapped, either 'group' or 'user'.
swarm.management.authorization-access.sensitivity-classification-constraint.types.KEY.classifications.KEY.applies-tos.KEY.address: Address pattern describing a resource or resources to which the constraint applies.
swarm.management.authorization-access.sensitivity-classification-constraint.types.KEY.classifications.KEY.applies-tos.KEY.attributes: List of the names of attributes to which the constraint specifically applies.
swarm.management.authorization-access.sensitivity-classification-constraint.types.KEY.classifications.KEY.applies-tos.KEY.entire-resource: True if the constraint applies to the resource as a whole; false if it only applies to one or more attributes or operations.
swarm.management.authorization-access.sensitivity-classification-constraint.types.KEY.classifications.KEY.applies-tos.KEY.operations: List of the names of operations to which the constraint specifically applies.
swarm.management.authorization-access.sensitivity-classification-constraint.types.KEY.classifications.KEY.configured-application: Set to override the default as to whether the constraint is considered an application resource.
swarm.management.authorization-access.sensitivity-classification-constraint.types.KEY.classifications.KEY.default-application: Whether targets having this application type constraint are considered application resources.
swarm.management.authorization-access.standard-role-names: The official names of the standard roles supported by the current management access control provider.
swarm.management.authorization-access.use-identity-roles: Should the raw roles obtained from the underlying security identity be used directly?
swarm.management.authorization-access.vault-expression-constraint.configured-requires-read: Set to override the default as to whether reading attributes containing vault expressions should be considered sensitive.
swarm.management.authorization-access.vault-expression-constraint.configured-requires-write: Set to override the default as to whether writing attributes containing vault expressions should be considered sensitive.
swarm.management.authorization-access.vault-expression-constraint.default-requires-read: Whether reading attributes containing vault expressions should be considered sensitive.
swarm.management.authorization-access.vault-expression-constraint.default-requires-write: Whether writing attributes containing vault expressions should be considered sensitive.
swarm.management.bind.interface: Interface to bind for the management ports
swarm.management.configuration-changes-service.max-history: The maximum number of configuration changes stored in history.
swarm.management.http-interface-management-interface.allowed-origins: Comma separated list of trusted Origins for sending Cross-Origin Resource Sharing requests on the management API once the user is authenticated.
swarm.management.http-interface-management-interface.console-enabled: Flag that indicates admin console is enabled
swarm.management.http-interface-management-interface.http-authentication-factory: The authentication policy to use to secure the interface for normal HTTP requests.
swarm.management.http-interface-management-interface.http-upgrade: HTTP Upgrade specific configuration
swarm.management.http-interface-management-interface.http-upgrade-enabled: Flag that indicates HTTP Upgrade is enabled, which allows HTTP requests to be upgraded to native remoting connections
swarm.management.http-interface-management-interface.sasl-protocol: The name of the protocol to be passed to the SASL mechanisms used for authentication.
swarm.management.http-interface-management-interface.secure-socket-binding: The name of the socket binding configuration to use for the HTTPS management interface’s socket. When defined at least one of ssl-context or security-realm must also be defined.
swarm.management.http-interface-management-interface.security-realm: The legacy security realm to use for the HTTP management interface.
swarm.management.http-interface-management-interface.server-name: The name of the server used in the initial Remoting exchange and within the SASL mechanisms.
swarm.management.http-interface-management-interface.socket-binding: The name of the socket binding configuration to use for the HTTP management interface’s socket.
swarm.management.http-interface-management-interface.ssl-context: Reference to the SSLContext to use for this management interface.
swarm.management.http.disable: Flag to disable HTTP access to management interface
swarm.management.http.port: Port for HTTP access to management interface
swarm.management.https.port: Port for HTTPS access to management interface
swarm.management.identity-access.security-domain: Reference to the security domain to use to obtain the current identity performing a management request.
swarm.management.ldap-connections.KEY.always-send-client-cert: If true, the client SSL certificate will be sent to LDAP server with every request; otherwise the client SSL certificate will not be sent when verifying the user credentials
swarm.management.ldap-connections.KEY.handles-referrals-for: List of URLs that this connection handles referrals for.
swarm.management.ldap-connections.KEY.initial-context-factory: The initial context factory to establish the LdapContext.
swarm.management.ldap-connections.KEY.properties.KEY.value: The optional value of the property.
swarm.management.ldap-connections.KEY.referrals: The referral handling mode for this connection.
swarm.management.ldap-connections.KEY.search-credential: The credential to use when connecting to perform a search.
swarm.management.ldap-connections.KEY.search-credential-reference: The reference to the search credential stored in CredentialStore under defined alias or clear text password.
swarm.management.ldap-connections.KEY.search-dn: The distinguished name to use when connecting to the LDAP server to perform searches.
swarm.management.ldap-connections.KEY.security-realm: The security realm to reference to obtain a configured SSLContext to use when establishing the connection.
swarm.management.ldap-connections.KEY.url: The URL to use to connect to the LDAP server.
swarm.management.management-operations-service.active-operations.KEY.access-mechanism: The mechanism used to submit a request to the server.
swarm.management.management-operations-service.active-operations.KEY.address: The address of the resource targeted by the operation. The value in the final element of the address will be '<hidden>' if the caller is not authorized to address the operation’s target resource.
swarm.management.management-operations-service.active-operations.KEY.caller-thread: The name of the thread that is executing the operation.
swarm.management.management-operations-service.active-operations.KEY.cancelled: Whether the operation has been cancelled.
swarm.management.management-operations-service.active-operations.KEY.domain-rollout: True if the operation is a subsidiary request on a domain process other than the one directly handling the original operation, executing locally as part of the rollout of the original operation across the domain.
swarm.management.management-operations-service.active-operations.KEY.domain-uuid: Identifier of an overall multi-process domain operation of which this operation is a part, or undefined if this operation is not associated with such a domain operation.
swarm.management.management-operations-service.active-operations.KEY.exclusive-running-time: Amount of time the operation has been executing with the exclusive operation execution lock held, or -1 if the operation does not hold the exclusive execution lock.
swarm.management.management-operations-service.active-operations.KEY.execution-status: The current activity of the operation.
swarm.management.management-operations-service.active-operations.KEY.operation: The name of the operation, or '<hidden>' if the caller is not authorized to address the operation’s target resource.
swarm.management.management-operations-service.active-operations.KEY.running-time: Amount of time the operation has been executing.
swarm.management.native-interface-management-interface.sasl-authentication-factory: The SASL authentication policy to use to secure this interface.
swarm.management.native-interface-management-interface.sasl-protocol: The name of the protocol to be passed to the SASL mechanisms used for authentication.
swarm.management.native-interface-management-interface.security-realm: The legacy security realm to use for the native management interface.
swarm.management.native-interface-management-interface.server-name: The name of the server used in the initial Remoting exchange and within the SASL mechanisms.
swarm.management.native-interface-management-interface.socket-binding: The name of the socket binding configuration to use for the native management interface’s socket.
swarm.management.native-interface-management-interface.ssl-context: Reference to the SSLContext to use for this management interface.
swarm.management.security-realms.KEY.jaas-authentication.assign-groups: Map the roles loaded by JAAS to groups.
swarm.management.security-realms.KEY.jaas-authentication.name: The name of the JAAS configuration to use.
swarm.management.security-realms.KEY.kerberos-authentication.remove-realm: After authentication should the realm name be stripped from the users name.
swarm.management.security-realms.KEY.kerberos-server-identity.keytabs.KEY.debug: Should additional debug logging be enabled during TGT acquisition?
swarm.management.security-realms.KEY.kerberos-server-identity.keytabs.KEY.for-hosts: A server can be accessed using different host names, this attribute specifies which host names this keytab can be used with.
swarm.management.security-realms.KEY.kerberos-server-identity.keytabs.KEY.path: The path to the keytab.
swarm.management.security-realms.KEY.kerberos-server-identity.keytabs.KEY.relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
swarm.management.security-realms.KEY.ldap-authentication.advanced-filter: The fully defined filter to be used to search for the user based on their entered user ID. The filter should contain a variable in the form {0} - this will be replaced with the username supplied by the user.
swarm.management.security-realms.KEY.ldap-authentication.allow-empty-passwords: Should empty passwords be accepted from the user being authenticated.
swarm.management.security-realms.KEY.ldap-authentication.base-dn: The base distinguished name to commence the search for the user.
swarm.management.security-realms.KEY.ldap-authentication.by-access-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authentication.by-access-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authentication.by-access-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authentication.by-access-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authentication.by-search-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authentication.by-search-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authentication.by-search-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authentication.by-search-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authentication.connection: The name of the connection to use to connect to LDAP.
swarm.management.security-realms.KEY.ldap-authentication.recursive: Whether the search should be recursive.
swarm.management.security-realms.KEY.ldap-authentication.user-dn: The name of the attribute which is the user’s distinguished name.
swarm.management.security-realms.KEY.ldap-authentication.username-attribute: The name of the attribute to search for the user. This filter will then perform a simple search where the username entered by the user matches the attribute specified here.
swarm.management.security-realms.KEY.ldap-authentication.username-load: The name of the attribute that should be loaded from the authenticated users LDAP entry to replace the username that they supplied, e.g. convert an e-mail address to an ID or correct the case entered.
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.base-dn: The starting point of the search for the user.
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.by-access-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.by-access-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.by-access-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.by-access-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.by-search-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.by-search-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.by-search-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.by-search-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.filter: The filter to use for the LDAP search.
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.force: Authentication may have already converted the username to a distinguished name, force this to occur again before loading groups.
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.recursive: Should levels below the starting point be recursively searched?
swarm.management.security-realms.KEY.ldap-authorization.advanced-filter-username-to-dn.user-dn-attribute: The attribute on the user entry that contains their distinguished name.
swarm.management.security-realms.KEY.ldap-authorization.connection: The name of the connection to use to connect to LDAP.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.base-dn: The starting point of the search for the group.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.by-access-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.by-access-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.by-access-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.by-access-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.by-search-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.by-search-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.by-search-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.by-search-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.group-dn-attribute: Which attribute on a group entry is it’s distinguished name.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.group-name: An enumeration to identify if groups should be referenced using a simple name or their distinguished name.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.group-name-attribute: Which attribute on a group entry is it’s simple name.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.iterative: Should further searches be performed to identify groups that the groups identified are a member of?
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.prefer-original-connection: After following a referral should subsequent searches prefer the original connection or use the connection of the last referral.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.principal-attribute: The attribute on the group entry that references the principal.
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.recursive: Should levels below the starting point be recursively searched?
swarm.management.security-realms.KEY.ldap-authorization.group-to-principal-group-search.search-by: Should searches be performed using simple names or distinguished names?
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.by-access-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.by-access-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.by-access-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.by-access-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.by-search-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.by-search-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.by-search-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.by-search-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.group-attribute: The attribute on the principal which references the group the principal is a member of.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.group-dn-attribute: Which attribute on a group entry is it’s distinguished name.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.group-name: An enumeration to identify if groups should be referenced using a simple name or their distinguished name.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.group-name-attribute: Which attribute on a group entry is it’s simple name.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.iterative: Should further searches be performed to identify groups that the groups identified are a member of?
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.parse-group-name-from-dn: Should the group name be extracted from the distinguished name.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.prefer-original-connection: After following a referral should subsequent searches prefer the original connection or use the connection of the last referral.
swarm.management.security-realms.KEY.ldap-authorization.principal-to-group-group-search.skip-missing-groups: If a non-existent group is referenced should it be quietly ignored.
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.attribute: The attribute on the user entry that is their username.
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.base-dn: The starting point of the search for the user.
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.by-access-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.by-access-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.by-access-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.by-access-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.by-search-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.by-search-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.by-search-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.by-search-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.force: Authentication may have already converted the username to a distinguished name, force this to occur again before loading groups.
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.recursive: Should levels below the starting point be recursively searched?
swarm.management.security-realms.KEY.ldap-authorization.username-filter-username-to-dn.user-dn-attribute: The attribute on the user entry that contains their distinguished name.
swarm.management.security-realms.KEY.ldap-authorization.username-is-dn-username-to-dn.by-access-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authorization.username-is-dn-username-to-dn.by-access-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authorization.username-is-dn-username-to-dn.by-access-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authorization.username-is-dn-username-to-dn.by-access-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authorization.username-is-dn-username-to-dn.by-search-time-cache.cache-failures: Should failures be cached?
swarm.management.security-realms.KEY.ldap-authorization.username-is-dn-username-to-dn.by-search-time-cache.cache-size: The current size of the cache.
swarm.management.security-realms.KEY.ldap-authorization.username-is-dn-username-to-dn.by-search-time-cache.eviction-time: The time in seconds until an entry should be evicted from the cache.
swarm.management.security-realms.KEY.ldap-authorization.username-is-dn-username-to-dn.by-search-time-cache.max-cache-size: The maximum size of the cache before the oldest items are removed to make room for new entries.
swarm.management.security-realms.KEY.ldap-authorization.username-is-dn-username-to-dn.force: Authentication may have already converted the username to a distinguished name, force this to occur again before loading groups.
swarm.management.security-realms.KEY.local-authentication.allowed-users: The comma separated list of users that will be accepted using the JBOSS-LOCAL-USER mechanism or '*' to accept all. If specified the default-user is always assumed allowed.
swarm.management.security-realms.KEY.local-authentication.default-user: The name of the default user to assume if no user specified by the remote client.
swarm.management.security-realms.KEY.local-authentication.skip-group-loading: Disable the loading of the users group membership information after local authentication has been used.
swarm.management.security-realms.KEY.map-groups-to-roles: After a users group membership has been loaded should a 1:1 relationship be assumed regarding group to role mapping.
swarm.management.security-realms.KEY.plug-in-authentication.mechanism: Allow the mechanism this plug-in is compatible with to be overridden from DIGEST.
swarm.management.security-realms.KEY.plug-in-authentication.name: The short name of the plug-in (as registered) to use.
swarm.management.security-realms.KEY.plug-in-authentication.properties.KEY.value: The optional value of the property.
swarm.management.security-realms.KEY.plug-in-authorization.name: The short name of the plug-in (as registered) to use.
swarm.management.security-realms.KEY.plug-in-authorization.properties.KEY.value: The optional value of the property.
swarm.management.security-realms.KEY.properties-authentication.path: The path of the properties file containing the users.
swarm.management.security-realms.KEY.properties-authentication.plain-text: Are the credentials within the properties file stored in plain text. If not the credential is expected to be the hex encoded Digest hash of 'username : realm : password'.
swarm.management.security-realms.KEY.properties-authentication.relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
swarm.management.security-realms.KEY.properties-authorization.path: The path of the properties file containing the users roles.
swarm.management.security-realms.KEY.properties-authorization.relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
swarm.management.security-realms.KEY.secret-server-identity.credential-reference: The reference to credential for the secret / password stored in CredentialStore under defined alias or clear text password.
swarm.management.security-realms.KEY.secret-server-identity.value: The secret / password - Base64 Encoded.
swarm.management.security-realms.KEY.ssl-server-identity.alias: The alias of the entry to use from the keystore.
swarm.management.security-realms.KEY.ssl-server-identity.enabled-cipher-suites: The cipher suites that can be enabled on the underlying SSLEngine.
swarm.management.security-realms.KEY.ssl-server-identity.enabled-protocols: The protocols that can be enabled on the underlying SSLEngine.
swarm.management.security-realms.KEY.ssl-server-identity.generate-self-signed-certificate-host: If the keystore does not exist and this attribute is set then a self signed certificate will be generated for the specified host name. This is not intended for production use.
swarm.management.security-realms.KEY.ssl-server-identity.key-password: The password to obtain the key from the keystore.
swarm.management.security-realms.KEY.ssl-server-identity.key-password-credential-reference: The reference to credential for the keystore key stored in CredentialStore under defined alias or clear text password.
swarm.management.security-realms.KEY.ssl-server-identity.keystore-password: The password to open the keystore.
swarm.management.security-realms.KEY.ssl-server-identity.keystore-password-credential-reference: The reference to credential for the keystore password stored in CredentialStore under defined alias or clear text password.
swarm.management.security-realms.KEY.ssl-server-identity.keystore-path: The path of the keystore, will be ignored if the keystore-provider is anything other than JKS.
swarm.management.security-realms.KEY.ssl-server-identity.keystore-provider: The provider for loading the keystore, defaults to JKS.
swarm.management.security-realms.KEY.ssl-server-identity.keystore-relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
swarm.management.security-realms.KEY.ssl-server-identity.protocol: The protocol to use when creating the SSLContext.
swarm.management.security-realms.KEY.truststore-authentication.keystore-password: The password to open the keystore.
swarm.management.security-realms.KEY.truststore-authentication.keystore-password-credential-reference: The reference to credential for the keystore password stored in CredentialStore under defined alias or clear text password.
swarm.management.security-realms.KEY.truststore-authentication.keystore-path: The path of the keystore, will be ignored if the keystore-provider is anything other than JKS.
swarm.management.security-realms.KEY.truststore-authentication.keystore-provider: The provider for loading the keystore, defaults to JKS.
swarm.management.security-realms.KEY.truststore-authentication.keystore-relative-to: The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
swarm.management.security-realms.KEY.users-authentication.users.KEY.credential-reference: The reference to credential for the password stored in CredentialStore under defined alias or clear text password.
swarm.management.security-realms.KEY.users-authentication.users.KEY.password: The user’s password.

D.23. MicroProfile

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>microprofile</artifactId>
</dependency>

D.23.1. MicroProfile Config

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>microprofile-config</artifactId>
</dependency>

Configuration

swarm.microprofile.config.config-source-providers.KEY.attribute-class: Class of the ConfigSourceProvider to load
swarm.microprofile.config.config-sources.KEY.attribute-class: Class of the config source to load
swarm.microprofile.config.config-sources.KEY.dir: Directory that is scanned to config properties for this config source (file names are key, file content are value)
swarm.microprofile.config.config-sources.KEY.ordinal: Ordinal value for the config source
swarm.microprofile.config.config-sources.KEY.properties: Properties configured for this config source

D.23.2. MicroProfile Fault Tolerance

This fraction implements the Eclipse MicroProfile Fault Tolerance API. The implementation depends on the Hystrix fraction, which is added transitively into your application. Use standard configuration mechanisms to configure Hystrix properties in your application.

D.23.2.1. Bulkhead fallback rejection

If you use the @Bulkhead pattern together with some @Fallback logic to limit the number of concurrent requests, an invocation may still result in an exception.

D.23.2.1.1. Semaphore Isolation

For semaphore-style @Bulkhead a BulkheadException may be thrown if the maximum concurrent limit is reached. To avoid that, set the swarm.hystrix.command.default.fallback.isolation.semaphore.maxConcurrentRequests property to increase the limit.

D.23.2.1.2. Thread Isolation

For @Bulkhead used together with @Asynchronous a RejectedExecutionException may be thrown if the maximum concurrent limit is reached. To avoid that, set the swarm.hystrix.threadpool.default.maximumSize property to increase the limit. Also don’t forget to set the swarm.hystrix.threadpool.default.allowMaximumSizeToDivergeFromCoreSize property to true.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>microprofile-fault-tolerance</artifactId>
</dependency>

Configuration

swarm.microprofile.fault-tolerance.synchronous-circuit-breaker: Enable/disable synchronous circuit breaker functionality. If disabled, CircuitBreaker#successThreshold() of value greater than 1 is not supported. Moreover, circuit breaker does not necessarily transition from CLOSED to OPEN immediately when a fault tolerance operation completes. However, applications are encouraged to disable this feature on high-volume circuits.

D.23.3. MicroProfile Health

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>microprofile-health</artifactId>
</dependency>

Configuration

swarm.microprofile.health.security-realm: Security realm configuration

D.23.4. MicroProfile JWT RBAC Auth

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>microprofile-jwt</artifactId>
</dependency>

Configuration

swarm.microprofile.jwt.default-missing-method-permissions-deny-access: If a JAX-RS resource has no class-level security metadata, then if this property is set to true and at least one resource method has security metadata all other resource methods without security metadata have an implicit @DenyAll, otherwise resource methods without security metadata are not secured
swarm.microprofile.jwt.token.exp-grace-period: The JWT token expiration grace period in seconds
swarm.microprofile.jwt.token.issued-by: The URI of the JWT token issuer
swarm.microprofile.jwt.token.jwks-refresh-interval: The interval at which the JWKS URI should be queried for keys (in minutes).
swarm.microprofile.jwt.token.jwks-uri: The JWKS URI from which to load public keys (if 'signer-pub-key' is set, this setting is ignored).
swarm.microprofile.jwt.token.signer-pub-key: The public key of the JWT token signer. Can be prefixed 'file:' or 'classpath:' for key assets, otherwise the key contents are expected

D.23.5. MicroProfile Metrics

This fraction implements the MicroProfile Metrics 1.0 specification.

To use this in your project you need the following in your pom.xml

   <dependency>
      <groupId>io.thorntail</groupId>
      <artifactId>microprofile-metrics</artifactId>
    </dependency>

There is no need to include the MicroProfile Metrics API dependency, as it comes with the fraction.

By default the base metrics and vendor metrics of the server are exposed as required by the spec.

Note

Exposing application metrics currently only works if you chose war packaging of your application

<project>
  <groupId>org.example</groupId>
  <artifactId>thorntail-demo</artifactId>
  <packaging>war</packaging> 1

1: war packaging

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>microprofile-metrics</artifactId>
</dependency>

D.23.6. MicroProfile OpenAPI

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>microprofile-openapi</artifactId>
</dependency>

D.23.7. MicroProfile OpenTracing

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>microprofile-opentracing</artifactId>
</dependency>

D.23.8. MicroProfile Rest Client

D.23.8.1. CDI Interceptors Support

In general, Rest Client proxies are not created by the CDI container and therefore method invocations do not pass through CDI interceptors. In Thorntail, however, you can associate business method interceptors (denoted by the @AroundInvoke annotation) with a Rest Client proxy by using interceptor bindings. This feature is non-portable. The primary use case is the support of Section D.23.2, “MicroProfile Fault Tolerance” annotations, for example:

import org.eclipse.microprofile.faulttolerance.Retry;

@Path("/v1")
interface MyClient {

    @Retry(maxRetries = 3) // Retry on any exception thrown
    @GET
    @Path("/hello")
    String hello();
}

Note

The org.eclipse.microprofile.faulttolerance.Asynchronous annotation is currently not supported because the underlying RESTEasy client is not able to handle the java.util.concurrent.Future return types.

D.23.8.2. RestClientProxy

In addition to the MicroProfile Rest Client specification, every Rest Client proxy implements io.smallrye.restclient.RestClientProxy interface which allows you to:

obtain the underlying javax.ws.rs.client.Client instance

release all associated resources, for example:

public void hello() {
   MyClient myClient = RestClientBuilder.newBuilder().build(MyClient.class);
   myClient.hello();
   // Finally release all associated resources
   ((RestClientProxy) helloClient).close();
}

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>microprofile-restclient</artifactId>
</dependency>

D.24. Monitor

Warning

This fraction is deprecated. Use the io.thorntail:microprofile-health fraction instead.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>monitor</artifactId>
</dependency>

Configuration

swarm.monitor.security-realm: (not yet documented)

D.25. MSC

Primarily an internal fraction providing support for the JBoss Modular Container (MSC). JBoss MSC provides the underpinning for all services wired together supporting the container and the application.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>msc</artifactId>
</dependency>

D.26. Naming

Provides support for JNDI.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>naming</artifactId>
</dependency>

Configuration

swarm.naming.bindings.KEY.attribute-class: The object factory class name for object factory bindings
swarm.naming.bindings.KEY.binding-type: The type of binding to create, may be simple, lookup, external-context or object-factory
swarm.naming.bindings.KEY.cache: If the external context should be cached
swarm.naming.bindings.KEY.environment: The environment to use on object factory instance retrieval
swarm.naming.bindings.KEY.lookup: The entry to lookup in JNDI for lookup bindings
swarm.naming.bindings.KEY.module: The module to load the object factory from for object factory bindings
swarm.naming.bindings.KEY.type: The type of the value to bind for simple bindings, this must be a primitive type
swarm.naming.bindings.KEY.value: The value to bind for simple bindings

D.27. Guava

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>netflix-guava</artifactId>
</dependency>

D.28. RX-Java

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>netflix-rxjava</artifactId>
</dependency>

D.29. OpenTracing

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>opentracing</artifactId>
</dependency>

Configuration

swarm.opentracing.servlet.skipPattern: The servlet skip pattern as a Java compilable Pattern. Optional. Ex.: /health-check

D.29.1. OpenTracing TracerResolver

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>opentracing-tracerresolver</artifactId>
</dependency>

D.30. Remoting

Primarily an internal fraction providing remote invocation support for higher-level fractions such as EJB.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>remoting</artifactId>
</dependency>

Configuration

swarm.remoting.connectors.KEY.authentication-provider: The "authentication-provider" element contains the name of the authentication provider to use for incoming connections.
swarm.remoting.connectors.KEY.properties.KEY.value: The property value.
swarm.remoting.connectors.KEY.sasl-authentication-factory: Reference to the SASL authentication factory to secure this connector.
swarm.remoting.connectors.KEY.sasl-protocol: The protocol to pass into the SASL mechanisms used for authentication.
swarm.remoting.connectors.KEY.sasl-security.include-mechanisms: The optional nested "include-mechanisms" element contains a whitelist of allowed SASL mechanism names. No mechanisms will be allowed which are not present in this list.
swarm.remoting.connectors.KEY.sasl-security.policy-sasl-policy.forward-secrecy: The optional nested "forward-secrecy" element contains a boolean value which specifies whether mechanisms that implement forward secrecy between sessions are required. Forward secrecy means that breaking into one session will not automatically provide information for breaking into future sessions.
swarm.remoting.connectors.KEY.sasl-security.policy-sasl-policy.no-active: The optional nested "no-active" element contains a boolean value which specifies whether mechanisms susceptible to active (non-dictionary) attacks are not permitted. "false" to permit, "true" to deny.
swarm.remoting.connectors.KEY.sasl-security.policy-sasl-policy.no-anonymous: The optional nested "no-anonymous" element contains a boolean value which specifies whether mechanisms that accept anonymous login are permitted. "false" to permit, "true" to deny.
swarm.remoting.connectors.KEY.sasl-security.policy-sasl-policy.no-dictionary: The optional nested "no-dictionary" element contains a boolean value which specifies whether mechanisms susceptible to passive dictionary attacks are permitted. "false" to permit, "true" to deny.
swarm.remoting.connectors.KEY.sasl-security.policy-sasl-policy.no-plain-text: The optional nested "no-plain-text" element contains a boolean value which specifies whether mechanisms susceptible to simple plain passive attacks (e.g., "PLAIN") are not permitted. "false" to permit, "true" to deny.
swarm.remoting.connectors.KEY.sasl-security.policy-sasl-policy.pass-credentials: The optional nested "pass-credentials" element contains a boolean value which specifies whether mechanisms that pass client credentials are required.
swarm.remoting.connectors.KEY.sasl-security.properties.KEY.value: The property value.
swarm.remoting.connectors.KEY.sasl-security.qop: The optional nested "qop" element contains a list of quality-of-protection values, in decreasing order of preference.
swarm.remoting.connectors.KEY.sasl-security.reuse-session: The optional nested "reuse-session" boolean element specifies whether or not the server should attempt to reuse previously authenticated session information. The mechanism may or may not support such reuse, and other factors may also prevent it.
swarm.remoting.connectors.KEY.sasl-security.server-auth: The optional nested "server-auth" boolean element specifies whether the server should authenticate to the client. Not all mechanisms may support this setting.
swarm.remoting.connectors.KEY.sasl-security.strength: The optional nested "strength" element contains a list of cipher strength values, in decreasing order of preference.
swarm.remoting.connectors.KEY.security-realm: The associated security realm to use for authentication for this connector.
swarm.remoting.connectors.KEY.server-name: The server name to send in the initial message exchange and for SASL based authentication.
swarm.remoting.connectors.KEY.socket-binding: The name of the socket binding to attach to.
swarm.remoting.connectors.KEY.ssl-context: Reference to the SSLContext to use for this connector.
swarm.remoting.endpoint-configuration.auth-realm: The authentication realm to use if no authentication {@code CallbackHandler} is specified.
swarm.remoting.endpoint-configuration.authentication-retries: Specify the number of times a client is allowed to retry authentication before closing the connection.
swarm.remoting.endpoint-configuration.authorize-id: The SASL authorization ID. Used as authentication user name to use if no authentication {@code CallbackHandler} is specifiedand the selected SASL mechanism demands a user name.
swarm.remoting.endpoint-configuration.buffer-region-size: The size of allocated buffer regions.
swarm.remoting.endpoint-configuration.heartbeat-interval: The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound directionfor this amount of time, a ping message will be sent, which will trigger a corresponding reply message.
swarm.remoting.endpoint-configuration.max-inbound-channels: The maximum number of inbound channels to support for a connection.
swarm.remoting.endpoint-configuration.max-inbound-message-size: The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown on the reading side as well as the writing side.
swarm.remoting.endpoint-configuration.max-inbound-messages: The maximum number of concurrent inbound messages on a channel.
swarm.remoting.endpoint-configuration.max-outbound-channels: The maximum number of outbound channels to support for a connection.
swarm.remoting.endpoint-configuration.max-outbound-message-size: The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do so will cause an exception on the writing side.
swarm.remoting.endpoint-configuration.max-outbound-messages: The maximum number of concurrent outbound messages on a channel.
swarm.remoting.endpoint-configuration.receive-buffer-size: The size of the largest buffer that this endpoint will accept over a connection.
swarm.remoting.endpoint-configuration.receive-window-size: The maximum window size of the receive direction for connection channels, in bytes.
swarm.remoting.endpoint-configuration.sasl-protocol: Where a SaslServer or SaslClient are created by default the protocol specified it 'remoting', this can be used to override this.
swarm.remoting.endpoint-configuration.send-buffer-size: The size of the largest buffer that this endpoint will transmit over a connection.
swarm.remoting.endpoint-configuration.server-name: The server side of the connection passes it’s name to the client in the initial greeting, by default the name is automatically discovered from the local address of the connection or it can be overridden using this.
swarm.remoting.endpoint-configuration.transmit-window-size: The maximum window size of the transmit direction for connection channels, in bytes.
swarm.remoting.endpoint-configuration.worker: Worker to use
swarm.remoting.http-connectors.KEY.authentication-provider: The "authentication-provider" element contains the name of the authentication provider to use for incoming connections.
swarm.remoting.http-connectors.KEY.connector-ref: The name (or names) of a connector in the Undertow subsystem to connect to.
swarm.remoting.http-connectors.KEY.properties.KEY.value: The property value.
swarm.remoting.http-connectors.KEY.sasl-authentication-factory: Reference to the SASL authentication factory to use for this connector.
swarm.remoting.http-connectors.KEY.sasl-protocol: The protocol to pass into the SASL mechanisms used for authentication.
swarm.remoting.http-connectors.KEY.sasl-security.include-mechanisms: The optional nested "include-mechanisms" element contains a whitelist of allowed SASL mechanism names. No mechanisms will be allowed which are not present in this list.
swarm.remoting.http-connectors.KEY.sasl-security.policy-sasl-policy.forward-secrecy: The optional nested "forward-secrecy" element contains a boolean value which specifies whether mechanisms that implement forward secrecy between sessions are required. Forward secrecy means that breaking into one session will not automatically provide information for breaking into future sessions.
swarm.remoting.http-connectors.KEY.sasl-security.policy-sasl-policy.no-active: The optional nested "no-active" element contains a boolean value which specifies whether mechanisms susceptible to active (non-dictionary) attacks are not permitted. "false" to permit, "true" to deny.
swarm.remoting.http-connectors.KEY.sasl-security.policy-sasl-policy.no-anonymous: The optional nested "no-anonymous" element contains a boolean value which specifies whether mechanisms that accept anonymous login are permitted. "false" to permit, "true" to deny.
swarm.remoting.http-connectors.KEY.sasl-security.policy-sasl-policy.no-dictionary: The optional nested "no-dictionary" element contains a boolean value which specifies whether mechanisms susceptible to passive dictionary attacks are permitted. "false" to permit, "true" to deny.
swarm.remoting.http-connectors.KEY.sasl-security.policy-sasl-policy.no-plain-text: The optional nested "no-plain-text" element contains a boolean value which specifies whether mechanisms susceptible to simple plain passive attacks (e.g., "PLAIN") are not permitted. "false" to permit, "true" to deny.
swarm.remoting.http-connectors.KEY.sasl-security.policy-sasl-policy.pass-credentials: The optional nested "pass-credentials" element contains a boolean value which specifies whether mechanisms that pass client credentials are required.
swarm.remoting.http-connectors.KEY.sasl-security.properties.KEY.value: The property value.
swarm.remoting.http-connectors.KEY.sasl-security.qop: The optional nested "qop" element contains a list of quality-of-protection values, in decreasing order of preference.
swarm.remoting.http-connectors.KEY.sasl-security.reuse-session: The optional nested "reuse-session" boolean element specifies whether or not the server should attempt to reuse previously authenticated session information. The mechanism may or may not support such reuse, and other factors may also prevent it.
swarm.remoting.http-connectors.KEY.sasl-security.server-auth: The optional nested "server-auth" boolean element specifies whether the server should authenticate to the client. Not all mechanisms may support this setting.
swarm.remoting.http-connectors.KEY.sasl-security.strength: The optional nested "strength" element contains a list of cipher strength values, in decreasing order of preference.
swarm.remoting.http-connectors.KEY.security-realm: The associated security realm to use for authentication for this connector.
swarm.remoting.http-connectors.KEY.server-name: The server name to send in the initial message exchange and for SASL based authentication.
swarm.remoting.local-outbound-connections.KEY.outbound-socket-binding-ref: Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.
swarm.remoting.local-outbound-connections.KEY.properties.KEY.value: The property value.
swarm.remoting.outbound-connections.KEY.properties.KEY.value: The property value.
swarm.remoting.outbound-connections.KEY.uri: The connection URI for the outbound connection.
swarm.remoting.port: Port for legacy remoting connector
swarm.remoting.remote-outbound-connections.KEY.authentication-context: Reference to the authentication context instance containing the configuration for outbound connections.
swarm.remoting.remote-outbound-connections.KEY.outbound-socket-binding-ref: Name of the outbound-socket-binding which will be used to determine the destination address and port for the connection.
swarm.remoting.remote-outbound-connections.KEY.properties.KEY.value: The property value.
swarm.remoting.remote-outbound-connections.KEY.protocol: The protocol to use for the remote connection.
swarm.remoting.remote-outbound-connections.KEY.security-realm: Reference to the security realm to use to obtain the password and SSL configuration.
swarm.remoting.remote-outbound-connections.KEY.username: The user name to use when authenticating against the remote server.
swarm.remoting.required: (not yet documented)
swarm.remoting.worker-read-threads: The number of read threads to create for the remoting worker.
swarm.remoting.worker-task-core-threads: The number of core threads for the remoting worker task thread pool.
swarm.remoting.worker-task-keepalive: The number of milliseconds to keep non-core remoting worker task threads alive.
swarm.remoting.worker-task-limit: The maximum number of remoting worker tasks to allow before rejecting.
swarm.remoting.worker-task-max-threads: The maximum number of threads for the remoting worker task thread pool.
swarm.remoting.worker-write-threads: The number of write threads to create for the remoting worker.

D.31. Request Controller

Provides support for the JBoss EAP request-controller, allowing for graceful pause/resume/shutdown of the container.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>request-controller</artifactId>
</dependency>

Configuration

swarm.request-controller.active-requests: The number of requests that are currently running in the server
swarm.request-controller.max-requests: The maximum number of all types of requests that can be running in a server at a time. Once this limit is hit any new requests will be rejected.
swarm.request-controller.track-individual-endpoints: If this is true requests are tracked at an endpoint level, which will allow individual deployments to be suspended

D.32. Resource Adapters

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>resource-adapters</artifactId>
</dependency>

Configuration

swarm.resource-adapters.resource-adapters.KEY.admin-objects.KEY.class-name: Specifies the fully qualified class name of an administration object.
swarm.resource-adapters.resource-adapters.KEY.admin-objects.KEY.config-properties.KEY.value: Custom defined config property value.
swarm.resource-adapters.resource-adapters.KEY.admin-objects.KEY.enabled: Specifies if the administration object should be enabled.
swarm.resource-adapters.resource-adapters.KEY.admin-objects.KEY.jndi-name: Specifies the JNDI name for the administration object.
swarm.resource-adapters.resource-adapters.KEY.admin-objects.KEY.use-java-context: Setting this to false will bind the object into global JNDI.
swarm.resource-adapters.resource-adapters.KEY.archive: Specifies the resource adapter archive.
swarm.resource-adapters.resource-adapters.KEY.beanvalidationgroups: Specifies the bean validation groups that should be used.
swarm.resource-adapters.resource-adapters.KEY.bootstrap-context: Specifies the unique name of the bootstrap context that should be used.
swarm.resource-adapters.resource-adapters.KEY.config-properties.KEY.value: Custom defined config property value.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.allocation-retry: The allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.allocation-retry-wait-millis: The allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.authentication-context: The Elytron authentication context which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.authentication-context-and-application: Indicates that either application-supplied parameters, such as from getConnection(user, pw), or Subject (provided by Elytron after authenticating using configured authentication-context), are used to distinguish connections in the pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.background-validation: An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.background-validation-millis: The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.blocking-timeout-wait-millis: The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.capacity-decrementer-class: Class defining the policy for decrementing connections in the pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.capacity-decrementer-properties: Properties to inject in class defining the policy for decrementing connections in the pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.capacity-incrementer-class: Class defining the policy for incrementing connections in the pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.capacity-incrementer-properties: Properties to inject in class defining the policy for incrementing connections in the pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.class-name: Specifies the fully qualified class name of a managed connection factory or admin object.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.config-properties.KEY.value: Custom defined config property value.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.connectable: Enable the use of CMR. This feature means that a local resource can reliably participate in an XA transaction.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.elytron-enabled: Enables Elytron security for handling authentication of connections. The Elytron authentication-context to be used will be current context if no context is specified (see authentication-context).
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.enabled: Specifies if the resource adapter should be enabled.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.enlistment: Defines if lazy enlistment should be used if supported by the resource adapter.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.enlistment-trace: Defines if WildFly/IronJacamar should record enlistment traces.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.flush-strategy: Specifies how the pool should be flushed in case of an error.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.idle-timeout-minutes: Specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value requires a server restart.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.initial-pool-size: Specifies the initial number of connections a pool should hold.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.interleaving: An element to enable interleaving for XA connections.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.jndi-name: Specifies the JNDI name for the connection factory.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.max-pool-size: Specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.mcp: Defines the ManagedConnectionPool implementation. For example: org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.min-pool-size: Specifies the minimum number of connections for a pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.no-recovery: Specifies if the connection pool should be excluded from recovery.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.no-tx-separate-pool: Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.pad-xid: Specifies whether the Xid should be padded.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.pool-fair: Defines if pool use should be fair.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.pool-prefill: Specifies if the pool should be prefilled. Changing this value requires a server restart.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.pool-use-strict-min: Specifies if the min-pool-size should be considered strict.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.recovery-authentication-context: The Elytron authentication context used for recovery (current authentication-context will be used if unspecified).
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.recovery-credential-reference: Credential (from Credential Store) to authenticate on recovery connection
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.recovery-elytron-enabled: Indicates that an Elytron authentication context will be used for recovery.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.recovery-password: The password used for recovery.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.recovery-plugin-class-name: The fully qualified class name of the recovery plugin implementation.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.recovery-plugin-properties: The properties for the recovery plugin.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.recovery-security-domain: The PicketBox security domain used for recovery.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.recovery-username: The user name used for recovery.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.same-rm-override: Using this attribute, you can unconditionally set whether javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.security-application: Indicates that application-supplied parameters, such as from getConnection(user, pw), are used to distinguish connections in the pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.security-domain: Specifies the PicketBox security domain which defines the javax.security.auth.Subject that is used to distinguish connections in the pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.security-domain-and-application: Indicates that either application-supplied parameters, such as from getConnection(user, pw), or Subject (from PicketBox security domain), are used to distinguish connections in the pool.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.sharable: Enable the use of sharable connections, which allows lazy association to be enabled if supported.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.tracking: Defines if IronJacamar should track connection handles across transaction boundaries.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.use-ccm: Enable the use of a cached connection manager.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.use-fast-fail: Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false).
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.use-java-context: Setting this to false will bind the object into global JNDI.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.validate-on-match: This specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.wrap-xa-resource: Specifies whether XAResource instances should be wrapped in an org.jboss.tm.XAResourceWrapper instance.
swarm.resource-adapters.resource-adapters.KEY.connection-definitions.KEY.xa-resource-timeout: The value is passed to XAResource.setTransactionTimeout(), in seconds.
swarm.resource-adapters.resource-adapters.KEY.module: Specifies the module from which resource adapter will be loaded
swarm.resource-adapters.resource-adapters.KEY.statistics-enabled: Define whether runtime statistics are enabled or not.
swarm.resource-adapters.resource-adapters.KEY.transaction-support: Specifies the transaction support level of the resource adapter.
swarm.resource-adapters.resource-adapters.KEY.wm-elytron-security-domain: Defines the name of the Elytron security domain that should be used.
swarm.resource-adapters.resource-adapters.KEY.wm-security: Toggle on/off wm.security for this resource adapter. In case of false all wm-security-* parameters are ignored, even the defaults.
swarm.resource-adapters.resource-adapters.KEY.wm-security-default-groups: Defines a default groups list that should be added to the used Subject instance.
swarm.resource-adapters.resource-adapters.KEY.wm-security-default-principal: Defines a default principal name that should be added to the used Subject instance.
swarm.resource-adapters.resource-adapters.KEY.wm-security-domain: Defines the name of the PicketBox security domain that should be used.
swarm.resource-adapters.resource-adapters.KEY.wm-security-mapping-groups: List of groups mappings.
swarm.resource-adapters.resource-adapters.KEY.wm-security-mapping-required: Defines if a mapping is required for security credentials.
swarm.resource-adapters.resource-adapters.KEY.wm-security-mapping-users: List of user mappings.

D.33. Security

Provides underlying security infrastructure to support JAAS and other security APIs.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>security</artifactId>
</dependency>

Configuration

swarm.security.classic-vault.code: Fully Qualified Name of the Security Vault Implementation.
swarm.security.classic-vault.vault-options: Security Vault options.
swarm.security.deep-copy-subject-mode: Sets the copy mode of subjects done by the security managers to be deep copies that makes copies of the subject principals and credentials if they are cloneable. It should be set to true if subject include mutable content that can be corrupted when multiple threads have the same identity and cache flushes/logout clearing the subject in one thread results in subject references affecting other threads.
swarm.security.elytron-key-managers.KEY.legacy-jsse-config: The name of the legacy security domain that contains a JSSE configuration that can be used to export the key manager.
swarm.security.elytron-key-stores.KEY.legacy-jsse-config: The name of the legacy security domain that contains a JSSE configuration that can be used to export the key store.
swarm.security.elytron-realms.KEY.apply-role-mappers: Indicates to the realm if it should apply the role mappers defined in the legacy domain to the roles obtained from authenticated Subjects or not.
swarm.security.elytron-realms.KEY.legacy-jaas-config: The name of the legacy security domain to which authentication will be delegated.
swarm.security.elytron-trust-managers.KEY.legacy-jsse-config: The name of the legacy security domain that contains a JSSE configuration that can be used to export the trust manager.
swarm.security.elytron-trust-stores.KEY.legacy-jsse-config: The name of the legacy security domain that contains a JSSE configuration that can be used to export the trust store.
swarm.security.initialize-jacc: Indicates if this subsystem should be in charge of initializing JACC related services.
swarm.security.security-domains.KEY.cache-type: Adds a cache to speed up authentication checks. Allowed values are 'default' to use simple map as the cache and 'infinispan' to use an Infinispan cache.
swarm.security.security-domains.KEY.classic-acl.acl-modules.KEY.code: Class name of the module to be instantiated.
swarm.security.security-domains.KEY.classic-acl.acl-modules.KEY.flag: The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.
swarm.security.security-domains.KEY.classic-acl.acl-modules.KEY.module: Name of JBoss Module where the login module is located.
swarm.security.security-domains.KEY.classic-acl.acl-modules.KEY.module-options: List of module options containing a name/value pair.
swarm.security.security-domains.KEY.classic-audit.provider-modules.KEY.code: Class name of the module to be instantiated.
swarm.security.security-domains.KEY.classic-audit.provider-modules.KEY.module: Name of JBoss Module where the mapping module code is located.
swarm.security.security-domains.KEY.classic-audit.provider-modules.KEY.module-options: List of module options containing a name/value pair.
swarm.security.security-domains.KEY.classic-authentication.login-modules.KEY.code: Class name of the module to be instantiated.
swarm.security.security-domains.KEY.classic-authentication.login-modules.KEY.flag: The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.
swarm.security.security-domains.KEY.classic-authentication.login-modules.KEY.module: Name of JBoss Module where the login module is located.
swarm.security.security-domains.KEY.classic-authentication.login-modules.KEY.module-options: List of module options containing a name/value pair.
swarm.security.security-domains.KEY.classic-authorization.policy-modules.KEY.code: Class name of the module to be instantiated.
swarm.security.security-domains.KEY.classic-authorization.policy-modules.KEY.flag: The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.
swarm.security.security-domains.KEY.classic-authorization.policy-modules.KEY.module: Name of JBoss Module where the login module is located.
swarm.security.security-domains.KEY.classic-authorization.policy-modules.KEY.module-options: List of module options containing a name/value pair.
swarm.security.security-domains.KEY.classic-identity-trust.trust-modules.KEY.code: Class name of the module to be instantiated.
swarm.security.security-domains.KEY.classic-identity-trust.trust-modules.KEY.flag: The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.
swarm.security.security-domains.KEY.classic-identity-trust.trust-modules.KEY.module: Name of JBoss Module where the login module is located.
swarm.security.security-domains.KEY.classic-identity-trust.trust-modules.KEY.module-options: List of module options containing a name/value pair.
swarm.security.security-domains.KEY.classic-jsse.additional-properties: Additional properties that may be necessary to configure JSSE.
swarm.security.security-domains.KEY.classic-jsse.cipher-suites: Comma separated list of cipher suites to enable on SSLSockets.
swarm.security.security-domains.KEY.classic-jsse.client-alias: Preferred alias to use when the KeyManager chooses the client alias.
swarm.security.security-domains.KEY.classic-jsse.client-auth: Boolean attribute to indicate if client’s certificates should also be authenticated on the server side.
swarm.security.security-domains.KEY.classic-jsse.key-manager: JSEE Key Manager factory
swarm.security.security-domains.KEY.classic-jsse.keystore: Configures a JSSE key store
swarm.security.security-domains.KEY.classic-jsse.protocols: Comma separated list of protocols to enable on SSLSockets.
swarm.security.security-domains.KEY.classic-jsse.server-alias: Preferred alias to use when the KeyManager chooses the server alias.
swarm.security.security-domains.KEY.classic-jsse.service-auth-token: Token to retrieve PrivateKeys from the KeyStore.
swarm.security.security-domains.KEY.classic-jsse.trust-manager: JSEE Trust Manager factory
swarm.security.security-domains.KEY.classic-jsse.truststore: Configures a JSSE trust store
swarm.security.security-domains.KEY.classic-mapping.mapping-modules.KEY.code: Class name of the module to be instantiated.
swarm.security.security-domains.KEY.classic-mapping.mapping-modules.KEY.module: Name of JBoss Module where the mapping module code is located.
swarm.security.security-domains.KEY.classic-mapping.mapping-modules.KEY.module-options: List of module options containing a name/value pair.
swarm.security.security-domains.KEY.classic-mapping.mapping-modules.KEY.type: Type of mapping this module performs. Allowed values are principal, role, attribute or credential..
swarm.security.security-domains.KEY.jaspi-authentication.auth-modules.KEY.code: Class name of the module to be instantiated.
swarm.security.security-domains.KEY.jaspi-authentication.auth-modules.KEY.flag: The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.
swarm.security.security-domains.KEY.jaspi-authentication.auth-modules.KEY.login-module-stack-ref: Reference to a login module stack name previously configured in the same security domain.
swarm.security.security-domains.KEY.jaspi-authentication.auth-modules.KEY.module: Name of JBoss Module where the mapping module code is located.
swarm.security.security-domains.KEY.jaspi-authentication.auth-modules.KEY.module-options: List of module options containing a name/value pair.
swarm.security.security-domains.KEY.jaspi-authentication.login-module-stacks.KEY.login-modules.KEY.code: Class name of the module to be instantiated.
swarm.security.security-domains.KEY.jaspi-authentication.login-module-stacks.KEY.login-modules.KEY.flag: The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.
swarm.security.security-domains.KEY.jaspi-authentication.login-module-stacks.KEY.login-modules.KEY.module: Name of JBoss Module where the login module is located.
swarm.security.security-domains.KEY.jaspi-authentication.login-module-stacks.KEY.login-modules.KEY.module-options: List of module options containing a name/value pair.

D.34. Topology

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>topology</artifactId>
</dependency>

D.34.1. OpenShift

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>topology-openshift</artifactId>
</dependency>

D.34.2. Topology UI

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>topology-webapp</artifactId>
</dependency>

Configuration

swarm.topology.web-app.expose-topology-endpoint: Flag to enable or disable the topology web endpoint
swarm.topology.web-app.proxied-service-mappings: Service name to URL path proxy mappings

D.35. Transactions

Provides support for the Java Transaction API (JTA) according to JSR-907.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>transactions</artifactId>
</dependency>

Configuration

swarm.transactions.average-commit-time: The average time of transaction commit in nanoseconds, measured from the moment the client calls commit until the transaction manager determines that the commit attempt was successful.
swarm.transactions.commit-markable-resources.KEY.batch-size: Batch size for this CMR resource
swarm.transactions.commit-markable-resources.KEY.immediate-cleanup: Immediate cleanup associated to this CMR resource
swarm.transactions.commit-markable-resources.KEY.jndi-name: JNDi name of this CMR resource
swarm.transactions.commit-markable-resources.KEY.name: table name for storing XIDs
swarm.transactions.default-timeout: The default timeout for a transaction managed by the transaction manager.
swarm.transactions.enable-statistics: Whether transaction statistics should be gathered.
swarm.transactions.enable-tsm-status: Whether the transaction status manager (TSM) service, needed for out of process recovery, should be provided or not.
swarm.transactions.hornetq-store-enable-async-io: Whether AsyncIO should be enabled for the journal store.
swarm.transactions.jdbc-action-store-drop-table: Configure if jdbc action store should drop tables.
swarm.transactions.jdbc-action-store-table-prefix: Optional prefix for table used to write transaction logs in configured jdbc action store.
swarm.transactions.jdbc-communication-store-drop-table: Configure if jdbc communication store should drop tables.
swarm.transactions.jdbc-communication-store-table-prefix: Optional prefix for table used to write transaction logs in configured jdbc communication store.
swarm.transactions.jdbc-state-store-drop-table: Configure if jdbc state store should drop tables.
swarm.transactions.jdbc-state-store-table-prefix: Optional prefix for table used to write transaction logs in configured jdbc state store.
swarm.transactions.jdbc-store-datasource: Jndi name of non-XA datasource used. Datasource sghould be define in datasources subsystem. For this would work the non-XA datasource has to be marked as jta="false".
swarm.transactions.journal-store-enable-async-io: Whether AsyncIO should be enabled for the journal store. For this settings being active journal natives libraries needs to be available.
swarm.transactions.jts: If true this enables the Java Transaction Service. Use of the JTS needs configuration in IIOP OpenJDK where Transactions parameter needs to be set to full.
swarm.transactions.log-store.expose-all-logs: Whether to expose all logs like orphans etc. By default only a subset of transaction logs is exposed.
swarm.transactions.log-store.transactions.KEY.age-in-seconds: The time since this transaction was prepared or when the recovery system last tried to recover it.
swarm.transactions.log-store.transactions.KEY.id: The id of this transaction.
swarm.transactions.log-store.transactions.KEY.jmx-name: The JMX name of this transaction.
swarm.transactions.log-store.transactions.KEY.participants.KEY.eis-product-name: The JCA enterprise information system’s product name.
swarm.transactions.log-store.transactions.KEY.participants.KEY.eis-product-version: The JCA enterprise information system’s product version
swarm.transactions.log-store.transactions.KEY.participants.KEY.jmx-name: The JMX name of this participant.
swarm.transactions.log-store.transactions.KEY.participants.KEY.jndi-name: JNDI name of this participant.
swarm.transactions.log-store.transactions.KEY.participants.KEY.status: Reports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly).
swarm.transactions.log-store.transactions.KEY.participants.KEY.type: The type name under which this record is stored.
swarm.transactions.log-store.transactions.KEY.type: The type name under which this record is stored.
swarm.transactions.log-store.type: Specifies the implementation type of the logging store.
swarm.transactions.node-identifier: Used to set the node identifier on the core environment. Each Xid that Transaction Manager creates will have this identifier encoded within it and ensures Transaction Manager will only recover branches which match the specified identifier. It is imperative that this identifier is unique between Application Server instances which share either an object store or access common resource managers.
swarm.transactions.number-of-aborted-transactions: The number of aborted (i.e. rolledback) transactions.
swarm.transactions.number-of-application-rollbacks: The number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behavior is considered an attribute of the application configuration.
swarm.transactions.number-of-committed-transactions: The number of committed transactions.
swarm.transactions.number-of-heuristics: The number of transactions which have terminated with heuristic outcomes.
swarm.transactions.number-of-inflight-transactions: The number of transactions that have begun but not yet terminated.
swarm.transactions.number-of-nested-transactions: The total number of nested (sub) transactions created.
swarm.transactions.number-of-resource-rollbacks: The number of transactions that rolled back due to resource (participant) failure.
swarm.transactions.number-of-system-rollbacks: The number of transactions that have been rolled back due to internal system errors.
swarm.transactions.number-of-timed-out-transactions: The number of transactions that have rolled back due to timeout.
swarm.transactions.number-of-transactions: The total number of transactions (top-level and nested) created
swarm.transactions.object-store-path: Denotes a relative or absolute filesystem path denoting where the transaction manager object store should store data. By default the value is treated as relative to the path denoted by the "relative-to" attribute. This settings is valid when default or journal store is used. It’s not used when jdbc journal store is used.
swarm.transactions.object-store-relative-to: References a global path configuration in the domain model, defaulting to the Application Server data directory (jboss.server.data.dir). The value of the "Object store path" attribute will treated as relative to this path. Undefine this attribute to disable the default behavior and force the value of the "Object store path" attribute to be treated as an absolute path.
swarm.transactions.port: Port for transaction manager
swarm.transactions.process-id-socket-binding: The name of the socket binding configuration to use if the transaction manager should use a socket-based process id. Will be 'undefined' if 'process-id-uuid' is 'true'; otherwise must be set.
swarm.transactions.process-id-socket-max-ports: The maximum number of ports to search for an open port if the transaction manager should use a socket-based process id. If the port specified by the socket binding referenced in 'process-id-socket-binding' is occupied, the next higher port will be tried until an open port is found or the number of ports specified by this attribute have been tried. Will be 'undefined' if 'process-id-uuid' is 'true'.
swarm.transactions.process-id-uuid: Indicates whether the transaction manager should use a UUID based process id.
swarm.transactions.recovery-listener: Used to specify if the recovery system should listen on a network socket or not.
swarm.transactions.socket-binding: Used to reference the correct socket binding to use for the recovery environment.
swarm.transactions.statistics-enabled: Whether transaction statistics should be gathered.
swarm.transactions.status-port: Status port for transaction manager
swarm.transactions.status-socket-binding: Used to reference the correct socket binding to use for the transaction status manager.
swarm.transactions.use-hornetq-store: Use the journal store for writing transaction logs. Set to true to enable and to false to use the default log store type. The default log store is normally one file system file per transaction log.It’s alternative to jdbc based store.
swarm.transactions.use-jdbc-store: Use the jdbc store for writing transaction logs. Set to true to enable and to false to use the default log store type. The default log store is normally one file file per transaction log. It’s alternative to journal based store.
swarm.transactions.use-journal-store: Use the journal store for writing transaction logs. Set to true to enable and to false to use the default log store type. The default log store creates normally one file system file per transaction log. The journal one consists from one file for all the transactions. It’s alternative to jdbc based store.

D.36. Undertow

Provides basic HTTP support, including Java Servlets, JavaServer Pages (JSP), and JavaServer Pages Standard Tag Library (JSTL) according to JSR-340, JSR-245 and JSR-52.

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>undertow</artifactId>
</dependency>

Configuration

swarm.ajp.enable: Determine if AJP should be enabled
swarm.ajp.port: Set the port for the default AJP listener
swarm.deployment: Map of security configuration by deployment
swarm.http.port: Set the port for the default HTTP listener
swarm.https.certificate.generate: Should a self-signed certificate be generated
swarm.https.certificate.generate.host: Hostname for the generated self-signed certificate
swarm.https.key.alias: Alias to the server certificate key entry in the keystore
swarm.https.key.password: Password to the server certificate
swarm.https.keystore.embedded: Should an embedded keystore be created
swarm.https.keystore.password: Password to the server keystore
swarm.https.keystore.path: Path to the server keystore
swarm.https.only: Only enable the HTTPS Listener
swarm.https.port: Set the port for the default HTTPS listener
swarm.undertow.application-security-domains.KEY.enable-jacc: Enable authorization using JACC
swarm.undertow.application-security-domains.KEY.http-authentication-factory: The HTTP Authentication Factory to be used by deployments that reference the mapped security domain.
swarm.undertow.application-security-domains.KEY.override-deployment-config: Should the authentication configuration in the deployment be overridden by the factory.
swarm.undertow.application-security-domains.KEY.referencing-deployments: The deployments currently referencing this mapping.
swarm.undertow.application-security-domains.KEY.single-sign-on-setting.client-ssl-context: Reference to the SSL context used to secure back-channel logout connection.
swarm.undertow.application-security-domains.KEY.single-sign-on-setting.cookie-name: Name of the cookie
swarm.undertow.application-security-domains.KEY.single-sign-on-setting.credential-reference: The credential reference to decrypt the private key entry.
swarm.undertow.application-security-domains.KEY.single-sign-on-setting.domain: The cookie domain that will be used.
swarm.undertow.application-security-domains.KEY.single-sign-on-setting.http-only: Set Cookie httpOnly attribute.
swarm.undertow.application-security-domains.KEY.single-sign-on-setting.key-alias: Alias of the private key entry used for signing and verifying back-channel logout connection.
swarm.undertow.application-security-domains.KEY.single-sign-on-setting.key-store: Reference to key store containing a private key entry.
swarm.undertow.application-security-domains.KEY.single-sign-on-setting.path: Cookie path.
swarm.undertow.application-security-domains.KEY.single-sign-on-setting.secure: Set Cookie secure attribute.
swarm.undertow.buffer-caches.KEY.buffer-size: The size of an individual buffer, in bytes.
swarm.undertow.buffer-caches.KEY.buffers-per-region: The numbers of buffers in a region
swarm.undertow.buffer-caches.KEY.max-regions: The maximum number of regions
swarm.undertow.default-security-domain: The default security domain used by web deployments
swarm.undertow.default-server: The default server to use for deployments
swarm.undertow.default-servlet-container: The default servlet container to use for deployments
swarm.undertow.default-virtual-host: The default virtual host to use for deployments
swarm.undertow.filter-configuration.custom-filters.KEY.class-name: Class name of HttpHandler
swarm.undertow.filter-configuration.custom-filters.KEY.module: Module name where class can be loaded from
swarm.undertow.filter-configuration.custom-filters.KEY.parameters: Filter parameters
swarm.undertow.filter-configuration.error-pages.KEY.code: Error page code
swarm.undertow.filter-configuration.error-pages.KEY.path: Error page path
swarm.undertow.filter-configuration.expression-filters.KEY.expression: The expression that defines the filter
swarm.undertow.filter-configuration.expression-filters.KEY.module: Module to use to load the filter definitions
swarm.undertow.filter-configuration.mod-clusters.KEY.advertise-frequency: The frequency (in milliseconds) that mod-cluster advertises itself on the network
swarm.undertow.filter-configuration.mod-clusters.KEY.advertise-path: The path that mod-cluster is registered under.
swarm.undertow.filter-configuration.mod-clusters.KEY.advertise-protocol: The protocol that is in use.
swarm.undertow.filter-configuration.mod-clusters.KEY.advertise-socket-binding: The multicast group and port that is used to advertise.
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.max-attempts: The number of attempts to send the request to a backend server
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.aliases: The nodes aliases
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.cache-connections: The number of connections to keep alive indefinitely
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.contexts.KEY.requests: The number of requests against this context
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.contexts.KEY.status: The status of this context
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.elected: The elected count
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.flush-packets: If received data should be immediately flushed
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.load: The current load of this node
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.load-balancing-group: The load balancing group this node belongs to
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.max-connections: The maximum number of connections per IO thread
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.open-connections: The current number of open connections
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.ping: The nodes ping
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.queue-new-requests: If a request is received and there is no worker immediately available should it be queued
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.read: The number of bytes read from the node
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.request-queue-size: The size of the request queue
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.status: The current status of this node
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.timeout: The request timeout
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.ttl: The time connections will stay alive with no requests before being closed, if the number of connections is larger than cache-connections
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.uri: The URI that the load balancer uses to connect to the node
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.nodes.KEY.written: The number of bytes transferred to the node
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.sticky-session: If sticky sessions are enabled
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.sticky-session-cookie: The session cookie name
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.sticky-session-force: If this is true then an error will be returned if the request cannot be routed to the sticky node, otherwise it will be routed to another node
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.sticky-session-path: The path of the sticky session cookie
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.sticky-session-remove: Remove the session cookie if the request cannot be routed to the correct host
swarm.undertow.filter-configuration.mod-clusters.KEY.balancers.KEY.wait-worker: The number of seconds to wait for an available worker
swarm.undertow.filter-configuration.mod-clusters.KEY.broken-node-timeout: The amount of time that must elapse before a broken node is removed from the table
swarm.undertow.filter-configuration.mod-clusters.KEY.cached-connections-per-thread: The number of connections that will be kept alive indefinitely
swarm.undertow.filter-configuration.mod-clusters.KEY.connection-idle-timeout: The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread)
swarm.undertow.filter-configuration.mod-clusters.KEY.connections-per-thread: The number of connections that will be maintained to backend servers, per IO thread.
swarm.undertow.filter-configuration.mod-clusters.KEY.enable-http2: If the load balancer should attempt to upgrade back end connections to HTTP2. If HTTP2 is not supported HTTP or HTTPS will be used as normal
swarm.undertow.filter-configuration.mod-clusters.KEY.failover-strategy: Determines how a failover node is chosen, in the event that the node to which a session has affinity is not available.
swarm.undertow.filter-configuration.mod-clusters.KEY.health-check-interval: The frequency of health check pings to backend nodes
swarm.undertow.filter-configuration.mod-clusters.KEY.http2-enable-push: If push should be enabled for HTTP/2 connections
swarm.undertow.filter-configuration.mod-clusters.KEY.http2-header-table-size: The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.
swarm.undertow.filter-configuration.mod-clusters.KEY.http2-initial-window-size: The flow control window size that controls how quickly the client can send data to the server
swarm.undertow.filter-configuration.mod-clusters.KEY.http2-max-concurrent-streams: The maximum number of HTTP/2 streams that can be active at any time on a single connection
swarm.undertow.filter-configuration.mod-clusters.KEY.http2-max-frame-size: The max HTTP/2 frame size
swarm.undertow.filter-configuration.mod-clusters.KEY.http2-max-header-list-size: The maximum size of request headers the server is prepared to accept
swarm.undertow.filter-configuration.mod-clusters.KEY.management-access-predicate: A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands. Provides additional security on top of what is provided by limiting management to requests that originate from the management-socket-binding
swarm.undertow.filter-configuration.mod-clusters.KEY.management-socket-binding: The socket binding of the mod_cluster management address and port. When using mod_cluster two HTTP listeners should be defined, a public one to handle requests, and one bound to the internal network to handle mod cluster commands. This socket binding should correspond to the internal listener, and should not be publicly accessible.
swarm.undertow.filter-configuration.mod-clusters.KEY.max-ajp-packet-size: The maximum size for AJP packets. Increasing this will allow AJP to work for requests/responses that have a large amount of headers. This is an advanced option, and must be the same between load balancers and backend servers.
swarm.undertow.filter-configuration.mod-clusters.KEY.max-request-time: The max amount of time that a request to a backend node can take before it is killed
swarm.undertow.filter-configuration.mod-clusters.KEY.max-retries: The number of times to attempt to retry a request if it fails. Note that if a request is not considered idempotent then it will only be retried if the proxy can be sure it was not sent to the backend server).
swarm.undertow.filter-configuration.mod-clusters.KEY.request-queue-size: The number of requests that can be queued if the connection pool is full before requests are rejected with a 503
swarm.undertow.filter-configuration.mod-clusters.KEY.security-key: The security key that is used for the mod-cluster group. All members must use the same security key.
swarm.undertow.filter-configuration.mod-clusters.KEY.security-realm: The security realm that provides the SSL configuration
swarm.undertow.filter-configuration.mod-clusters.KEY.ssl-context: Reference to the SSLContext to be used by this filter.
swarm.undertow.filter-configuration.mod-clusters.KEY.use-alias: If an alias check is performed
swarm.undertow.filter-configuration.mod-clusters.KEY.worker: The XNIO worker that is used to send the advertise notifications
swarm.undertow.filter-configuration.request-limits.KEY.max-concurrent-requests: Maximum number of concurrent requests
swarm.undertow.filter-configuration.request-limits.KEY.queue-size: Number of requests to queue before they start being rejected
swarm.undertow.filter-configuration.response-headers.KEY.header-name: Header name
swarm.undertow.filter-configuration.response-headers.KEY.header-value: Value for header
swarm.undertow.filter-configuration.rewrites.KEY.redirect: If this is true then a redirect will be done instead of a rewrite
swarm.undertow.filter-configuration.rewrites.KEY.target: The expression that defines the target. If you are redirecting to a constant target put single quotes around the value
swarm.undertow.handler-configuration.files.KEY.cache-buffer-size: Size of the buffers, in bytes.
swarm.undertow.handler-configuration.files.KEY.cache-buffers: Number of buffers
swarm.undertow.handler-configuration.files.KEY.case-sensitive: Use case sensitive file handling
swarm.undertow.handler-configuration.files.KEY.directory-listing: Enable directory listing?
swarm.undertow.handler-configuration.files.KEY.follow-symlink: Enable following symbolic links
swarm.undertow.handler-configuration.files.KEY.path: Path on filesystem from where file handler will serve resources
swarm.undertow.handler-configuration.files.KEY.safe-symlink-paths: Paths that are safe to be targets of symbolic links
swarm.undertow.handler-configuration.reverse-proxies.KEY.cached-connections-per-thread: The number of connections that will be kept alive indefinitely
swarm.undertow.handler-configuration.reverse-proxies.KEY.connection-idle-timeout: The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread)
swarm.undertow.handler-configuration.reverse-proxies.KEY.connections-per-thread: The number of connections that will be maintained to backend servers, per IO thread.
swarm.undertow.handler-configuration.reverse-proxies.KEY.hosts.KEY.enable-http2: If this is true then the proxy will attempt to use HTTP/2 to connect to the backend. If it is not supported it will fall back to HTTP/1.1/
swarm.undertow.handler-configuration.reverse-proxies.KEY.hosts.KEY.instance-id: The instance id (aka JVM route) that will be used to enable sticky sessions
swarm.undertow.handler-configuration.reverse-proxies.KEY.hosts.KEY.outbound-socket-binding: Outbound socket binding for this host
swarm.undertow.handler-configuration.reverse-proxies.KEY.hosts.KEY.path: Optional path if host is using non root resource
swarm.undertow.handler-configuration.reverse-proxies.KEY.hosts.KEY.scheme: What kind of scheme is used
swarm.undertow.handler-configuration.reverse-proxies.KEY.hosts.KEY.security-realm: The security realm that provides the SSL configuration for the connection to the host
swarm.undertow.handler-configuration.reverse-proxies.KEY.hosts.KEY.ssl-context: Reference to the SSLContext to be used by this handler.
swarm.undertow.handler-configuration.reverse-proxies.KEY.max-request-time: The maximum time that a proxy request can be active for, before being killed
swarm.undertow.handler-configuration.reverse-proxies.KEY.max-retries: The number of times to attempt to retry a request if it fails. Note that if a request is not considered idempotent then it will only be retried if the proxy can be sure it was not sent to the backend server).
swarm.undertow.handler-configuration.reverse-proxies.KEY.problem-server-retry: Time in seconds to wait before attempting to reconnect to a server that is down
swarm.undertow.handler-configuration.reverse-proxies.KEY.request-queue-size: The number of requests that can be queued if the connection pool is full before requests are rejected with a 503
swarm.undertow.handler-configuration.reverse-proxies.KEY.session-cookie-names: Comma separated list of session cookie names. Generally this will just be JSESSIONID.
swarm.undertow.instance-id: The cluster instance id
swarm.undertow.servers.KEY.ajp-listeners.KEY.allow-encoded-slash: If a request comes in with encoded / characters (i.e. %2F), will these be decoded.
swarm.undertow.servers.KEY.ajp-listeners.KEY.allow-equals-in-cookie-value: If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.
swarm.undertow.servers.KEY.ajp-listeners.KEY.always-set-keep-alive: If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.
swarm.undertow.servers.KEY.ajp-listeners.KEY.buffer-pipelined-data: If we should buffer pipelined requests.
swarm.undertow.servers.KEY.ajp-listeners.KEY.buffer-pool: The listeners buffer pool
swarm.undertow.servers.KEY.ajp-listeners.KEY.bytes-received: The number of bytes that have been received by this listener
swarm.undertow.servers.KEY.ajp-listeners.KEY.bytes-sent: The number of bytes that have been sent out on this listener
swarm.undertow.servers.KEY.ajp-listeners.KEY.decode-url: If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.
swarm.undertow.servers.KEY.ajp-listeners.KEY.disallowed-methods: A comma separated list of HTTP methods that are not allowed
swarm.undertow.servers.KEY.ajp-listeners.KEY.error-count: The number of 500 responses that have been sent by this listener
swarm.undertow.servers.KEY.ajp-listeners.KEY.max-ajp-packet-size: The maximum supported size of AJP packets. If this is modified it has to be increased on the load balancer and the backend server.
swarm.undertow.servers.KEY.ajp-listeners.KEY.max-buffered-request-size: Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.
swarm.undertow.servers.KEY.ajp-listeners.KEY.max-connections: The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.
swarm.undertow.servers.KEY.ajp-listeners.KEY.max-cookies: The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.
swarm.undertow.servers.KEY.ajp-listeners.KEY.max-header-size: The maximum size of a http request header, in bytes.
swarm.undertow.servers.KEY.ajp-listeners.KEY.max-headers: The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.
swarm.undertow.servers.KEY.ajp-listeners.KEY.max-parameters: The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).
swarm.undertow.servers.KEY.ajp-listeners.KEY.max-post-size: The maximum size of a post that will be accepted, in bytes.
swarm.undertow.servers.KEY.ajp-listeners.KEY.max-processing-time: The maximum processing time taken by a request on this listener
swarm.undertow.servers.KEY.ajp-listeners.KEY.no-request-timeout: The length of time in milliseconds that the connection can be idle before it is closed by the container.
swarm.undertow.servers.KEY.ajp-listeners.KEY.processing-time: The total processing time of all requests handed by this listener
swarm.undertow.servers.KEY.ajp-listeners.KEY.read-timeout: Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket’s next read will throw a {@link ReadTimeoutException}.
swarm.undertow.servers.KEY.ajp-listeners.KEY.receive-buffer: The receive buffer size, in bytes.
swarm.undertow.servers.KEY.ajp-listeners.KEY.record-request-start-time: If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact
swarm.undertow.servers.KEY.ajp-listeners.KEY.redirect-socket: If this listener is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here.
swarm.undertow.servers.KEY.ajp-listeners.KEY.request-count: The number of requests this listener has served
swarm.undertow.servers.KEY.ajp-listeners.KEY.request-parse-timeout: The maximum amount of time (in milliseconds) that can be spent parsing the request
swarm.undertow.servers.KEY.ajp-listeners.KEY.resolve-peer-address: Enables host dns lookup
swarm.undertow.servers.KEY.ajp-listeners.KEY.rfc6265-cookie-validation: If cookies should be validated to ensure they comply with RFC6265.
swarm.undertow.servers.KEY.ajp-listeners.KEY.scheme: The listener scheme, can be HTTP or HTTPS. By default the scheme will be taken from the incoming AJP request.
swarm.undertow.servers.KEY.ajp-listeners.KEY.secure: If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.
swarm.undertow.servers.KEY.ajp-listeners.KEY.send-buffer: The send buffer size, in bytes.
swarm.undertow.servers.KEY.ajp-listeners.KEY.socket-binding: The listener socket binding
swarm.undertow.servers.KEY.ajp-listeners.KEY.tcp-backlog: Configure a server with the specified backlog.
swarm.undertow.servers.KEY.ajp-listeners.KEY.tcp-keep-alive: Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.
swarm.undertow.servers.KEY.ajp-listeners.KEY.url-charset: URL charset
swarm.undertow.servers.KEY.ajp-listeners.KEY.worker: The listeners XNIO worker
swarm.undertow.servers.KEY.ajp-listeners.KEY.write-timeout: Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket’s next write will throw a {@link WriteTimeoutException}.
swarm.undertow.servers.KEY.default-host: The servers default virtual host
swarm.undertow.servers.KEY.hosts.KEY.access-log-setting.directory: Directory in which to save logs
swarm.undertow.servers.KEY.hosts.KEY.access-log-setting.extended: If the log uses the extended log file format
swarm.undertow.servers.KEY.hosts.KEY.access-log-setting.pattern: The access log pattern.
swarm.undertow.servers.KEY.hosts.KEY.access-log-setting.predicate: Predicate that determines if the request should be logged
swarm.undertow.servers.KEY.hosts.KEY.access-log-setting.prefix: Prefix for the log file name.
swarm.undertow.servers.KEY.hosts.KEY.access-log-setting.relative-to: The directory the path is relative to
swarm.undertow.servers.KEY.hosts.KEY.access-log-setting.rotate: Rotate the access log every day.
swarm.undertow.servers.KEY.hosts.KEY.access-log-setting.suffix: Suffix for the log file name.
swarm.undertow.servers.KEY.hosts.KEY.access-log-setting.use-server-log: If the log should be written to the server log, rather than a separate file.
swarm.undertow.servers.KEY.hosts.KEY.access-log-setting.worker: Name of the worker to use for logging
swarm.undertow.servers.KEY.hosts.KEY.alias: Aliases for the host
swarm.undertow.servers.KEY.hosts.KEY.default-response-code: If set, this will be response code sent back in case requested context does not exist on server.
swarm.undertow.servers.KEY.hosts.KEY.default-web-module: Default web module
swarm.undertow.servers.KEY.hosts.KEY.disable-console-redirect: if set to true, /console redirect wont be enabled for this host, default is false
swarm.undertow.servers.KEY.hosts.KEY.filter-refs.KEY.predicate: Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition.
swarm.undertow.servers.KEY.hosts.KEY.filter-refs.KEY.priority: Defines filter order, it should be set to 1 or more, higher number instructs server to be included earlier in handler chain than others under same context.
swarm.undertow.servers.KEY.hosts.KEY.http-invoker-setting.http-authentication-factory: The HTTP authentication factory to use for authentication
swarm.undertow.servers.KEY.hosts.KEY.http-invoker-setting.path: The path that the services are installed under
swarm.undertow.servers.KEY.hosts.KEY.http-invoker-setting.security-realm: The legacy security realm to use for authentication
swarm.undertow.servers.KEY.hosts.KEY.locations.KEY.filter-refs.KEY.predicate: Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition.
swarm.undertow.servers.KEY.hosts.KEY.locations.KEY.filter-refs.KEY.priority: Defines filter order, it should be set to 1 or more, higher number instructs server to be included earlier in handler chain than others under same context.
swarm.undertow.servers.KEY.hosts.KEY.locations.KEY.handler: Default handler for this location
swarm.undertow.servers.KEY.hosts.KEY.single-sign-on-setting.cookie-name: Name of the cookie
swarm.undertow.servers.KEY.hosts.KEY.single-sign-on-setting.domain: The cookie domain that will be used.
swarm.undertow.servers.KEY.hosts.KEY.single-sign-on-setting.http-only: Set Cookie httpOnly attribute.
swarm.undertow.servers.KEY.hosts.KEY.single-sign-on-setting.path: Cookie path.
swarm.undertow.servers.KEY.hosts.KEY.single-sign-on-setting.secure: Set Cookie secure attribute.
swarm.undertow.servers.KEY.http-listeners.KEY.allow-encoded-slash: If a request comes in with encoded / characters (i.e. %2F), will these be decoded.
swarm.undertow.servers.KEY.http-listeners.KEY.allow-equals-in-cookie-value: If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.
swarm.undertow.servers.KEY.http-listeners.KEY.always-set-keep-alive: If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.
swarm.undertow.servers.KEY.http-listeners.KEY.buffer-pipelined-data: If we should buffer pipelined requests.
swarm.undertow.servers.KEY.http-listeners.KEY.buffer-pool: The listeners buffer pool
swarm.undertow.servers.KEY.http-listeners.KEY.bytes-received: The number of bytes that have been received by this listener
swarm.undertow.servers.KEY.http-listeners.KEY.bytes-sent: The number of bytes that have been sent out on this listener
swarm.undertow.servers.KEY.http-listeners.KEY.certificate-forwarding: If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers.
swarm.undertow.servers.KEY.http-listeners.KEY.decode-url: If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.
swarm.undertow.servers.KEY.http-listeners.KEY.disallowed-methods: A comma separated list of HTTP methods that are not allowed
swarm.undertow.servers.KEY.http-listeners.KEY.enable-http2: Enables HTTP2 support for this listener
swarm.undertow.servers.KEY.http-listeners.KEY.error-count: The number of 500 responses that have been sent by this listener
swarm.undertow.servers.KEY.http-listeners.KEY.http2-enable-push: If server push is enabled for this connection
swarm.undertow.servers.KEY.http-listeners.KEY.http2-header-table-size: The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.
swarm.undertow.servers.KEY.http-listeners.KEY.http2-initial-window-size: The flow control window size that controls how quickly the client can send data to the server
swarm.undertow.servers.KEY.http-listeners.KEY.http2-max-concurrent-streams: The maximum number of HTTP/2 streams that can be active at any time on a single connection
swarm.undertow.servers.KEY.http-listeners.KEY.http2-max-frame-size: The max HTTP/2 frame size
swarm.undertow.servers.KEY.http-listeners.KEY.http2-max-header-list-size: The maximum size of request headers the server is prepared to accept
swarm.undertow.servers.KEY.http-listeners.KEY.max-buffered-request-size: Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.
swarm.undertow.servers.KEY.http-listeners.KEY.max-connections: The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.
swarm.undertow.servers.KEY.http-listeners.KEY.max-cookies: The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.
swarm.undertow.servers.KEY.http-listeners.KEY.max-header-size: The maximum size of a http request header, in bytes.
swarm.undertow.servers.KEY.http-listeners.KEY.max-headers: The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.
swarm.undertow.servers.KEY.http-listeners.KEY.max-parameters: The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).
swarm.undertow.servers.KEY.http-listeners.KEY.max-post-size: The maximum size of a post that will be accepted, in bytes.
swarm.undertow.servers.KEY.http-listeners.KEY.max-processing-time: The maximum processing time taken by a request on this listener
swarm.undertow.servers.KEY.http-listeners.KEY.no-request-timeout: The length of time in milliseconds that the connection can be idle before it is closed by the container.
swarm.undertow.servers.KEY.http-listeners.KEY.processing-time: The total processing time of all requests handed by this listener
swarm.undertow.servers.KEY.http-listeners.KEY.proxy-address-forwarding: Enables handling of x-forwarded-host header (and other x-forwarded-* headers) and use this header information to set the remote address. This should only be used behind a trusted proxy that sets these headers otherwise a remote user can spoof their IP address.
swarm.undertow.servers.KEY.http-listeners.KEY.read-timeout: Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket’s next read will throw a {@link ReadTimeoutException}.
swarm.undertow.servers.KEY.http-listeners.KEY.receive-buffer: The receive buffer size, in bytes.
swarm.undertow.servers.KEY.http-listeners.KEY.record-request-start-time: If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact
swarm.undertow.servers.KEY.http-listeners.KEY.redirect-socket: If this listener is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here.
swarm.undertow.servers.KEY.http-listeners.KEY.request-count: The number of requests this listener has served
swarm.undertow.servers.KEY.http-listeners.KEY.request-parse-timeout: The maximum amount of time (in milliseconds) that can be spent parsing the request
swarm.undertow.servers.KEY.http-listeners.KEY.require-host-http11: Require that all HTTP/1.1 requests have a 'Host' header, as per the RFC. IF the request does not include this header it will be rejected with a 403.
swarm.undertow.servers.KEY.http-listeners.KEY.resolve-peer-address: Enables host dns lookup
swarm.undertow.servers.KEY.http-listeners.KEY.rfc6265-cookie-validation: If cookies should be validated to ensure they comply with RFC6265.
swarm.undertow.servers.KEY.http-listeners.KEY.secure: If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.
swarm.undertow.servers.KEY.http-listeners.KEY.send-buffer: The send buffer size, in bytes.
swarm.undertow.servers.KEY.http-listeners.KEY.socket-binding: The listener socket binding
swarm.undertow.servers.KEY.http-listeners.KEY.tcp-backlog: Configure a server with the specified backlog.
swarm.undertow.servers.KEY.http-listeners.KEY.tcp-keep-alive: Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.
swarm.undertow.servers.KEY.http-listeners.KEY.url-charset: URL charset
swarm.undertow.servers.KEY.http-listeners.KEY.worker: The listeners XNIO worker
swarm.undertow.servers.KEY.http-listeners.KEY.write-timeout: Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket’s next write will throw a {@link WriteTimeoutException}.
swarm.undertow.servers.KEY.https-listeners.KEY.allow-encoded-slash: If a request comes in with encoded / characters (i.e. %2F), will these be decoded.
swarm.undertow.servers.KEY.https-listeners.KEY.allow-equals-in-cookie-value: If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.
swarm.undertow.servers.KEY.https-listeners.KEY.always-set-keep-alive: If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.
swarm.undertow.servers.KEY.https-listeners.KEY.buffer-pipelined-data: If we should buffer pipelined requests.
swarm.undertow.servers.KEY.https-listeners.KEY.buffer-pool: The listeners buffer pool
swarm.undertow.servers.KEY.https-listeners.KEY.bytes-received: The number of bytes that have been received by this listener
swarm.undertow.servers.KEY.https-listeners.KEY.bytes-sent: The number of bytes that have been sent out on this listener
swarm.undertow.servers.KEY.https-listeners.KEY.certificate-forwarding: If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers.
swarm.undertow.servers.KEY.https-listeners.KEY.decode-url: If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.
swarm.undertow.servers.KEY.https-listeners.KEY.disallowed-methods: A comma separated list of HTTP methods that are not allowed
swarm.undertow.servers.KEY.https-listeners.KEY.enable-http2: Enables HTTP2 support for this listener
swarm.undertow.servers.KEY.https-listeners.KEY.enabled-cipher-suites: Configures Enabled SSL ciphers
swarm.undertow.servers.KEY.https-listeners.KEY.enabled-protocols: Configures SSL protocols
swarm.undertow.servers.KEY.https-listeners.KEY.error-count: The number of 500 responses that have been sent by this listener
swarm.undertow.servers.KEY.https-listeners.KEY.http2-enable-push: If server push is enabled for this connection
swarm.undertow.servers.KEY.https-listeners.KEY.http2-header-table-size: The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.
swarm.undertow.servers.KEY.https-listeners.KEY.http2-initial-window-size: The flow control window size that controls how quickly the client can send data to the server
swarm.undertow.servers.KEY.https-listeners.KEY.http2-max-concurrent-streams: The maximum number of HTTP/2 streams that can be active at any time on a single connection
swarm.undertow.servers.KEY.https-listeners.KEY.http2-max-frame-size: The max HTTP/2 frame size
swarm.undertow.servers.KEY.https-listeners.KEY.http2-max-header-list-size: The maximum size of request headers the server is prepared to accept
swarm.undertow.servers.KEY.https-listeners.KEY.max-buffered-request-size: Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.
swarm.undertow.servers.KEY.https-listeners.KEY.max-connections: The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.
swarm.undertow.servers.KEY.https-listeners.KEY.max-cookies: The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.
swarm.undertow.servers.KEY.https-listeners.KEY.max-header-size: The maximum size of a http request header, in bytes.
swarm.undertow.servers.KEY.https-listeners.KEY.max-headers: The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.
swarm.undertow.servers.KEY.https-listeners.KEY.max-parameters: The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).
swarm.undertow.servers.KEY.https-listeners.KEY.max-post-size: The maximum size of a post that will be accepted, in bytes.
swarm.undertow.servers.KEY.https-listeners.KEY.max-processing-time: The maximum processing time taken by a request on this listener
swarm.undertow.servers.KEY.https-listeners.KEY.no-request-timeout: The length of time in milliseconds that the connection can be idle before it is closed by the container.
swarm.undertow.servers.KEY.https-listeners.KEY.processing-time: The total processing time of all requests handed by this listener
swarm.undertow.servers.KEY.https-listeners.KEY.proxy-address-forwarding: Enables handling of x-forwarded-host header (and other x-forwarded-* headers) and use this header information to set the remote address. This should only be used behind a trusted proxy that sets these headers otherwise a remote user can spoof their IP address.
swarm.undertow.servers.KEY.https-listeners.KEY.read-timeout: Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket’s next read will throw a {@link ReadTimeoutException}.
swarm.undertow.servers.KEY.https-listeners.KEY.receive-buffer: The receive buffer size, in bytes.
swarm.undertow.servers.KEY.https-listeners.KEY.record-request-start-time: If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact
swarm.undertow.servers.KEY.https-listeners.KEY.request-count: The number of requests this listener has served
swarm.undertow.servers.KEY.https-listeners.KEY.request-parse-timeout: The maximum amount of time (in milliseconds) that can be spent parsing the request
swarm.undertow.servers.KEY.https-listeners.KEY.require-host-http11: Require that all HTTP/1.1 requests have a 'Host' header, as per the RFC. IF the request does not include this header it will be rejected with a 403.
swarm.undertow.servers.KEY.https-listeners.KEY.resolve-peer-address: Enables host dns lookup
swarm.undertow.servers.KEY.https-listeners.KEY.rfc6265-cookie-validation: If cookies should be validated to ensure they comply with RFC6265.
swarm.undertow.servers.KEY.https-listeners.KEY.secure: If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.
swarm.undertow.servers.KEY.https-listeners.KEY.security-realm: The listeners security realm
swarm.undertow.servers.KEY.https-listeners.KEY.send-buffer: The send buffer size, in bytes.
swarm.undertow.servers.KEY.https-listeners.KEY.socket-binding: The listener socket binding
swarm.undertow.servers.KEY.https-listeners.KEY.ssl-context: Reference to the SSLContext to be used by this listener.
swarm.undertow.servers.KEY.https-listeners.KEY.ssl-session-cache-size: The maximum number of active SSL sessions
swarm.undertow.servers.KEY.https-listeners.KEY.ssl-session-timeout: The timeout for SSL sessions, in seconds
swarm.undertow.servers.KEY.https-listeners.KEY.tcp-backlog: Configure a server with the specified backlog.
swarm.undertow.servers.KEY.https-listeners.KEY.tcp-keep-alive: Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.
swarm.undertow.servers.KEY.https-listeners.KEY.url-charset: URL charset
swarm.undertow.servers.KEY.https-listeners.KEY.verify-client: The desired SSL client authentication mode for SSL channels
swarm.undertow.servers.KEY.https-listeners.KEY.worker: The listeners XNIO worker
swarm.undertow.servers.KEY.https-listeners.KEY.write-timeout: Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket’s next write will throw a {@link WriteTimeoutException}.
swarm.undertow.servers.KEY.servlet-container: The servers default servlet container
swarm.undertow.servlet-containers.KEY.allow-non-standard-wrappers: If true then request and response wrappers that do not extend the standard wrapper classes can be used
swarm.undertow.servlet-containers.KEY.crawler-session-management-setting.session-timeout: The session timeout for sessions that are owned by crawlers
swarm.undertow.servlet-containers.KEY.crawler-session-management-setting.user-agents: Regular expression that is used to match the user agent of a crawler
swarm.undertow.servlet-containers.KEY.default-buffer-cache: The buffer cache to use for caching static resources
swarm.undertow.servlet-containers.KEY.default-encoding: Default encoding to use for all deployed applications
swarm.undertow.servlet-containers.KEY.default-session-timeout: The default session timeout (in minutes) for all applications deployed in the container.
swarm.undertow.servlet-containers.KEY.directory-listing: If directory listing should be enabled for default servlets.
swarm.undertow.servlet-containers.KEY.disable-caching-for-secured-pages: If Undertow should set headers to disable caching for secured paged. Disabling this can cause security problems, as sensitive pages may be cached by an intermediary.
swarm.undertow.servlet-containers.KEY.disable-file-watch-service: If this is true then the file watch service will not be used to monitor exploded deployments for changes
swarm.undertow.servlet-containers.KEY.disable-session-id-reuse: If this is true then an unknown session ID will never be reused, and a new session id will be generated. If this is false then it will be re-used if and only if it is present in the session manager of another deployment, to allow the same session id to be shared between applications on the same server.
swarm.undertow.servlet-containers.KEY.eager-filter-initialization: If true undertow calls filter init() on deployment start rather than when first requested.
swarm.undertow.servlet-containers.KEY.ignore-flush: Ignore flushes on the servlet output stream. In most cases these just hurt performance for no good reason.
swarm.undertow.servlet-containers.KEY.jsp-setting.check-interval: Check interval for JSP updates using a background thread. This has no effect for most deployments where JSP change notifications are handled using the File System notification API. This only takes effect if the file watch service is disabled.
swarm.undertow.servlet-containers.KEY.jsp-setting.development: Enable Development mode which enables reloading JSP on-the-fly
swarm.undertow.servlet-containers.KEY.jsp-setting.disabled: Disable the JSP container.
swarm.undertow.servlet-containers.KEY.jsp-setting.display-source-fragment: When a runtime error occurs, attempts to display corresponding JSP source fragment
swarm.undertow.servlet-containers.KEY.jsp-setting.dump-smap: Write SMAP data to a file.
swarm.undertow.servlet-containers.KEY.jsp-setting.error-on-use-bean-invalid-class-attribute: Enable errors when using a bad class in useBean.
swarm.undertow.servlet-containers.KEY.jsp-setting.generate-strings-as-char-arrays: Generate String constants as char arrays.
swarm.undertow.servlet-containers.KEY.jsp-setting.java-encoding: Specify the encoding used for Java sources.
swarm.undertow.servlet-containers.KEY.jsp-setting.keep-generated: Keep the generated Servlets.
swarm.undertow.servlet-containers.KEY.jsp-setting.mapped-file: Map to the JSP source.
swarm.undertow.servlet-containers.KEY.jsp-setting.modification-test-interval: Minimum amount of time between two tests for updates, in seconds.
swarm.undertow.servlet-containers.KEY.jsp-setting.optimize-scriptlets: If JSP scriptlets should be optimised to remove string concatenation
swarm.undertow.servlet-containers.KEY.jsp-setting.recompile-on-fail: Retry failed JSP compilations on each request.
swarm.undertow.servlet-containers.KEY.jsp-setting.scratch-dir: Specify a different work directory.
swarm.undertow.servlet-containers.KEY.jsp-setting.smap: Enable SMAP.
swarm.undertow.servlet-containers.KEY.jsp-setting.source-vm: Source VM level for compilation.
swarm.undertow.servlet-containers.KEY.jsp-setting.tag-pooling: Enable tag pooling.
swarm.undertow.servlet-containers.KEY.jsp-setting.target-vm: Target VM level for compilation.
swarm.undertow.servlet-containers.KEY.jsp-setting.trim-spaces: Trim some spaces from the generated Servlet.
swarm.undertow.servlet-containers.KEY.jsp-setting.xPowered-by: Enable advertising the JSP engine in x-powered-by.
swarm.undertow.servlet-containers.KEY.max-sessions: The maximum number of sessions that can be active at one time
swarm.undertow.servlet-containers.KEY.mime-mappings.KEY.value: The mime type for this mapping
swarm.undertow.servlet-containers.KEY.persistent-sessions-setting.path: The path to the persistent session data directory. If this is null sessions will be stored in memory
swarm.undertow.servlet-containers.KEY.persistent-sessions-setting.relative-to: The directory the path is relative to
swarm.undertow.servlet-containers.KEY.proactive-authentication: If proactive authentication should be used. If this is true a user will always be authenticated if credentials are present.
swarm.undertow.servlet-containers.KEY.session-cookie-setting.comment: Cookie comment
swarm.undertow.servlet-containers.KEY.session-cookie-setting.domain: Cookie domain
swarm.undertow.servlet-containers.KEY.session-cookie-setting.http-only: Is cookie http-only
swarm.undertow.servlet-containers.KEY.session-cookie-setting.max-age: Max age of cookie
swarm.undertow.servlet-containers.KEY.session-cookie-setting.name: Name of the cookie
swarm.undertow.servlet-containers.KEY.session-cookie-setting.secure: Is cookie secure?
swarm.undertow.servlet-containers.KEY.session-id-length: The length of the generated session ID. Longer session ID’s are more secure. This number refers to the number of bytes of randomness that are used to generate the session ID, the actual ID that is sent to the client will be base64 encoded so will be approximately 33% larger (e.g. a session id length of 30 will result in a cookie value of length 40).
swarm.undertow.servlet-containers.KEY.stack-trace-on-error: If an error page with the stack trace should be generated on error. Values are all, none and local-only
swarm.undertow.servlet-containers.KEY.use-listener-encoding: Use encoding defined on listener
swarm.undertow.servlet-containers.KEY.websockets-setting.buffer-pool: The buffer pool to use for websocket deployments
swarm.undertow.servlet-containers.KEY.websockets-setting.deflater-level: Configures the level of compression of the DEFLATE algorithm
swarm.undertow.servlet-containers.KEY.websockets-setting.dispatch-to-worker: If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations.
swarm.undertow.servlet-containers.KEY.websockets-setting.per-message-deflate: Enables websocket’s per-message compression extension, RFC-7692
swarm.undertow.servlet-containers.KEY.websockets-setting.worker: The worker to use for websocket deployments
swarm.undertow.statistics-enabled: Configures if statistics are enabled. Changes take effect on the connector level statistics immediately, deployment level statistics will only be affected after the deployment is redeployed (or the container is reloaded).

D.37. Web

Provides a collection of fractions equivalent to the Web Profile:

Bean Validation
CDI
EJB
JAX-RS
- JSON-P
- JAXB
- Multipart
- Validator
JPA
JSF
Transactions
Undertow (Servlets)

Maven Coordinates

<dependency>
  <groupId>io.thorntail</groupId>
  <artifactId>web</artifactId>
</dependency>

Where did the comment section go?

Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.