Search

3.4. Enterprise Application Server 7 Plugin

download PDF
Table 3.2078. Basic Details
Internal Name:EAP7
Description:Provides monitoring and management of Wildfly 10 and JBoss EAP7
Version:4.4.0

Top-Level Resource Types

3.4.1. EAP7 - Standalone Server

Overview

Table 3.2079. Overview
Description:Standalone AS7 server
Singleton: no
Plugin:EAP7

Note

The server can be started, restarted, or stopped via the Start, Restart, and Shutdown operations. The Start and Restart operations start the server by executing the server start script, typically standalone.sh on UNIX or standalone.bat on Windows. The following connection settings can be used to configure the start script execution: * Start Script - the absolute path of the start script (e.g. "/opt/jboss-as-7.1.1.Final/bin/standalone.sh") * Start Script Prefix - a prefix command line to be prepended to the start script command line (e.g. "nohup sudo -u jboss -g jboss") * Start Script Arguments - arguments to be passed to the start script (e.g. "--server-config=standalone-full-ha.xml") * Start Script Environment - environment variables to be set in the start script's environment (e.g. "JAVA_HOME=/usr/java/jdk1.6.0_30") These settings are automatically initialized by the EAP7 plugin discovery code to match the currently running server process' command line and environment. The settings are not used by the Stop operation, since it stops the server via the management interface, not via a script. For more detailed descriptions of the settings, see the Connection Settings section below.

Child Resource Types

Autodiscovery Process Scans

Table 3.2080. Metrics
NameQuery
StandaloneASprocess|basename|match=^java.*,arg|org.jboss.as.standalone|match=.*

Connection Properties

Table 3.2081. 
NameDescriptionRequiredInternal Name
Start Script PathThe path to the script that the Start and Restart operations should use to start the server. If the path is not absolute, it is resolved relative to the server home directory (e.g. "bin/standalone.sh", "bin/domain.sh"). no startScript
Start Script PrefixA prefix command line that should be prepended to the start script command line by the Start and Restart operations; the prefix command must be an absolute path (e.g. "/usr/bin/sudo"). This property is most commonly used to run the AS7 process as a different user than the RHQ Agent (e.g. "sudo -u jboss -g jboss" could be used to run AS7 as user "jboss" and group "jboss". It is also possible to chain prefix commands (e.g. "nohup sudo -u jboss" could be used to make AS7 ignore HUP signals and to run as user "jboss"). no startScriptPrefix
Start Script Environment VariablesThe variables that the Start and Restart operations will add to the environment of the server start script. Each name=value pair should be on a new line. Variable values should *not* be enclosed in quotes (e.g. PATH=/usr/bin:/bin). On UNIX systems, the typical minimum set of environment variables is: PATH=/usr/bin:/bin . And on Windows the typical minimum set is: PATH=C:\Windows\System32;C:\Windows , OS=Windows_NT , SYSTEMROOT=C:\Windows . In addition, it is good practice to set JAVA_HOME to the absolute path of the install directory of the JRE or JDK you wish to use to run the AS7 instance. However, if JAVA_HOME is not specified, the start script will attempt to find java in the PATH. There is currently a 2000 character limit for this value. no startScriptEnv
Start Script ArgumentsThe arguments that the Start and Restart operations will pass to the server start script. Each argument should be on a new line - for example: --server-config=standalone-ha-full.xml. As an exception, the value of a space-delimited option can optionally be on the same line as the option - for example: -c standalone-ha-full.xml. There is currently a 2000 character limit for this value. no startScriptArgs
Additional JAVA_OPTSProperty used to make persistent changes to JAVA_OPTS. !!!WARNING!!! Feature available only if standard configuration file is used (standalone.conf or standalone.conf.bat). Please do not update the configuration file manually after setting this property. If value not set then configuration specific values are used. Value not set does not imply that configuration file does not set JAVA_OPTS, it simply means that the value was not set via RHQ. !!!WARNING!!! Value will be persisted to standalone.conf or standalone.conf.bat config file (OS dependent). Use this option to make the JAVA_OPTS configuration available for restarts outside of RHQ. The value (e.g.: -Xms512M -Xmx1024M) will be persisted in the configuration file. To remove any modifications done to the config file unset this property. The server requires restart for these changes to take effect. no javaOptsAdditional
CLI Local AuthenticationSpecifies if the local authentication should be used to interact with the EAP CLI (this includes bundle:handover feature, EAP patching and CLI operations). If this is set to "Yes", User and Password supplied above are NOT going to be passed to jboss-cli binary and plugin relies on local authentication. no nativeLocalAuth
Log Event Sources  yes logEventSources
Trust StrategyDefines the trust strategy to use when reading the server certificate:
  • Standard: standard verification using a truststore
  • Trust Self-signed: trust self-signed certificates (certification chain size equals to 1)
  • Trust Any: trust any server certificate
yes trustStrategy
Hostname VerificationDefines the hostname verification logic:
  • Strict: The hostname must match either the first CN, or any of the Subject Alternatives. A wildcard can occur in the CN, and in any of the Subject Alternatives.
  • Browser-compatible: same as Strict, except that it allows nested subdomains validation with wildcards.
  • Skip: no hostname verification
yes hostnameVerification
TruststorePath to a truststore file. If undefined, the JVM default truststore is used. no truststore
Truststore TypeTruststore file format (required when the Truststore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats. no truststoreType
Truststore PasswordPassword protecting the truststore file. no truststorePassword
Client Certificate Authentication  yes clientcertAuthentication
KeystorePath to a keystore file. Required when Client Certificate Authentication is on. no keystore
Keystore TypeKeystore file format (required when the Keystore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats. no keystoreType
Keystore PasswordPassword protecting the keystore file. no keystorePassword
Key PasswordPassword protecting the secret key in the keystore file. no keyPassword
Hostname  yes hostname
Port  yes port
SecureEncrypted transport indicator yes secure
UserManagement user for a secured AS no user
PasswordPassword for the management user no password
Management Connection TimeoutMaximum time in milliseconds to keep alive an idle management connection. Zero and negative values will disable connection persistence. Defaults to 5000 ms. no managementConnectionTimeout
Home DirectoryRoot directory of the server installation no homeDir
Base DirectoryBase directory for server content no baseDir
Configuration DirectoryBase configuration directory no configDir
Log Directorythe directory where log files will be written for this server no logDir
Product TypeServer product type (e.g. AS or EAP) no productType

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 3.2082. Metrics
NameTypeDescriptionInternal Name
Number of management requestsmeasurementNumber of requests sent to the controller_internal:mgmtRequests
Number of management requests per MinutemeasurementNumber of requests sent to the controller_internal:mgmtRequests
Time used for management requestsmeasurementTotal time for requests_internal:requestTime
Time used for management requests per MinutemeasurementTotal time for requests_internal:requestTime
Maximum request timemeasurementMax time for a request since last metric get_internal:maxTime
Server StatetraitDetailed server stateserver-state
Server Code NametraitServer Code Name_skm:release-codename
Server VersiontraitServer Version_skm:release-version
Product NametraitProduct Name_skm:product-name
Product VersiontraitProduct Version_skm:product-version
Server Start TimetraitServer Start TimestartTime
JGroups Multicast Addresstraitthe host and port used by JGroups for multicastmulticastAddress
Server Config FiletraitThe name of the server configuration file this server is usingconfig-file
Deploy DirectorytraitThe deployment directory for file based bundles (usually 'standalone/deployments')deployDir
Temporary DirectorytraitThe temporary directory (usually 'standalone/tmp'). May serve as deployment directory for handover only bundles'temp-dir
Active PatchestraitThe comma-separated list of patches that are currently applied to the server. The first entry is always the cumulative patch, followed by 0 or more one-off patches.active-patches

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 3.2083. 
NameDescriptionRequiredInternal Name
Properties  no *2
PathThe standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances no *3
Installed extensions  no *1
Base DirThe base directory for JBoss Application Server. yes base-dir
Config DirThe directory where the configurations are stored. yes config-dir
Config FileThe configuration file used to launch JBoss Application Server. yes config-file
Content DirThe directory where user content (e.g. deployments) that is managed by the server is stored. yes content-dir
Data DirThe data directory. yes data-dir
Deploy DirDeprecated variant of 'content-dir'. yes deploy-dir
Ext DirsA list of ext directories. yes ext-dirs
Home DirThe home directory for JBoss Application Server. yes home-dir
Host NameThe host name. yes host-name
Initial Running ModeThe current running mode of the server. Either LIVE (normal operations) or ADMIN_ONLY. An ADMIN_ONLY server will start any configured management interfaces and accept management requests, but will not start services used for handling end user requests. yes initial-running-mode
Launch TypeThe type of the running server. yes launch-type
Log DirThe directory where log files are sent. yes log-dir
Modules DirThe directory where modules are found. yes modules-dir
Node NameThe name of the server node. yes node-name
Qualified Host NameThe qualified host name. yes qualified-host-name
Server NameThe name of the server. yes server-name
Temp DirThe temporary directory. yes temp-dir

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 3.2084. Metrics
NameDescription
ReloadMake the server re-load the (changed) configuration. To load a different startup config use 'restart'
StartStart the server by invoking its start script
RestartRestart the server by shutting it down and invoking its start script
ShutdownShut down the server.
Install RHQ userInstalls a user in the server for management
Execute CLI commandsExecutes command via jboss-cli
Execute CLI scriptExecutes script via jboss-cli
Setup CLISetup jboss-cli.xml configuration file based on pluginConfiguration properties. Note that jboss-cli.xml was introduced in EAP 6.2 and this operation will fail for previous versions.

Package Types

none

3.4.1.1. EAP7 - ModCluster Standalone Service

Overview
Table 3.2085. Overview
Description:Mod_cluster support
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2086. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.2087. Metrics
NameDescription
Add ProxyAdd the proxy to the list of httpd connected to the node.
List ProxiesRead the list of httpd connected to the node.
Read Proxies ConfigurationSend a DUMP to httpd and display the result.
Read Proxies InfoSend a INFO to httpd and display the result.
RefreshRefresh the node sending a new CONFIG message to Apache httpd.
Remove ProxyRemove the proxy to the list of httpd connected to the node.
ResetReset the node connection to Apache httpd.
Package Types
none
3.4.1.1.1. EAP7 - Service Configuration Service
Overview
Table 3.2088. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2089. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2090. 
NameDescriptionRequiredInternal Name
Proxy ListList of proxies, Format (hostname:port) separated with commas. no proxy-list
Proxy UrlBase URL for MCMP requests. no proxy-url
Advertise SocketName of Socket binding to use for the Advertise socket. no advertise-socket
AdvertiseUse Advertise logic or not. no advertise
Advertise Security KeyString containing the security key for the Advertise logic. no advertise-security-key
BalancerThe balancer name. no balancer
ConnectorName of the web connector used to communicate with the load balancer. yes connector
Load Balancing GrouploadBalancingGroup name. no load-balancing-group
Excluded ContextsList of contexts mod_cluster should ignore, Format String separated with commas. no excluded-contexts
Auto Enable ContextsEnable contexts even if disabled in mod_cluster_manger (httpd). no auto-enable-contexts
Sticky SessionUse sticky sessions for requests. no sticky-session
Sticky Session RemoveRemove session information on failover. no sticky-session-remove
Sticky Session ForceDon't failover a request with session information. no sticky-session-force
Worker TimeoutTimeout to wait in httpd for an available worker to process the requests. no worker-timeout
Max AttemptsMax attempts to process an idempotent request. no max-attempts
Flush PacketsEnables/disables packet flushing in httpd. no flush-packets
Flush WaitTime to wait before flushing packets in httpd. no flush-wait
PingTime (in seconds) in which to wait for a pong answer to a ping. no ping
SmaxSoft maximum idle connection count in httpd no smax
TtlTime to live (in seconds) for idle connections above smax no ttl
Node TimeoutTimeout (in seconds) for proxy connections to a node. no node-timeout
Stop Context TimeoutMax time to wait for context to process pending requests. no stop-context-timeout
Socket TimeoutTimeout to wait for httpd to answer a MCMP message. no socket-timeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2091. Metrics
NameDescription
Add Custom MetricAdd new custom metric to the load balancer provider.
Add MetricAdd new metric to the load balancer provider.
Remove Custom MetricRemove a custom metric from the load balancer provider.
Remove MetricAdd new metric to the load balancer provider.
Package Types
none
3.4.1.1.1.1. EAP7 - Dynamic Load Provider Service
Overview
Table 3.2092. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2093. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2094. 
NameDescriptionRequiredInternal Name
DecayDecay. The default value is 2. no decay
HistoryHistory. The default value is 9. no history

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.1.1.1.1. EAP7 - Custom Load Metric Service
Overview
Table 3.2095. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2096. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2097. 
NameDescriptionRequiredInternal Name
CapacityCapacity of the metric. The default value is 1 no capacity
ClassClass name of the custom metric. yes class
WeightWeight of the metric. The default value is 1. no weight

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.1.1.1.2. EAP7 - Load Metric Service
Overview
Table 3.2098. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2099. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2100. 
NameDescriptionRequiredInternal Name
CapacityCapacity of the metric. The default value is 1. no capacity
TypeType of the metric yes type
WeightWeight of the metric. The default value is 1. no weight

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.1.1.2. EAP7 - Ssl Service
Overview
Table 3.2101. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2102. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2103. 
NameDescriptionRequiredInternal Name
Ca Certificate FileCertificate authority. no ca-certificate-file
Ca Revocation UrCertificate authority revocation list. no ca-revocation-ur
Certificate Key FileKey file for the certificate. no certificate-key-file
Cipher SuiteThe allowed cipher suite. no cipher-suite
Key AliasThe key alias. no key-alias
PasswordPassword. no password
ProtocolThe SSL protocols that are enabled. no protocol

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.2. EAP7 - IIOP-OpenJDK Service

Overview
Table 3.2104. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2105. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2106. 
NameDescriptionRequiredInternal Name
Add Component Via InterceptorIndicates whether SSL components should be added by an IOR interceptor (on) or not (off). The default value is true. no add-component-via-interceptor
Auth MethodThe authentication method. Valid values are 'none' and 'username_password'. The default value is username_password. no auth-method
Caller PropagationIndicates whether the caller identity should be propagated in the SAS context or not. Valid values are 'none' and 'supported'. The default value is none. no caller-propagation
Client RequiresValue that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no client-requires
Client SupportsValue that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no client-supports
ConfidentialityIndicates whether the transport must require confidentiality protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no confidentiality
Detect MisorderingIndicates whether the transport must require misordering detection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no detect-misordering
Detect ReplayIndicates whether the transport must require replay detection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no detect-replay
Export CorbalocIndicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off). The default value is true. no export-corbaloc
Giop VersionThe GIOP version to be used. The default value is 1.2. no giop-version
High Water Mark:exprTCP connection cache parameter. Each time the number of connections exceeds this value ORB tries to reclaim connections. Number of reclaimed connections is specified by tcp-number-to-reclaim property. If this property is not set then it is configured as OpenJDK ORB default. no high-water-mark:expr
IntegrityIndicates whether the transport must require integrity protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no integrity
Number To Reclaim:exprTCP connection cache parameter. Each time number of connections exceeds tcp-high-water-mark property then ORB tries to reclaim connections. Number of reclaimed connections is specified by this property. If it is not set then it is configured as OpenJDK ORB default. no number-to-reclaim:expr
Persistent Server IdPersistent id of the server. Persistent object references are valid across many activactions of the server and they identify it using this property. As a result of that: many activations of the same server should have this property set to the same value, different server instances running on the same host should have different server ids. The default value is 1. no persistent-server-id
PropertiesA list of generic key/value properties. no properties
RealmThe authentication service (AS) realm name. no realm
RequiredIndicates if authentication is required (true) or not (false). The default value is false. no required
Root ContextThe naming service root context. The default value is JBoss/Naming/root. no root-context
SecurityIndicates whether the security interceptors are to be installed (on) or not (off). The default value is none. no security
Security DomainThe name of the security domain that holds the key and trust stores that will be used to establish SSL connections. no security-domain
Server RequiresValue that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no server-requires
Server SupportsValue that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no server-supports
Socket BindingThe name of the socket binding configuration that specifies the ORB port. The default value is iiop. no socket-binding
Ssl Socket BindingThe name of the socket binding configuration that specifies the ORB SSL port. The default value is iiop-ssl. no ssl-socket-binding
Support SslIndicates whether SSL is to be supported (on) or not (off). The default value is false. no support-ssl
TransactionsIndicates whether the transactions interceptors are to be installed (on or spec) or not (off). The value 'on' enabled JTS while 'spec' enables a spec compliant mode (non JTS) that rejects incoming transaction contexts. The default value is none. no transactions
Trust In ClientIndicates if the transport must require trust in client to be established. Valid values are 'none', 'supported' and 'required'. The default value is none. no trust-in-client
Trust In TargetIndicates if the transport must require trust in target to be established. Valid values are 'none' and 'supported'. The default value is none. no trust-in-target

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.3. EAP7 - JVM Service

Overview
Table 3.2107. Overview
Description:Information about the underlying JVM
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2108. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.3.1. EAP7 - Operating System Service
Overview
Table 3.2109. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2110. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2111. Metrics
NameTypeDescriptionInternal Name
Available ProcessorsmeasurementThe number of processors available to the Java virtual machine.available-processors
System Load AveragemeasurementThe system load average for the last minute. The load average may not be available on some platforms; if the load average is not available, a negative value is returned.system-load-average

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.3.2. EAP7 - Memory Service
Overview
Table 3.2112. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2113. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2114. Metrics
NameTypeDescriptionInternal Name
Object Pending Finalization CountmeasurementThe approximate number of objects for which finalization is pending.object-pending-finalization-count
Initial heap usagemeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.heap-memory-usage:init
Used heapmeasurementThe amount of used memory in bytes.heap-memory-usage:used
Committed heapmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.heap-memory-usage:committed
Maximum heap usagemeasurementThe maximum amount of memory in bytes that can be used for memory management.heap-memory-usage:max
Initial non-heap usagemeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.non-heap-memory-usage:init
Used non-heap memorymeasurementThe amount of used memory in bytes.non-heap-memory-usage:used
Committed non-heap memorymeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.non-heap-memory-usage:committed
Maximum non-heap usagemeasurementThe maximum amount of memory in bytes that can be used for memory management.non-heap-memory-usage:max

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.2115. Metrics
NameDescription
Trigger GCRuns the garbage collector.
Package Types
none
3.4.1.3.3. EAP7 - Runtime Service
Overview
Table 3.2116. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2117. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2118. Metrics
NameTypeDescriptionInternal Name
UptimemeasurementThe uptime of the Java virtual machine in milliseconds.uptime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.3.4. EAP7 - Threading Service
Overview
Table 3.2119. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2120. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2121. Metrics
NameTypeDescriptionInternal Name
Thread CountmeasurementThe current number of live threads including both daemon and non-daemon threads.thread-count
Peak Thread CountmeasurementThe peak live thread count since the Java virtual machine started or peak was reset.peak-thread-count
Total Started Thread CountmeasurementThe total number of threads created and also started since the Java virtual machine started.total-started-thread-count
Daemon Thread CountmeasurementThe current number of live daemon threads.daemon-thread-count
Current Thread Cpu TimemeasurementThe total CPU time for the current thread in nanoseconds, or -1 if 'thread-cpu-time-enabled' is 'false'. A Java virtual machine implementation may not support CPU time measurement. If 'thread-cpu-time-supported', is 'false' undefined.current-thread-cpu-time
Current Thread User TimemeasurementThe CPU time that the current thread has executed in user mode in nanoseconds, or -1 if 'thread-cpu-time-enabled' is 'false'. A Java virtual machine implementation may not support CPU time measurement. If 'thread-cpu-time-supported', is 'false' the result will be undefined current-thread-user-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2122. 
NameDescriptionRequiredInternal Name
Thread Contention Monitoring EnabledWhether thread contention monitoring is enabled. no thread-contention-monitoring-enabled
Thread Cpu Time EnabledWhether thread CPU time measurement is enabled. no thread-cpu-time-enabled
Thread Contention Monitoring SupportedWhether the Java virtual machine supports thread contention monitoring. no thread-contention-monitoring-supported
Thread Cpu Time SupportedWhether the Java virtual machine implementation supports CPU time measurement for any thread. no thread-cpu-time-supported
Current Thread Cpu Time SupportedWhether the Java virtual machine supports CPU time measurement for the current thread. no current-thread-cpu-time-supported
Object Monitor Usage SupportedWhether the Java virtual machine supports monitoring of object monitor usage. no object-monitor-usage-supported
Synchronizer Usage SupportedWhether the Java virtual machine supports monitoring of ownable synchronizer usage. no synchronizer-usage-supported

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2123. Metrics
NameDescription
Dump All ThreadsReturns the thread info for all live threads with stack trace and synchronization information.
Find Deadlocked ThreadsFinds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.
Find Monitor Deadlocked ThreadsFinds cycles of threads that are in deadlock waiting to acquire object monitors.
Get Thread Cpu TimeReturns the total CPU time for a thread of the specified ID in nanoseconds.
Get Thread InfoReturns the thread info for a thread of the specified id. The stack trace, locked monitors, and locked synchronizers in the returned reply object will be empty.
Get Thread InfosReturns the thread info for each thread whose ID is in the input list.
Get Thread User TimeReturns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds.
Reset Peak Thread CountResets the peak thread count to the current number of live threads.
Get All thread idsGet all live thread IDs. If a security manager is installed and the caller does not have ManagementPermission('monitor'), the result will be undefined.
Package Types
none
3.4.1.3.5. EAP7 - Garbage Collector Service
Overview
Table 3.2124. Overview
Description:Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2125. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.3.5.1. EAP7 - Garbage Collector Resource Service
Overview
Table 3.2126. Overview
Description:The management interface for one of the garbage collectors in the Java virtual machine.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2127. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2128. Metrics
NameTypeDescriptionInternal Name
Collection CountmeasurementThe total number of collections that have occurred.collection-count
Collection Count per MinutemeasurementThe total number of collections that have occurred.collection-count
Collection TimemeasurementThe approximate accumulated collection elapsed time in milliseconds.collection-time
Collection Time per MinutemeasurementThe approximate accumulated collection elapsed time in milliseconds.collection-time
NametraitThe name representing this garbage collectorname
ValidtraitWhether this this memory manager is valid in the Java virtual machine.valid

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2129. 
NameDescriptionRequiredInternal Name
Memory Pool NamesThe name of memory pools that this garbage collector manages. yes memory-pool-names

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.3.6. EAP7 - Memory Pool Service
Overview
Table 3.2130. Overview
Description:Parent resource for the resources providing the management interface for the Java virtual machine's memory pools.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2131. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.3.6.1. EAP7 - Memory Pool Resource Service
Overview
Table 3.2132. Overview
Description:The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2133. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2134. Metrics
NameTypeDescriptionInternal Name
Collection Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.collection-usage:init
Collection Usage - UsedmeasurementThe amount of used memory in bytes.collection-usage:used
Collection Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.collection-usage:committed
Collection Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.collection-usage:max
Collection Usage Threshold CountmeasurementThe number of times that the Java virtual machine has detected that the memory usage has reached or exceeded the collection usage threshold. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.collection-usage-threshold-count
Collection Usage Threshold ExceededtraitWhether the memory usage of this memory pool after the most recent collection on which the Java virtual machine has expended effort has reached or exceeded its collection usage threshold. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.collection-usage-threshold-exceeded
Collection Usage Threshold SupportedtraitWhether this memory pool supports a collection usage threshold.collection-usage-threshold-supported
NametraitThe name representing this memory pool.name
Peak Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.peak-usage:init
Peak Usage - UsedmeasurementThe amount of used memory in bytes.peak-usage:used
Peak Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.peak-usage:committed
Peak Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.peak-usage:max
TypetraitThe type of this memory pool.type
Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.usage:init
Usage - UsedmeasurementThe amount of used memory in bytes.usage:used
Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.usage:committed
Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.usage:max
Usage Threshold CountmeasurementThe number of times that the memory usage has crossed the usage threshold. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.usage-threshold-count
Usage Threshold ExceededtraitWhether the memory usage of this memory pool reaches or exceeds its usage threshold value. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.usage-threshold-exceeded
Usage Threshold SupportedtraitWhether this memory pool supports usage threshold.usage-threshold-supported
ValidtraitWhether this memory pool is valid in the Java virtual machine. A memory pool becomes invalid once the Java virtual machine removes it from the memory system.valid

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2135. 
NameDescriptionRequiredInternal Name
Collection Usage ThresholdThe collection usage threshold value of this memory pool in bytes. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'. no collection-usage-threshold
Memory Manager NamesThe names of the memory managers that manage this memory pool. yes memory-manager-names
Usage ThresholdThe usage threshold value of this memory pool in bytes. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'. no usage-threshold

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2136. Metrics
NameDescription
Reset Peak UsageResets the peak memory usage statistic of this memory pool to the current memory usage.
Package Types
none

3.4.1.4. EAP7 - Undertow Service

Overview
Table 3.2137. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2138. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2139. 
NameDescriptionRequiredInternal Name
Default Security DomainThe default security domain used by web deployments. The default value is other. no default-security-domain
Default ServerThe default server to use for deployments. The default value is default-server. no default-server
Default Servlet ContainerThe default servlet container to use for deployments. The default value is default. no default-servlet-container
Default Virtual HostThe default virtual host to use for deployments. The default value is default-host. no default-virtual-host
Instance IdThe cluster instance id. The default value is {EXPRESSION_VALUE=${jboss.node.name}}. no instance-id
Statistics EnabledConfigures if are statistics enabled. The default value is false. no statistics-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.1. EAP7 - Filter configurations Service
Overview
Table 3.2140. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2141. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.4.1.1. EAP7 - Error page Service
Overview
Table 3.2142. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2143. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2144. 
NameDescriptionRequiredInternal Name
Code:exprError page code yes code:expr
PathError page path no path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.1.2. EAP7 - Expression filter Service
Overview
Table 3.2145. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2146. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2147. 
NameDescriptionRequiredInternal Name
ExpressionThe expression that defines the filter yes expression
ModuleModule to use to load the filter definitions no module

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.1.3. EAP7 - GZIP Service
Overview
Table 3.2148. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2149. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.4.1.4. EAP7 - Mod cluster Service
Overview
Table 3.2150. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2151. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2152. 
NameDescriptionRequiredInternal Name
Advertise Frequency:exprThe frequency (in milliseconds) that mod-cluster advertises itself on the network. The default value is 10000. no advertise-frequency:expr
Advertise PathThe path that mod-cluster is registered under, defaults to /. The default value is /. no advertise-path
Advertise ProtocolThe protocol that is in use, defaults to HTTP. The default value is http. no advertise-protocol
Advertise Socket BindingThe multicast group that is used to advertise yes advertise-socket-binding
Broken Node Timeout:exprThe amount of time that must elapse before a broken node is removed from the table. The default value is 60000. no broken-node-timeout:expr
Cached Connections Per Thread:exprThe number of connections that will be kept alive indefinitely. The default value is 40. no cached-connections-per-thread:expr
Connection Idle Timeout:exprThe 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). The default value is 60. no connection-idle-timeout:expr
Connections Per Thread:exprThe number of connections that will be maintained to backend servers, per IO thread. Defaults to 10. The default value is 40. no connections-per-thread:expr
Enable Http 2If 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. The default value is false. no enable-http2
Health Check Interval:exprThe frequency of health check pings to backend nodes. The default value is 10000. no health-check-interval:expr
Management Access PredicateA 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 no management-access-predicate
Management Socket BindingThe socket binding of the mod_cluster management 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 yes management-socket-binding
Max Ajp Packet SizeThe 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. no max-ajp-packet-size
Max Request Time:exprThe max amount of time that a request to a backend node can take before it is killed. The default value is -1. no max-request-time:expr
Request Queue Size:exprThe number of requests that can be queued if the connection pool is full before requests are rejected with a 503. The default value is 1000. no request-queue-size:expr
Security KeyThe security key that is used for the mod-cluster group. All members must use the same security key. no security-key
Security RealmThe security realm that provides the SSL configuration no security-realm
Use AliasIf an alias check is performed. The default value is false. no use-alias
WorkerThe XNIO worker that is used to send the advertise notifications. The default value is default. no worker

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.1.5. EAP7 - Rewrite Service
Overview
Table 3.2153. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2154. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2155. 
NameDescriptionRequiredInternal Name
RedirectIf this is true then a redirect will be done instead of a rewrite. The default value is false. no redirect
TargetThe expression that defines the target. If you are redirecting to a constant target put single quotes around the value yes target

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.1.6. EAP7 - Response header Service
Overview
Table 3.2156. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2157. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2158. 
NameDescriptionRequiredInternal Name
Header NameHeader name yes header-name
Header ValueValue for header yes header-value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.1.7. EAP7 - Request limit Service
Overview
Table 3.2159. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2160. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2161. 
NameDescriptionRequiredInternal Name
Max Concurrent Requests:exprMaximum number of concurrent requests no max-concurrent-requests:expr
Queue Size:exprNumber of requests to queue before they start being rejected no queue-size:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.1.8. EAP7 - Custom filter Service
Overview
Table 3.2162. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2163. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2164. 
NameDescriptionRequiredInternal Name
Class NameClass name of HttpHandler yes class-name
ModuleModule name where class can be loaded from yes module
ParametersFilter parameters no parameters

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.2. EAP7 - Handler configuration Service
Overview
Table 3.2165. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2166. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.4.2.1. EAP7 - File Handler - Undertow Service
Overview
Table 3.2167. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2168. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2169. 
NameDescriptionRequiredInternal Name
Cache Buffer Size:exprSize of the buffers. The default value is 1024. no cache-buffer-size:expr
Cache Buffers:exprNumber of buffers. The default value is 1024. no cache-buffers:expr
Case SensitiveUse case sensitive file handling. The default value is true. no case-sensitive
Directory ListingEnable directory listing?. The default value is false. no directory-listing
Follow SymlinkEnable following symbolic links. The default value is false. no follow-symlink
PathPath on filesystem from where file handler will serve resources no path
Safe Symlink PathsPaths that are safe to be targets of symbolic links no safe-symlink-paths

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.2.2. EAP7 - Reverse proxy Service
Overview
Table 3.2170. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2171. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2172. 
NameDescriptionRequiredInternal Name
Cached Connections Per Thread:exprThe number of connections that will be kept alive indefinitely. The default value is 5. no cached-connections-per-thread:expr
Connection Idle Timeout:exprThe 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). The default value is 60. no connection-idle-timeout:expr
Connections Per Thread:exprThe number of connections that will be maintained to backend servers, per IO thread. Defaults to 10. The default value is 10. no connections-per-thread:expr
Max Request Time:exprThe maximum time that a proxy request can be active for, before being killed. Defaults to unlimited. The default value is -1. no max-request-time:expr
Problem Server Retry:exprTime in seconds to wait before attempting to reconnect to a server that is down. The default value is 30. no problem-server-retry:expr
Request Queue Size:exprThe number of requests that can be queued if the connection pool is full before requests are rejected with a 503. The default value is 10. no request-queue-size:expr
Session Cookie NamesComma separated list of session cookie names. Generally this will just be JSESSIONID. The default value is JSESSIONID. no session-cookie-names

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.2.2.1. EAP7 - Reverse proxy host Service
Overview
Table 3.2173. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2174. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2175. 
NameDescriptionRequiredInternal Name
Instance IdThe instance id (aka JVM route) that will be used to enable sticky sessions no instance-id
Outbound Socket BindingOutbound socket binding for this host no outbound-socket-binding
PathOptional path if host is using non root resource. The default value is /. no path
SchemeWhat kind of scheme is used. The default value is http. no scheme
Security RealmThe security realm that provides the SSL configuration for the connection to the host no security-realm

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.3. EAP7 - Buffer Cache Service
Overview
Table 3.2176. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2177. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2178. 
NameDescriptionRequiredInternal Name
Buffer Size:exprThe size of an individual buffer. The default value is 1024. no buffer-size:expr
Buffers Per Region:exprThe numbers of buffers in a region. The default value is 1024. no buffers-per-region:expr
Max Regions:exprThe maximum number of regions. The default value is 10. no max-regions:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.4. EAP7 - Server Service
Overview
Table 3.2179. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2180. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2181. 
NameDescriptionRequiredInternal Name
Default HostThe servers default virtual host. The default value is default-host. no default-host
Servlet ContainerThe servers default servlet container. The default value is default. no servlet-container

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.4.1. EAP7 - Ajp Listener Service
Overview
Table 3.2182. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2183. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2184. Metrics
NameTypeDescriptionInternal Name
Bytes ReceivedmeasurementThe number of bytes that have been received by this listenerbytes-received
Bytes SentmeasurementThe number of bytes that have been sent out on this listenerbytes-sent
Error CountmeasurementThe number of 500 responses that have been sent by this listenererror-count
Max Processing TimemeasurementThe maximum processing time taken by a request on this listenermax-processing-time
Processing TimemeasurementThe total processing time of all requests handed by this listenerprocessing-time
Request CountmeasurementThe number of requests this listener has servedrequest-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2185. 
NameDescriptionRequiredInternal Name
Allow Encoded SlashIf a request comes in with encoded / characters (i.e. %2F), will these be decoded. The default value is false. no allow-encoded-slash
Allow Equals In Cookie ValueIf 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. The default value is false. no allow-equals-in-cookie-value
Always Set Keep AliveIf this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. no always-set-keep-alive
Buffer Pipelined DataIf we should buffer pipelined requests. The default value is true. no buffer-pipelined-data
Buffer PoolThe AJP listeners buffer pool. The default value is default. no buffer-pool
Decode UrlIf 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. The default value is true. no decode-url
Disallowed MethodsA comma separated list of HTTP methods that are not allowed no disallowed-methods
EnabledIf the listener is enabled. The default value is true. no enabled
Max Buffered Request Size:exprMaximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation. The default value is 16384. no max-buffered-request-size:expr
Max Connections:exprThe maximum number of concurrent connections. no max-connections:expr
Max Cookies:exprThe maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-cookies:expr
Max Header Size:exprThe maximum size in bytes of a http request header. The default value is 1048576. no max-header-size:expr
Max Headers:exprThe maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-headers:expr
Max Parameters:exprThe 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). The default value is 1000. no max-parameters:expr
Max Post Size:exprThe maximum size of a post that will be accepted. The default value is 10485760. no max-post-size:expr
No Request Timeout:exprThe length of time in milliseconds that the connection can be idle before it is closed by the container no no-request-timeout:expr
Read Timeout:exprConfigure 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}. no read-timeout:expr
Receive Buffer:exprThe receive buffer size. no receive-buffer:expr
Record Request Start TimeIf 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. The default value is false. no record-request-start-time
Redirect SocketIf 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. no redirect-socket
Request Parse Timeout:exprThe maximum amount of time (in milliseconds) that can be spent parsing the request no request-parse-timeout:expr
Resolve Peer AddressEnables host dns lookup. The default value is false. no resolve-peer-address
SchemeThe listener scheme, can be HTTP or HTTPS. By default the scheme will be taken from the incoming AJP request. no scheme
Send Buffer:exprThe send buffer size. no send-buffer:expr
Socket BindingThe AJP listener socket binder yes socket-binding
Tcp Backlog:exprConfigure a server with the specified backlog. no tcp-backlog:expr
Tcp Keep AliveConfigure a channel to send TCP keep-alive messages in an implementation-dependent manner. no tcp-keep-alive
Url CharsetURL charset. The default value is UTF-8. no url-charset
WorkerThe AJP listeners XNIO worker. The default value is default. no worker
Write Timeout:exprConfigure 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}. no write-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.4.2. EAP7 - Undertow Host Service
Overview
Table 3.2186. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2187. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2188. 
NameDescriptionRequiredInternal Name
AliasAliases for the host no alias
Default Response Code:exprIf set, this will be response code sent back in case requested context does not exist on server. The default value is 404. no default-response-code:expr
Default Web ModuleDefault web module. The default value is ROOT.war. no default-web-module
Disable Console Redirectif set to true, /console redirect wont be enabled for this host, default is false. The default value is false. no disable-console-redirect

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.4.2.1. EAP7 - Host Filter Ref Service
Overview
Table 3.2189. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2190. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2191. 
NameDescriptionRequiredInternal Name
PredicatePredicates 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. no predicate
Priority:exprDefines 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. The default value is 1. no priority:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.4.2.2. EAP7 - Undertow-Location Service
Overview
Table 3.2192. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2193. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2194. 
NameDescriptionRequiredInternal Name
HandlerDefault handler for this location yes handler

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.4.2.2.1. EAP7 - Location Filter Ref Service
Overview
Table 3.2195. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2196. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2197. 
NameDescriptionRequiredInternal Name
PredicatePredicates 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. no predicate
Priority:exprDefines 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. The default value is 1. no priority:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.4.3. EAP7 - Http Listener Service
Overview
Table 3.2198. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2199. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2200. Metrics
NameTypeDescriptionInternal Name
Bytes ReceivedmeasurementThe number of bytes that have been received by this listenerbytes-received
Bytes SentmeasurementThe number of bytes that have been sent out on this listenerbytes-sent
Error CountmeasurementThe number of 500 responses that have been sent by this listenererror-count
Max Processing TimemeasurementThe maximum processing time taken by a request on this listenermax-processing-time
Processing TimemeasurementThe total processing time of all requests handed by this listenerprocessing-time
Request CountmeasurementThe number of requests this listener has servedrequest-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2201. 
NameDescriptionRequiredInternal Name
Allow Encoded SlashIf a request comes in with encoded / characters (i.e. %2F), will these be decoded. The default value is false. no allow-encoded-slash
Allow Equals In Cookie ValueIf 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. The default value is false. no allow-equals-in-cookie-value
Always Set Keep AliveIf this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. no always-set-keep-alive
Buffer Pipelined DataIf we should buffer pipelined requests. The default value is true. no buffer-pipelined-data
Buffer PoolThe AJP listeners buffer pool. The default value is default. no buffer-pool
Certificate ForwardingIf 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. The default value is false. no certificate-forwarding
Decode UrlIf 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. The default value is true. no decode-url
Disallowed MethodsA comma separated list of HTTP methods that are not allowed no disallowed-methods
Enable Http 2Enables HTTP2 support for this listener. The default value is false. no enable-http2
EnabledIf the listener is enabled. The default value is true. no enabled
Max Buffered Request Size:exprMaximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation. The default value is 16384. no max-buffered-request-size:expr
Max Connections:exprThe maximum number of concurrent connections. no max-connections:expr
Max Cookies:exprThe maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-cookies:expr
Max Header Size:exprThe maximum size in bytes of a http request header. The default value is 1048576. no max-header-size:expr
Max Headers:exprThe maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-headers:expr
Max Parameters:exprThe 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). The default value is 1000. no max-parameters:expr
Max Post Size:exprThe maximum size of a post that will be accepted. The default value is 10485760. no max-post-size:expr
No Request Timeout:exprThe length of time in milliseconds that the connection can be idle before it is closed by the container no no-request-timeout:expr
Proxy Address Forwardingenables x-forwarded-host and similar headers and set a remote ip address and hostname. The default value is false. no proxy-address-forwarding
Read Timeout:exprConfigure 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}. no read-timeout:expr
Receive Buffer:exprThe receive buffer size. no receive-buffer:expr
Record Request Start TimeIf 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. The default value is false. no record-request-start-time
Redirect SocketIf 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. no redirect-socket
Request Parse Timeout:exprThe maximum amount of time (in milliseconds) that can be spent parsing the request no request-parse-timeout:expr
Resolve Peer AddressEnables host dns lookup. The default value is false. no resolve-peer-address
Send Buffer:exprThe send buffer size. no send-buffer:expr
Socket BindingThe AJP listener socket binder yes socket-binding
Tcp Backlog:exprConfigure a server with the specified backlog. no tcp-backlog:expr
Tcp Keep AliveConfigure a channel to send TCP keep-alive messages in an implementation-dependent manner. no tcp-keep-alive
Url CharsetURL charset. The default value is UTF-8. no url-charset
WorkerThe AJP listeners XNIO worker. The default value is default. no worker
Write Timeout:exprConfigure 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}. no write-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.4.4. EAP7 - Https Listener Service
Overview
Table 3.2202. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2203. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2204. Metrics
NameTypeDescriptionInternal Name
Bytes ReceivedmeasurementThe number of bytes that have been received by this listenerbytes-received
Bytes SentmeasurementThe number of bytes that have been sent out on this listenerbytes-sent
Error CountmeasurementThe number of 500 responses that have been sent by this listenererror-count
Max Processing TimemeasurementThe maximum processing time taken by a request on this listenermax-processing-time
Processing TimemeasurementThe total processing time of all requests handed by this listenerprocessing-time
Request CountmeasurementThe number of requests this listener has servedrequest-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2205. 
NameDescriptionRequiredInternal Name
Allow Encoded SlashIf a request comes in with encoded / characters (i.e. %2F), will these be decoded. The default value is false. no allow-encoded-slash
Allow Equals In Cookie ValueIf 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. The default value is false. no allow-equals-in-cookie-value
Always Set Keep AliveIf this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. no always-set-keep-alive
Buffer Pipelined DataIf we should buffer pipelined requests. The default value is true. no buffer-pipelined-data
Buffer PoolThe AJP listeners buffer pool. The default value is default. no buffer-pool
Decode UrlIf 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. The default value is true. no decode-url
Disallowed MethodsA comma separated list of HTTP methods that are not allowed no disallowed-methods
Enable Http 2Enables HTTP2 support for this listener. The default value is false. no enable-http2
Enable SpdyEnables SPDY support for this listener. The default value is false. no enable-spdy
EnabledIf the listener is enabled. The default value is true. no enabled
Enabled Cipher SuitesConfigures Enabled SSL cyphers no enabled-cipher-suites
Enabled ProtocolsConfigures SSL protocols no enabled-protocols
Max Buffered Request Size:exprMaximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation. The default value is 16384. no max-buffered-request-size:expr
Max Connections:exprThe maximum number of concurrent connections. no max-connections:expr
Max Cookies:exprThe maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-cookies:expr
Max Header Size:exprThe maximum size in bytes of a http request header. The default value is 1048576. no max-header-size:expr
Max Headers:exprThe maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-headers:expr
Max Parameters:exprThe 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). The default value is 1000. no max-parameters:expr
Max Post Size:exprThe maximum size of a post that will be accepted. The default value is 10485760. no max-post-size:expr
No Request Timeout:exprThe length of time in milliseconds that the connection can be idle before it is closed by the container no no-request-timeout:expr
Read Timeout:exprConfigure 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}. no read-timeout:expr
Receive Buffer:exprThe receive buffer size. no receive-buffer:expr
Record Request Start TimeIf 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. The default value is false. no record-request-start-time
Request Parse Timeout:exprThe maximum amount of time (in milliseconds) that can be spent parsing the request no request-parse-timeout:expr
Resolve Peer AddressEnables host dns lookup. The default value is false. no resolve-peer-address
Security RealmThe listeners security realm yes security-realm
Send Buffer:exprThe send buffer size. no send-buffer:expr
Socket BindingThe AJP listener socket binder yes socket-binding
Ssl Session Cache Size:exprThe maximum number of active SSL sessions no ssl-session-cache-size:expr
Ssl Session Timeout:exprThe timeout for SSL sessions, in seconds no ssl-session-timeout:expr
Tcp Backlog:exprConfigure a server with the specified backlog. no tcp-backlog:expr
Tcp Keep AliveConfigure a channel to send TCP keep-alive messages in an implementation-dependent manner. no tcp-keep-alive
Url CharsetURL charset. The default value is UTF-8. no url-charset
Verify ClientThe desired SSL client authentication mode for SSL channels. The default value is NOT_REQUESTED. no verify-client
WorkerThe AJP listeners XNIO worker. The default value is default. no worker
Write Timeout:exprConfigure 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}. no write-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.5. EAP7 - Servlet Container Service
Overview
Table 3.2206. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2207. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2208. 
NameDescriptionRequiredInternal Name
Check Interval:exprCheck interval for JSP updates using a background thread. The default value is 0. no check-interval:expr
DevelopmentEnable Development mode which enables reloading JSP on-the-fly. The default value is false. no development
DisabledEnable the JSP container. The default value is false. no disabled
Display Source FragmentWhen a runtime error occurs, attempts to display corresponding JSP source fragment. The default value is true. no display-source-fragment
Dump SmapWrite SMAP data to a file. The default value is false. no dump-smap
Error On Use Bean Invalid Class AttributeEnable errors when using a bad class in useBean. The default value is false. no error-on-use-bean-invalid-class-attribute
Generate Strings As Char ArraysGenerate String constants as char arrays. The default value is false. no generate-strings-as-char-arrays
Java EncodingSpecify the encoding used for Java sources. The default value is UTF8. no java-encoding
Keep GeneratedKeep the generated Servlets. The default value is true. no keep-generated
Mapped FileMap to the JSP source. The default value is true. no mapped-file
Modification Test Interval:exprMinimum amount of time between two tests for updates, in seconds. The default value is 4. no modification-test-interval:expr
Optimize ScriptletsIf JSP scriptlets should be optimised to remove string concatenation. The default value is false. no optimize-scriptlets
Recompile On FailRetry failed JSP compilations on each request. The default value is false. no recompile-on-fail
Scratch DirSpecify a different work directory. no scratch-dir
SmapEnable SMAP. The default value is true. no smap
Source VmSource VM level for compilation. The default value is 1.8. no source-vm
Tag PoolingEnable tag pooling. The default value is true. no tag-pooling
Target VmTarget VM level for compilation. The default value is 1.8. no target-vm
Trim SpacesTrim some spaces from the generated Servlet. The default value is false. no trim-spaces
X Powered ByEnable advertising the JSP engine in x-powered-by. The default value is true. no x-powered-by
Buffer PoolThe buffer pool to use for websocket deployments. The default value is default. no buffer-pool
Dispatch To WorkerIf 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. The default value is true. no dispatch-to-worker
WorkerThe worker to use for websocket deployments. The default value is default. no worker
Allow Non Standard WrappersIf true then request and response wrappers that do not extend the standard wrapper classes can be used. The default value is false. no allow-non-standard-wrappers
Default Buffer CacheThe buffer cache to use for caching static resources. The default value is default. no default-buffer-cache
Default EncodingDefault encoding to use for all deployed applications no default-encoding
Default Session Timeout:exprThe default session timeout (in minutes) for all applications deployed in the container. The default value is 30. no default-session-timeout:expr
Directory ListingIf directory listing should be enabled for default servlets. no directory-listing
Disable Caching For Secured PagesIf 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. The default value is true. no disable-caching-for-secured-pages
Eager Filter InitializationIf true undertow calls filter init() on deployment start rather than when first requested. The default value is false. no eager-filter-initialization
Ignore FlushIgnore flushes on the servlet output stream. In most cases these just hurt performance for no good reason. The default value is false. no ignore-flush
Max Sessions:exprThe maximum number of sessions that can be active at one time no max-sessions:expr
Proactive AuthenticationIf proactive authentication should be used. If this is true a user will always be authenticated if credentials are present. The default value is true. no proactive-authentication
Session Id Length:exprThe length of the generated session ID. Longer session ID's are more secure. The default value is 30. no session-id-length:expr
Stack Trace On ErrorIf an error page with the stack trace should be generated on error. Values are all, none and local-only. The default value is local-only. no stack-trace-on-error
Use Listener EncodingUse encoding defined on listener. The default value is false. no use-listener-encoding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.5.1. EAP7 - Mime Mapping Service
Overview
Table 3.2209. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2210. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2211. 
NameDescriptionRequiredInternal Name
ValueThe mime type for this mapping yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.4.5.2. EAP7 - Welcome File Service
Overview
Table 3.2212. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2213. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none

3.4.1.5. EAP7 - General JCA connectors Service

Overview
Table 3.2214. Overview
Description:General settings of the JCA engine. Not necessarily for end-users
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2215. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2216. 
NameDescriptionRequiredInternal Name
Default Workmanager Short Running Thread PoolSpecify the name of short running thread pool yes default-workmanager-short-running-thread-pool
Default Workmanager Long Running Thread PoolSpecify the name of long running thread pool yes default-workmanager-long-running-thread-pool
Bean Validation EnabledSpecify whether bean validation is enabled yes bean-validation-enabled
Archive Validation EnabledEnabling the validation yes archive-validation-enabled
Archive Validation Fail On ErrorShould an archive validation error report fail the deployment. Default: true yes archive-validation-fail-on-error
Archive Validation Fail On WarnShould an archive validation warning report fail the deployment. Default: false yes archive-validation-fail-on-warn
Cached Connection Manager Debugenable/disable debug information logging for cached connection manager yes cached-connection-manager-debug
Cached Connection Manager Errorenable/disable error information logging for cached connection manager yes cached-connection-manager-error

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.6. EAP7 - Datasources (Standalone) Service

Overview
Table 3.2217. Overview
Description:Datasources subsystem for Standalone servers.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2218. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2219. 
NameDescriptionRequiredInternal Name
Available drivers  yes *4

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.6.1. EAP7 - DataSource (Standalone) Service
Overview
Table 3.2220. Overview
Description:A non-XA data source
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2221. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2222. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2223. 
NameDescriptionRequiredInternal Name
Connection Property  no *1
Connection UrlThe JDBC driver connection URL yes connection-url
Driver NameName of the (existing) JDBC driver to use yes driver-name
Driver ClassThe fully qualified name of the JDBC driver class no driver-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
DriverDefines the JDBC driver the datasource should use with this format: driver-name>#major-version.minor-version where driver-name is the fully qualified name of the JDBC driver class no driver
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
JtaEnable JTA integration no jta
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. Existing value cannot be unset. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. Existing value cannot be unset. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. Existing value cannot be unset. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. Existing value cannot be unset. no pool-use-strict-min
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Allow Multiple UsersSpecifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that no allow-multiple-users
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait MillisIndicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. Existing value cannot be unset. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. Existing value cannot be unset. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. Existing value cannot be unset. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. Existing value cannot be unset. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2224. Metrics
NameDescription
EnableEnables the data-source. Note this operation will not be supported runtime in next versions.
DisableDisables the data-source. Note this operation will not be supported runtime in next versions.
Flush All Connection In PoolFlushes the pool for all connections
Flush Idle Connection In PoolFlushes the pool for idle connections
Test Connection In PoolTests if a connection can be obtained
Package Types
none
3.4.1.6.2. EAP7 - XADataSource (Standalone) Service
Overview
Table 3.2225. Overview
Description:An XA data source
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2226. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2227. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2228. 
NameDescriptionRequiredInternal Name
Properties  yes *2
Xa Datasource ClassThe fully qualified name of the javax.sql.XADataSource implementation yes xa-datasource-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
Driver NameDefines 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 yes driver-name
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. Existing value cannot be unset. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. Existing value cannot be unset. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. Existing value cannot be unset. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. Existing value cannot be unset. no pool-use-strict-min
InterleavingAn element to enable interleaving for XA connection factories no interleaving
No Tx Separate PoolOracle 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 context no no-tx-separate-pool
Pad XidShould the Xid be padded no pad-xid
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Wrap Xa DatasourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance no wrap-xa-datasource
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Recovery Plugin Class Namerecovery plugin implementation provided for specific purpose (i.e vendor) no recovery-plugin-class-name
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait Millishe allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. Existing value cannot be unset. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. Existing value cannot be unset. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. Existing value cannot be unset. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. Existing value cannot be unset. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Xa Resource TimeoutPassed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds no xa-resource-timeout
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm
Recovery Usernameusername used to try connection recovery no recovery-username
Recovery Passwordpassword used to try connection recovery no recovery-password
Recovery Security Domainsecurity-domain used to try connection recovery no recovery-security-domain
No Recoveryif true no recovery are tried for this connection pool no no-recovery

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2229. Metrics
NameDescription
EnableEnables the data-source. Note this operation will not be supported runtime in next versions.
DisableDisables the data-source. Note this operation will not be supported runtime in next versions.
Flush All Connection In PoolFlushes the pool for all connections
Flush Idle Connection In PoolFlushes the pool for idle connections
Test Connection In PoolTests if a connection can be obtained
Package Types
none

3.4.1.7. EAP7 - Logging Service

Overview
Table 3.2230. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2231. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2232. 
NameDescriptionRequiredInternal Name
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
HandlersThe Handlers associated with this Logger. yes handlers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.7.1. EAP7 - Async Handler Service
Overview
Table 3.2233. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2234. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2235. 
NameDescriptionRequiredInternal Name
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
Overflow ActionSpecify what action to take when the overflowing. The valid options are 'block' and 'discard'. The default value is BLOCK. yes overflow-action
Queue LengthThe queue length to use before flushing writing yes queue-length
SubhandlersThe Handlers associated with this async handler. no subhandlers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2236. Metrics
NameDescription
Assign SubhandlerAssign a subhandler to the ASYNC handler.
DisableDisable a logging handler.
EnableEnable a logging handler.
Unassign SubhandlerUnassign a subhandler from the ASYNC handler.
Package Types
none
3.4.1.7.2. EAP7 - Console Handler Service
Overview
Table 3.2237. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2238. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2239. 
NameDescriptionRequiredInternal Name
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
TargetDefines the target of the console handler. The value can either be SYSTEM_OUT or SYSTEM_ERR. The default value is System.out. no target

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2240. Metrics
NameDescription
DisableDisable a logging handler.
EnableEnable a logging handler.
Package Types
none
3.4.1.7.3. EAP7 - Custom Handler Service
Overview
Table 3.2241. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2242. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2243. 
NameDescriptionRequiredInternal Name
ClassThe logging handler class to be used. yes class
EncodingThe character encoding used by this Handler. no encoding
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
ModuleThe module that the logging handler depends on. yes module
Properties  yes properties

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2244. Metrics
NameDescription
DisableDisable a logging handler.
EnableEnable a logging handler.
Package Types
none
3.4.1.7.4. EAP7 - File Handler Service
Overview
Table 3.2245. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2246. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2247. 
NameDescriptionRequiredInternal Name
AppendSpecify whether to append to the target file. The default value is true. no append
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FileThe file description consisting of the path and optional relative to path. no file
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2248. Metrics
NameDescription
DisableDisable a logging handler.
EnableEnable a logging handler.
Package Types
none
3.4.1.7.5. EAP7 - Logger Service
Overview
Table 3.2249. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2250. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2251. 
NameDescriptionRequiredInternal Name
HandlersThe Handlers associated with this Logger. no handlers
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
Use Parent HandlersSpecifies whether or not this logger should send its output to it's parent Logger. The default value is true. no use-parent-handlers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2252. Metrics
NameDescription
Change Log LevelChange the logging level for a logger category.
Package Types
none
3.4.1.7.6. EAP7 - Periodic Rotating File Handler Service
Overview
Table 3.2253. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2254. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2255. 
NameDescriptionRequiredInternal Name
AppendSpecify whether to append to the target file. The default value is true. no append
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FileThe file description consisting of the path and optional relative to path. no file
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
SuffixSet 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. yes suffix

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2256. Metrics
NameDescription
DisableDisable a logging handler.
EnableEnable a logging handler.
Package Types
none
3.4.1.7.7. EAP7 - Size Rotating File Handler Service
Overview
Table 3.2257. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2258. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2259. 
NameDescriptionRequiredInternal Name
AppendSpecify whether to append to the target file. The default value is true. no append
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FileThe file description consisting of the path and optional relative to path. no file
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
Max Backup IndexThe maximum number of backups to keep. The default value is 1. yes max-backup-index
Rotate SizeThe size at which to rotate the log file. The default value is 2m. yes rotate-size

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2260. Metrics
NameDescription
DisableDisable a logging handler.
EnableEnable a logging handler.
Package Types
none

3.4.1.8. EAP7 - Webservices Service

Overview
Table 3.2261. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2262. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2263. 
NameDescriptionRequiredInternal Name
Modify Wsdl AddressWhether the soap address can be modified. no modify-wsdl-address
Wsdl HostThe WSDL, that is a required deployment artifact for an endpoint, has a <soap:address> element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of <soap:address> is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of <soap:address> is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the <soap:address> no wsdl-host
Wsdl PortThe non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors. no wsdl-port
Wsdl Secure PortThe secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors. no wsdl-secure-port

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.8.1. EAP7 - Endpoint Service
Overview
Table 3.2264. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2265. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.8.1.1. EAP7 - Post Handler Chain Service
Overview
Table 3.2266. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2267. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2268. 
NameDescriptionRequiredInternal Name
Protocol BindingsProtocol binding no protocol-bindings

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.8.1.1.1. EAP7 - Post Handler Service
Overview
Table 3.2269. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2270. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2271. 
NameDescriptionRequiredInternal Name
ClassHandler class yes class

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.8.1.2. EAP7 - Pre Handler Chain Service
Overview
Table 3.2272. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2273. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2274. 
NameDescriptionRequiredInternal Name
Protocol BindingsProtocol binding no protocol-bindings

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.8.1.2.1. EAP7 - Pre Handler Service
Overview
Table 3.2275. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2276. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2277. 
NameDescriptionRequiredInternal Name
ClassHandler class yes class

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.8.1.3. EAP7 - Property Service
Overview
Table 3.2278. Overview
Description:A property
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2279. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2280. 
NameDescriptionRequiredInternal Name
ValueThe property value. no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.9. EAP7 - Naming Service

Overview
Table 3.2281. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2282. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.2283. Metrics
NameDescription
JNDIViewPeek at the JNDI tree
Package Types
none
3.4.1.9.1. EAP7 - Binding Service
Overview
Table 3.2284. Overview
Description:JNDI bindings for primitive types
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2285. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2286. 
NameDescriptionRequiredInternal Name
Binding TypeThe type of binding to create, may be simple, lookup or object-factory yes binding-type
ClassThe object factory class name for object factory bindings no class
LookupThe entry to lookup in JNDI for lookup bindings no lookup
ModuleThe module to load the object factory from for object factory bindings no module
TypeThe type of the value to bind for simple bindings, this must be a primitive type no type
ValueThe value to bind for simple bindings no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.10. EAP7 - Transactions Subsystem (Standalone) Service

Overview
Table 3.2287. Overview
Description:The transactions subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2288. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2289. Metrics
NameTypeDescriptionInternal Name
Number Of Nested TransactionsmeasurementThe total number of nested (sub) transactions created.number-of-nested-transactions
Number Of Nested Transactions per MinutemeasurementThe total number of nested (sub) transactions created.number-of-nested-transactions
Number Of Timed Out TransactionsmeasurementThe number of transactions that have rolled back due to timeout.number-of-timed-out-transactions
Number Of Timed Out Transactions per MinutemeasurementThe number of transactions that have rolled back due to timeout.number-of-timed-out-transactions
Number Of Committed TransactionsmeasurementThe number of committed transactions.number-of-committed-transactions
Number Of Committed Transactions per MinutemeasurementThe number of committed transactions.number-of-committed-transactions
Number Of TransactionsmeasurementThe total number of transactions (top-level and nested) creatednumber-of-transactions
Number Of Transactions per MinutemeasurementThe total number of transactions (top-level and nested) creatednumber-of-transactions
Number Of HeuristicsmeasurementThe number of transactions which have terminated with heuristic outcomes.number-of-heuristics
Number Of Heuristics per MinutemeasurementThe number of transactions which have terminated with heuristic outcomes.number-of-heuristics
Number Of Aborted TransactionsmeasurementThe number of aborted (i.e. rolledback) transactions.number-of-aborted-transactions
Number Of Aborted Transactions per MinutemeasurementThe number of aborted (i.e. rolledback) transactions.number-of-aborted-transactions
Number Of Inflight TransactionsmeasurementThe number of transactions that have begun but not yet terminated.number-of-inflight-transactions
Number Of Inflight Transactions per MinutemeasurementThe number of transactions that have begun but not yet terminated.number-of-inflight-transactions
Number Of Application RollbacksmeasurementThe number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behaviour is considered an attribute of the application configuration.number-of-application-rollbacks
Number Of Application Rollbacks per MinutemeasurementThe number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behaviour is considered an attribute of the application configuration.number-of-application-rollbacks
Number Of Resource RollbacksmeasurementThe number of transactions that rolled back due to resource (participant) failure.number-of-resource-rollbacks
Number Of Resource Rollbacks per MinutemeasurementThe number of transactions that rolled back due to resource (participant) failure.number-of-resource-rollbacks

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2290. 
NameDescriptionRequiredInternal Name
Process Id UuidIndicates whether the transaction manager should use a UUID based process id. no process-id-uuid
Socket BindingUsed to reference the correct socket binding to use for the recovery environment. yes socket-binding
JtsIf true this enables the Java Transaction Service. The default value is false. no jts
Object Store PathDenotes 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. The default value is tx-object-store. no object-store-path
Process Id Socket BindingThe 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. no process-id-socket-binding
Default TimeoutThe default timeout. The default value is 300. no default-timeout
Process Id Socket Max PortsThe 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'. The default value is 10. no process-id-socket-max-ports
Recovery ListenerUsed to specify if the recovery system should listen on a network socket or not. The default value is false. no recovery-listener
Status Socket BindingUsed to reference the correct socket binding to use for the transaction status manager. no status-socket-binding
Node IdentifierUsed to set the node identifier on the core environment. The default value is 1. no node-identifier
Enable Tsm StatusWhether the transaction status manager (TSM) service, needed for out of process recovery, should be provided or not. The default value is false. no enable-tsm-status
Object Store Relative ToReferences a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the 'path' attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the 'path' attribute to be treated as an absolute path. The default value is jboss.server.data.dir. no object-store-relative-to
Enable StatisticsWhether statistics should be enabled. The default value is false. no enable-statistics

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.10.1. EAP7 - Log Store (Standalone) Service
Overview
Table 3.2291. Overview
Description:Representation of the transaction logging storage mechanism.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2292. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2293. 
NameDescriptionRequiredInternal Name
TypeSpecifies the implementation type of the logging store. no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2294. Metrics
NameDescription
ProbeScan for new transaction logs. This operation will creates a child for each pending transaction.
Package Types
none
3.4.1.10.1.1. EAP7 - Transactions (Standalone) Service
Overview
Table 3.2295. Overview
Description:The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2296. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2297. 
NameDescriptionRequiredInternal Name
Age In SecondsThe time since this transaction was prepared or when the recovery system last tried to recover it. no age-in-seconds
IdThe id of this transaction. no id
Jmx NameThe JMX name of this transaction. no jmx-name
TypeThe type name under which this record is stored. no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2298. Metrics
NameDescription
DeleteRemove this transaction log. WARNING after this operation the transaction manager will have no knowledge of the transaction and will therefore never be able to recover it. If you are sure that the transaction is complete then the operation is safe. The representation of the transaction log is removed from the model too.
Package Types
none
3.4.1.10.1.1.1. EAP7 - Participants (Standalone) Service
Overview
Table 3.2299. Overview
Description:The resources that did work in a transaction.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2300. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2301. 
NameDescriptionRequiredInternal Name
Eis Product NameThe JCA enterprise information system's product name. no eis-product-name
Eis Product VersionThe JCA enterprise information system's product version no eis-product-version
Jmx NameThe JMX name of this participant. no jmx-name
Jndi NameJNDI name of this participant. no jndi-name
StatusReports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly). no status
TypeThe type name under which this record is stored. no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2302. Metrics
NameDescription
RecoverIf this record is in a heuristic state then attempt to replay the commit phase of the 2PC transaction.
RefreshRefresh the management view of the attributes of this participant record by querying the transaction log. (Note that the read-resource operaton only reads the model, hence the need for this refresh operation).
Package Types
none

3.4.1.11. EAP7 - Network Interface Service

Overview
Table 3.2303. Overview
Description:A named network interface, along with required criteria for determining the IP address to associate with that interface
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2304. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2305. 
NameDescriptionRequiredInternal Name
Any AddressAttribute indicating that sockets using this interface should be bound to a wildcard address. The IPv6 wildcard address (::) will be used unless the java.net.preferIpV4Stack system property is set to true, in which case the IPv4 wildcard address (0.0.0.0) will be used. If a socket is bound to an IPv6 anylocal address on a dual-stack machine, it can accept both IPv6 and IPv4 traffic; if it is bound to an IPv4 (IPv4-mapped) anylocal address, it can only accept IPv4 traffic. no any-address
Link Local AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no link-local-address
LoopbackAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no loopback
Loopback AddressAttribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no loopback-address
MulticastAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no multicast
NicAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection. no nic
Nic MatchAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection. no nic-match
Point To PointAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no point-to-point
Public AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no public-address
Site Local AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no site-local-address
Subnet MatchAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in 'slash notation'; e.g. '192.168.0.0/16'. An 'undefined' value means this attribute is not relevant to the IP address selection. no subnet-match
UpAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no up
VirtualAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no virtual
Inet AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either a IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection. no inet-address

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.12. EAP7 - SocketBindingGroup Service

Overview
Table 3.2306. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2307. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2308. 
NameDescriptionRequiredInternal Name
Bindings  yes *
Bindings  yes *1
Bindings  yes *2
Default InterfaceDefault Interface for these bindings. See Network Interfaces for its definition yes default-interface
Port OffsetOffset from standard ports for this group. This is only available in standalone mode no port-offset

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.13. EAP7 - Deployment Service

Overview
Table 3.2309. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2310. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2311. Metrics
NameTypeDescriptionInternal Name
StatustraitThe current runtime status of a deployment. Possible status modes are OK, FAILED, and STOPPED. FAILED indicates a dependency is missing or a service could not start. STOPPED indicates that the deployment was manually stopped.status

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2312. 
NameDescriptionRequiredInternal Name
ContentList of pieces of content that comprise the deployment. yes content
EnabledBoolean indicating whether the deployment content is currently deployed in the runtime (or should be deployed in the runtime the next time the server starts.) no enabled
NameUnique identifier of the deployment. Must be unique across all deployments. no name
PersistentBoolean indicating whether the existence of the deployment should be recorded in the persistent server configuration. Only relevant to a standalone mode server. Default is 'true'. A deployment managed by a deployment scanner would have this set to 'false' to ensure the deployment is only deployed at server start if the scanner again detects the deployment. no persistent
Runtime NameName by which the deployment should be known within a server runtime. This would be equivalent to the file name of a deployment file, and would form the basis for such things as default Java Enterprise Edition application and module names. This would typically be the same as 'name', but in some cases users may wish to have two deployments with the same runtime-name (e.g. two versions of foo.war) both available in the deployment content repository, in which case the deployments would need to have distinct name; values but would have the same runtime-name. no runtime-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2313. Metrics
NameDescription
Enable 
Disable 
Restart 
Package Types
Table 3.2314. Package Types
NameCategoryDescription
FileDeployableDeployments on this server group
3.4.1.13.1. EAP7 - EJB3 Runtime Service
Overview
Table 3.2315. Overview
Description:Runtime resources exposed by EJBs components included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2316. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.1.1. EAP7 - Message Driven Bean Runtime Service
Overview
Table 3.2317. Overview
Description:Bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2318. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2319. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2320. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.1.2. EAP7 - Singleton Bean Runtime Service
Overview
Table 3.2321. Overview
Description:Singleton bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2322. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2323. Metrics
NameTypeDescriptionInternal Name
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2324. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.1.3. EAP7 - Stateless Session Bean Runtime Service
Overview
Table 3.2325. Overview
Description:Stateless session bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2326. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2327. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2328. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.1.4. EAP7 - Entity Bean Runtime Service
Overview
Table 3.2329. Overview
Description:Entity bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2330. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2331. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2332. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.1.5. EAP7 - Stateful Session Bean Runtime Service
Overview
Table 3.2333. Overview
Description:Stateful session bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2334. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2335. Metrics
NameTypeDescriptionInternal Name
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2336. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.2. EAP7 - Subdeployment Service
Overview
Table 3.2337. Overview
Description:Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear.
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2338. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.1. EAP7 - EJB3 Runtime Service
Overview
Table 3.2339. Overview
Description:Runtime resources exposed by EJBs components included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2340. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.1.1. EAP7 - Message Driven Bean Runtime Service
Overview
Table 3.2341. Overview
Description:Bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2342. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2343. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2344. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.2.1.2. EAP7 - Singleton Bean Runtime Service
Overview
Table 3.2345. Overview
Description:Singleton bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2346. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2347. Metrics
NameTypeDescriptionInternal Name
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2348. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.2.1.3. EAP7 - Stateless Session Bean Runtime Service
Overview
Table 3.2349. Overview
Description:Stateless session bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2350. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2351. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2352. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.2.1.4. EAP7 - Entity Bean Runtime Service
Overview
Table 3.2353. Overview
Description:Entity bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2354. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2355. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2356. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.2.1.5. EAP7 - Stateful Session Bean Runtime Service
Overview
Table 3.2357. Overview
Description:Stateful session bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2358. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2359. Metrics
NameTypeDescriptionInternal Name
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2360. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.2.2. EAP7 - Resource Adapters Runtime Service
Overview
Table 3.2361. Overview
Description:Configuration of the resource adapters subsystem.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2362. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.2.1. EAP7 - Connection Definition Runtime Service
Overview
Table 3.2363. Overview
Description:Specifies the connection definitions.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2364. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2365. Metrics
NameTypeDescriptionInternal Name
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.3. EAP7 - Web Runtime Service
Overview
Table 3.2366. Overview
Description:Runtime resources exposed by web components in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2367. 
NameDescriptionRequiredInternal Name
Response Time Log Filethe full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludesa space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transformsa space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2368. Metrics
NameTypeDescriptionInternal Name
Virtual Hosttraitthe virtual host this webapp is deployed tovirtual-host
Context Roottraitthe context root of this webappcontext-root
ServertraitThe name of server this application belongs toserver
Response Timecalltimethe minimum, maximum, and average response times for requests serviced by this webappresponseTime
Currently Active SessionsmeasurementThe number of sessions that are currently activeactive-sessions
Expired SessionsmeasurementThe number of expired sessionsexpired-sessions
Expired Sessions per MinutemeasurementThe number of expired sessionsexpired-sessions
Maximum Active SessionsmeasurementThe maximum number of sessions that have been activemax-active-sessions
Rejected SessionsmeasurementThe number of sessions rejectedrejected-sessions
Rejected Sessions per MinutemeasurementThe number of sessions rejectedrejected-sessions
Average Session Alive TimemeasurementThe average alive time of sessionssession-avg-alive-time
Max Session Alive TimemeasurementThe maximum alive time of sessionssession-max-alive-time
Created SessionsmeasurementThe number of sessions createdsessions-created
Created Sessions per MinutemeasurementThe number of sessions createdsessions-created

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.4. EAP7 - JPA Runtime Service
Overview
Table 3.2369. Overview
Description:The configuration of the JPA subsystem.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2370. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.4.1. EAP7 - Hibernate Persistence Unit Service
Overview
Table 3.2371. Overview
Description:Runtime information about JPA use in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2372. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2373. Metrics
NameTypeDescriptionInternal Name
Close Statement CountmeasurementNumber of released prepared statements.close-statement-count
Close Statement Count per MinutemeasurementNumber of released prepared statements.close-statement-count
Collection Fetch CountmeasurementNumber of collections fetched.collection-fetch-count
Collection Fetch Count per MinutemeasurementNumber of collections fetched.collection-fetch-count
Collection Load CountmeasurementNumber of collections loaded.collection-load-count
Collection Load Count per MinutemeasurementNumber of collections loaded.collection-load-count
Collection Recreated CountmeasurementNumber of collections recreated.collection-recreated-count
Collection Recreated Count per MinutemeasurementNumber of collections recreated.collection-recreated-count
Collection Remove CountmeasurementNumber of collections removed.collection-remove-count
Collection Remove Count per MinutemeasurementNumber of collections removed.collection-remove-count
Collection Update CountmeasurementNumber of collections updated.collection-update-count
Collection Update Count per MinutemeasurementNumber of collections updated.collection-update-count
Completed Transaction CountmeasurementNumber of completed transactions.completed-transaction-count
Completed Transaction Count per MinutemeasurementNumber of completed transactions.completed-transaction-count
Connect CountmeasurementGet the number of connections asked for by the sessions.connect-count
Connect Count per MinutemeasurementGet the number of connections asked for by the sessions.connect-count
Entity Delete CountmeasurementGet number of entity deletes.entity-delete-count
Entity Delete Count per MinutemeasurementGet number of entity deletes.entity-delete-count
Entity Fetch CountmeasurementGet number of entity fetches.entity-fetch-count
Entity Fetch Count per MinutemeasurementGet number of entity fetches.entity-fetch-count
Entity Insert CountmeasurementGet number of entity inserts.entity-insert-count
Entity Insert Count per MinutemeasurementGet number of entity inserts.entity-insert-count
Entity Load CountmeasurementGet number of entity loads.entity-load-count
Entity Load Count per MinutemeasurementGet number of entity loads.entity-load-count
Entity Update CountmeasurementGet number of entity updates.entity-update-count
Entity Update Count per MinutemeasurementGet number of entity updates.entity-update-count
Flush CountmeasurementGet the number of flushes executed by sessions (either implicit or explicit).flush-count
Flush Count per MinutemeasurementGet the number of flushes executed by sessions (either implicit or explicit).flush-count
Optimistic Failure CountmeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Optimistic Failure Count per MinutemeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Prepared Statement CountmeasurementNumber of acquired prepared statements.prepared-statement-count
Prepared Statement Count per MinutemeasurementNumber of acquired prepared statements.prepared-statement-count
Query Cache Hit CountmeasurementGet the number of cached queries successfully retrieved from cache.query-cache-hit-count
Query Cache Hit Count per MinutemeasurementGet the number of cached queries successfully retrieved from cache.query-cache-hit-count
Query Cache Miss CountmeasurementGet the number of cached queries not found in cache.query-cache-miss-count
Query Cache Miss Count per MinutemeasurementGet the number of cached queries not found in cache.query-cache-miss-count
Query Cache Put CountmeasurementGet the number of cacheable queries put in cache.query-cache-put-count
Query Cache Put Count per MinutemeasurementGet the number of cacheable queries put in cache.query-cache-put-count
Query Execution CountmeasurementGet number of executed queries.query-execution-count
Query Execution Count per MinutemeasurementGet number of executed queries.query-execution-count
Query Execution Max TimemeasurementGet the time in milliseconds of the slowest query.query-execution-max-time
Query Execution Max Time Query StringtraitGet the query string for the slowest query.query-execution-max-time-query-string
Second Level Cache Hit CountmeasurementNumber of cacheable entities/collections successfully retrieved from the cache.second-level-cache-hit-count
Second Level Cache Hit Count per MinutemeasurementNumber of cacheable entities/collections successfully retrieved from the cache.second-level-cache-hit-count
Second Level Cache Miss CountmeasurementNumber of cacheable entities/collections not found in the cache and loaded.second-level-cache-miss-count
Second Level Cache Miss Count per MinutemeasurementNumber of cacheable entities/collections not found in the cache and loaded.second-level-cache-miss-count
Second Level Cache Put CountmeasurementNumber of cacheable entities/collections put in the cache.second-level-cache-put-count
Second Level Cache Put Count per MinutemeasurementNumber of cacheable entities/collections put in the cache.second-level-cache-put-count
Session Close CountmeasurementNumber of sessions closed.session-close-count
Session Close Count per MinutemeasurementNumber of sessions closed.session-close-count
Session Open CountmeasurementNumber of sessions opened.session-open-count
Session Open Count per MinutemeasurementNumber of sessions opened.session-open-count
Successful Transaction CountmeasurementNumber of successful transactions.successful-transaction-count
Successful Transaction Count per MinutemeasurementNumber of successful transactions.successful-transaction-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2374. 
NameDescriptionRequiredInternal Name
EnabledDetermine if statistics are enabled. no enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2375. Metrics
NameDescription
Subsystem:clearClear statistics.
Subsystem:evict AllEvict all entities from second level cache.
Subsystem:summaryLog the statistics.
View QueriesView statistical information about queries executed by Hibernate
Package Types
none
3.4.1.13.2.4.1.1. EAP7 - Entity Cache Service
Overview
Table 3.2376. Overview
Description:Statistics for a Hibernate Second Level Cache region.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2377. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2378. Metrics
NameTypeDescriptionInternal Name
Element Count In MemorymeasurementNumber of cacheable entities/collections currently stored in memory.element-count-in-memory
Hit CountmeasurementNumber of cacheable entities/collections successfully retrieved from the cache.hit-count
Miss CountmeasurementNumber of cacheable entities/collections not found in the cache and loaded.miss-count
Put CountmeasurementNumber of cacheable entities/collections put in the cache.put-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.4.1.2. EAP7 - Entity Service
Overview
Table 3.2379. Overview
Description:Statistics for individual entities.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2380. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2381. Metrics
NameTypeDescriptionInternal Name
Entity Delete CountmeasurementGet number of entity deletes.entity-delete-count
Entity Delete Count per MinutemeasurementGet number of entity deletes.entity-delete-count
Entity Fetch CountmeasurementGet number of entity fetches.entity-fetch-count
Entity Fetch Count per MinutemeasurementGet number of entity fetches.entity-fetch-count
Entity Insert CountmeasurementGet number of entity inserts.entity-insert-count
Entity Insert Count per MinutemeasurementGet number of entity inserts.entity-insert-count
Entity Load CountmeasurementGet number of entity loads.entity-load-count
Entity Load Count per MinutemeasurementGet number of entity loads.entity-load-count
Entity Update CountmeasurementGet number of entity updates.entity-update-count
Entity Update Count per MinutemeasurementGet number of entity updates.entity-update-count
Optimistic Failure CountmeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Optimistic Failure Count per MinutemeasurementNumber of optimistic lock exceptions.optimistic-failure-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.4.1.3. EAP7 - Collection Service
Overview
Table 3.2382. Overview
Description:Statistics for individual collections.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2383. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2384. Metrics
NameTypeDescriptionInternal Name
Collection Fetch CountmeasurementNumber of times collection was fetched.collection-fetch-count
Collection Fetch Count per MinutemeasurementNumber of times collection was fetched.collection-fetch-count
Collection Load CountmeasurementNumber of times collection was loaded.collection-load-count
Collection Load Count per MinutemeasurementNumber of times collection was loaded.collection-load-count
Collection Recreated CountmeasurementNumber of times collection was recreated.collection-recreated-count
Collection Recreated Count per MinutemeasurementNumber of times collection was recreated.collection-recreated-count
Collection Remove CountmeasurementNumber of times collection was removed.collection-remove-count
Collection Remove Count per MinutemeasurementNumber of times collection was removed.collection-remove-count
Collection Update CountmeasurementNumber of times collection was updated.collection-update-count
Collection Update Count per MinutemeasurementNumber of times collection was updated.collection-update-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.5. EAP7 - Messaging Runtime Service
Overview
Table 3.2385. Overview
Description:Runtime resources exposed by messaging resources included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2386. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.5.1. EAP7 - ActiveMQ Artemis Server Runtime Service
Overview
Table 3.2387. Overview
Description:A ActiveMQ Artemis server instance.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2388. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.5.1.1. EAP7 - JMS Queue Runtime Service
Overview
Table 3.2389. Overview
Description:Defines a JMS queue.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2390. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2391. Metrics
NameTypeDescriptionInternal Name
Consumer CountmeasurementThe number of consumers consuming messages from this queue.consumer-count
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Dead Letter AddresstraitThe address to send dead messages to.dead-letter-address
DurabletraitWhether the queue is durable or not. The default value is true.durable
Expiry AddresstraitThe address to send expired messages to.expiry-address
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
PausedtraitWhether the queue is paused.paused
Queue AddresstraitThe queue address defines what address is used for routing messages.queue-address
Scheduled CountmeasurementThe number of scheduled messages in this queue.scheduled-count
SelectortraitThe queue selector.selector
TemporarytraitWhether the queue is temporary.temporary

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2392. 
NameDescriptionRequiredInternal Name
EntriesThe jndi names the queue will be bound to. no entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2393. Metrics
NameDescription
Change Message PriorityChange the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages PriorityChange the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count MessagesReturns the number of the messages in the queue matching the given filter.
Expire MessageExpire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire MessagesExpire the messages matching the given filter.
List Consumers as JSONA string in JSON format.
Subsystem:list Delivering MessagesList the messages are currently being delivered.
Subsystem:list Delivering Messages As JsonList the messages are currently being delivered as a string in JSON format
List Message Counter as HTMLList the message counter as a string in HTML format.
List Message Counter as JSONList the message counter as a string in JSON format.
List Message Counter History as HTMLList the message counter history.
List Message Counter History as JSONList the message counter history as a string in JSON format.
List MessagesList all messages in the queue that match the filter
List Messages as JSONList all messages in the queue that match the filter and return them as a string in JSON format.
Move MessageMove the message corresponding to the given message-id to another queue
Move MessagesMove the messages corresponding to the given filter to another queue.
PausePause the queue.
Remove MessageRemove the message corresponding to the given message-id.
Remove MessagesRemove messages matching the given filter from the destination.
Reset Message CounterReset the message counters.
ResumeResume the queue.
Send Message to Dead Letter AddressSend the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter AddressSend the messages corresponding to the given filter to this queue's Dead Letter Address.
Package Types
none
3.4.1.13.2.5.1.2. EAP7 - JMS Topic Runtime Service
Overview
Table 3.2394. Overview
Description:Defines a JMS queue.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2395. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2396. Metrics
NameTypeDescriptionInternal Name
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Durable Message CountmeasurementThe number of messages for all durable subscribers for this topic.durable-message-count
Durable Subscription CountmeasurementThe number of durable subscribers for this topic.durable-subscription-count
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
Non Durable Message CountmeasurementThe number of messages for all non-durable subscribers for this topic.non-durable-message-count
Non Durable Subscription CountmeasurementThe number of non-durable subscribers for this topic.non-durable-subscription-count
Subscription CountmeasurementThe number of (durable and non-durable) subscribers for this topic.subscription-count
TemporarytraitWhether the topic is temporary.temporary
Topic AddresstraitThe address the topic points to.topic-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2397. 
NameDescriptionRequiredInternal Name
JNDI NamesThe jndi names the queue will be bound to. no entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2398. Metrics
NameDescription
Count Messages for SubscriptionCount the number of messages matching the filter for the given subscription.
Drop All SubscriptionsDrop all subscriptions from this topic.
Drop Durable SubscriptionDrop a durable subscription
List All SubscriptionsList all subscriptions.
List All Subscriptions as JSONList all subscriptions as a string in JSON format.
List Durable SubscriptionsList only the durable subscriptions.
List Durable Subscriptions as JSONList only the durable subscriptions, as a string in JSON format.
List Messages for SubscriptionList all the messages for the given subscription.
List Messages for Subscription as JSONList all the messages for the given subscription as a string in JSON format.
List Non-Durable SubscriptionsList only the non-durable subscriptions.
List Non-Durable Subscriptions as JSONList only the non-durable subscriptions, as a string in JSON format.
Remove MessagesRemove messages matching the given filter from the destination.
Package Types
none
3.4.1.13.2.5.1.3. EAP7 - Pooled Connection Factory Runtime Service
Overview
Table 3.2399. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2400. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2401. 
NameDescriptionRequiredInternal Name
Auto GroupThe autogroup. The default value is false. no auto-group
Block On AcknowledgeTrue to set block on acknowledge. The default value is false. no block-on-acknowledge
Block On Durable SendTrue to set block on durable send. The default value is true. no block-on-durable-send
Block On Non Durable SendTrue to set block on non durable send. The default value is false. no block-on-non-durable-send
Cache Large Message ClientTrue to cache large messages. The default value is false. no cache-large-message-client
Call Failover Timeout:exprThe timeout to use when fail over is in process (in ms). The default value is -1. no call-failover-timeout:expr
Call Timeout:exprThe call time out. The default value is 30000. no call-timeout:expr
Client Failure Check Period:exprThe client failure check period. The default value is 30000. no client-failure-check-period:expr
Client IdThe client id. no client-id
Compress Large MessagesWhether large messages should be compressed. The default value is false. no compress-large-messages
Confirmation Window Size:exprThe confirmation window size. The default value is -1. no confirmation-window-size:expr
Connection Load Balancing Policy Class NameName of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. no connection-load-balancing-policy-class-name
Connection Ttl:exprThe connection ttl. The default value is 60000. no connection-ttl:expr
ConnectorsDefines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. no connectors
Consumer Max Rate:exprThe consumer max rate. The default value is -1. no consumer-max-rate:expr
Consumer Window Size:exprThe consumer window size. The default value is 1048576. no consumer-window-size:expr
Discovery GroupThe discovery group name. no discovery-group
Dups Ok Batch Size:exprThe dups ok batch size. The default value is 1048576. no dups-ok-batch-size:expr
Enlistment TraceEnables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property. no enlistment-trace
EntriesThe jndi names the connection factory should be bound to. yes entries
Failover On Initial ConnectionTrue to fail over on initial connection. The default value is false. no failover-on-initial-connection
Group IdThe group id. no group-id
HaWhether the connection factory supports High Availability. The default value is false. no ha
Initial Connect Attempts:exprThe number of attempts to connect initially with this factory. The default value is 1. no initial-connect-attempts:expr
Initial Message Packet Size:exprThe initial size of messages created through this factory. The default value is 1500. no initial-message-packet-size:expr
Jndi ParamsThe JNDI params to use for locating the destination for incoming connections. no jndi-params
Managed Connection PoolThe class name of the managed connection pool used by this pooled-connection-factory. no managed-connection-pool
Max Pool Size:exprThe maximum size for the pool. The default value is -1. no max-pool-size:expr
Max Retry Interval:exprThe max retry interval. The default value is 2000. no max-retry-interval:expr
Min Large Message Size:exprThe min large message size. The default value is 102400. no min-large-message-size:expr
Min Pool Size:exprThe minimum size for the pool. The default value is -1. no min-pool-size:expr
PasswordThe default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host. no password
Pre AcknowledgeTrue to pre-acknowledge. The default value is false. no pre-acknowledge
Producer Max Rate:exprThe producer max rate. The default value is -1. no producer-max-rate:expr
Producer Window Size:exprThe producer window size. The default value is 65536. no producer-window-size:expr
Protocol Manager FactoryThe protocol manager factory used by this pooled connection factory. no protocol-manager-factory
Reconnect Attempts:exprThe reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s). The default value is -1. no reconnect-attempts:expr
Retry Interval:exprThe retry interval. The default value is 2000. no retry-interval:expr
Retry Interval Multiplier:exprThe retry interval multiplier. The default value is 1.0. no retry-interval-multiplier:expr
Scheduled Thread Pool Max Size:exprThe scheduled thread pool max size. The default value is 5. no scheduled-thread-pool-max-size:expr
Setup Attempts:exprThe number of times to set up an MDB endpoint no setup-attempts:expr
Setup Interval:exprThe interval between attempts at setting up an MDB endpoint. no setup-interval:expr
Thread Pool Max Size:exprThe thread pool max size. The default value is 30. no thread-pool-max-size:expr
TransactionTODO. The default value is transaction. no transaction
Transaction Batch Size:exprThe transaction batch size. The default value is 1048576. no transaction-batch-size:expr
Use Auto RecoveryTrue to use auto recovery. The default value is true. no use-auto-recovery
Use Global PoolsTrue to use global pools. The default value is true. no use-global-pools
Use JndiUse JNDI to locate the destination for incoming connections no use-jndi
Use Local TxUse a local transaction for incoming sessions no use-local-tx
UserThe default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host. no user

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.2.6. EAP7 - Datasources Runtime Service
Overview
Table 3.2402. Overview
Description:Runtime resources exposed by data sources included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2403. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.6.1. EAP7 - XA Datasource Runtime Service
Overview
Table 3.2404. Overview
Description:A JDBC XA data-source configuration
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2405. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2406. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2407. 
NameDescriptionRequiredInternal Name
Properties  no *2
Xa Datasource ClassThe fully qualified name of the javax.sql.XADataSource implementation yes xa-datasource-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
Driver NameDefines 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 yes driver-name
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. no pool-use-strict-min
InterleavingAn element to enable interleaving for XA connection factories no interleaving
No Tx Separate PoolOracle 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 context no no-tx-separate-pool
Pad XidShould the Xid be padded no pad-xid
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Wrap Xa DatasourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance no wrap-xa-datasource
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Recovery Plugin Class Namerecovery plugin implementation provided for specific purpose (i.e vendor) no recovery-plugin-class-name
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait Millishe allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Xa Resource TimeoutPassed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds no xa-resource-timeout
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm
Recovery Usernameusername used to try connection recovery no recovery-username
Recovery Passwordpassword used to try connection recovery no recovery-password
Recovery Security Domainsecurity-domain used to try connection recovery no recovery-security-domain
No Recoveryif true no recovery are tried for this connection pool no no-recovery

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2408. Metrics
NameDescription
Subsystem:flush All Connection In PoolFlushes all connections in the pool
Subsystem:flush Idle Connection In PoolFlushes all idle connections in the pool
Subsystem:test Connection In PoolTest if a connection can be obtained
Package Types
none
3.4.1.13.2.6.2. EAP7 - Datasource Runtime Service
Overview
Table 3.2409. Overview
Description:A JDBC data-source configuration
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2410. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2411. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2412. 
NameDescriptionRequiredInternal Name
Connection Property  no *1
Connection UrlThe JDBC driver connection URL yes connection-url
Driver NameName of the (existing) JDBC driver to use yes driver-name
Driver ClassThe fully qualified name of the JDBC driver class no driver-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
DriverDefines the JDBC driver the datasource should use with this format: driver-name>#major-version.minor-version where driver-name is the fully qualified name of the JDBC driver class no driver
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. no pool-use-strict-min
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait MillisIndicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2413. Metrics
NameDescription
Subsystem:flush All Connection In PoolFlushes all connections in the pool
Subsystem:flush Idle Connection In PoolFlushes all idle connections in the pool
Subsystem:test Connection In PoolTest if a connection can be obtained
Package Types
none
3.4.1.13.2.7. EAP7 - Webservices Runtime Service
Overview
Table 3.2414. Overview
Description:Runtime resources exposed by web service components in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2415. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.2.7.1. EAP7 - Endpoint Runtime Service
Overview
Table 3.2416. Overview
Description:Webservice endpoint.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2417. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2418. Metrics
NameTypeDescriptionInternal Name
Average Processing TimemeasurementAverage endpoint processing time.average-processing-time
Fault CountmeasurementCount of faults the endpoint generated.fault-count
Max Processing TimemeasurementMaximal endpoint processing time.max-processing-time
Min Processing TimemeasurementMinimal endpoint processing time.min-processing-time
Request CountmeasurementCount of requests the endpoint processed.request-count
Response CountmeasurementCount of responses the endpoint generated.response-count
Total Processing TimemeasurementTotal endpoint processing time.total-processing-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2419. 
NameDescriptionRequiredInternal Name
ClassWebservice endpoint class. no class
ContextWebservice endpoint context. no context
NameWebservice endpoint name. no name
TypeWebservice endpoint type. no type
Wsdl UrlWebservice endpoint WSDL URL. no wsdl-url

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.3. EAP7 - Resource Adapters Runtime Service
Overview
Table 3.2420. Overview
Description:Configuration of the resource adapters subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2421. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.3.1. EAP7 - Connection Definition Runtime Service
Overview
Table 3.2422. Overview
Description:Specifies the connection definitions.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2423. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2424. Metrics
NameTypeDescriptionInternal Name
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.4. EAP7 - Web Runtime Service
Overview
Table 3.2425. Overview
Description:Runtime resources exposed by web components in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2426. 
NameDescriptionRequiredInternal Name
Response Time Log Filethe full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludesa space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transformsa space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2427. Metrics
NameTypeDescriptionInternal Name
Virtual Hosttraitthe virtual host this webapp is deployed tovirtual-host
Context Roottraitthe context root of this webappcontext-root
ServertraitThe name of server this application belongs toserver
Response Timecalltimethe minimum, maximum, and average response times for requests serviced by this webappresponseTime
Currently Active SessionsmeasurementThe number of sessions that are currently activeactive-sessions
Expired SessionsmeasurementThe number of expired sessionsexpired-sessions
Expired Sessions per MinutemeasurementThe number of expired sessionsexpired-sessions
Maximum Active SessionsmeasurementThe maximum number of sessions that have been activemax-active-sessions
Rejected SessionsmeasurementThe number of sessions rejectedrejected-sessions
Rejected Sessions per MinutemeasurementThe number of sessions rejectedrejected-sessions
Average Session Alive TimemeasurementThe average alive time of sessionssession-avg-alive-time
Max Session Alive TimemeasurementThe maximum alive time of sessionssession-max-alive-time
Created SessionsmeasurementThe number of sessions createdsessions-created
Created Sessions per MinutemeasurementThe number of sessions createdsessions-created

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.5. EAP7 - JPA Runtime Service
Overview
Table 3.2428. Overview
Description:The configuration of the JPA subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2429. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.5.1. EAP7 - Hibernate Persistence Unit Service
Overview
Table 3.2430. Overview
Description:Runtime information about JPA use in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2431. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2432. Metrics
NameTypeDescriptionInternal Name
Close Statement CountmeasurementNumber of released prepared statements.close-statement-count
Close Statement Count per MinutemeasurementNumber of released prepared statements.close-statement-count
Collection Fetch CountmeasurementNumber of collections fetched.collection-fetch-count
Collection Fetch Count per MinutemeasurementNumber of collections fetched.collection-fetch-count
Collection Load CountmeasurementNumber of collections loaded.collection-load-count
Collection Load Count per MinutemeasurementNumber of collections loaded.collection-load-count
Collection Recreated CountmeasurementNumber of collections recreated.collection-recreated-count
Collection Recreated Count per MinutemeasurementNumber of collections recreated.collection-recreated-count
Collection Remove CountmeasurementNumber of collections removed.collection-remove-count
Collection Remove Count per MinutemeasurementNumber of collections removed.collection-remove-count
Collection Update CountmeasurementNumber of collections updated.collection-update-count
Collection Update Count per MinutemeasurementNumber of collections updated.collection-update-count
Completed Transaction CountmeasurementNumber of completed transactions.completed-transaction-count
Completed Transaction Count per MinutemeasurementNumber of completed transactions.completed-transaction-count
Connect CountmeasurementGet the number of connections asked for by the sessions.connect-count
Connect Count per MinutemeasurementGet the number of connections asked for by the sessions.connect-count
Entity Delete CountmeasurementGet number of entity deletes.entity-delete-count
Entity Delete Count per MinutemeasurementGet number of entity deletes.entity-delete-count
Entity Fetch CountmeasurementGet number of entity fetches.entity-fetch-count
Entity Fetch Count per MinutemeasurementGet number of entity fetches.entity-fetch-count
Entity Insert CountmeasurementGet number of entity inserts.entity-insert-count
Entity Insert Count per MinutemeasurementGet number of entity inserts.entity-insert-count
Entity Load CountmeasurementGet number of entity loads.entity-load-count
Entity Load Count per MinutemeasurementGet number of entity loads.entity-load-count
Entity Update CountmeasurementGet number of entity updates.entity-update-count
Entity Update Count per MinutemeasurementGet number of entity updates.entity-update-count
Flush CountmeasurementGet the number of flushes executed by sessions (either implicit or explicit).flush-count
Flush Count per MinutemeasurementGet the number of flushes executed by sessions (either implicit or explicit).flush-count
Optimistic Failure CountmeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Optimistic Failure Count per MinutemeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Prepared Statement CountmeasurementNumber of acquired prepared statements.prepared-statement-count
Prepared Statement Count per MinutemeasurementNumber of acquired prepared statements.prepared-statement-count
Query Cache Hit CountmeasurementGet the number of cached queries successfully retrieved from cache.query-cache-hit-count
Query Cache Hit Count per MinutemeasurementGet the number of cached queries successfully retrieved from cache.query-cache-hit-count
Query Cache Miss CountmeasurementGet the number of cached queries not found in cache.query-cache-miss-count
Query Cache Miss Count per MinutemeasurementGet the number of cached queries not found in cache.query-cache-miss-count
Query Cache Put CountmeasurementGet the number of cacheable queries put in cache.query-cache-put-count
Query Cache Put Count per MinutemeasurementGet the number of cacheable queries put in cache.query-cache-put-count
Query Execution CountmeasurementGet number of executed queries.query-execution-count
Query Execution Count per MinutemeasurementGet number of executed queries.query-execution-count
Query Execution Max TimemeasurementGet the time in milliseconds of the slowest query.query-execution-max-time
Query Execution Max Time Query StringtraitGet the query string for the slowest query.query-execution-max-time-query-string
Second Level Cache Hit CountmeasurementNumber of cacheable entities/collections successfully retrieved from the cache.second-level-cache-hit-count
Second Level Cache Hit Count per MinutemeasurementNumber of cacheable entities/collections successfully retrieved from the cache.second-level-cache-hit-count
Second Level Cache Miss CountmeasurementNumber of cacheable entities/collections not found in the cache and loaded.second-level-cache-miss-count
Second Level Cache Miss Count per MinutemeasurementNumber of cacheable entities/collections not found in the cache and loaded.second-level-cache-miss-count
Second Level Cache Put CountmeasurementNumber of cacheable entities/collections put in the cache.second-level-cache-put-count
Second Level Cache Put Count per MinutemeasurementNumber of cacheable entities/collections put in the cache.second-level-cache-put-count
Session Close CountmeasurementNumber of sessions closed.session-close-count
Session Close Count per MinutemeasurementNumber of sessions closed.session-close-count
Session Open CountmeasurementNumber of sessions opened.session-open-count
Session Open Count per MinutemeasurementNumber of sessions opened.session-open-count
Successful Transaction CountmeasurementNumber of successful transactions.successful-transaction-count
Successful Transaction Count per MinutemeasurementNumber of successful transactions.successful-transaction-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2433. 
NameDescriptionRequiredInternal Name
EnabledDetermine if statistics are enabled. no enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2434. Metrics
NameDescription
Subsystem:clearClear statistics.
Subsystem:evict AllEvict all entities from second level cache.
Subsystem:summaryLog the statistics.
View QueriesView statistical information about queries executed by Hibernate
Package Types
none
3.4.1.13.5.1.1. EAP7 - Entity Cache Service
Overview
Table 3.2435. Overview
Description:Statistics for a Hibernate Second Level Cache region.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2436. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2437. Metrics
NameTypeDescriptionInternal Name
Element Count In MemorymeasurementNumber of cacheable entities/collections currently stored in memory.element-count-in-memory
Hit CountmeasurementNumber of cacheable entities/collections successfully retrieved from the cache.hit-count
Miss CountmeasurementNumber of cacheable entities/collections not found in the cache and loaded.miss-count
Put CountmeasurementNumber of cacheable entities/collections put in the cache.put-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.5.1.2. EAP7 - Entity Service
Overview
Table 3.2438. Overview
Description:Statistics for individual entities.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2439. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2440. Metrics
NameTypeDescriptionInternal Name
Entity Delete CountmeasurementGet number of entity deletes.entity-delete-count
Entity Delete Count per MinutemeasurementGet number of entity deletes.entity-delete-count
Entity Fetch CountmeasurementGet number of entity fetches.entity-fetch-count
Entity Fetch Count per MinutemeasurementGet number of entity fetches.entity-fetch-count
Entity Insert CountmeasurementGet number of entity inserts.entity-insert-count
Entity Insert Count per MinutemeasurementGet number of entity inserts.entity-insert-count
Entity Load CountmeasurementGet number of entity loads.entity-load-count
Entity Load Count per MinutemeasurementGet number of entity loads.entity-load-count
Entity Update CountmeasurementGet number of entity updates.entity-update-count
Entity Update Count per MinutemeasurementGet number of entity updates.entity-update-count
Optimistic Failure CountmeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Optimistic Failure Count per MinutemeasurementNumber of optimistic lock exceptions.optimistic-failure-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.5.1.3. EAP7 - Collection Service
Overview
Table 3.2441. Overview
Description:Statistics for individual collections.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2442. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2443. Metrics
NameTypeDescriptionInternal Name
Collection Fetch CountmeasurementNumber of times collection was fetched.collection-fetch-count
Collection Fetch Count per MinutemeasurementNumber of times collection was fetched.collection-fetch-count
Collection Load CountmeasurementNumber of times collection was loaded.collection-load-count
Collection Load Count per MinutemeasurementNumber of times collection was loaded.collection-load-count
Collection Recreated CountmeasurementNumber of times collection was recreated.collection-recreated-count
Collection Recreated Count per MinutemeasurementNumber of times collection was recreated.collection-recreated-count
Collection Remove CountmeasurementNumber of times collection was removed.collection-remove-count
Collection Remove Count per MinutemeasurementNumber of times collection was removed.collection-remove-count
Collection Update CountmeasurementNumber of times collection was updated.collection-update-count
Collection Update Count per MinutemeasurementNumber of times collection was updated.collection-update-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.6. EAP7 - Messaging Runtime Service
Overview
Table 3.2444. Overview
Description:Runtime resources exposed by messaging resources included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2445. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.6.1. EAP7 - ActiveMQ Artemis Server Runtime Service
Overview
Table 3.2446. Overview
Description:A ActiveMQ Artemis server instance.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2447. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.6.1.1. EAP7 - JMS Queue Runtime Service
Overview
Table 3.2448. Overview
Description:Defines a JMS queue.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2449. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2450. Metrics
NameTypeDescriptionInternal Name
Consumer CountmeasurementThe number of consumers consuming messages from this queue.consumer-count
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Dead Letter AddresstraitThe address to send dead messages to.dead-letter-address
DurabletraitWhether the queue is durable or not. The default value is true.durable
Expiry AddresstraitThe address to send expired messages to.expiry-address
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
PausedtraitWhether the queue is paused.paused
Queue AddresstraitThe queue address defines what address is used for routing messages.queue-address
Scheduled CountmeasurementThe number of scheduled messages in this queue.scheduled-count
SelectortraitThe queue selector.selector
TemporarytraitWhether the queue is temporary.temporary

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2451. 
NameDescriptionRequiredInternal Name
EntriesThe jndi names the queue will be bound to. no entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2452. Metrics
NameDescription
Change Message PriorityChange the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages PriorityChange the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count MessagesReturns the number of the messages in the queue matching the given filter.
Expire MessageExpire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire MessagesExpire the messages matching the given filter.
List Consumers as JSONA string in JSON format.
Subsystem:list Delivering MessagesList the messages are currently being delivered.
Subsystem:list Delivering Messages As JsonList the messages are currently being delivered as a string in JSON format
List Message Counter as HTMLList the message counter as a string in HTML format.
List Message Counter as JSONList the message counter as a string in JSON format.
List Message Counter History as HTMLList the message counter history.
List Message Counter History as JSONList the message counter history as a string in JSON format.
List MessagesList all messages in the queue that match the filter
List Messages as JSONList all messages in the queue that match the filter and return them as a string in JSON format.
Move MessageMove the message corresponding to the given message-id to another queue
Move MessagesMove the messages corresponding to the given filter to another queue.
PausePause the queue.
Remove MessageRemove the message corresponding to the given message-id.
Remove MessagesRemove messages matching the given filter from the destination.
Reset Message CounterReset the message counters.
ResumeResume the queue.
Send Message to Dead Letter AddressSend the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter AddressSend the messages corresponding to the given filter to this queue's Dead Letter Address.
Package Types
none
3.4.1.13.6.1.2. EAP7 - JMS Topic Runtime Service
Overview
Table 3.2453. Overview
Description:Defines a JMS queue.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2454. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2455. Metrics
NameTypeDescriptionInternal Name
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Durable Message CountmeasurementThe number of messages for all durable subscribers for this topic.durable-message-count
Durable Subscription CountmeasurementThe number of durable subscribers for this topic.durable-subscription-count
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
Non Durable Message CountmeasurementThe number of messages for all non-durable subscribers for this topic.non-durable-message-count
Non Durable Subscription CountmeasurementThe number of non-durable subscribers for this topic.non-durable-subscription-count
Subscription CountmeasurementThe number of (durable and non-durable) subscribers for this topic.subscription-count
TemporarytraitWhether the topic is temporary.temporary
Topic AddresstraitThe address the topic points to.topic-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2456. 
NameDescriptionRequiredInternal Name
JNDI NamesThe jndi names the queue will be bound to. no entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2457. Metrics
NameDescription
Count Messages for SubscriptionCount the number of messages matching the filter for the given subscription.
Drop All SubscriptionsDrop all subscriptions from this topic.
Drop Durable SubscriptionDrop a durable subscription
List All SubscriptionsList all subscriptions.
List All Subscriptions as JSONList all subscriptions as a string in JSON format.
List Durable SubscriptionsList only the durable subscriptions.
List Durable Subscriptions as JSONList only the durable subscriptions, as a string in JSON format.
List Messages for SubscriptionList all the messages for the given subscription.
List Messages for Subscription as JSONList all the messages for the given subscription as a string in JSON format.
List Non-Durable SubscriptionsList only the non-durable subscriptions.
List Non-Durable Subscriptions as JSONList only the non-durable subscriptions, as a string in JSON format.
Remove MessagesRemove messages matching the given filter from the destination.
Package Types
none
3.4.1.13.6.1.3. EAP7 - Pooled Connection Factory Runtime Service
Overview
Table 3.2458. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2459. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2460. 
NameDescriptionRequiredInternal Name
Auto GroupThe autogroup. The default value is false. no auto-group
Block On AcknowledgeTrue to set block on acknowledge. The default value is false. no block-on-acknowledge
Block On Durable SendTrue to set block on durable send. The default value is true. no block-on-durable-send
Block On Non Durable SendTrue to set block on non durable send. The default value is false. no block-on-non-durable-send
Cache Large Message ClientTrue to cache large messages. The default value is false. no cache-large-message-client
Call Failover Timeout:exprThe timeout to use when fail over is in process (in ms). The default value is -1. no call-failover-timeout:expr
Call Timeout:exprThe call time out. The default value is 30000. no call-timeout:expr
Client Failure Check Period:exprThe client failure check period. The default value is 30000. no client-failure-check-period:expr
Client IdThe client id. no client-id
Compress Large MessagesWhether large messages should be compressed. The default value is false. no compress-large-messages
Confirmation Window Size:exprThe confirmation window size. The default value is -1. no confirmation-window-size:expr
Connection Load Balancing Policy Class NameName of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. no connection-load-balancing-policy-class-name
Connection Ttl:exprThe connection ttl. The default value is 60000. no connection-ttl:expr
ConnectorsDefines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. no connectors
Consumer Max Rate:exprThe consumer max rate. The default value is -1. no consumer-max-rate:expr
Consumer Window Size:exprThe consumer window size. The default value is 1048576. no consumer-window-size:expr
Discovery GroupThe discovery group name. no discovery-group
Dups Ok Batch Size:exprThe dups ok batch size. The default value is 1048576. no dups-ok-batch-size:expr
Enlistment TraceEnables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property. no enlistment-trace
EntriesThe jndi names the connection factory should be bound to. yes entries
Failover On Initial ConnectionTrue to fail over on initial connection. The default value is false. no failover-on-initial-connection
Group IdThe group id. no group-id
HaWhether the connection factory supports High Availability. The default value is false. no ha
Initial Connect Attempts:exprThe number of attempts to connect initially with this factory. The default value is 1. no initial-connect-attempts:expr
Initial Message Packet Size:exprThe initial size of messages created through this factory. The default value is 1500. no initial-message-packet-size:expr
Jndi ParamsThe JNDI params to use for locating the destination for incoming connections. no jndi-params
Managed Connection PoolThe class name of the managed connection pool used by this pooled-connection-factory. no managed-connection-pool
Max Pool Size:exprThe maximum size for the pool. The default value is -1. no max-pool-size:expr
Max Retry Interval:exprThe max retry interval. The default value is 2000. no max-retry-interval:expr
Min Large Message Size:exprThe min large message size. The default value is 102400. no min-large-message-size:expr
Min Pool Size:exprThe minimum size for the pool. The default value is -1. no min-pool-size:expr
PasswordThe default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host. no password
Pre AcknowledgeTrue to pre-acknowledge. The default value is false. no pre-acknowledge
Producer Max Rate:exprThe producer max rate. The default value is -1. no producer-max-rate:expr
Producer Window Size:exprThe producer window size. The default value is 65536. no producer-window-size:expr
Protocol Manager FactoryThe protocol manager factory used by this pooled connection factory. no protocol-manager-factory
Reconnect Attempts:exprThe reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s). The default value is -1. no reconnect-attempts:expr
Retry Interval:exprThe retry interval. The default value is 2000. no retry-interval:expr
Retry Interval Multiplier:exprThe retry interval multiplier. The default value is 1.0. no retry-interval-multiplier:expr
Scheduled Thread Pool Max Size:exprThe scheduled thread pool max size. The default value is 5. no scheduled-thread-pool-max-size:expr
Setup Attempts:exprThe number of times to set up an MDB endpoint no setup-attempts:expr
Setup Interval:exprThe interval between attempts at setting up an MDB endpoint. no setup-interval:expr
Thread Pool Max Size:exprThe thread pool max size. The default value is 30. no thread-pool-max-size:expr
TransactionTODO. The default value is transaction. no transaction
Transaction Batch Size:exprThe transaction batch size. The default value is 1048576. no transaction-batch-size:expr
Use Auto RecoveryTrue to use auto recovery. The default value is true. no use-auto-recovery
Use Global PoolsTrue to use global pools. The default value is true. no use-global-pools
Use JndiUse JNDI to locate the destination for incoming connections no use-jndi
Use Local TxUse a local transaction for incoming sessions no use-local-tx
UserThe default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host. no user

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.13.7. EAP7 - Datasources Runtime Service
Overview
Table 3.2461. Overview
Description:Runtime resources exposed by data sources included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2462. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.7.1. EAP7 - XA Datasource Runtime Service
Overview
Table 3.2463. Overview
Description:A JDBC XA data-source configuration
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2464. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2465. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2466. 
NameDescriptionRequiredInternal Name
Properties  no *2
Xa Datasource ClassThe fully qualified name of the javax.sql.XADataSource implementation yes xa-datasource-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
Driver NameDefines 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 yes driver-name
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. no pool-use-strict-min
InterleavingAn element to enable interleaving for XA connection factories no interleaving
No Tx Separate PoolOracle 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 context no no-tx-separate-pool
Pad XidShould the Xid be padded no pad-xid
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Wrap Xa DatasourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance no wrap-xa-datasource
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Recovery Plugin Class Namerecovery plugin implementation provided for specific purpose (i.e vendor) no recovery-plugin-class-name
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait Millishe allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Xa Resource TimeoutPassed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds no xa-resource-timeout
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm
Recovery Usernameusername used to try connection recovery no recovery-username
Recovery Passwordpassword used to try connection recovery no recovery-password
Recovery Security Domainsecurity-domain used to try connection recovery no recovery-security-domain
No Recoveryif true no recovery are tried for this connection pool no no-recovery

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2467. Metrics
NameDescription
Subsystem:flush All Connection In PoolFlushes all connections in the pool
Subsystem:flush Idle Connection In PoolFlushes all idle connections in the pool
Subsystem:test Connection In PoolTest if a connection can be obtained
Package Types
none
3.4.1.13.7.2. EAP7 - Datasource Runtime Service
Overview
Table 3.2468. Overview
Description:A JDBC data-source configuration
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2469. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2470. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2471. 
NameDescriptionRequiredInternal Name
Connection Property  no *1
Connection UrlThe JDBC driver connection URL yes connection-url
Driver NameName of the (existing) JDBC driver to use yes driver-name
Driver ClassThe fully qualified name of the JDBC driver class no driver-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
DriverDefines the JDBC driver the datasource should use with this format: driver-name>#major-version.minor-version where driver-name is the fully qualified name of the JDBC driver class no driver
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. no pool-use-strict-min
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait MillisIndicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2472. Metrics
NameDescription
Subsystem:flush All Connection In PoolFlushes all connections in the pool
Subsystem:flush Idle Connection In PoolFlushes all idle connections in the pool
Subsystem:test Connection In PoolTest if a connection can be obtained
Package Types
none
3.4.1.13.8. EAP7 - Webservices Runtime Service
Overview
Table 3.2473. Overview
Description:Runtime resources exposed by web service components in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2474. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.13.8.1. EAP7 - Endpoint Runtime Service
Overview
Table 3.2475. Overview
Description:Webservice endpoint.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2476. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2477. Metrics
NameTypeDescriptionInternal Name
Average Processing TimemeasurementAverage endpoint processing time.average-processing-time
Fault CountmeasurementCount of faults the endpoint generated.fault-count
Max Processing TimemeasurementMaximal endpoint processing time.max-processing-time
Min Processing TimemeasurementMinimal endpoint processing time.min-processing-time
Request CountmeasurementCount of requests the endpoint processed.request-count
Response CountmeasurementCount of responses the endpoint generated.response-count
Total Processing TimemeasurementTotal endpoint processing time.total-processing-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2478. 
NameDescriptionRequiredInternal Name
ClassWebservice endpoint class. no class
ContextWebservice endpoint context. no context
NameWebservice endpoint name. no name
TypeWebservice endpoint type. no type
Wsdl UrlWebservice endpoint WSDL URL. no wsdl-url

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.14. EAP7 - DeploymentScanner Service

Overview
Table 3.2479. Overview
Description:Management of the deployment scanner
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2480. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2481. 
NameDescriptionRequiredInternal Name
ScannersList of scanners yes *

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.15. EAP7 - JacORB Service

Overview
Table 3.2482. Overview
Description:JacORB subsystem configuration
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2483. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2484. 
NameDescriptionRequiredInternal Name
Add Component Via InterceptorIndicates whether SSL components should be added by an IOR interceptor (on) or not (off). The default value is on. no add-component-via-interceptor
Cache Poa NamesIndicates whether POA names should be cached (on) or not (off). The default value is off. no cache-poa-names
Cache TypecodesIndicates whether typecodes should be cached (on) or not (off). The default value is off. no cache-typecodes
Chunk Custom Rmi ValuetypesIndicates whether custom RMI valuetypes should be encoded as chunks (on) or not (off). The default value is on. no chunk-custom-rmi-valuetypes
Client RequiresValue that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no client-requires
Client SupportsValue that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no client-supports
Client TimeoutThe client-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out. The default value is 0. no client-timeout
CometIndicates whether interoperability with Comet's ORB is enabled (on) or not (off). The default value is off. no comet
Export CorbalocIndicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off). The default value is on. no export-corbaloc
Giop Minor VersionThe GIOP minor version to be used. The default value is 2. no giop-minor-version
Indirection Encoding DisableIndicates whether indirection encoding for repeated typecodes should be disabled (on) or not (off). The default value is off. no indirection-encoding-disable
IonaIndicates whether interoperability with IONA's ASP is enabled (on) or not (off). The default value is off. no iona
Lax Boolean EncodingIndicates whether any non-zero CDR encoded boolean value should be interpreted as true (on) or not (off). The default value is off. no lax-boolean-encoding
Max Managed Buf SizeThe log2 of maximum size managed by the internal buffer manager. The default value is 24. no max-managed-buf-size
Max Server ConnectionsThe maximum number of connections accepted by the server. The default value is 2147483647. no max-server-connections
Max ThreadsThe maximum number of active request processor threads. Threads are first obtained from the pool and once the pool is exhausted new threads are created until the number of threads reaches this limit. New requests will wait until an active thread finishes its job. The default value is 32. no max-threads
MonitoringIndicates whether the monitoring GUI should be displayed (on) or not (off). The default value is off. no monitoring
NameThe name of the running ORB. The default value is JBoss. no name
Outbuf Cache TimeoutThe buffer cache timeout in milliseconds. The default value is -1. no outbuf-cache-timeout
Outbuf SizeThe size of the network buffers for outgoing messages. The default value is 2048. no outbuf-size
Pool SizeThe size of the request processors thread-pool. Threads that finish processing a request are placed back in the pool if the pool is not full and discarded otherwise. The default value is 5. no pool-size
Print VersionIndicates whether the version number should be printed during ORB startup (on) or not (off). The default value is off. no print-version
PropertiesA list of generic key/value properties. no properties
Queue MaxThe maximum number of requests that can be queued. The default value is 100. no queue-max
Queue MinThe size of the queue for notifying waiting requests. In other words, blocked requests are only notified when the queue has no more than queue-min requests. The default value is 10. no queue-min
Queue WaitIndicates whether requests that exceed the maximum queue size should wait (on) or not (off). When disabled, a TRANSIENT exception is thrown if the queue is full. The default value is off. no queue-wait
RetriesThe number of retries if connections cannot be promptly established. The default value is 5. no retries
Retry IntervalThe interval in milliseconds between retries. The default value is 500. no retry-interval
Root ContextThe naming service root context. The default value is JBoss/Naming/root. no root-context
SecurityIndicates whether the security interceptors are to be installed (on) or not (off). The default value is off. no security
Security DomainThe name of the security domain that holds the key and trust stores that will be used to establish SSL connections. no security-domain
Server RequiresValue that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no server-requires
Server SupportsValue that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no server-supports
Server TimeoutThe server-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out. The default value is 0. no server-timeout
Strict Check On Tc CreationIndicates whether the method create_abstract_interface_tc should perform a validation check on the name parameter (on) or not (off). The default value is off. no strict-check-on-tc-creation
SunIndicates whether interoperability with Sun's ORB is enabled (on) or not (off). The default value is on. no sun
Support SslIndicates whether SSL is to be supported (on) or not (off). The default value is off. no support-ssl
TransactionsIndicates whether the transactions interceptors are to be installed (on or spec) or not (off). The value 'on' enabled JTS while 'spec' enables a spec compliant mode (non JTS) that rejects incoming transaction contexts. The default value is off. no transactions
Use BomIndicates whether GIOP 1.2 byte order markers should be used (on) or not (off). The default value is off. no use-bom
Use ImrIndicates whether the implementation repository should be used (on) or not (off). The default value is off. no use-imr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.16. EAP7 - JDR Service

Overview
Table 3.2485. Overview
Description:JBoss Diagnostic Reporter (JDR) Subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2486. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.2487. Metrics
NameDescription
Generate JDR ReportRequest the generation of a JDR report.
Package Types
none

3.4.1.17. EAP7 - JCA Service

Overview
Table 3.2488. Overview
Description:The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2489. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2490. 
NameDescriptionRequiredInternal Name
EnabledSpecify whether bean validation is enabled. The default value is true. no enabled:1
EnabledSpecify whether archive validation is enabled. The default value is true. no enabled:2
Fail On ErrorShould an archive validation error report fail the deployment. The default value is true. no fail-on-error
Fail On WarnShould an archive validation warning report fail the deployment. The default value is false. no fail-on-warn
DebugEnable/disable debug information logging. The default value is false. no debug
ErrorEnable/disable error information logging. The default value is false. no error
InstallEnable/disable the cached connection manager valve and interceptor. The default value is false. no install

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.17.1. EAP7 - BootstrapContext Service
Overview
Table 3.2491. Overview
Description:Bootstrap context for resource adapters.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2492. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2493. 
NameDescriptionRequiredInternal Name
NameThe name of the BootstrapContext no name
WorkmanagerThe WorkManager instance for the BootstrapContext no workmanager

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.17.2. EAP7 - Workmanager Service
Overview
Table 3.2494. Overview
Description:WorkManager for resource adapters.
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2495. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2496. 
NameDescriptionRequiredInternal Name
NameThe name of the WorkManager no name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.17.2.1. EAP7 - Long Running Thread Pool Service
Overview
Table 3.2497. Overview
Description:Long running thread pool executor with a bounded queue where threads submitting tasks may block.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2498. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2499. Metrics
NameTypeDescriptionInternal Name
Current Thread CountmeasurementThe current number of threads in the pool.current-thread-count
Largest Thread CountmeasurementThe largest number of threads that have ever simultaneously been in the pool.largest-thread-count
Rejected CountmeasurementThe number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.rejected-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2500. 
NameDescriptionRequiredInternal Name
Allow Core TimeoutWhether core threads may time out. The default value is false. no allow-core-timeout
Core ThreadsThe 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. no core-threads:expr
Handoff ExecutorAn 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. no handoff-executor
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. yes max-threads:expr
NameThe name of the thread pool. no name
Queue LengthThe queue length. yes queue-length:expr
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.17.2.2. EAP7 - Short Running Thread Pool Service
Overview
Table 3.2501. Overview
Description:Short running thread pool executor with a bounded queue where threads submitting tasks may block.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2502. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2503. Metrics
NameTypeDescriptionInternal Name
Current Thread CountmeasurementThe current number of threads in the pool.current-thread-count
Largest Thread CountmeasurementThe largest number of threads that have ever simultaneously been in the pool.largest-thread-count
Rejected CountmeasurementThe number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.rejected-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2504. 
NameDescriptionRequiredInternal Name
Allow Core TimeoutWhether core threads may time out. The default value is false. no allow-core-timeout
Core ThreadsThe 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. no core-threads:expr
Handoff ExecutorAn 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. no handoff-executor
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. yes max-threads:expr
NameThe name of the thread pool. no name
Queue LengthThe queue length. yes queue-length:expr
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.18. EAP7 - JAXR Service

Overview
Table 3.2505. Overview
Description:The configuration of the JAXR subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2506. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2507. 
NameDescriptionRequiredInternal Name
ClassThe JAXR ConnectionFactory implementation class no class
Jndi NameThe JNDI name under which the JAXR ConnectionFactory is bound no jndi-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.18.1. EAP7 - Property (JAXR) Service
Overview
Table 3.2508. Overview
Description:A JAXR property. The identity of the resource defines the property name.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2509. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2510. 
NameDescriptionRequiredInternal Name
ValueThe JAXR property value. yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.19. EAP7 - JPA Service

Overview
Table 3.2511. Overview
Description:The configuration of the JPA subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2512. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2513. 
NameDescriptionRequiredInternal Name
Default DatasourceThe name of the default global datasource. no default-datasource

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.20. EAP7 - CMP Service

Overview
Table 3.2514. Overview
Description:The configuration of the cmp subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2515. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.20.1. EAP7 - HiloKeygenerator Service
Overview
Table 3.2516. Overview
Description:HiLo based key generators.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2517. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2518. 
NameDescriptionRequiredInternal Name
Block SizeThe block size no block-size
Create TableBoolean to determine whether to create create the tables no create-table
Create Table DdlThe DDL used to create the table no create-table-ddl
Data SourceThe datasource used for sequence generation yes data-source
Drop TableBoolean to determine whether to create drop the tables no drop-table
Id ColumnThe ID column name yes id-column
Select Hi DdlThe DDL used to select the hi value no select-hi-ddl
Sequence ColumnThe sequence column name yes sequence-column
Sequence NameThe name of the sequence yes sequence-name
Table NameThe table name yes table-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.21. EAP7 - EE Service

Overview
Table 3.2519. Overview
Description:The configuration of the EE subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2520. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2521. 
NameDescriptionRequiredInternal Name
Ear Subdeployments IsolatedFlag 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. The default value is false. no ear-subdeployments-isolated
Global ModulesA list of modules that should be made available to all deployments. no global-modules

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.22. EAP7 - Security Service

Overview
Table 3.2522. Overview
Description:The configuration of the security subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2523. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2524. 
NameDescriptionRequiredInternal Name
Deep Copy Subject ModeSets 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. The default value is false. no deep-copy-subject-mode

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1. EAP7 - Security Domain Service
Overview
Table 3.2525. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2526. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2527. 
NameDescriptionRequiredInternal Name
Cache TypeAdds 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. no cache-type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2528. Metrics
NameDescription
Flush CacheRemove entries stored in the authentication cache for this security domain. A single entry can be flushed by using the principal argument with the username as the value. If no argument is passed to the operation, all entries are flushed.
List Cached PrincipalsLists the principals stored in the authentication cache for this security domain.
Package Types
none
3.4.1.22.1.1. EAP7 - ACL Service
Overview
Table 3.2529. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2530. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2531. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.1.1. EAP7 - Acl Modules Service
Overview
Table 3.2532. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2533. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2534. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.1.1.1. EAP7 - Module Options (Acl) Service
Overview
Table 3.2535. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2536. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2537. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.2. EAP7 - Audit Service
Overview
Table 3.2538. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2539. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2540. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.2.1. EAP7 - Provider Modules Service
Overview
Table 3.2541. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2542. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2543. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.2.1.1. EAP7 - Module Options (Provider Modules) Service
Overview
Table 3.2544. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2545. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2546. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.3. EAP7 - Authentication (Classic) Service
Overview
Table 3.2547. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2548. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2549. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.3.1. EAP7 - Login Modules (Classic) Service
Overview
Table 3.2550. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2551. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2552. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.3.1.1. EAP7 - Module Options (Classic) Service
Overview
Table 3.2553. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2554. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2555. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.4. EAP7 - Authentication (Jaspi) Service
Overview
Table 3.2556. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2557. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2558. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.4.1. EAP7 - Login Module Stack Service
Overview
Table 3.2559. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2560. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2561. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.4.1.1. EAP7 - Module Options (Login Module Stack) Service
Overview
Table 3.2562. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2563. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2564. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.5. EAP7 - Authorization Service
Overview
Table 3.2565. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2566. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2567. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.5.1. EAP7 - Authorization Modules Service
Overview
Table 3.2568. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2569. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2570. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.5.1.1. EAP7 - Module Options (Authorization) Service
Overview
Table 3.2571. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2572. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2573. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.6. EAP7 - Identity Trust Service
Overview
Table 3.2574. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2575. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2576. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.6.1. EAP7 - Identity Trust Modules Service
Overview
Table 3.2577. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2578. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2579. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.6.1.1. EAP7 - Module Options (Identity Trust) Service
Overview
Table 3.2580. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2581. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2582. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.7. EAP7 - JSSE Service
Overview
Table 3.2583. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2584. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2585. 
NameDescriptionRequiredInternal Name
Cipher SuitesComma separated list of cipher suites to enable on SSLSockets. no cipher-suites
Client AliasPreferred alias to use when the KeyManager chooses the client alias. no client-alias
Client AuthBoolean attribute to indicate if client's certificates should also be authenticated on the server side. no client-auth
Key ManagerJSEE Key Manager factory no key-manager
KeystoreConfigures a JSSE key store no keystore
ProtocolsComma separated list of protocols to enable on SSLSockets. no protocols
Server AliasPreferred alias to use when the KeyManager chooses the server alias. no server-alias
Service Auth TokenToken to retrieve PrivateKeys from the KeyStore. no service-auth-token
Trust ManagerJSEE Trust Manager factory no trust-manager
TruststoreConfigures a JSSE trust store no truststore

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.8. EAP7 - Mapping Service
Overview
Table 3.2586. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2587. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2588. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
TypeType of mapping this module performs. Allowed values are principal, role, attribute or credential.. yes type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.8.1. EAP7 - Mapping Modules Service
Overview
Table 3.2589. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2590. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2591. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
TypeType of mapping this module performs. Allowed values are principal, role, attribute or credential.. yes type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.1.8.1.1. EAP7 - Module Options (Mapping) Service
Overview
Table 3.2592. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2593. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2594. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.22.2. EAP7 - Vault Service
Overview
Table 3.2595. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2596. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2597. 
NameDescriptionRequiredInternal Name
CodeFully Qualified Name of the Security Vault Implementation. no code

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.23. EAP7 - Threads Service

Overview
Table 3.2598. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2599. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.23.1. EAP7 - ThreadFactory Service
Overview
Table 3.2600. Overview
Description:A thread factory (implementing java.util.concurrent.ThreadFactory).
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2601. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2602. 
NameDescriptionRequiredInternal Name
Group NameSpecifies the name of a thread group to create for this thread factory. no group-name
NameThe name of the created thread factory. no name
PriorityMay be used to specify the thread priority of created threads. The default value is -1. no priority:expr
Thread Name PatternThe template used to create names for threads. The following patterns may be used: %% - emit a percent sign %t - emit the per-factory thread sequence number %g - emit the global thread sequence number %f - emit the factory sequence number %i - emit the thread ID. no thread-name-pattern

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.23.2. EAP7 - ThreadPool Service
Overview
Table 3.2603. Overview
Description:A thread pool executor
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2604. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2605. Metrics
NameTypeDescriptionInternal Name
Active CountmeasurementThe approximate number of threads that are actively executing tasks.active-count
Completed Task CountmeasurementThe approximate total number of tasks that have completed execution.completed-task-count
Current Thread CountmeasurementThe current number of threads in the pool.current-thread-count
Largest Thread CountmeasurementThe largest number of threads that have ever simultaneously been in the pool.largest-thread-count
Rejected CountmeasurementThe number of tasks that have been rejected.rejected-count
Task CountmeasurementThe approximate total number of tasks that have ever been scheduled for execution.task-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2606. 
NameDescriptionRequiredInternal Name
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. yes max-threads:expr
NameThe name of the thread pool. no name
Queue LengthThe queue length. Required only for Bounded and Blocking Bounded Thread Pools. no queue-length:expr
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory
Allow Core TimeoutWhether core threads may time out. The default value is false. no allow-core-timeout
Core ThreadsThe 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. no core-threads:expr
Handoff ExecutorAn 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. no handoff-executor
Thread Pool TypeThread pool type yes __type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.24. EAP7 - EJB3 Service

Overview
Table 3.2607. Overview
Description:The configuration of the ejb3 subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2608. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2609. 
NameDescriptionRequiredInternal Name
Default Clustered Sfsb CacheName of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level no default-clustered-sfsb-cache
Default Entity Bean Instance PoolName of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level no default-entity-bean-instance-pool
Default Entity Bean Optimistic LockingIf set to true entity beans will use optimistic locking by default no default-entity-bean-optimistic-locking
Default Mdb Instance PoolName of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level no default-mdb-instance-pool
Default Resource Adapter NameName of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level. The default value is activemq-ra. no default-resource-adapter-name
Default Sfsb CacheName of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level no default-sfsb-cache
Default Singleton Bean Access TimeoutThe default access timeout for singleton beans. The default value is 5000. no default-singleton-bean-access-timeout:expr
Default Slsb Instance PoolName of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level no default-slsb-instance-pool
Default Stateful Bean Access TimeoutThe default access timeout for stateful beans. The default value is 5000. no default-stateful-bean-access-timeout:expr
In Vm Remote Interface Invocation Pass By ValueIf 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. The default value is true. no in-vm-remote-interface-invocation-pass-by-value
Enable StatisticsIf set to true, enable the collection of invocation statistics. no enable-statistics

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.1. EAP7 - EJB3 Thread Pool Service
Overview
Table 3.2610. Overview
Description:A thread pool executor with an unbounded queue. Such a thread pool has a core size and a queue with no upper bound. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, the task is placed in queue. If too many tasks are allowed to be submitted to this type of executor, an out of memory condition may occur.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2611. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2612. Metrics
NameTypeDescriptionInternal Name
Active CountmeasurementThe approximate number of threads that are actively executing tasks.active-count
Completed Task CountmeasurementThe approximate total number of tasks that have completed execution.completed-task-count
Current Thread CountmeasurementThe current number of threads in the pool.current-thread-count
Largest Thread CountmeasurementThe largest number of threads that have ever simultaneously been in the pool.largest-thread-count
Rejected CountmeasurementThe number of tasks that have been rejected.rejected-count
Task CountmeasurementThe approximate total number of tasks that have ever been scheduled for execution.task-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2613. 
NameDescriptionRequiredInternal Name
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. no max-threads:expr
NameThe name of the thread pool. no name
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.2. EAP7 - File Passivation Store Service
Overview
Table 3.2614. Overview
Description:A file system based passivation store.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2615. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2616. 
NameDescriptionRequiredInternal Name
Groups Path  no groups-path
Idle TimeoutThe timeout in units specified by idle-timeout-unit, after which a bean will passivate. The default value is 300. no idle-timeout:expr
Idle Timeout UnitThe unit of idle-timeout. The default value is SECONDS. no idle-timeout-unit
Max SizeThe maximum number of beans this cache should store before forcing old beans to passivate. The default value is 10000. no max-size:expr
Relative To  no relative-to
Sessions Path  no sessions-path
Subdirectory count  no subdirectory-count:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.3. EAP7 - MDB Delivery Group Service
Overview
Table 3.2617. Overview
Description:Delivery group to manage delivery for mdbs
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2618. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2619. 
NameDescriptionRequiredInternal Name
ActiveIndicates if delivery for all MDBs belonging to this group is active. The default value is true. no active

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.4. EAP7 - Strict Max Bean Instance Pool Service
Overview
Table 3.2620. Overview
Description:A bean instance pool with a strict upper limit
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2621. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2622. 
NameDescriptionRequiredInternal Name
Derive SizeSpecifies if and what the max pool size should be derived from. A value of 'none', the default, 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. The default value is none. no derive-size
Max Pool SizeThe maximum number of bean instances that the pool can hold at a given point in time. no max-pool-size
TimeoutThe maximum amount of time to wait for a bean instance to be available from the pool. The default value is 5. no timeout
Timeout UnitThe instance acquisition timeout unit. The default value is MINUTES. no timeout-unit

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.5. EAP7 - SFSB Cache Service
Overview
Table 3.2623. Overview
Description:A SFSB cache.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2624. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2625. 
NameDescriptionRequiredInternal Name
AliasesThe aliases by which this cache may also be referenced yes aliases
Passivation StoreThe passivation store used by this cache no passivation-store

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.6. EAP7 - Cluster Passivation Store Service
Overview
Table 3.2626. Overview
Description:A clustered passivation store.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2627. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2628. 
NameDescriptionRequiredInternal Name
Bean CacheThe name of the cache used to store bean instances. no bean-cache
Cache ContainerThe name of the cache container used for the bean and client-mappings caches. The default value is ejb. no cache-container
Client Mappings CacheThe name of the cache used to store client-mappings of the EJB remoting connector's socket-bindings. The default value is remote-connector-client-mappings. no client-mappings-cache
Idle TimeoutThe timeout in units specified by idle-timeout-unit, after which a bean will passivate. The default value is 300. no idle-timeout:expr
Idle Timeout UnitThe unit of idle-timeout. The default value is SECONDS. no idle-timeout-unit
Max SizeThe maximum number of beans this cache should store before forcing old beans to passivate. The default value is 10000. no max-size:expr
Passivate Events On ReplicateIndicates whether replication should trigger passivation events on the bean. The default value is true. no passivate-events-on-replicate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.7. EAP7 - Async Service
Overview
Table 3.2629. Overview
Description:The EJB3 Asynchronous Invocation Service
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2630. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2631. 
NameDescriptionRequiredInternal Name
Thread Pool NameThe name of the thread pool which handles asynchronous invocations no thread-pool-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.8. EAP7 - IIOP Service
Overview
Table 3.2632. Overview
Description:The IIOP service
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2633. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2634. 
NameDescriptionRequiredInternal Name
Enable By DefaultIf this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor no enable-by-default
Use Qualified NameIf 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) no use-qualified-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.9. EAP7 - Remote Service
Overview
Table 3.2635. Overview
Description:The EJB3 remote service
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2636. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2637. 
NameDescriptionRequiredInternal Name
Connector RefThe name of the connector on which the EJB3 remoting channel is registered no connector-ref
Thread Pool NameThe name of the thread pool that handles remote invocations no thread-pool-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.9.1. EAP7 - Channel Creation Options Service
Overview
Table 3.2638. Overview
Description:The options that will be used during the EJB remote channel creation
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2639. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2640. 
NameDescriptionRequiredInternal Name
TypeThe type of the channel creation option no type
ValueThe value for the EJB remote channel creation option no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.24.10. EAP7 - Timer Service
Overview
Table 3.2641. Overview
Description:The EJB timer service
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2642. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2643. 
NameDescriptionRequiredInternal Name
PathThe directory to store persistent timer information in no path
Relative ToThe relative path that is used to resolve the timer data store location no relative-to
Thread Pool NameThe name of the thread pool used to run timer service invocations no thread-pool-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.25. EAP7 - JMX Service

Overview
Table 3.2644. Overview
Description:The configuration of the JMX subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2645. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2646. 
NameDescriptionRequiredInternal Name
Show ModelSet to 'true' to include MBeans for the model controller resources no show-model

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.25.1. EAP7 - Remoting Connector Service
Overview
Table 3.2647. Overview
Description:The configuration of a resource adapter.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2648. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2649. 
NameDescriptionRequiredInternal Name
Use Management EndpointIf true the connector will use the management endpoint, otherwise it will use the remoting subsystem one. The default value is true. no use-management-endpoint

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.26. EAP7 - Resource Adapters Service

Overview
Table 3.2650. Overview
Description:Configuration of the resource adapters subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2651. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.26.1. EAP7 - Resource Adapter Service
Overview
Table 3.2652. Overview
Description:The configuration of a resource adapter.
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2653. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2654. 
NameDescriptionRequiredInternal Name
ArchiveSpecifies the resource adapter archive yes archive
BeanvalidationgroupsSpecifies the bean validation groups that should be used no beanvalidationgroups
BootstrapcontextSpecifies the unique name of the bootstrap context that should be used no bootstrapcontext
Transaction SupportSpecifies the transaction support level of the resource adapter yes transaction-support

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.26.1.1. EAP7 - Admin Objects Service
Overview
Table 3.2655. Overview
Description:Specifies the administration objects.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2656. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2657. 
NameDescriptionRequiredInternal Name
Class NameSpecifies the fully qualified class name of a managed connection factory or admin object yes class-name
EnabledSpecifies if the resource adapter should be enabled. The default value is true. no enabled
Jndi NameSpecifies the JNDI name for the connection factory or admin object no jndi-name
Use Java ContextSetting this to false will bind the object into global JNDI. The default value is true. no use-java-context

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.26.1.2. EAP7 - Connection Definitions Service
Overview
Table 3.2658. Overview
Description:Specifies the connection definitions.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2659. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2660. 
NameDescriptionRequiredInternal Name
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception no allocation-retry:expr
Allocation Retry Wait MillisThe allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection no allocation-retry-wait-millis:expr
Background ValidationAn 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. The default value is false. no background-validation
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart no background-validation-millis:expr
Blocking Timeout Wait MillisThe 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 no blocking-timeout-wait-millis:expr
Class NameSpecifies the fully qualified class name of a managed connection factory or admin object yes class-name
EnabledSpecifies if the resource adapter should be enabled. The default value is true. no enabled
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Idle Timeout MinutesThe 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 requires a server restart. no idle-timeout-minutes:expr
InterleavingAn element to enable interleaving for XA connections. The default value is false. no interleaving
Jndi NameSpecifies the JNDI name for the connection factory or admin object no jndi-name
Max Pool SizeThe max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20. no max-pool-size:expr
Min Pool SizeThe min-pool-size element specifies the minimum number of connections for a pool. The default value is 0. no min-pool-size:expr
No RecoverySpecifies if the connection pool should be excluded from recovery no no-recovery
No Tx Separate PoolOracle 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. The default value is false. no no-tx-separate-pool
Pad XidShould the Xid be padded. The default value is false. no pad-xid
Pool PrefillShould the pool be prefilled. Changing this value requires a server restart. The default value is false. no pool-prefill
Pool Use Strict MinSpecifies if the min-pool-size should be considered strictly. The default value is false. no pool-use-strict-min
Recovery PasswordThe password used for recovery no recovery-password
Recovery Plugin Class NameThe fully qualified class name of the recovery plugin implementation no recovery-plugin-class-name
Recovery Plugin PropertiesThe properties for the recovery plugin no recovery-plugin-properties
Recovery Security DomainThe security domain used for recovery no recovery-security-domain
Recovery UsernameThe user name used for recovery no recovery-username
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Security ApplicationIndicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool no security-application
Security DomainSpecifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool no security-domain
Security Domain and ApplicationIndicates that either app supplied parameters (such as from getConnection(user, pw)) or Subject (from security domain) are used to distinguish connections in the pool no security-domain-and-application
Use CcmEnable the use of a cached connection manager. The default value is true. no use-ccm
Use Fast FailWhether 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). The default value is false. no use-fast-fail
Use Java ContextSetting this to false will bind the object into global JNDI. The default value is true. no use-java-context
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock:expr
Wrap Xa ResourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true. no wrap-xa-resource
XA Resource TimeoutThe value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero no xa-resource-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2661. Metrics
NameDescription
Flush All Connections in PoolFlushes all connections in the pool
Flush Idle Connections in PoolFlushes all idle connections in the pool
Test Connection in PoolTest if a connection can be obtained
Package Types
none
3.4.1.26.1.2.1. EAP7 - Config Properties Service
Overview
Table 3.2662. Overview
Description:Custom defined config properties.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2663. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2664. 
NameDescriptionRequiredInternal Name
ValueCustom defined config property value no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.26.1.3. EAP7 - Config Properties Service
Overview
Table 3.2665. Overview
Description:Custom defined config properties.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2666. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2667. 
NameDescriptionRequiredInternal Name
ValueCustom defined config property value no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.27. EAP7 - Infinispan Service

Overview
Table 3.2668. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2669. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.27.1. EAP7 - Cache Container Service
Overview
Table 3.2670. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2671. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2672. Metrics
NameTypeDescriptionInternal Name
Cache Manager StatustraitThe status of the cache manager component. May return null if the cache manager is not started.cache-manager-status
Cluster NametraitThe name of the cluster this node belongs to. May return null if the cache manager is not started.cluster-name
Coordinator AddresstraitThe logical address of the cluster's coordinator. May return null if the cache manager is not started.coordinator-address
Is CoordinatortraitTrue if this node is the cluster's coordinator. May return null if the cache manager is not started.is-coordinator
Local AddresstraitThe local address of the node. May return null if the cache manager is not started.local-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2673. 
NameDescriptionRequiredInternal Name
AliasesThe list of aliases for this cache container no aliases
Default CacheThe default infinispan cache no default-cache
Jndi NameThe jndi name to which to bind this cache container no jndi-name
ModuleThe module whose class loader should be used when building this cache container's configuration. The default value is org.jboss.as.clustering.infinispan. no module
Statistics EnabledIf enabled, statistics will be collected for this cache container. no statistics-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.27.1.1. EAP7 - Cache Service
Overview
Table 3.2674. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2675. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2676. Metrics
NameTypeDescriptionInternal Name
ActivationsmeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Activations per MinutemeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Average Read TimemeasurementAverage time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.average-read-time
Average Write TimemeasurementAverage time (in ms) for cache writes. May return null if the cache is not started.average-write-time
Cache StatustraitThe status of the cache component. May return null if the cache is not started.cache-status
Elapsed TimemeasurementTime (in secs) since cache started. May return null if the cache is not started.elapsed-time
Hit RatiomeasurementThe hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.hit-ratio
HitsmeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
Hits per MinutemeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
InvalidationsmeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
Invalidations per MinutemeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
MissesmeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Misses per MinutemeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Number Of EntriesmeasurementThe current number of entries in the cache. May return null if the cache is not started.number-of-entries
PassivationsmeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Passivations per MinutemeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Read Write RatiomeasurementThe read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.read-write-ratio
Remove HitsmeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove Hits per MinutemeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove MissesmeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
Remove Misses per MinutemeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
StoresmeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Stores per MinutemeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Time Since ResetmeasurementTime (in secs) since cache statistics were reset. May return null if the cache is not started.time-since-reset

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2677. 
NameDescriptionRequiredInternal Name
Jndi NameThe jndi-name to which to bind this cache instance. no jndi-name
ModeSets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. yes mode
ModuleThe module whose class loader should be used when building this cache's configuration. no module
Queue Flush IntervalIn ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds. no queue-flush-interval
Queue SizeIn ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. no queue-size
Remote TimeoutIn SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown. no remote-timeout
Type of cacheType of cache yes __type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.27.1.2. EAP7 - Distributed Cache Service
Overview
Table 3.2678. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2679. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2680. Metrics
NameTypeDescriptionInternal Name
ActivationsmeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Activations per MinutemeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Average Read TimemeasurementAverage time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.average-read-time
Average Write TimemeasurementAverage time (in ms) for cache writes. May return null if the cache is not started.average-write-time
Cache StatustraitThe status of the cache component. May return null if the cache is not started.cache-status
Elapsed TimemeasurementTime (in secs) since cache started. May return null if the cache is not started.elapsed-time
Hit RatiomeasurementThe hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.hit-ratio
HitsmeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
Hits per MinutemeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
InvalidationsmeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
Invalidations per MinutemeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
MissesmeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Misses per MinutemeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Number Of EntriesmeasurementThe current number of entries in the cache. May return null if the cache is not started.number-of-entries
PassivationsmeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Passivations per MinutemeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Read Write RatiomeasurementThe read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.read-write-ratio
Remove HitsmeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove Hits per MinutemeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove MissesmeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
Remove Misses per MinutemeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
StoresmeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Stores per MinutemeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Time Since ResetmeasurementTime (in secs) since cache statistics were reset. May return null if the cache is not started.time-since-reset

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2681. 
NameDescriptionRequiredInternal Name
Jndi NameThe jndi-name to which to bind this cache instance. no jndi-name
L 1 LifespanMaximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored. The default value is 600000. no l1-lifespan
ModeSets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. yes mode
ModuleThe module whose class loader should be used when building this cache's configuration. no module
OwnersNumber of cluster-wide replicas for each cache entry. The default value is 2. no owners
Queue Flush IntervalIn ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds. no queue-flush-interval
Queue SizeIn ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. no queue-size
Remote TimeoutIn SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown. no remote-timeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.27.1.3. EAP7 - Local Cache Service
Overview
Table 3.2682. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2683. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2684. Metrics
NameTypeDescriptionInternal Name
ActivationsmeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Activations per MinutemeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Average Read TimemeasurementAverage time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.average-read-time
Average Write TimemeasurementAverage time (in ms) for cache writes. May return null if the cache is not started.average-write-time
Cache StatustraitThe status of the cache component. May return null if the cache is not started.cache-status
Elapsed TimemeasurementTime (in secs) since cache started. May return null if the cache is not started.elapsed-time
Hit RatiomeasurementThe hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.hit-ratio
HitsmeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
Hits per MinutemeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
InvalidationsmeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
Invalidations per MinutemeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
MissesmeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Misses per MinutemeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Number Of EntriesmeasurementThe current number of entries in the cache. May return null if the cache is not started.number-of-entries
PassivationsmeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Passivations per MinutemeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Read Write RatiomeasurementThe read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.read-write-ratio
Remove HitsmeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove Hits per MinutemeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove MissesmeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
Remove Misses per MinutemeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
StoresmeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Stores per MinutemeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Time Since ResetmeasurementTime (in secs) since cache statistics were reset. May return null if the cache is not started.time-since-reset

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2685. 
NameDescriptionRequiredInternal Name
Jndi NameThe jndi-name to which to bind this cache instance. no jndi-name
ModuleThe module whose class loader should be used when building this cache's configuration. no module

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.27.1.4. EAP7 - Transport Service
Overview
Table 3.2686. Overview
Description:The description of the transport used by this cache container
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2687. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2688. 
NameDescriptionRequiredInternal Name
ChannelThe channel of this cache container's transport. no channel
Lock TimeoutThe timeout for locks for the transport. The default value is 240000. no lock-timeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.28. EAP7 - JGroups Service

Overview
Table 3.2689. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2690. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2691. 
NameDescriptionRequiredInternal Name
Default StackDefault stack to use yes default-stack

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.29. EAP7 - Remoting Service

Overview
Table 3.2692. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2693. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2694. 
NameDescriptionRequiredInternal Name
Worker Read ThreadsThe number of read threads to create for the remoting worker. The default value is 1. no worker-read-threads
Worker Task Core ThreadsThe number of core threads for the remoting worker task thread pool. The default value is 4. no worker-task-core-threads
Worker Task KeepaliveThe number of milliseconds to keep non-core remoting worker task threads alive. The default value is 60. no worker-task-keepalive
Worker Task LimitThe maximum number of remoting worker tasks to allow before rejecting. The default value is 16384. no worker-task-limit
Worker Task Max ThreadsThe maximum number of threads for the remoting worker task thread pool. The default value is 16. no worker-task-max-threads
Worker Write ThreadsThe number of write threads to create for the remoting worker. The default value is 1. no worker-write-threads

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.30. EAP7 - Osgi Service

Overview
Table 3.2695. Overview
Description:The OSGi subsystem configuration.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2696. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2697. 
NameDescriptionRequiredInternal Name
ActivationActivation flag for the OSGi subsystem. Possible values: lazy, eager. The default value is LAZY. no activation
StartlevelThe current Start Level of the OSGi Framework. Changing this value will change the Start Level of the Framework accordingly. no startlevel

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2698. Metrics
NameDescription
ActivateActivate the OSGi subsystem.
Package Types
none
3.4.1.30.1. EAP7 - Capability Service
Overview
Table 3.2699. Overview
Description:A framework capability. A capability maps to a JBoss Module in the modules directory or an OSGi bundle in the bundles directory. The identity maps to the resource identifier of the module or bundle.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2700. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2701. 
NameDescriptionRequiredInternal Name
StartlevelThe startlevel for the capability. Can only be specified for OSGi bundles. no startlevel

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.30.2. EAP7 - Bundle Service
Overview
Table 3.2702. Overview
Description:Runtime bundle information.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2703. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2704. 
NameDescriptionRequiredInternal Name
IdThe bundle ID. no id
StartlevelThe bundle's start level. no startlevel
Symbolic NameThe bundle symbolic name. no symbolic-name
VersionThe bundle version. no version

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2705. Metrics
NameDescription
StartStarts the bundle.
StopStops the bundle.
Package Types
none
3.4.1.30.3. EAP7 - Property Service
Overview
Table 3.2706. Overview
Description:A property
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2707. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2708. 
NameDescriptionRequiredInternal Name
ValueThe property value. no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.31. EAP7 - Mail Service

Overview
Table 3.2709. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2710. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.31.1. EAP7 - Mail Session Service
Overview
Table 3.2711. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2712. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2713. 
NameDescriptionRequiredInternal Name
DebugEnables javamail debugging. The default value is false. no debug
FromFrom address that is used as default from, if not set when sending no from
Jndi NameJNDI name to where mail session should be bound no jndi-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.31.1.1. EAP7 - SMTP Mail Server Service
Overview
Table 3.2714. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2715. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2716. 
NameDescriptionRequiredInternal Name
Outbound Socket Binding RefOutbound Socket binding to SMTP server yes outbound-socket-binding-ref
PasswordPassword to authenticate on server no password
SslDoes server requires SSL?. The default value is false. no ssl
UsernameUsername to authenticate on server no username

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.31.1.2. EAP7 - IMAP Mail Server Service
Overview
Table 3.2717. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2718. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2719. 
NameDescriptionRequiredInternal Name
Outbound Socket Binding RefOutbound Socket binding to IMAP server yes outbound-socket-binding-ref
PasswordPassword to authenticate on server no password
SslDoes server requires SSL?. The default value is false. no ssl
UsernameUsername to authenticate on server no username

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.31.1.3. EAP7 - POP3 Mail Server Service
Overview
Table 3.2720. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2721. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2722. 
NameDescriptionRequiredInternal Name
Outbound Socket Binding RefOutbound Socket binding to POP3 server yes outbound-socket-binding-ref
PasswordPassword to authenticate on server no password
SslDoes server requires SSL?. The default value is false. no ssl
UsernameUsername to authenticate on server no username

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.1.32. EAP7 - ActiveMQ Messaging Service

Overview
Table 3.2723. Overview
Description:The messaging subsystems
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2724. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.32.1. EAP7 - ActiveMQ Artemis Service
Overview
Table 3.2725. Overview
Description:The ActiveMQ Artemis based messaging subsystem
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2726. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2727. Metrics
NameTypeDescriptionInternal Name
ActivetraitWhether the server is active (and accepting connections) or passive (in backup mode, waiting for failover).active
StartedtraitWhether this server is started.started
VersiontraitThe server's version.version

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2728. 
NameDescriptionRequiredInternal Name
Async Connection Execution EnabledWhether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread. The default value is true. no async-connection-execution-enabled
Cluster PasswordThe password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!. no cluster-password
Cluster UserThe user used by cluster connections to communicate between the clustered nodes. The default value is ACTIVEMQ.CLUSTER.ADMIN.USER. no cluster-user
Connection Ttl Override:exprIf set, this will override how long (in ms) to keep a connection alive without receiving a ping. The default value is -1. no connection-ttl-override:expr
Create Bindings DirWhether the server should create the bindings directory on start up. The default value is true. no create-bindings-dir
Create Journal DirWhether the server should create the journal directory on start up. The default value is true. no create-journal-dir
Id Cache Size:exprThe size of the cache for pre-creating message IDs. The default value is 20000. no id-cache-size:expr
Incoming InterceptorsThe list of incoming interceptor classes used by this server. no incoming-interceptors
Jmx DomainThe JMX domain used to register internal ActiveMQ MBeans in the MBeanServer. The default value is org.apache.activemq.artemis. no jmx-domain
Jmx Management EnabledWhether ActiveMQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration. The default value is false. no jmx-management-enabled
Journal Buffer Size:exprThe size of the internal buffer on the journal. no journal-buffer-size:expr
Journal Buffer Timeout:exprThe timeout (in nanoseconds) used to flush internal buffers on the journal. no journal-buffer-timeout:expr
Journal Compact Min Files:exprThe minimal number of journal data files before we can start compacting. The default value is 10. no journal-compact-min-files:expr
Journal Compact Percentage:exprThe percentage of live data on which we consider compacting the journal. The default value is 30. no journal-compact-percentage:expr
Journal File Size:exprThe size (in bytes) of each journal file. The default value is 10485760. no journal-file-size:expr
Journal Max Io:exprThe maximum number of write requests that can be in the AIO queue at any one time. no journal-max-io:expr
Journal Min Files:exprHow many journal files to pre-create. The default value is 2. no journal-min-files:expr
Journal Pool Files:exprThe number of journal files that can be reused. ActiveMQ will create as many files as needed however when reclaiming files it will shrink back to the value (-1 means no limit). The default value is -1. no journal-pool-files:expr
Journal Sync Non TransactionalWhether to wait for non transaction data to be synced to the journal before returning a response to the client. The default value is true. no journal-sync-non-transactional
Journal Sync TransactionalWhether to wait for transaction data to be synchronized to the journal before returning a response to the client. The default value is true. no journal-sync-transactional
Journal TypeThe type of journal to use. The default value is ASYNCIO. no journal-type
Log Journal Write RateWhether to periodically log the journal's write rate and flush rate. The default value is false. no log-journal-write-rate
Management AddressAddress to send management messages to. The default value is jms.queue.activemq.management. no management-address
Management Notification AddressThe name of the address that consumers bind to to receive management notifications. The default value is activemq.notifications. no management-notification-address
Memory Measure Interval:exprFrequency to sample JVM memory in ms (or -1 to disable memory sampling). The default value is -1. no memory-measure-interval:expr
Memory Warning Threshold:exprPercentage of available memory which if exceeded results in a warning log. The default value is 25. no memory-warning-threshold:expr
Message Counter Max Day History:exprHow many days to keep message counter history. The default value is 10. no message-counter-max-day-history:expr
Message Counter Sample Period:exprThe sample period (in ms) to use for message counters. The default value is 10000. no message-counter-sample-period:expr
Message Expiry Scan Period:exprHow often (in ms) to scan for expired messages. The default value is 30000. no message-expiry-scan-period:expr
Message Expiry Thread Priority:exprThe priority of the thread expiring messages. The default value is 3. no message-expiry-thread-priority:expr
Outgoing InterceptorsThe list of outgoing interceptor classes used by this server. no outgoing-interceptors
Override In Vm SecurityWhether the ActiveMQ server will override security credentials for in-vm connections. The default value is true. no override-in-vm-security
Page Max Concurrent Io:exprThe maximum number of concurrent reads allowed on paging. The default value is 5. no page-max-concurrent-io:expr
Perf Blast Pages:exprTODO. The default value is -1. no perf-blast-pages:expr
Persist Delivery Count Before DeliveryWhether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. The default value is false. no persist-delivery-count-before-delivery
Persist Id CacheWhether IDs are persisted to the journal. The default value is true. no persist-id-cache
Persistence EnabledWhether the server will use the file based journal for persistence. The default value is true. no persistence-enabled
Run Sync Speed TestWhether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues. The default value is false. no run-sync-speed-test
Scheduled Thread Pool Max Size:exprThe number of threads that the main scheduled thread pool has. The default value is 5. no scheduled-thread-pool-max-size:expr
Security DomainThe security domain to use to verify user and role information. The default value is other. no security-domain
Security EnabledWhether security is enabled. The default value is true. no security-enabled
Security Invalidation Interval:exprHow long (in ms) to wait before invalidating the security cache. The default value is 10000. no security-invalidation-interval:expr
Server Dump Interval:exprHow often to dump basic runtime information to the server log. A value less than 1 disables this feature. The default value is -1. no server-dump-interval:expr
Statistics EnabledWhether gathering of statistics such as message counters are enabled. The default value is false. no statistics-enabled
Thread Pool Max Size:exprThe number of threads that the main thread pool has. -1 means no limit. The default value is 30. no thread-pool-max-size:expr
Transaction Timeout:exprHow long (in ms) before a transaction can be removed from the resource manager after create time. The default value is 300000. no transaction-timeout:expr
Transaction Timeout Scan Period:exprHow often (in ms) to scan for timeout transactions. The default value is 1000. no transaction-timeout-scan-period:expr
Wild Card Routing EnabledWhether the server supports wild card routing. The default value is true. no wild-card-routing-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2729. Metrics
NameDescription
Close Connections for AddressCloses all the connections of clients connected to this server whose remote address contains the specified IP address.
Close Connections for UserCloses all the connections of clients connected to this server under the specified user name.
Close Consumer Connections for AddressCloses all the connections of consumers that are consuming from queues bound to the specified address.
Commit Prepared TransactionHeuristically commits a prepared transaction.
Export JournalExport the journal to a XML file
Force FailoverForce the messaging server to stop and notify clients to failover.
Get address settings as JSONReturns the address settings as a JSON string for an address match.
Get connectors as JSONReturns the connectors configured for this server in a JSON string containing the connectors information.
Get last sent message IDReturns the ID of the last message sent from the given session to the given address.
Get rolesGet the security roles for a specific address match.
Get roles as JSONGets the roles (as a JSON string) for a specific address match.
Get session creation timeGets the session's creation time.
Import JournalImport an XML file to the journal
List addAdd entry to list attribute
List all consumers as JSONLists all the consumers.
List clearClear all entries from list attribute
List connection IDsLists the IDs of all the connections connected to this server.
List connections as JSONLists all JMS connections.
List consumers as JSONLists all the consumers which belongs to the JMS Connection specified by the connection id.
List getGet entry from list attribute
List heuristic committed transactionsLists transactions which have been heuristically committed.
List heuristic rolled back transactionsLists transactions which have been heuristically rolled back.
List prepared transaction details as HTMLLists all the prepared transaction, sorted by date, oldest first, with details, in HTML format.
List prepared transaction details as JSONLists all the prepared transaction, sorted by date, oldest first, with details, in JSON format.
List prepared transaction JMS details as HTMLLists all the prepared transactions, sorted by date, oldest first, in a HTML format.
List prepared transaction JMS details as JSONLists all the prepared transactions, sorted by date, oldest first, in a JSON format.
List prepared transactionsLists all the prepared transaction, sorted by date, oldest first.
List producers info as JSONFor all sessions, lists information about message producers using JSON serialization.
List remote addressesLists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.
List removeRemove entry from list attribute
List sessionsLists all the sessions IDs for the specified connection ID.
List sessions as JSONLists all the sessions IDs for the specified connection id.
List target destinationsLists all addresses to which the designated session has sent messages.
Map clearClear all entries from map attribute
Map getGet entry from map attribute
Map putAdd entry to map attribute
Map removeRemove entry from map attribute
QueryQuery a resource
Reset all message counter historiesResets all message counters history.
Reset All Message CountersResets all message counters.
Resolve address settingResolve the address settings using ActiveMQ hierarchy of address settings.
Rollback prepared transactionHeuristically rolls back a prepared transaction.
Package Types
none
3.4.1.32.1.1. EAP7 - JMS Queue Service
Overview
Table 3.2730. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2731. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2732. Metrics
NameTypeDescriptionInternal Name
Consumer CountmeasurementThe number of consumers consuming messages from this queue.consumer-count
Dead Letter AddresstraitThe address to send dead messages to.dead-letter-address
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Expiry AddresstraitThe address to send expired messages to.expiry-address
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
PausedtraitWhether the queue is paused.paused
Scheduled CountmeasurementThe number of scheduled messages in this queue.scheduled-count
TemporarytraitWhether the queue is temporary.temporary
Queue AddresstraitThe queue address defines what address is used for routing messages.queue-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2733. 
NameDescriptionRequiredInternal Name
DurableWhether the queue is durable or not. The default value is true. no durable
EntriesThe jndi names the queue will be bound to. yes entries
SelectorThe queue selector. no selector

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2734. Metrics
NameDescription
Change Message PriorityChange the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages PriorityChange the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count MessagesReturns the number of the messages in the queue matching the given filter.
Expire MessageExpire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire MessagesExpire the messages matching the given filter.
List AddAdd entry to list attribute
List ClearClear all entries from list attribute
List Consumers as JSONA string in JSON format.
List Delivering MessagesList the messages are currently being delivered.
List Delivering Messages As JsonList the messages are currently being delivered as a string in JSON format
List GetGet entry from list attribute
List Message Counter as HTMLList the message counter as a string in HTML format.
List Message Counter as JSONList the message counter as a string in JSON format.
List Message Counter History as HTMLList the message counter history.
List Message Counter History as JSONList the message counter history as a string in JSON format.
List MessagesList all messages in the queue that match the filter
List Messages as JSONList all messages in the queue that match the filter and return them as a string in JSON format.
Map ClearClear all entries from map attribute
Map GetGet entry from map attribute
Map PutAdd entry to map attribute
Map RemoveRemove entry from map attribute
Move MessageMove the message corresponding to the given message-id to another queue
Move MessagesMove the messages corresponding to the given filter to another queue.
PausePause the queue.
Remove MessageRemove the message corresponding to the given message-id.
Remove MessagesRemove messages matching the given filter from the destination.
Reset Message CounterReset the message counters.
ResumeResume the queue.
Send Message to Dead Letter AddressSend the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter AddressSend the messages corresponding to the given filter to this queue's Dead Letter Address.
Package Types
none
3.4.1.32.1.2. EAP7 - JMS Topic Service
Overview
Table 3.2735. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2736. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2737. Metrics
NameTypeDescriptionInternal Name
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Durable Message CountmeasurementThe number of messages for all durable subscribers for this topic.durable-message-count
Durable Subscription CountmeasurementThe number of durable subscribers for this topic.durable-subscription-count
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
Non Durable Message CountmeasurementThe number of messages for all non-durable subscribers for this topic.non-durable-message-count
Non Durable Subscription CountmeasurementThe number of non-durable subscribers for this topic.non-durable-subscription-count
Subscription CountmeasurementThe number of (durable and non-durable) subscribers for this topic.subscription-count
TemporarytraitWhether the topic is temporary.temporary
Topic AddresstraitThe address the topic points to.topic-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2738. 
NameDescriptionRequiredInternal Name
JNDI NamesThe jndi names the queue will be bound to. yes entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2739. Metrics
NameDescription
Count Messages for SubscriptionCount the number of messages matching the filter for the given subscription.
Drop All SubscriptionsDrop all subscriptions from this topic.
Drop Durable SubscriptionDrop a durable subscription
List All SubscriptionsList all subscriptions.
List All Subscriptions as JSONList all subscriptions as a string in JSON format.
List Durable SubscriptionsList only the durable subscriptions.
List Durable Subscriptions as JSONList only the durable subscriptions, as a string in JSON format.
List Messages for SubscriptionList all the messages for the given subscription.
List Messages for Subscription as JSONList all the messages for the given subscription as a string in JSON format.
List Non-Durable SubscriptionsList only the non-durable subscriptions.
List Non-Durable Subscriptions as JSONList only the non-durable subscriptions, as a string in JSON format.
Remove MessagesRemove messages matching the given filter from the destination.
Package Types
none
3.4.1.32.1.3. EAP7 - Connection Factory Service
Overview
Table 3.2740. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2741. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2742. 
NameDescriptionRequiredInternal Name
Auto GroupWhether or not message grouping is automatically used. The default value is false. no auto-group
Block On AcknowledgeTrue to set block on acknowledge. The default value is false. no block-on-acknowledge
Block On Durable SendTrue to set block on durable send. The default value is true. no block-on-durable-send
Block On Non Durable SendTrue to set block on non durable send. The default value is false. no block-on-non-durable-send
Cache Large Message ClientTrue to cache large messages. The default value is false. no cache-large-message-client
Call Failover Timeout:exprThe timeout to use when fail over is in process (in ms). The default value is -1. no call-failover-timeout:expr
Call Timeout:exprThe call time out. The default value is 30000. no call-timeout:expr
Client Failure Check Period:exprThe client failure check period. The default value is 30000. no client-failure-check-period:expr
Client IdThe client id. no client-id
Compress Large MessagesWhether large messages should be compressed. The default value is false. no compress-large-messages
Confirmation Window Size:exprThe confirmation window size. The default value is -1. no confirmation-window-size:expr
Connection Load Balancing Policy Class NameName of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. no connection-load-balancing-policy-class-name
Connection Ttl:exprThe connection ttl. The default value is 60000. no connection-ttl:expr
ConnectorsDefines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. no connectors
Consumer Max Rate:exprThe consumer max rate. The default value is -1. no consumer-max-rate:expr
Consumer Window Size:exprThe consumer window size. The default value is 1048576. no consumer-window-size:expr
Discovery GroupThe discovery group name. no discovery-group
Dups Ok Batch Size:exprThe dups ok batch size. The default value is 1048576. no dups-ok-batch-size:expr
EntriesThe jndi names the connection factory should be bound to. yes entries
Factory TypeThe type of connection factory. The default value is GENERIC. no factory-type
Failover On Initial ConnectionTrue to fail over on initial connection. The default value is false. no failover-on-initial-connection
Group IdThe group id. no group-id
HaWhether the connection factory supports High Availability. The default value is false. no ha
Max Retry Interval:exprThe max retry interval. The default value is 2000. no max-retry-interval:expr
Min Large Message Size:exprThe min large message size. The default value is 102400. no min-large-message-size:expr
Pre AcknowledgeTrue to pre-acknowledge. The default value is false. no pre-acknowledge
Producer Max Rate:exprThe producer max rate. The default value is -1. no producer-max-rate:expr
Producer Window Size:exprThe producer window size. The default value is 65536. no producer-window-size:expr
Reconnect Attempts:exprThe reconnect attempts. The default value is 0. no reconnect-attempts:expr
Retry Interval:exprThe retry interval. The default value is 2000. no retry-interval:expr
Retry Interval Multiplier:exprThe retry interval multiplier. The default value is 1.0. no retry-interval-multiplier:expr
Scheduled Thread Pool Max Size:exprThe scheduled thread pool max size. The default value is 5. no scheduled-thread-pool-max-size:expr
Thread Pool Max Size:exprThe thread pool max size. The default value is 30. no thread-pool-max-size:expr
Transaction Batch Size:exprThe transaction batch size. The default value is 1048576. no transaction-batch-size:expr
Use Global PoolsTrue to use global pools. The default value is true. no use-global-pools

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.4. EAP7 - Pooled Connection Factory Service
Overview
Table 3.2743. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2744. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2745. 
NameDescriptionRequiredInternal Name
Auto GroupWhether or not message grouping is automatically used. The default value is false. no auto-group
Block On AcknowledgeTrue to set block on acknowledge. The default value is false. no block-on-acknowledge
Block On Durable SendTrue to set block on durable send. The default value is true. no block-on-durable-send
Block On Non Durable SendTrue to set block on non durable send. The default value is false. no block-on-non-durable-send
Cache Large Message ClientTrue to cache large messages. The default value is false. no cache-large-message-client
Call Failover Timeout:exprThe timeout to use when fail over is in process (in ms). The default value is -1. no call-failover-timeout:expr
Call Timeout:exprThe call time out. The default value is 30000. no call-timeout:expr
Client Failure Check Period:exprThe client failure check period. The default value is 30000. no client-failure-check-period:expr
Client IdThe client id. no client-id
Compress Large MessagesWhether large messages should be compressed. The default value is false. no compress-large-messages
Confirmation Window Size:exprThe confirmation window size. The default value is -1. no confirmation-window-size:expr
Connection Load Balancing Policy Class NameName of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. no connection-load-balancing-policy-class-name
Connection Ttl:exprThe connection ttl. The default value is 60000. no connection-ttl:expr
ConnectorsDefines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. no connectors
Consumer Max Rate:exprThe consumer max rate. The default value is -1. no consumer-max-rate:expr
Consumer Window Size:exprThe consumer window size. The default value is 1048576. no consumer-window-size:expr
Discovery GroupThe discovery group name. no discovery-group
Dups Ok Batch Size:exprThe dups ok batch size. The default value is 1048576. no dups-ok-batch-size:expr
EntriesThe jndi names the connection factory should be bound to. yes entries
Failover On Initial ConnectionTrue to fail over on initial connection. The default value is false. no failover-on-initial-connection
Group IdThe group id. no group-id
HaWhether the connection factory supports High Availability. The default value is false. no ha
Max Retry Interval:exprThe max retry interval. The default value is 2000. no max-retry-interval:expr
Min Large Message Size:exprThe min large message size. The default value is 102400. no min-large-message-size:expr
Pre AcknowledgeTrue to pre-acknowledge. The default value is false. no pre-acknowledge
Producer Max Rate:exprThe producer max rate. The default value is -1. no producer-max-rate:expr
Producer Window Size:exprThe producer window size. The default value is 65536. no producer-window-size:expr
Protocol Manager FactoryThe protocol manager factory used by this connection factory. no protocol-manager-factory
Reconnect Attempts:exprThe reconnect attempts. The default value is 0. no reconnect-attempts:expr
Retry Interval:exprThe retry interval. The default value is 2000. no retry-interval:expr
Retry Interval Multiplier:exprThe retry interval multiplier. The default value is 1.0. no retry-interval-multiplier:expr
Scheduled Thread Pool Max Size:exprThe scheduled thread pool max size. The default value is 5. no scheduled-thread-pool-max-size:expr
Thread Pool Max Size:exprThe thread pool max size. The default value is 30. no thread-pool-max-size:expr
Transaction Batch Size:exprThe transaction batch size. The default value is 1048576. no transaction-batch-size:expr
Use Global PoolsTrue to use global pools. The default value is true. no use-global-pools

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.5. EAP7 - Security Setting Service
Overview
Table 3.2746. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2747. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.32.1.5.1. EAP7 - Role Service
Overview
Table 3.2748. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2749. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2750. 
NameDescriptionRequiredInternal Name
Consumehis permission allows the user to consume a message from a queue bound to matching addresses. The default value is false. yes consume
Create Durable QueueThis permission allows the user to create a durable queue. The default value is false. yes create-durable-queue
Create Non Durable QueueThis permission allows the user to create a temporary queue. The default value is false. yes create-non-durable-queue
Delete Durable QueueThis permission allows the user to delete a durable queue. The default value is false. yes delete-durable-queue
Delete Non Durable QueueThis permission allows the user to delete a temporary queue. The default value is false. yes delete-non-durable-queue
ManageThis permission allows the user to invoke management operations by sending management messages to the management address. The default value is false. yes manage
SendThis permission allows the user to send a message to matching addresses. The default value is false. yes send

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.6. EAP7 - Address Setting Service
Overview
Table 3.2751. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2752. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2753. 
NameDescriptionRequiredInternal Name
Address Full PolicyDetermines what happens when an address where max-size-bytes is specified becomes full. (PAGE, DROP or BLOCK). The default value is PAGE. no address-full-policy
Dead Letter AddressThe dead letter address no dead-letter-address
Expiry AddressDefines where to send a message that has expired. no expiry-address
Last Value QueueDefines whether a queue only uses last values or not. The default value is false. no last-value-queue
Max Delivery AttemptsDefines how many time a cancelled message can be redelivered before sending to the dead-letter-address. The default value is 10. no max-delivery-attempts
Max Size BytesThe max bytes size. The default value is -1. no max-size-bytes
Message Counter History Day LimitDay limit for the message counter history. The default value is 0. no message-counter-history-day-limit
Page Max Cache SizeThe number of page files to keep in memory to optimize IO during paging navigation. The default value is 5. no page-max-cache-size
Page Size BytesThe paging size. The default value is 10485760. no page-size-bytes
Redelivery DelayDefines how long to wait before attempting redelivery of a cancelled message. The default value is 0. no redelivery-delay
Redistribution DelayDefines how long to wait when the last consumer is closed on a queue before redistributing any messages. The default value is -1. no redistribution-delay
Send To Dla On No RouteIf this parameter is set to true for that address, if the message is not routed to any queues it will instead be sent to the dead letter address (DLA) for that address, if it exists. The default value is false. no send-to-dla-on-no-route
Auto Create Jms QueuesDetermines whether ActiveMQ should automatically create a JMS queue corresponding to the address-settings match when a JMS producer or a consumer is tries to use such a queue. no auto-create-jms-queues
Auto Delete Jms QueuesDetermines Whether ActiveMQ should automatically delete auto-created JMS queues when they have no consumers and no messages. no auto-delete-jms-queues
Expiry DelayDefines the expiration time that will be used for messages using the default expiration time. no expiry-delay
Max Redelivery DelayMaximum value for the redelivery-delay (in ms). no max-redelivery-delay
Redelivery MultiplierMultiplier to apply to the redelivery-delay parameter. no redelivery-multiplier

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.7. EAP7 - Grouping Handler Service
Overview
Table 3.2754. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2755. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2756. 
NameDescriptionRequiredInternal Name
Grouping Handler AddressA reference to a cluster connection and the address it uses. yes grouping-handler-address
TimeoutHow long to wait for a handling decision to be made; an exception will be thrown during the send if this timeout is reached, ensuring that strict ordering is kept. The default value is 5000. no timeout
TypeWhether the handler is the single 'Local' handler for the cluster, which makes handling decisions, or a 'Remote' handler which converses with the local handler. no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.8. EAP7 - Acceptor Service
Overview
Table 3.2757. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2758. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2759. Metrics
NameTypeDescriptionInternal Name
StartedtraitWhether this acceptor is started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2760. 
NameDescriptionRequiredInternal Name
Factory ClassThe factory class. yes factory-class
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2761. Metrics
NameDescription
StartStarts the acceptor.
StopStops the acceptor.
Package Types
none
3.4.1.32.1.8.1. EAP7 - Param Service
Overview
Table 3.2762. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2763. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2764. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.9. EAP7 - Connector (ActiveMQ) Service
Overview
Table 3.2765. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2766. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2767. 
NameDescriptionRequiredInternal Name
Factory ClassThe factory class. yes factory-class
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.9.1. EAP7 - Param Service
Overview
Table 3.2768. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2769. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2770. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.10. EAP7 - In VM Acceptor Service
Overview
Table 3.2771. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2772. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2773. Metrics
NameTypeDescriptionInternal Name
StartedtraitWhether it's stopped or started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2774. 
NameDescriptionRequiredInternal Name
Server IdThe server id. yes server-id

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2775. Metrics
NameDescription
StartStarts the acceptor.
StopStops the acceptor.
Package Types
none
3.4.1.32.1.10.1. EAP7 - Param Service
Overview
Table 3.2776. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2777. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2778. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.11. EAP7 - In VM Connector Service
Overview
Table 3.2779. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2780. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2781. 
NameDescriptionRequiredInternal Name
Server IdThe server id. yes server-id

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.11.1. EAP7 - Param Service
Overview
Table 3.2782. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2783. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2784. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.12. EAP7 - Remote Acceptor Service
Overview
Table 3.2785. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2786. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2787. Metrics
NameTypeDescriptionInternal Name
StartedtraitWhether this acceptor is started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2788. 
NameDescriptionRequiredInternal Name
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2789. Metrics
NameDescription
StartStarts the acceptor.
StopStops the acceptor.
Package Types
none
3.4.1.32.1.12.1. EAP7 - Param Service
Overview
Table 3.2790. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2791. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2792. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.13. EAP7 - Remote Connector Service
Overview
Table 3.2793. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2794. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2795. 
NameDescriptionRequiredInternal Name
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.13.1. EAP7 - Param Service
Overview
Table 3.2796. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2797. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2798. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.14. EAP7 - Divert Service
Overview
Table 3.2799. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2800. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2801. 
NameDescriptionRequiredInternal Name
Divert AddressAddress to divert from yes divert-address
ExclusiveWhether the divert is exclusive, meaning that the message is diverted to the new address, and does not go to the old address at all. The default value is false. no exclusive
FilterAn optional filter string. If specified then only messages which match the filter expression specified will be diverted. The filter string follows the ActiveMQ Artemis filter expression syntax described in the ActiveMQ Artemis documentation. no filter
Forwarding AddressAddress to divert to yes forwarding-address
Routing NameRouting name of the divert no routing-name
Transformer Class NameThe name of a class used to transform the message's body or properties before it is diverted. no transformer-class-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.15. EAP7 - Queue Service
Overview
Table 3.2802. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2803. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2804. Metrics
NameTypeDescriptionInternal Name
IdtraitThe id of the queue.id
PausedtraitWhether the queue is paused.paused
TemporarytraitWhether the queue is temporary.temporary

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2805. 
NameDescriptionRequiredInternal Name
DurableDefines whether the queue is durable. The default value is true. no durable
FilterA queue message filter definition. An undefined or empty filter will match all messages. no filter
Queue AddressThe queue address defines what address is used for routing messages. yes queue-address

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2806. Metrics
NameDescription
Change Message PriorityChange the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages PriorityChange the priority of the messages corresponding to the given filter.
Count MessagesReturns the number of the messages in the queue matching the given filter.
Expire MessageExpire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire MessagesExpire the messages matching the given filter.
List Consumers as JSONA string in JSON format.
List Message Counter as HTMLList the message counter as a string in HTML format.
List Message Counter as JSONList the message counter as a string in JSON format.
List Message Counter History as HTMLList the message counter history.
List Message Counter History as JSONList the message counter history as a string in JSON format.
List MessagesList all messages in the queue that match the filter
List Messages as JSONList all messages in the queue that match the filter and return them as a string in JSON format.
List Scheduled MessagesList the messages scheduled for delivery.
List Scheduled Messages as JSONList the messages scheduled for delivery as a string in JSON format.
Move MessageMove the message corresponding to the given message-id to another queue
Move MessagesMove the messages corresponding to the given filter to another queue.
PausePause the queue.
Remove MessageRemove the message corresponding to the given message-id.
Remove MessagesRemove messages matching the given filter from the destination.
Reset Message CounterReset the message counters.
ResumeResume the queue.
Send Message to Dead Letter AddressSend the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter AddressSend the messages corresponding to the given filter to this queue's Dead Letter Address.
Package Types
none
3.4.1.32.1.16. EAP7 - Core Address Service
Overview
Table 3.2807. Overview
Description:A runtime-only resource representing an ActiveMQ address. Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2808. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2809. 
NameDescriptionRequiredInternal Name
Binding NamesThe names of all bindings (both queues and diverts) bound to this address. yes binding-names
Number Of Bytes Per PageThe number of bytes used by each page for this address. yes number-of-bytes-per-page
Number Of PagesThe number of pages used by this address. yes number-of-pages
Queue NamesThe names of the queues associated with the address. yes queue-names
RolesA list of the security roles (name and permissions) associated with the address. yes roles

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.17. EAP7 - Cluster Connection Service
Overview
Table 3.2810. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2811. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2812. Metrics
NameTypeDescriptionInternal Name
Node IdtraitThe node ID used by this cluster connection.node-id
StartedtraitWhether the cluster connection is started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2813. 
NameDescriptionRequiredInternal Name
Call TimeoutThe timeout (in ms) for remote calls made by the cluster connection. The default value is 30000. no call-timeout
Check PeriodThe period (in milliseconds) between client failure check. The default value is 30000. no check-period
Cluster Connection AddressEach cluster connection only applies to messages sent to an address that starts with this value. yes cluster-connection-address
Confirmation Window SizeThe confirmation-window-size to use for the connection used to forward messages to a target node. The default value is 1048576. no confirmation-window-size
Connection TtlThe maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat). The default value is 60000. no connection-ttl
Connector RefThe confirmation-window-size to use for the connection used to forward messages to a target node. yes connector-ref
Discovery Group NameThe discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined. no discovery-group-name
Forward When No ConsumersWhether messages will be distributed round robin between other nodes of the cluster irrespective of whether there are matching or indeed any consumers on other nodes. If this is set to false (the default) then ActiveMQ Artemis will only forward messages to other nodes of the cluster if the address to which they are being forwarded has queues which have consumers, and if those consumers have message filters (selectors) at least one of those selectors must match the message. The default value is false. no forward-when-no-consumers
Max HopsThe maximum number of times a message can be forwarded. ActiveMQ Artemis can be configured to also load balance messages to nodes which might be connected to it only indirectly with other ActiveMQ Artemis servers as intermediates in a chain. The default value is 1. no max-hops
Max Retry IntervalThe maximum interval of time used to retry connections. The default value is 2000. no max-retry-interval
Min Large Message SizeThe minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400. no min-large-message-size
Reconnect AttemptsThe total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1. no reconnect-attempts
Retry IntervalThe period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 500. no retry-interval
Retry Interval MultiplierA multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0. no retry-interval-multiplier
Static ConnectorsThe statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined. no static-connectors:nullable
Use Duplicate DetectionWhether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. no use-duplicate-detection

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2814. Metrics
NameDescription
Get NodesReturns a map of the nodes connected to this cluster connection, where keys are node IDs and values are the addresses used to connect to the nodes.
StartStarts the cluster connection.
StopStops the cluster connection.
Package Types
none
3.4.1.32.1.18. EAP7 - Broadcast Group Service
Overview
Table 3.2815. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2816. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2817. Metrics
NameTypeDescriptionInternal Name
StartedtraitWhether the broadcast group is started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2818. 
NameDescriptionRequiredInternal Name
Broadcast PeriodThe period in milliseconds between consecutive broadcasts. The default value is 2000. no broadcast-period
ConnectorsSpecifies the names of connectors that will be broadcast. no connectors
Socket BindingThe broadcast group socket binding. yes socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2819. Metrics
NameDescription
Get Connector Pairs as JSONReturns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization.
StartStarts the broadcast group.
StopStops the broadcast group.
Package Types
none
3.4.1.32.1.19. EAP7 - Path Service
Overview
Table 3.2820. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2821. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2822. 
NameDescriptionRequiredInternal Name
PathThe actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.
If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:
If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.
yes path
Relative ToThe 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. The standard paths provided by the system include:
  • jboss.home - the root directory of the JBoss AS distribution
  • user.home - user's home directory
  • user.dir - user's current working directory
  • java.home - java installation directory
  • jboss.server.base.dir - root directory for an individual server instance
  • jboss.server.data.dir - directory the server will use for persistent data file storage
  • jboss.server.log.dir - directory the server will use for log file storage
  • jboss.server.tmp.dir - directory the server will use for temporary file storage
  • jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances
no relative-to
Path TypePath Type yes __name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.20. EAP7 - Bridge Service
Overview
Table 3.2823. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2824. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2825. Metrics
NameTypeDescriptionInternal Name
StartedtraitWhether the bridge is started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2826. 
NameDescriptionRequiredInternal Name
Check PeriodThe period (in milliseconds) between client failure check. The default value is 30000. no check-period
Confirmation Window SizeThe confirmation-window-size to use for the connection used to forward messages to the target node. The default value is 1048576. no confirmation-window-size
Connection TtlThe maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat). The default value is 60000. no connection-ttl
Discovery Group NameThe name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined. no discovery-group-name
Failover On Server ShutdownWhether the bridge will attempt to failover onto a backup server (if specified) when the target server is cleanly shutdown rather than crashed. no failover-on-server-shutdown
FilterAn optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the ActiveMQ Artemis filter expression syntax described in the ActiveMQ Artemis documentation. no filter
Forwarding AddressThe address on the target server that the message will be forwarded to. If a forwarding address is not specified then the original destination of the message will be retained. no forwarding-address
HaWhether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover. The default value is false. no ha
Max Retry IntervalThe maximum interval of time used to retry connections. The default value is 2000. no max-retry-interval
Min Large Message SizeThe minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400. no min-large-message-size
PasswordThe password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used. The default value is CHANGE ME!!. no password
Queue NameThe unique name of the local queue that the bridge consumes from. yes queue-name
Reconnect AttemptsThe total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1. no reconnect-attempts
Retry IntervalThe period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 2000. no retry-interval
Retry Interval MultiplierA multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0. no retry-interval-multiplier
Static ConnectorsA list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined. no static-connectors:nullable
Transformer Class NameThe name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface. no transformer-class-name
Use Duplicate DetectionWhether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. no use-duplicate-detection
UserThe user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used. The default value is ACTIVEMQ.CLUSTER.ADMIN.USER. no user

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2827. Metrics
NameDescription
StartStarts the bridge.
StopStops the bridge.
Package Types
none
3.4.1.32.1.21. EAP7 - Discovery Group Service
Overview
Table 3.2828. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2829. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2830. 
NameDescriptionRequiredInternal Name
Initial Wait TimeoutPeriod, in ms, to wait for an initial broadcast to give us at least one node in the cluster. The default value is 10000. no initial-wait-timeout
Refresh TimeoutPeriod the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list. The default value is 10000. no refresh-timeout
Socket BindingThe discovery group socket binding. yes socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.22. EAP7 - Connector Service
Overview
Table 3.2831. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2832. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2833. 
NameDescriptionRequiredInternal Name
Factory ClassClass name of the factory class that can instantiate the connector service. yes factory-class

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.22.1. EAP7 - Param Service
Overview
Table 3.2834. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2835. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2836. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.32.1.23. EAP7 - Runtime Queue Service
Overview
Table 3.2837. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2838. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2839. Metrics
NameTypeDescriptionInternal Name
Consumer CountmeasurementThe number of consumers consuming messages from this queue.consumer-count
Dead Letter AddresstraitThe address to send the queue's dead messages to.dead-letter-address
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
DurabletraitDefines whether the queue is durable.durable
Expiry AddresstraitThe address to send the queue's expired messages to.expiry-address
FiltertraitA queue message filter definition. An undefined or empty filter will match all messages.filter
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
PausedtraitWhether the queue is paused.paused
Queue AddresstraitThe queue address defines what address is used for routing messages.queue-address
Scheduled CountmeasurementThe number of scheduled messages in this queue.scheduled-count
TemporarytraitWhether the queue is temporary.temporary

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.2840. Metrics
NameDescription
List Scheduled Messages as JSONList the messages scheduled for delivery as a string in JSON format.
List Messages as JSONList all messages in the queue that match the filter and return them as a string in JSON format.
Count MessagesReturns the number of the messages in the queue matching the given filter.
List Consumers as JSONLists consumers.
Change Messages PriorityChange the priority of the messages corresponding to the given filter.
PausePause the queue.
List Message Counter History as JSONList the message counter history as a string in JSON format.
Expire MessagesExpire the messages matching the given filter.
List MessagesList all messages in the queue that match the filter
Send message To Dead Letter AddressSend the message corresponding to the given message-id to this queue's Dead Letter Address.
Reset Message CountersReset the message counters.
Move MessageMove the message corresponding to the given message-id to another queue
Expire MessageExpire the message corresponding to the given message-id.
List Message Counter as JSONList the message counter as a string in JSON format.
List Message Counter as HTMLList the message counter as a string in HTML format.
Remove MessagesRemove messages matching the given filter from the destination.
Move MessagesMove the messages corresponding to the given filter to another queue.
List Message Counter as HTMLList the message counter history.
List Scheduled MessagesList the messages scheduled for delivery.
ResumeResume the queue.
Send Messages to Dead Letter AddressSend the messages corresponding to the given filter to this queue's Dead Letter Address.
Remove MessageRemove the message corresponding to the given message-id.
Change Message PriorityChange the priority of the message corresponding to the given message-id.
Package Types
none

3.4.2. EAP7 - Host Controller Server

Overview

Table 3.2841. Overview
Description:Domain controller (delegate) for this host
Singleton: no
Plugin:EAP7

Note

The server can be started, restarted, or stopped via the Start, Restart, and Shutdown operations. The Start and Restart operations start the server by executing the server start script, typically domain.sh on UNIX or domain.bat on Windows. The following connection settings can be used to configure the start script execution: * Start Script - the absolute path of the start script (e.g. "/opt/jboss-as-7.1.1.Final/bin/domain.sh") * Start Script Prefix - a prefix command line to be prepended to the start script command line (e.g. "nohup sudo -u jboss -g jboss") * Start Script Arguments - arguments to be passed to the start script (e.g. "--host-config=host-master.xml") * Start Script Environment - environment variables to be set in the start script's environment (e.g. "JAVA_HOME=/usr/java/jdk1.6.0_30") These settings are automatically initialized by the EAP7 plugin discovery code to match the currently running server process' command line and environment. The settings are not used by the Stop operation, since it stops the server via the management interface, not via a script. For more detailed descriptions of the settings, see the Connection Settings section below.

Child Resource Types

Autodiscovery Process Scans

Table 3.2842. Metrics
NameQuery
HostControllerprocess|basename|match=^java.*,arg|org.jboss.as.host-controller|match=.*

Connection Properties

Table 3.2843. 
NameDescriptionRequiredInternal Name
Start Script PathThe path to the script that the Start and Restart operations should use to start the server. If the path is not absolute, it is resolved relative to the server home directory (e.g. "bin/standalone.sh", "bin/domain.sh"). no startScript
Start Script PrefixA prefix command line that should be prepended to the start script command line by the Start and Restart operations; the prefix command must be an absolute path (e.g. "/usr/bin/sudo"). This property is most commonly used to run the AS7 process as a different user than the RHQ Agent (e.g. "sudo -u jboss -g jboss" could be used to run AS7 as user "jboss" and group "jboss". It is also possible to chain prefix commands (e.g. "nohup sudo -u jboss" could be used to make AS7 ignore HUP signals and to run as user "jboss"). no startScriptPrefix
Start Script Environment VariablesThe variables that the Start and Restart operations will add to the environment of the server start script. Each name=value pair should be on a new line. Variable values should *not* be enclosed in quotes (e.g. JAVA_OPTS=-Xms512M -Xmx1024M). On UNIX systems, the typical minimum set of environment variables is: PATH=/usr/bin:/bin . And on Windows the typical minimum set is: PATH=C:\Windows\System32;C:\Windows , OS=Windows_NT , SYSTEMROOT=C:\Windows . In addition, it is good practice to set JAVA_HOME to the absolute path of the install directory of the JRE or JDK you wish to use to run the AS7 instance. However, if JAVA_HOME is not specified, the start script will attempt to find java in the PATH. There is currently a 2000 character limit for this value. no startScriptEnv
Start Script ArgumentsThe arguments that the Start and Restart operations will pass to the server start script. Each argument should be on a new line - for example: --server-config=standalone-ha-full.xml. As an exception, the value of a space-delimited option can optionally be on the same line as the option - for example: -c standalone-ha-full.xml. There is currently a 2000 character limit for this value. no startScriptArgs
CLI Local AuthenticationSpecifies if the local authentication should be used to interact with the EAP CLI (this includes bundle:handover feature, EAP patching and CLI operations). If this is set to "Yes", User and Password supplied above are NOT going to be passed to jboss-cli binary and plugin relies on local authentication. no nativeLocalAuth
Log Event Sources  yes logEventSources
Trust StrategyDefines the trust strategy to use when reading the server certificate:
  • Standard: standard verification using a truststore
  • Trust Self-signed: trust self-signed certificates (certification chain size equals to 1)
  • Trust Any: trust any server certificate
yes trustStrategy
Hostname VerificationDefines the hostname verification logic:
  • Strict: The hostname must match either the first CN, or any of the Subject Alternatives. A wildcard can occur in the CN, and in any of the Subject Alternatives.
  • Browser-compatible: same as Strict, except that it allows nested subdomains validation with wildcards.
  • Skip: no hostname verification
yes hostnameVerification
TruststorePath to a truststore file. If undefined, the JVM default truststore is used. no truststore
Truststore TypeTruststore file format (required when the Truststore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats. no truststoreType
Truststore PasswordPassword protecting the truststore file. no truststorePassword
Client Certificate Authentication  yes clientcertAuthentication
KeystorePath to a keystore file. Required when Client Certificate Authentication is on. no keystore
Keystore TypeKeystore file format (required when the Keystore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats. no keystoreType
Keystore PasswordPassword protecting the keystore file. no keystorePassword
Key PasswordPassword protecting the secret key in the keystore file. no keyPassword
HostnameHost name of the domain API yes hostname
PortPort of the domain API yes port
SecureEncrypted transport indicator yes secure
UserManagement user for a secured Host controller no user
PasswordPassword for the management user no password
Management Connection TimeoutMaximum time in milliseconds to keep alive an idle management connection. Zero and negative values will disable connection persistence. Defaults to 5000 ms. no managementConnectionTimeout
Home DirectoryRoot directory of the server installation no homeDir
Base DirectoryBase directory for server content no baseDir
Configuration DirectoryBase configuration directory no configDir
Log Directorythe directory where log files will be written for this host controller no logDir
Domain HostHost name within the AS7 domain (Deprecated, use 'name' trait) no domainHost
Product TypeServer product type (e.g. AS or EAP) no productType

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 3.2844. Metrics
NameTypeDescriptionInternal Name
Number of management requestsmeasurementNumber of requests sent to the controller_internal:mgmtRequests
Number of management requests per MinutemeasurementNumber of requests sent to the controller_internal:mgmtRequests
Time used for management requestsmeasurementTotal time for requests_internal:requestTime
Time used for management requests per MinutemeasurementTotal time for requests_internal:requestTime
Maximum request timemeasurementMax time for a request since last metric get_internal:maxTime
Server Code NametraitServer Code Name_skm:release-codename
Server VersiontraitServer Version_skm:release-version
Product NametraitProduct Name_skm:product-name
Product VersiontraitProduct Version_skm:product-version
Start time of the servertraitStart time of the serverstartTime
Domain Config FiletraitThe name of the domain configuration file this host controller is usingdomain-config-file
Host Config FiletraitThe name of the host configuration file this host controller is usinghost-config-file
Domain Host NametraitThe name of the host in domain this host controller is usingdomain-host-name
Domain NametraitThe name of the managed domain this Host Controller belongs to.domain-name
Temporary DirectorytraitThe temporary directory (usually 'domain/tmp'). May serve as deployment directory for handover bundles'domain-temp-dir
Active PatchestraitThe comma-separated list of patches that are currently applied to the server. The first entry is always the cumulative patch, followed by 0 or more one-off patches.active-patches

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 3.2845. 
NameDescriptionRequiredInternal Name
Properties  no *2
PathThe standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances no *3
Installed extensions  no *
Domain NameName of the managed domain. This value is same for all HostControllers in domain, but only DomainController resource is allowed to update it. yes name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 3.2846. Metrics
NameDescription
Start this host controllerStart this Host/Domain Controller with all its enabled managed servers
Shut down this host controllerStop this Host/Domain Controller with all its managed servers
Restart this host controllerRestart this Host/Domain Controller with all its running managed servers
Install a management userInstalls a user in the server for management
Execute CLI commandsExecutes command via jboss-cli
Execute CLI scriptExecutes script via jboss-cli
Setup CLISetup jboss-cli.xml configuration file based on pluginConfiguration properties. Note that jboss-cli.xml was introduced in EAP 6.2 and this operation will fail for previous versions.

Package Types

none

3.4.2.1. EAP7 - ServerGroup Service

Overview
Table 3.2847. Overview
Description:A server group on this domain
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2848. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2849. 
NameDescriptionRequiredInternal Name
Properties  no *2
ProfileThe profile name yes profile
Socket Binding Group  yes socket-binding-group
Socket Binding Port OffsetThe default offset to be added to the port values given by the socket binding group. no socket-binding-port-offset

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2850. Metrics
NameDescription
Start ServersStarts all configured servers belonging to the server group in the domain that are not currently running.
Restart ServersRestarts all servers belonging to the server group currently running in the domain.
Stop ServersStops all servers belonging to the server group currently running in the domain.
Package Types
none
3.4.2.1.1. EAP7 - JVM Definition Service
Overview
Table 3.2851. Overview
Description:A JVM definition that can override host and server group level definitions with the same name
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2852. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2853. 
NameDescriptionRequiredInternal Name
Base DefinitionThe definition from host level to use/override yes baseDefinition
Agent LibThe JVM agent lib. no agent-lib
Agent PathThe JVM agent path. no agent-path
Env Classpath IgnoredIgnore the environment classpath. no env-classpath-ignored
Environment VariablesThe JVM environment variables. no environment-variables
Heap SizeThe initial heap size allocated by the JVM. no heap-size
Java AgentThe java agent. no java-agent
Java HomeThe java home no java-home
Jvm OptionsThe JVM options. Those can not be changed after initial creation of the definition. no jvm-options
Max Heap SizeThe maximum heap size that can be allocated by the JVM. no max-heap-size
Max Permgen SizeThe maximum size of the permanent generation. no max-permgen-size
Permgen SizeThe initial permanent generation size. no permgen-size
Stack SizeThe JVM stack size settings. no stack-size
TypeThe JVM type can be either SUN or IBM no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.2.2. EAP7 - Host Service

Overview
Table 3.2854. Overview
Description:A host involved in this domain
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2855. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2856. Metrics
NameTypeDescriptionInternal Name
Host statetraitDetailed host statehost-state
Start time of the servertraitStart time of the serverstartTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2857. 
NameDescriptionRequiredInternal Name
Properties  no *2
PathThe standard paths provided by the system include: jboss.home - the root directory of the JBoss AS distribution; user.home - user's home directory; user.dir - user's current working directory; java.home - java installation directory; jboss.server.base.dir - root directory for an individual server instance; jboss.server.data.dir - directory the server will use for persistent data file storage; jboss.server.log.dir - directory the server will use for log file storage; jboss.server.tmp.dir - directory the server will use for temporary file storage; jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances no *3

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.2.1. EAP7 - Network Interface Service
Overview
Table 3.2858. Overview
Description:A named network interface, along with required criteria for determining the IP address to associate with that interface
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2859. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2860. 
NameDescriptionRequiredInternal Name
Any AddressAttribute indicating that sockets using this interface should be bound to a wildcard address. The IPv6 wildcard address (::) will be used unless the java.net.preferIpV4Stack system property is set to true, in which case the IPv4 wildcard address (0.0.0.0) will be used. If a socket is bound to an IPv6 anylocal address on a dual-stack machine, it can accept both IPv6 and IPv4 traffic; if it is bound to an IPv4 (IPv4-mapped) anylocal address, it can only accept IPv4 traffic. no any-address
Link Local AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no link-local-address
LoopbackAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no loopback
Loopback AddressAttribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no loopback-address
MulticastAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no multicast
NicAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection. no nic
Nic MatchAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection. no nic-match
Point To PointAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no point-to-point
Public AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no public-address
Site Local AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no site-local-address
Subnet MatchAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in 'slash notation'; e.g. '192.168.0.0/16'. An 'undefined' value means this attribute is not relevant to the IP address selection. no subnet-match
UpAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no up
VirtualAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no virtual
Inet AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either a IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection. no inet-address

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.2.2. EAP7 - JVM Service
Overview
Table 3.2861. Overview
Description:Information about the underlying JVM
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2862. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.2.2.1. EAP7 - Operating System Service
Overview
Table 3.2863. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2864. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2865. Metrics
NameTypeDescriptionInternal Name
Available ProcessorsmeasurementThe number of processors available to the Java virtual machine.available-processors
System Load AveragemeasurementThe system load average for the last minute. The load average may not be available on some platforms; if the load average is not available, a negative value is returned.system-load-average

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.2.2.2. EAP7 - Memory Service
Overview
Table 3.2866. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2867. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2868. Metrics
NameTypeDescriptionInternal Name
Object Pending Finalization CountmeasurementThe approximate number of objects for which finalization is pending.object-pending-finalization-count
Initial heap usagemeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.heap-memory-usage:init
Used heapmeasurementThe amount of used memory in bytes.heap-memory-usage:used
Committed heapmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.heap-memory-usage:committed
Maximum heap usagemeasurementThe maximum amount of memory in bytes that can be used for memory management.heap-memory-usage:max
Initial non-heap usagemeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.non-heap-memory-usage:init
Used non-heap memorymeasurementThe amount of used memory in bytes.non-heap-memory-usage:used
Committed non-heap memorymeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.non-heap-memory-usage:committed
Maximum non-heap usagemeasurementThe maximum amount of memory in bytes that can be used for memory management.non-heap-memory-usage:max

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.2869. Metrics
NameDescription
Trigger GCRuns the garbage collector.
Package Types
none
3.4.2.2.2.3. EAP7 - Runtime Service
Overview
Table 3.2870. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2871. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2872. Metrics
NameTypeDescriptionInternal Name
UptimemeasurementThe uptime of the Java virtual machine in milliseconds.uptime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.2.2.4. EAP7 - Threading Service
Overview
Table 3.2873. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2874. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2875. Metrics
NameTypeDescriptionInternal Name
Thread CountmeasurementThe current number of live threads including both daemon and non-daemon threads.thread-count
Peak Thread CountmeasurementThe peak live thread count since the Java virtual machine started or peak was reset.peak-thread-count
Total Started Thread CountmeasurementThe total number of threads created and also started since the Java virtual machine started.total-started-thread-count
Daemon Thread CountmeasurementThe current number of live daemon threads.daemon-thread-count
Current Thread Cpu TimemeasurementThe total CPU time for the current thread in nanoseconds, or -1 if 'thread-cpu-time-enabled' is 'false'. A Java virtual machine implementation may not support CPU time measurement. If 'thread-cpu-time-supported', is 'false' undefined.current-thread-cpu-time
Current Thread User TimemeasurementThe CPU time that the current thread has executed in user mode in nanoseconds, or -1 if 'thread-cpu-time-enabled' is 'false'. A Java virtual machine implementation may not support CPU time measurement. If 'thread-cpu-time-supported', is 'false' the result will be undefined current-thread-user-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2876. 
NameDescriptionRequiredInternal Name
Thread Contention Monitoring EnabledWhether thread contention monitoring is enabled. no thread-contention-monitoring-enabled
Thread Cpu Time EnabledWhether thread CPU time measurement is enabled. no thread-cpu-time-enabled
Thread Contention Monitoring SupportedWhether the Java virtual machine supports thread contention monitoring. no thread-contention-monitoring-supported
Thread Cpu Time SupportedWhether the Java virtual machine implementation supports CPU time measurement for any thread. no thread-cpu-time-supported
Current Thread Cpu Time SupportedWhether the Java virtual machine supports CPU time measurement for the current thread. no current-thread-cpu-time-supported
Object Monitor Usage SupportedWhether the Java virtual machine supports monitoring of object monitor usage. no object-monitor-usage-supported
Synchronizer Usage SupportedWhether the Java virtual machine supports monitoring of ownable synchronizer usage. no synchronizer-usage-supported

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2877. Metrics
NameDescription
Dump All ThreadsReturns the thread info for all live threads with stack trace and synchronization information.
Find Deadlocked ThreadsFinds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.
Find Monitor Deadlocked ThreadsFinds cycles of threads that are in deadlock waiting to acquire object monitors.
Get Thread Cpu TimeReturns the total CPU time for a thread of the specified ID in nanoseconds.
Get Thread InfoReturns the thread info for a thread of the specified id. The stack trace, locked monitors, and locked synchronizers in the returned reply object will be empty.
Get Thread InfosReturns the thread info for each thread whose ID is in the input list.
Get Thread User TimeReturns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds.
Reset Peak Thread CountResets the peak thread count to the current number of live threads.
Get All thread idsGet all live thread IDs. If a security manager is installed and the caller does not have ManagementPermission('monitor'), the result will be undefined.
Package Types
none
3.4.2.2.2.5. EAP7 - Garbage Collector Service
Overview
Table 3.2878. Overview
Description:Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2879. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.2.2.5.1. EAP7 - Garbage Collector Resource Service
Overview
Table 3.2880. Overview
Description:The management interface for one of the garbage collectors in the Java virtual machine.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2881. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2882. Metrics
NameTypeDescriptionInternal Name
Collection CountmeasurementThe total number of collections that have occurred.collection-count
Collection Count per MinutemeasurementThe total number of collections that have occurred.collection-count
Collection TimemeasurementThe approximate accumulated collection elapsed time in milliseconds.collection-time
Collection Time per MinutemeasurementThe approximate accumulated collection elapsed time in milliseconds.collection-time
NametraitThe name representing this garbage collectorname
ValidtraitWhether this this memory manager is valid in the Java virtual machine.valid

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2883. 
NameDescriptionRequiredInternal Name
Memory Pool NamesThe name of memory pools that this garbage collector manages. yes memory-pool-names

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.2.2.6. EAP7 - Memory Pool Service
Overview
Table 3.2884. Overview
Description:Parent resource for the resources providing the management interface for the Java virtual machine's memory pools.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2885. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.2.2.6.1. EAP7 - Memory Pool Resource Service
Overview
Table 3.2886. Overview
Description:The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2887. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2888. Metrics
NameTypeDescriptionInternal Name
Collection Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.collection-usage:init
Collection Usage - UsedmeasurementThe amount of used memory in bytes.collection-usage:used
Collection Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.collection-usage:committed
Collection Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.collection-usage:max
Collection Usage Threshold CountmeasurementThe number of times that the Java virtual machine has detected that the memory usage has reached or exceeded the collection usage threshold. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.collection-usage-threshold-count
Collection Usage Threshold ExceededtraitWhether the memory usage of this memory pool after the most recent collection on which the Java virtual machine has expended effort has reached or exceeded its collection usage threshold. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.collection-usage-threshold-exceeded
Collection Usage Threshold SupportedtraitWhether this memory pool supports a collection usage threshold.collection-usage-threshold-supported
NametraitThe name representing this memory pool.name
Peak Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.peak-usage:init
Peak Usage - UsedmeasurementThe amount of used memory in bytes.peak-usage:used
Peak Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.peak-usage:committed
Peak Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.peak-usage:max
TypetraitThe type of this memory pool.type
Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.usage:init
Usage - UsedmeasurementThe amount of used memory in bytes.usage:used
Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.usage:committed
Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.usage:max
Usage Threshold CountmeasurementThe number of times that the memory usage has crossed the usage threshold. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.usage-threshold-count
Usage Threshold ExceededtraitWhether the memory usage of this memory pool reaches or exceeds its usage threshold value. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.usage-threshold-exceeded
Usage Threshold SupportedtraitWhether this memory pool supports usage threshold.usage-threshold-supported
ValidtraitWhether this memory pool is valid in the Java virtual machine. A memory pool becomes invalid once the Java virtual machine removes it from the memory system.valid

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2889. 
NameDescriptionRequiredInternal Name
Collection Usage ThresholdThe collection usage threshold value of this memory pool in bytes. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'. no collection-usage-threshold
Memory Manager NamesThe names of the memory managers that manage this memory pool. yes memory-manager-names
Usage ThresholdThe usage threshold value of this memory pool in bytes. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'. no usage-threshold

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2890. Metrics
NameDescription
Reset Peak UsageResets the peak memory usage statistic of this memory pool to the current memory usage.
Package Types
none
3.4.2.2.3. EAP7 - JVM Definition (Host) Service
Overview
Table 3.2891. Overview
Description:A JVM Definition on Host level, that can serve as templates for server groups and managed servers
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2892. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2893. 
NameDescriptionRequiredInternal Name
Agent LibThe JVM agent lib. no agent-lib
Agent PathThe JVM agent path. no agent-path
Env Classpath IgnoredIgnore the environment classpath. no env-classpath-ignored
Environment VariablesThe JVM environment variables. no environment-variables
Heap SizeThe initial heap size allocated by the JVM. no heap-size
Java AgentThe java agent. no java-agent
Java HomeThe java home no java-home
Jvm OptionsThe JVM options. Those can not be changed after initial creation of the definition. no jvm-options
Max Heap SizeThe maximum heap size that can be allocated by the JVM. no max-heap-size
Max Permgen SizeThe maximum size of the permanent generation. no max-permgen-size
Permgen SizeThe initial permanent generation size. no permgen-size
Stack SizeThe JVM stack size settings. no stack-size
TypeThe JVM type can be either SUN or IBM no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.2.3. EAP7 - DomainDeployment Service

Overview
Table 3.2894. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2895. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2896. 
NameDescriptionRequiredInternal Name
Name  yes name
Runtime Name  yes runtime-name
Content  yes content
Assigned to  yes *1

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2897. Metrics
NameDescription
Assign to Server-GroupDeprecated: Use server-group property found in resource configuration instead
Restart in Server-GroupRestarts this deployment in one or all assigned server group(s)
Package Types
Table 3.2898. Package Types
NameCategoryDescription
FileDeployableDeployments on this domain

3.4.2.4. EAP7 - Managed Server

Overview
Table 3.2899. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
Autodiscovery Process Scans
none
Connection Properties
Table 3.2900. 
NameDescriptionRequiredInternal Name
Log Event Sources  yes logEventSources
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2901. Metrics
NameTypeDescriptionInternal Name
Server Code NametraitServer Code Name_skm:release-codename
Server VersiontraitServer Version_skm:release-version
Product NametraitProduct Name_skm:product-name
Product VersiontraitProduct Version_skm:product-version
Server statetraitDetailed server statestatus
Start time of the servertraitStart time of the serverstartTime
JGroups Multicast Addresstraitthe host and port used by JGroups for multicastmulticastAddress

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2902. 
NameDescriptionRequiredInternal Name
Properties  no *2
Name of the host to put the server on  yes hostname
Server GroupServer Group this instance belongs to. yes group
Socket binding groupSocket bindings to use yes socket-binding-group
Port OffsetOffset to the base ports yes socket-binding-port-offset
AutostartWhether or not this server should be started when the Host Controller starts. yes auto-start

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2903. Metrics
NameDescription
StartStart this server instance.
StopStop this server instance.
RestartRestart this server instance.
Package Types
none
3.4.2.4.1. EAP7 - ManagedServerDeployment Service
Overview
Table 3.2904. Overview
Description:Deployed package on a managed server. Go to corresponding DomainDeployment to manipulate it
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.2905. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2906. Metrics
NameTypeDescriptionInternal Name
StatustraitThe current runtime status of a deployment. Possible status modes are OK, FAILED, and STOPPED. FAILED indicates a dependency is missing or a service could not start. STOPPED indicates that the deployment was manually stopped.status

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2907. 
NameDescriptionRequiredInternal Name
Name  yes name
Runtime Name  yes runtime-name
Content  yes content

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.1. EAP7 - EJB3 Runtime Service
Overview
Table 3.2908. Overview
Description:Runtime resources exposed by EJBs components included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2909. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.1.1. EAP7 - Message Driven Bean Runtime Service
Overview
Table 3.2910. Overview
Description:Bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2911. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2912. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2913. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.1.2. EAP7 - Singleton Bean Runtime Service
Overview
Table 3.2914. Overview
Description:Singleton bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2915. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2916. Metrics
NameTypeDescriptionInternal Name
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2917. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.1.3. EAP7 - Stateless Session Bean Runtime Service
Overview
Table 3.2918. Overview
Description:Stateless session bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2919. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2920. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2921. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.1.4. EAP7 - Entity Bean Runtime Service
Overview
Table 3.2922. Overview
Description:Entity bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2923. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2924. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2925. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.1.5. EAP7 - Stateful Session Bean Runtime Service
Overview
Table 3.2926. Overview
Description:Stateful session bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2927. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2928. Metrics
NameTypeDescriptionInternal Name
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2929. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.2. EAP7 - Subdeployment Service
Overview
Table 3.2930. Overview
Description:Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2931. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.1. EAP7 - EJB3 Runtime Service
Overview
Table 3.2932. Overview
Description:Runtime resources exposed by EJBs components included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2933. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.1.1. EAP7 - Message Driven Bean Runtime Service
Overview
Table 3.2934. Overview
Description:Bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2935. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2936. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2937. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.2.1.2. EAP7 - Singleton Bean Runtime Service
Overview
Table 3.2938. Overview
Description:Singleton bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2939. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2940. Metrics
NameTypeDescriptionInternal Name
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2941. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.2.1.3. EAP7 - Stateless Session Bean Runtime Service
Overview
Table 3.2942. Overview
Description:Stateless session bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2943. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2944. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2945. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain
TimersEJB timers associated with the component. yes timers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.2.1.4. EAP7 - Entity Bean Runtime Service
Overview
Table 3.2946. Overview
Description:Entity bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2947. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2948. Metrics
NameTypeDescriptionInternal Name
Pool Available CountmeasurementThe number of available (i.e. not in use) instances in the pool.pool-available-count
Pool Create CountmeasurementThe number of instances created for the pool.pool-create-count
Pool Current SizemeasurementThe current size of the instance pool.pool-current-size
Pool Max SizemeasurementThe maximum size of the instance pool.pool-max-size
Pool Remove CountmeasurementThe number of instances removed from the pool.pool-remove-count
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2949. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.2.1.5. EAP7 - Stateful Session Bean Runtime Service
Overview
Table 3.2950. Overview
Description:Stateful session bean component included in the deployment.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2951. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2952. Metrics
NameTypeDescriptionInternal Name
Peak concurrent invocationsmeasurementThe maximum number of concurrent invocations at any given time.peak-concurrent-invocations
InvocationsmeasurementThe total number of invocations made on this EJB.invocations
Invocations per MinutemeasurementNumber of invocations processed.invocations
Wait TimemeasurementTotal sum of wait-time for all methods in milliseconds.wait-time
Execution TimemeasurementTotal execution-time (sum of all execution-time from all of the methods) in millisecondsexecution-time
Execution Time per MinutemeasurementTime spent within a bean methodexecution-time
Method Execution TimecalltimeThe execution times of individual methods on a bean. Note that you need to enable statistics at server level in the ejb3 subsystem__calltime:execution-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2953. 
NameDescriptionRequiredInternal Name
Component Class NameThe component's class name. no component-class-name
Declared RolesThe roles declared (via @DeclareRoles) on this EJB component. yes declared-roles
Run As RoleThe run-as role (if any) for this EJB component. no run-as-role
Security DomainThe security domain for this EJB component. no security-domain

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.2.2. EAP7 - Resource Adapters Runtime Service
Overview
Table 3.2954. Overview
Description:Configuration of the resource adapters subsystem.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2955. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.2.1. EAP7 - Connection Definition Runtime Service
Overview
Table 3.2956. Overview
Description:Specifies the connection definitions.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2957. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2958. Metrics
NameTypeDescriptionInternal Name
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.3. EAP7 - Web Runtime Service
Overview
Table 3.2959. Overview
Description:Runtime resources exposed by web components in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2960. 
NameDescriptionRequiredInternal Name
Response Time Log Filethe full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludesa space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transformsa space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2961. Metrics
NameTypeDescriptionInternal Name
Virtual Hosttraitthe virtual host this webapp is deployed tovirtual-host
Context Roottraitthe context root of this webappcontext-root
ServertraitThe name of server this application belongs toserver
Response Timecalltimethe minimum, maximum, and average response times for requests serviced by this webappresponseTime
Currently Active SessionsmeasurementThe number of sessions that are currently activeactive-sessions
Expired SessionsmeasurementThe number of expired sessionsexpired-sessions
Expired Sessions per MinutemeasurementThe number of expired sessionsexpired-sessions
Maximum Active SessionsmeasurementThe maximum number of sessions that have been activemax-active-sessions
Rejected SessionsmeasurementThe number of sessions rejectedrejected-sessions
Rejected Sessions per MinutemeasurementThe number of sessions rejectedrejected-sessions
Average Session Alive TimemeasurementThe average alive time of sessionssession-avg-alive-time
Max Session Alive TimemeasurementThe maximum alive time of sessionssession-max-alive-time
Created SessionsmeasurementThe number of sessions createdsessions-created
Created Sessions per MinutemeasurementThe number of sessions createdsessions-created

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.4. EAP7 - JPA Runtime Service
Overview
Table 3.2962. Overview
Description:The configuration of the JPA subsystem.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2963. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.4.1. EAP7 - Hibernate Persistence Unit Service
Overview
Table 3.2964. Overview
Description:Runtime information about JPA use in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2965. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2966. Metrics
NameTypeDescriptionInternal Name
Close Statement CountmeasurementNumber of released prepared statements.close-statement-count
Close Statement Count per MinutemeasurementNumber of released prepared statements.close-statement-count
Collection Fetch CountmeasurementNumber of collections fetched.collection-fetch-count
Collection Fetch Count per MinutemeasurementNumber of collections fetched.collection-fetch-count
Collection Load CountmeasurementNumber of collections loaded.collection-load-count
Collection Load Count per MinutemeasurementNumber of collections loaded.collection-load-count
Collection Recreated CountmeasurementNumber of collections recreated.collection-recreated-count
Collection Recreated Count per MinutemeasurementNumber of collections recreated.collection-recreated-count
Collection Remove CountmeasurementNumber of collections removed.collection-remove-count
Collection Remove Count per MinutemeasurementNumber of collections removed.collection-remove-count
Collection Update CountmeasurementNumber of collections updated.collection-update-count
Collection Update Count per MinutemeasurementNumber of collections updated.collection-update-count
Completed Transaction CountmeasurementNumber of completed transactions.completed-transaction-count
Completed Transaction Count per MinutemeasurementNumber of completed transactions.completed-transaction-count
Connect CountmeasurementGet the number of connections asked for by the sessions.connect-count
Connect Count per MinutemeasurementGet the number of connections asked for by the sessions.connect-count
Entity Delete CountmeasurementGet number of entity deletes.entity-delete-count
Entity Delete Count per MinutemeasurementGet number of entity deletes.entity-delete-count
Entity Fetch CountmeasurementGet number of entity fetches.entity-fetch-count
Entity Fetch Count per MinutemeasurementGet number of entity fetches.entity-fetch-count
Entity Insert CountmeasurementGet number of entity inserts.entity-insert-count
Entity Insert Count per MinutemeasurementGet number of entity inserts.entity-insert-count
Entity Load CountmeasurementGet number of entity loads.entity-load-count
Entity Load Count per MinutemeasurementGet number of entity loads.entity-load-count
Entity Update CountmeasurementGet number of entity updates.entity-update-count
Entity Update Count per MinutemeasurementGet number of entity updates.entity-update-count
Flush CountmeasurementGet the number of flushes executed by sessions (either implicit or explicit).flush-count
Flush Count per MinutemeasurementGet the number of flushes executed by sessions (either implicit or explicit).flush-count
Optimistic Failure CountmeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Optimistic Failure Count per MinutemeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Prepared Statement CountmeasurementNumber of acquired prepared statements.prepared-statement-count
Prepared Statement Count per MinutemeasurementNumber of acquired prepared statements.prepared-statement-count
Query Cache Hit CountmeasurementGet the number of cached queries successfully retrieved from cache.query-cache-hit-count
Query Cache Hit Count per MinutemeasurementGet the number of cached queries successfully retrieved from cache.query-cache-hit-count
Query Cache Miss CountmeasurementGet the number of cached queries not found in cache.query-cache-miss-count
Query Cache Miss Count per MinutemeasurementGet the number of cached queries not found in cache.query-cache-miss-count
Query Cache Put CountmeasurementGet the number of cacheable queries put in cache.query-cache-put-count
Query Cache Put Count per MinutemeasurementGet the number of cacheable queries put in cache.query-cache-put-count
Query Execution CountmeasurementGet number of executed queries.query-execution-count
Query Execution Count per MinutemeasurementGet number of executed queries.query-execution-count
Query Execution Max TimemeasurementGet the time in milliseconds of the slowest query.query-execution-max-time
Query Execution Max Time Query StringtraitGet the query string for the slowest query.query-execution-max-time-query-string
Second Level Cache Hit CountmeasurementNumber of cacheable entities/collections successfully retrieved from the cache.second-level-cache-hit-count
Second Level Cache Hit Count per MinutemeasurementNumber of cacheable entities/collections successfully retrieved from the cache.second-level-cache-hit-count
Second Level Cache Miss CountmeasurementNumber of cacheable entities/collections not found in the cache and loaded.second-level-cache-miss-count
Second Level Cache Miss Count per MinutemeasurementNumber of cacheable entities/collections not found in the cache and loaded.second-level-cache-miss-count
Second Level Cache Put CountmeasurementNumber of cacheable entities/collections put in the cache.second-level-cache-put-count
Second Level Cache Put Count per MinutemeasurementNumber of cacheable entities/collections put in the cache.second-level-cache-put-count
Session Close CountmeasurementNumber of sessions closed.session-close-count
Session Close Count per MinutemeasurementNumber of sessions closed.session-close-count
Session Open CountmeasurementNumber of sessions opened.session-open-count
Session Open Count per MinutemeasurementNumber of sessions opened.session-open-count
Successful Transaction CountmeasurementNumber of successful transactions.successful-transaction-count
Successful Transaction Count per MinutemeasurementNumber of successful transactions.successful-transaction-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2967. 
NameDescriptionRequiredInternal Name
EnabledDetermine if statistics are enabled. no enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2968. Metrics
NameDescription
Subsystem:clearClear statistics.
Subsystem:evict AllEvict all entities from second level cache.
Subsystem:summaryLog the statistics.
View QueriesView statistical information about queries executed by Hibernate
Package Types
none
3.4.2.4.1.2.4.1.1. EAP7 - Entity Cache Service
Overview
Table 3.2969. Overview
Description:Statistics for a Hibernate Second Level Cache region.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2970. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2971. Metrics
NameTypeDescriptionInternal Name
Element Count In MemorymeasurementNumber of cacheable entities/collections currently stored in memory.element-count-in-memory
Hit CountmeasurementNumber of cacheable entities/collections successfully retrieved from the cache.hit-count
Miss CountmeasurementNumber of cacheable entities/collections not found in the cache and loaded.miss-count
Put CountmeasurementNumber of cacheable entities/collections put in the cache.put-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.4.1.2. EAP7 - Entity Service
Overview
Table 3.2972. Overview
Description:Statistics for individual entities.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2973. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2974. Metrics
NameTypeDescriptionInternal Name
Entity Delete CountmeasurementGet number of entity deletes.entity-delete-count
Entity Delete Count per MinutemeasurementGet number of entity deletes.entity-delete-count
Entity Fetch CountmeasurementGet number of entity fetches.entity-fetch-count
Entity Fetch Count per MinutemeasurementGet number of entity fetches.entity-fetch-count
Entity Insert CountmeasurementGet number of entity inserts.entity-insert-count
Entity Insert Count per MinutemeasurementGet number of entity inserts.entity-insert-count
Entity Load CountmeasurementGet number of entity loads.entity-load-count
Entity Load Count per MinutemeasurementGet number of entity loads.entity-load-count
Entity Update CountmeasurementGet number of entity updates.entity-update-count
Entity Update Count per MinutemeasurementGet number of entity updates.entity-update-count
Optimistic Failure CountmeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Optimistic Failure Count per MinutemeasurementNumber of optimistic lock exceptions.optimistic-failure-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.4.1.3. EAP7 - Collection Service
Overview
Table 3.2975. Overview
Description:Statistics for individual collections.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2976. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2977. Metrics
NameTypeDescriptionInternal Name
Collection Fetch CountmeasurementNumber of times collection was fetched.collection-fetch-count
Collection Fetch Count per MinutemeasurementNumber of times collection was fetched.collection-fetch-count
Collection Load CountmeasurementNumber of times collection was loaded.collection-load-count
Collection Load Count per MinutemeasurementNumber of times collection was loaded.collection-load-count
Collection Recreated CountmeasurementNumber of times collection was recreated.collection-recreated-count
Collection Recreated Count per MinutemeasurementNumber of times collection was recreated.collection-recreated-count
Collection Remove CountmeasurementNumber of times collection was removed.collection-remove-count
Collection Remove Count per MinutemeasurementNumber of times collection was removed.collection-remove-count
Collection Update CountmeasurementNumber of times collection was updated.collection-update-count
Collection Update Count per MinutemeasurementNumber of times collection was updated.collection-update-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.5. EAP7 - Messaging Runtime Service
Overview
Table 3.2978. Overview
Description:Runtime resources exposed by messaging resources included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2979. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.5.1. EAP7 - ActiveMQ Artemis Server Runtime Service
Overview
Table 3.2980. Overview
Description:A ActiveMQ Artemis server instance.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2981. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.5.1.1. EAP7 - JMS Queue Runtime Service
Overview
Table 3.2982. Overview
Description:Defines a JMS queue.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2983. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2984. Metrics
NameTypeDescriptionInternal Name
Consumer CountmeasurementThe number of consumers consuming messages from this queue.consumer-count
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Dead Letter AddresstraitThe address to send dead messages to.dead-letter-address
DurabletraitWhether the queue is durable or not. The default value is true.durable
Expiry AddresstraitThe address to send expired messages to.expiry-address
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
PausedtraitWhether the queue is paused.paused
Queue AddresstraitThe queue address defines what address is used for routing messages.queue-address
Scheduled CountmeasurementThe number of scheduled messages in this queue.scheduled-count
SelectortraitThe queue selector.selector
TemporarytraitWhether the queue is temporary.temporary

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2985. 
NameDescriptionRequiredInternal Name
EntriesThe jndi names the queue will be bound to. no entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2986. Metrics
NameDescription
Change Message PriorityChange the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages PriorityChange the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count MessagesReturns the number of the messages in the queue matching the given filter.
Expire MessageExpire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire MessagesExpire the messages matching the given filter.
List Consumers as JSONA string in JSON format.
Subsystem:list Delivering MessagesList the messages are currently being delivered.
Subsystem:list Delivering Messages As JsonList the messages are currently being delivered as a string in JSON format
List Message Counter as HTMLList the message counter as a string in HTML format.
List Message Counter as JSONList the message counter as a string in JSON format.
List Message Counter History as HTMLList the message counter history.
List Message Counter History as JSONList the message counter history as a string in JSON format.
List MessagesList all messages in the queue that match the filter
List Messages as JSONList all messages in the queue that match the filter and return them as a string in JSON format.
Move MessageMove the message corresponding to the given message-id to another queue
Move MessagesMove the messages corresponding to the given filter to another queue.
PausePause the queue.
Remove MessageRemove the message corresponding to the given message-id.
Remove MessagesRemove messages matching the given filter from the destination.
Reset Message CounterReset the message counters.
ResumeResume the queue.
Send Message to Dead Letter AddressSend the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter AddressSend the messages corresponding to the given filter to this queue's Dead Letter Address.
Package Types
none
3.4.2.4.1.2.5.1.2. EAP7 - JMS Topic Runtime Service
Overview
Table 3.2987. Overview
Description:Defines a JMS queue.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2988. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2989. Metrics
NameTypeDescriptionInternal Name
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Durable Message CountmeasurementThe number of messages for all durable subscribers for this topic.durable-message-count
Durable Subscription CountmeasurementThe number of durable subscribers for this topic.durable-subscription-count
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
Non Durable Message CountmeasurementThe number of messages for all non-durable subscribers for this topic.non-durable-message-count
Non Durable Subscription CountmeasurementThe number of non-durable subscribers for this topic.non-durable-subscription-count
Subscription CountmeasurementThe number of (durable and non-durable) subscribers for this topic.subscription-count
TemporarytraitWhether the topic is temporary.temporary
Topic AddresstraitThe address the topic points to.topic-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2990. 
NameDescriptionRequiredInternal Name
JNDI NamesThe jndi names the queue will be bound to. no entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2991. Metrics
NameDescription
Count Messages for SubscriptionCount the number of messages matching the filter for the given subscription.
Drop All SubscriptionsDrop all subscriptions from this topic.
Drop Durable SubscriptionDrop a durable subscription
List All SubscriptionsList all subscriptions.
List All Subscriptions as JSONList all subscriptions as a string in JSON format.
List Durable SubscriptionsList only the durable subscriptions.
List Durable Subscriptions as JSONList only the durable subscriptions, as a string in JSON format.
List Messages for SubscriptionList all the messages for the given subscription.
List Messages for Subscription as JSONList all the messages for the given subscription as a string in JSON format.
List Non-Durable SubscriptionsList only the non-durable subscriptions.
List Non-Durable Subscriptions as JSONList only the non-durable subscriptions, as a string in JSON format.
Remove MessagesRemove messages matching the given filter from the destination.
Package Types
none
3.4.2.4.1.2.5.1.3. EAP7 - Pooled Connection Factory Runtime Service
Overview
Table 3.2992. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2993. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2994. 
NameDescriptionRequiredInternal Name
Auto GroupThe autogroup. The default value is false. no auto-group
Block On AcknowledgeTrue to set block on acknowledge. The default value is false. no block-on-acknowledge
Block On Durable SendTrue to set block on durable send. The default value is true. no block-on-durable-send
Block On Non Durable SendTrue to set block on non durable send. The default value is false. no block-on-non-durable-send
Cache Large Message ClientTrue to cache large messages. The default value is false. no cache-large-message-client
Call Failover Timeout:exprThe timeout to use when fail over is in process (in ms). The default value is -1. no call-failover-timeout:expr
Call Timeout:exprThe call time out. The default value is 30000. no call-timeout:expr
Client Failure Check Period:exprThe client failure check period. The default value is 30000. no client-failure-check-period:expr
Client IdThe client id. no client-id
Compress Large MessagesWhether large messages should be compressed. The default value is false. no compress-large-messages
Confirmation Window Size:exprThe confirmation window size. The default value is -1. no confirmation-window-size:expr
Connection Load Balancing Policy Class NameName of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. no connection-load-balancing-policy-class-name
Connection Ttl:exprThe connection ttl. The default value is 60000. no connection-ttl:expr
ConnectorsDefines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. no connectors
Consumer Max Rate:exprThe consumer max rate. The default value is -1. no consumer-max-rate:expr
Consumer Window Size:exprThe consumer window size. The default value is 1048576. no consumer-window-size:expr
Discovery GroupThe discovery group name. no discovery-group
Dups Ok Batch Size:exprThe dups ok batch size. The default value is 1048576. no dups-ok-batch-size:expr
Enlistment TraceEnables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property. no enlistment-trace
EntriesThe jndi names the connection factory should be bound to. yes entries
Failover On Initial ConnectionTrue to fail over on initial connection. The default value is false. no failover-on-initial-connection
Group IdThe group id. no group-id
HaWhether the connection factory supports High Availability. The default value is false. no ha
Initial Connect Attempts:exprThe number of attempts to connect initially with this factory. The default value is 1. no initial-connect-attempts:expr
Initial Message Packet Size:exprThe initial size of messages created through this factory. The default value is 1500. no initial-message-packet-size:expr
Jndi ParamsThe JNDI params to use for locating the destination for incoming connections. no jndi-params
Managed Connection PoolThe class name of the managed connection pool used by this pooled-connection-factory. no managed-connection-pool
Max Pool Size:exprThe maximum size for the pool. The default value is -1. no max-pool-size:expr
Max Retry Interval:exprThe max retry interval. The default value is 2000. no max-retry-interval:expr
Min Large Message Size:exprThe min large message size. The default value is 102400. no min-large-message-size:expr
Min Pool Size:exprThe minimum size for the pool. The default value is -1. no min-pool-size:expr
PasswordThe default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host. no password
Pre AcknowledgeTrue to pre-acknowledge. The default value is false. no pre-acknowledge
Producer Max Rate:exprThe producer max rate. The default value is -1. no producer-max-rate:expr
Producer Window Size:exprThe producer window size. The default value is 65536. no producer-window-size:expr
Protocol Manager FactoryThe protocol manager factory used by this pooled connection factory. no protocol-manager-factory
Reconnect Attempts:exprThe reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s). The default value is -1. no reconnect-attempts:expr
Retry Interval:exprThe retry interval. The default value is 2000. no retry-interval:expr
Retry Interval Multiplier:exprThe retry interval multiplier. The default value is 1.0. no retry-interval-multiplier:expr
Scheduled Thread Pool Max Size:exprThe scheduled thread pool max size. The default value is 5. no scheduled-thread-pool-max-size:expr
Setup Attempts:exprThe number of times to set up an MDB endpoint no setup-attempts:expr
Setup Interval:exprThe interval between attempts at setting up an MDB endpoint. no setup-interval:expr
Thread Pool Max Size:exprThe thread pool max size. The default value is 30. no thread-pool-max-size:expr
TransactionTODO. The default value is transaction. no transaction
Transaction Batch Size:exprThe transaction batch size. The default value is 1048576. no transaction-batch-size:expr
Use Auto RecoveryTrue to use auto recovery. The default value is true. no use-auto-recovery
Use Global PoolsTrue to use global pools. The default value is true. no use-global-pools
Use JndiUse JNDI to locate the destination for incoming connections no use-jndi
Use Local TxUse a local transaction for incoming sessions no use-local-tx
UserThe default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host. no user

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.2.6. EAP7 - Datasources Runtime Service
Overview
Table 3.2995. Overview
Description:Runtime resources exposed by data sources included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.2996. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.6.1. EAP7 - XA Datasource Runtime Service
Overview
Table 3.2997. Overview
Description:A JDBC XA data-source configuration
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.2998. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2999. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3000. 
NameDescriptionRequiredInternal Name
Properties  no *2
Xa Datasource ClassThe fully qualified name of the javax.sql.XADataSource implementation yes xa-datasource-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
Driver NameDefines 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 yes driver-name
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. no pool-use-strict-min
InterleavingAn element to enable interleaving for XA connection factories no interleaving
No Tx Separate PoolOracle 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 context no no-tx-separate-pool
Pad XidShould the Xid be padded no pad-xid
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Wrap Xa DatasourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance no wrap-xa-datasource
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Recovery Plugin Class Namerecovery plugin implementation provided for specific purpose (i.e vendor) no recovery-plugin-class-name
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait Millishe allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Xa Resource TimeoutPassed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds no xa-resource-timeout
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm
Recovery Usernameusername used to try connection recovery no recovery-username
Recovery Passwordpassword used to try connection recovery no recovery-password
Recovery Security Domainsecurity-domain used to try connection recovery no recovery-security-domain
No Recoveryif true no recovery are tried for this connection pool no no-recovery

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3001. Metrics
NameDescription
Subsystem:flush All Connection In PoolFlushes all connections in the pool
Subsystem:flush Idle Connection In PoolFlushes all idle connections in the pool
Subsystem:test Connection In PoolTest if a connection can be obtained
Package Types
none
3.4.2.4.1.2.6.2. EAP7 - Datasource Runtime Service
Overview
Table 3.3002. Overview
Description:A JDBC data-source configuration
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3003. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3004. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3005. 
NameDescriptionRequiredInternal Name
Connection Property  no *1
Connection UrlThe JDBC driver connection URL yes connection-url
Driver NameName of the (existing) JDBC driver to use yes driver-name
Driver ClassThe fully qualified name of the JDBC driver class no driver-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
DriverDefines the JDBC driver the datasource should use with this format: driver-name>#major-version.minor-version where driver-name is the fully qualified name of the JDBC driver class no driver
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. no pool-use-strict-min
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait MillisIndicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3006. Metrics
NameDescription
Subsystem:flush All Connection In PoolFlushes all connections in the pool
Subsystem:flush Idle Connection In PoolFlushes all idle connections in the pool
Subsystem:test Connection In PoolTest if a connection can be obtained
Package Types
none
3.4.2.4.1.2.7. EAP7 - Webservices Runtime Service
Overview
Table 3.3007. Overview
Description:Runtime resources exposed by web service components in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3008. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.2.7.1. EAP7 - Endpoint Runtime Service
Overview
Table 3.3009. Overview
Description:Webservice endpoint.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3010. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3011. Metrics
NameTypeDescriptionInternal Name
Average Processing TimemeasurementAverage endpoint processing time.average-processing-time
Fault CountmeasurementCount of faults the endpoint generated.fault-count
Max Processing TimemeasurementMaximal endpoint processing time.max-processing-time
Min Processing TimemeasurementMinimal endpoint processing time.min-processing-time
Request CountmeasurementCount of requests the endpoint processed.request-count
Response CountmeasurementCount of responses the endpoint generated.response-count
Total Processing TimemeasurementTotal endpoint processing time.total-processing-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3012. 
NameDescriptionRequiredInternal Name
ClassWebservice endpoint class. no class
ContextWebservice endpoint context. no context
NameWebservice endpoint name. no name
TypeWebservice endpoint type. no type
Wsdl UrlWebservice endpoint WSDL URL. no wsdl-url

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.3. EAP7 - Resource Adapters Runtime Service
Overview
Table 3.3013. Overview
Description:Configuration of the resource adapters subsystem.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3014. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.3.1. EAP7 - Connection Definition Runtime Service
Overview
Table 3.3015. Overview
Description:Specifies the connection definitions.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3016. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3017. Metrics
NameTypeDescriptionInternal Name
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.4. EAP7 - Web Runtime Service
Overview
Table 3.3018. Overview
Description:Runtime resources exposed by web components in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3019. 
NameDescriptionRequiredInternal Name
Response Time Log Filethe full path to the log file containing response-time stats for this webapp no responseTimeLogFile
Response Time Url Excludesa space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection no responseTimeUrlExcludes
Response Time Url Transformsa space-delimited list of Perl-style substitution expressions that should be applied to all URLs for which response-time stats are collected (e.g. |^/dept/finance/.*|/dept/finance/*|) no responseTimeUrlTransforms
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3020. Metrics
NameTypeDescriptionInternal Name
Virtual Hosttraitthe virtual host this webapp is deployed tovirtual-host
Context Roottraitthe context root of this webappcontext-root
ServertraitThe name of server this application belongs toserver
Response Timecalltimethe minimum, maximum, and average response times for requests serviced by this webappresponseTime
Currently Active SessionsmeasurementThe number of sessions that are currently activeactive-sessions
Expired SessionsmeasurementThe number of expired sessionsexpired-sessions
Expired Sessions per MinutemeasurementThe number of expired sessionsexpired-sessions
Maximum Active SessionsmeasurementThe maximum number of sessions that have been activemax-active-sessions
Rejected SessionsmeasurementThe number of sessions rejectedrejected-sessions
Rejected Sessions per MinutemeasurementThe number of sessions rejectedrejected-sessions
Average Session Alive TimemeasurementThe average alive time of sessionssession-avg-alive-time
Max Session Alive TimemeasurementThe maximum alive time of sessionssession-max-alive-time
Created SessionsmeasurementThe number of sessions createdsessions-created
Created Sessions per MinutemeasurementThe number of sessions createdsessions-created

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.5. EAP7 - JPA Runtime Service
Overview
Table 3.3021. Overview
Description:The configuration of the JPA subsystem.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3022. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.5.1. EAP7 - Hibernate Persistence Unit Service
Overview
Table 3.3023. Overview
Description:Runtime information about JPA use in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3024. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3025. Metrics
NameTypeDescriptionInternal Name
Close Statement CountmeasurementNumber of released prepared statements.close-statement-count
Close Statement Count per MinutemeasurementNumber of released prepared statements.close-statement-count
Collection Fetch CountmeasurementNumber of collections fetched.collection-fetch-count
Collection Fetch Count per MinutemeasurementNumber of collections fetched.collection-fetch-count
Collection Load CountmeasurementNumber of collections loaded.collection-load-count
Collection Load Count per MinutemeasurementNumber of collections loaded.collection-load-count
Collection Recreated CountmeasurementNumber of collections recreated.collection-recreated-count
Collection Recreated Count per MinutemeasurementNumber of collections recreated.collection-recreated-count
Collection Remove CountmeasurementNumber of collections removed.collection-remove-count
Collection Remove Count per MinutemeasurementNumber of collections removed.collection-remove-count
Collection Update CountmeasurementNumber of collections updated.collection-update-count
Collection Update Count per MinutemeasurementNumber of collections updated.collection-update-count
Completed Transaction CountmeasurementNumber of completed transactions.completed-transaction-count
Completed Transaction Count per MinutemeasurementNumber of completed transactions.completed-transaction-count
Connect CountmeasurementGet the number of connections asked for by the sessions.connect-count
Connect Count per MinutemeasurementGet the number of connections asked for by the sessions.connect-count
Entity Delete CountmeasurementGet number of entity deletes.entity-delete-count
Entity Delete Count per MinutemeasurementGet number of entity deletes.entity-delete-count
Entity Fetch CountmeasurementGet number of entity fetches.entity-fetch-count
Entity Fetch Count per MinutemeasurementGet number of entity fetches.entity-fetch-count
Entity Insert CountmeasurementGet number of entity inserts.entity-insert-count
Entity Insert Count per MinutemeasurementGet number of entity inserts.entity-insert-count
Entity Load CountmeasurementGet number of entity loads.entity-load-count
Entity Load Count per MinutemeasurementGet number of entity loads.entity-load-count
Entity Update CountmeasurementGet number of entity updates.entity-update-count
Entity Update Count per MinutemeasurementGet number of entity updates.entity-update-count
Flush CountmeasurementGet the number of flushes executed by sessions (either implicit or explicit).flush-count
Flush Count per MinutemeasurementGet the number of flushes executed by sessions (either implicit or explicit).flush-count
Optimistic Failure CountmeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Optimistic Failure Count per MinutemeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Prepared Statement CountmeasurementNumber of acquired prepared statements.prepared-statement-count
Prepared Statement Count per MinutemeasurementNumber of acquired prepared statements.prepared-statement-count
Query Cache Hit CountmeasurementGet the number of cached queries successfully retrieved from cache.query-cache-hit-count
Query Cache Hit Count per MinutemeasurementGet the number of cached queries successfully retrieved from cache.query-cache-hit-count
Query Cache Miss CountmeasurementGet the number of cached queries not found in cache.query-cache-miss-count
Query Cache Miss Count per MinutemeasurementGet the number of cached queries not found in cache.query-cache-miss-count
Query Cache Put CountmeasurementGet the number of cacheable queries put in cache.query-cache-put-count
Query Cache Put Count per MinutemeasurementGet the number of cacheable queries put in cache.query-cache-put-count
Query Execution CountmeasurementGet number of executed queries.query-execution-count
Query Execution Count per MinutemeasurementGet number of executed queries.query-execution-count
Query Execution Max TimemeasurementGet the time in milliseconds of the slowest query.query-execution-max-time
Query Execution Max Time Query StringtraitGet the query string for the slowest query.query-execution-max-time-query-string
Second Level Cache Hit CountmeasurementNumber of cacheable entities/collections successfully retrieved from the cache.second-level-cache-hit-count
Second Level Cache Hit Count per MinutemeasurementNumber of cacheable entities/collections successfully retrieved from the cache.second-level-cache-hit-count
Second Level Cache Miss CountmeasurementNumber of cacheable entities/collections not found in the cache and loaded.second-level-cache-miss-count
Second Level Cache Miss Count per MinutemeasurementNumber of cacheable entities/collections not found in the cache and loaded.second-level-cache-miss-count
Second Level Cache Put CountmeasurementNumber of cacheable entities/collections put in the cache.second-level-cache-put-count
Second Level Cache Put Count per MinutemeasurementNumber of cacheable entities/collections put in the cache.second-level-cache-put-count
Session Close CountmeasurementNumber of sessions closed.session-close-count
Session Close Count per MinutemeasurementNumber of sessions closed.session-close-count
Session Open CountmeasurementNumber of sessions opened.session-open-count
Session Open Count per MinutemeasurementNumber of sessions opened.session-open-count
Successful Transaction CountmeasurementNumber of successful transactions.successful-transaction-count
Successful Transaction Count per MinutemeasurementNumber of successful transactions.successful-transaction-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3026. 
NameDescriptionRequiredInternal Name
EnabledDetermine if statistics are enabled. no enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3027. Metrics
NameDescription
Subsystem:clearClear statistics.
Subsystem:evict AllEvict all entities from second level cache.
Subsystem:summaryLog the statistics.
View QueriesView statistical information about queries executed by Hibernate
Package Types
none
3.4.2.4.1.5.1.1. EAP7 - Entity Cache Service
Overview
Table 3.3028. Overview
Description:Statistics for a Hibernate Second Level Cache region.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3029. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3030. Metrics
NameTypeDescriptionInternal Name
Element Count In MemorymeasurementNumber of cacheable entities/collections currently stored in memory.element-count-in-memory
Hit CountmeasurementNumber of cacheable entities/collections successfully retrieved from the cache.hit-count
Miss CountmeasurementNumber of cacheable entities/collections not found in the cache and loaded.miss-count
Put CountmeasurementNumber of cacheable entities/collections put in the cache.put-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.5.1.2. EAP7 - Entity Service
Overview
Table 3.3031. Overview
Description:Statistics for individual entities.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3032. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3033. Metrics
NameTypeDescriptionInternal Name
Entity Delete CountmeasurementGet number of entity deletes.entity-delete-count
Entity Delete Count per MinutemeasurementGet number of entity deletes.entity-delete-count
Entity Fetch CountmeasurementGet number of entity fetches.entity-fetch-count
Entity Fetch Count per MinutemeasurementGet number of entity fetches.entity-fetch-count
Entity Insert CountmeasurementGet number of entity inserts.entity-insert-count
Entity Insert Count per MinutemeasurementGet number of entity inserts.entity-insert-count
Entity Load CountmeasurementGet number of entity loads.entity-load-count
Entity Load Count per MinutemeasurementGet number of entity loads.entity-load-count
Entity Update CountmeasurementGet number of entity updates.entity-update-count
Entity Update Count per MinutemeasurementGet number of entity updates.entity-update-count
Optimistic Failure CountmeasurementNumber of optimistic lock exceptions.optimistic-failure-count
Optimistic Failure Count per MinutemeasurementNumber of optimistic lock exceptions.optimistic-failure-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.5.1.3. EAP7 - Collection Service
Overview
Table 3.3034. Overview
Description:Statistics for individual collections.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3035. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3036. Metrics
NameTypeDescriptionInternal Name
Collection Fetch CountmeasurementNumber of times collection was fetched.collection-fetch-count
Collection Fetch Count per MinutemeasurementNumber of times collection was fetched.collection-fetch-count
Collection Load CountmeasurementNumber of times collection was loaded.collection-load-count
Collection Load Count per MinutemeasurementNumber of times collection was loaded.collection-load-count
Collection Recreated CountmeasurementNumber of times collection was recreated.collection-recreated-count
Collection Recreated Count per MinutemeasurementNumber of times collection was recreated.collection-recreated-count
Collection Remove CountmeasurementNumber of times collection was removed.collection-remove-count
Collection Remove Count per MinutemeasurementNumber of times collection was removed.collection-remove-count
Collection Update CountmeasurementNumber of times collection was updated.collection-update-count
Collection Update Count per MinutemeasurementNumber of times collection was updated.collection-update-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.6. EAP7 - Messaging Runtime Service
Overview
Table 3.3037. Overview
Description:Runtime resources exposed by messaging resources included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3038. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.6.1. EAP7 - ActiveMQ Artemis Server Runtime Service
Overview
Table 3.3039. Overview
Description:A ActiveMQ Artemis server instance.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3040. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.6.1.1. EAP7 - JMS Queue Runtime Service
Overview
Table 3.3041. Overview
Description:Defines a JMS queue.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3042. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3043. Metrics
NameTypeDescriptionInternal Name
Consumer CountmeasurementThe number of consumers consuming messages from this queue.consumer-count
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Dead Letter AddresstraitThe address to send dead messages to.dead-letter-address
DurabletraitWhether the queue is durable or not. The default value is true.durable
Expiry AddresstraitThe address to send expired messages to.expiry-address
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
PausedtraitWhether the queue is paused.paused
Queue AddresstraitThe queue address defines what address is used for routing messages.queue-address
Scheduled CountmeasurementThe number of scheduled messages in this queue.scheduled-count
SelectortraitThe queue selector.selector
TemporarytraitWhether the queue is temporary.temporary

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3044. 
NameDescriptionRequiredInternal Name
EntriesThe jndi names the queue will be bound to. no entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3045. Metrics
NameDescription
Change Message PriorityChange the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages PriorityChange the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count MessagesReturns the number of the messages in the queue matching the given filter.
Expire MessageExpire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire MessagesExpire the messages matching the given filter.
List Consumers as JSONA string in JSON format.
Subsystem:list Delivering MessagesList the messages are currently being delivered.
Subsystem:list Delivering Messages As JsonList the messages are currently being delivered as a string in JSON format
List Message Counter as HTMLList the message counter as a string in HTML format.
List Message Counter as JSONList the message counter as a string in JSON format.
List Message Counter History as HTMLList the message counter history.
List Message Counter History as JSONList the message counter history as a string in JSON format.
List MessagesList all messages in the queue that match the filter
List Messages as JSONList all messages in the queue that match the filter and return them as a string in JSON format.
Move MessageMove the message corresponding to the given message-id to another queue
Move MessagesMove the messages corresponding to the given filter to another queue.
PausePause the queue.
Remove MessageRemove the message corresponding to the given message-id.
Remove MessagesRemove messages matching the given filter from the destination.
Reset Message CounterReset the message counters.
ResumeResume the queue.
Send Message to Dead Letter AddressSend the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter AddressSend the messages corresponding to the given filter to this queue's Dead Letter Address.
Package Types
none
3.4.2.4.1.6.1.2. EAP7 - JMS Topic Runtime Service
Overview
Table 3.3046. Overview
Description:Defines a JMS queue.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3047. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3048. Metrics
NameTypeDescriptionInternal Name
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Durable Message CountmeasurementThe number of messages for all durable subscribers for this topic.durable-message-count
Durable Subscription CountmeasurementThe number of durable subscribers for this topic.durable-subscription-count
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
Non Durable Message CountmeasurementThe number of messages for all non-durable subscribers for this topic.non-durable-message-count
Non Durable Subscription CountmeasurementThe number of non-durable subscribers for this topic.non-durable-subscription-count
Subscription CountmeasurementThe number of (durable and non-durable) subscribers for this topic.subscription-count
TemporarytraitWhether the topic is temporary.temporary
Topic AddresstraitThe address the topic points to.topic-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3049. 
NameDescriptionRequiredInternal Name
JNDI NamesThe jndi names the queue will be bound to. no entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3050. Metrics
NameDescription
Count Messages for SubscriptionCount the number of messages matching the filter for the given subscription.
Drop All SubscriptionsDrop all subscriptions from this topic.
Drop Durable SubscriptionDrop a durable subscription
List All SubscriptionsList all subscriptions.
List All Subscriptions as JSONList all subscriptions as a string in JSON format.
List Durable SubscriptionsList only the durable subscriptions.
List Durable Subscriptions as JSONList only the durable subscriptions, as a string in JSON format.
List Messages for SubscriptionList all the messages for the given subscription.
List Messages for Subscription as JSONList all the messages for the given subscription as a string in JSON format.
List Non-Durable SubscriptionsList only the non-durable subscriptions.
List Non-Durable Subscriptions as JSONList only the non-durable subscriptions, as a string in JSON format.
Remove MessagesRemove messages matching the given filter from the destination.
Package Types
none
3.4.2.4.1.6.1.3. EAP7 - Pooled Connection Factory Runtime Service
Overview
Table 3.3051. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3052. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3053. 
NameDescriptionRequiredInternal Name
Auto GroupThe autogroup. The default value is false. no auto-group
Block On AcknowledgeTrue to set block on acknowledge. The default value is false. no block-on-acknowledge
Block On Durable SendTrue to set block on durable send. The default value is true. no block-on-durable-send
Block On Non Durable SendTrue to set block on non durable send. The default value is false. no block-on-non-durable-send
Cache Large Message ClientTrue to cache large messages. The default value is false. no cache-large-message-client
Call Failover Timeout:exprThe timeout to use when fail over is in process (in ms). The default value is -1. no call-failover-timeout:expr
Call Timeout:exprThe call time out. The default value is 30000. no call-timeout:expr
Client Failure Check Period:exprThe client failure check period. The default value is 30000. no client-failure-check-period:expr
Client IdThe client id. no client-id
Compress Large MessagesWhether large messages should be compressed. The default value is false. no compress-large-messages
Confirmation Window Size:exprThe confirmation window size. The default value is -1. no confirmation-window-size:expr
Connection Load Balancing Policy Class NameName of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. no connection-load-balancing-policy-class-name
Connection Ttl:exprThe connection ttl. The default value is 60000. no connection-ttl:expr
ConnectorsDefines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. no connectors
Consumer Max Rate:exprThe consumer max rate. The default value is -1. no consumer-max-rate:expr
Consumer Window Size:exprThe consumer window size. The default value is 1048576. no consumer-window-size:expr
Discovery GroupThe discovery group name. no discovery-group
Dups Ok Batch Size:exprThe dups ok batch size. The default value is 1048576. no dups-ok-batch-size:expr
Enlistment TraceEnables IronJacamar to record enlistment traces for this pooled-connection-factory. This attribute is undefined by default and the behaviour is driven by the presence of the ironjacamar.disable_enlistment_trace system property. no enlistment-trace
EntriesThe jndi names the connection factory should be bound to. yes entries
Failover On Initial ConnectionTrue to fail over on initial connection. The default value is false. no failover-on-initial-connection
Group IdThe group id. no group-id
HaWhether the connection factory supports High Availability. The default value is false. no ha
Initial Connect Attempts:exprThe number of attempts to connect initially with this factory. The default value is 1. no initial-connect-attempts:expr
Initial Message Packet Size:exprThe initial size of messages created through this factory. The default value is 1500. no initial-message-packet-size:expr
Jndi ParamsThe JNDI params to use for locating the destination for incoming connections. no jndi-params
Managed Connection PoolThe class name of the managed connection pool used by this pooled-connection-factory. no managed-connection-pool
Max Pool Size:exprThe maximum size for the pool. The default value is -1. no max-pool-size:expr
Max Retry Interval:exprThe max retry interval. The default value is 2000. no max-retry-interval:expr
Min Large Message Size:exprThe min large message size. The default value is 102400. no min-large-message-size:expr
Min Pool Size:exprThe minimum size for the pool. The default value is -1. no min-pool-size:expr
PasswordThe default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host. no password
Pre AcknowledgeTrue to pre-acknowledge. The default value is false. no pre-acknowledge
Producer Max Rate:exprThe producer max rate. The default value is -1. no producer-max-rate:expr
Producer Window Size:exprThe producer window size. The default value is 65536. no producer-window-size:expr
Protocol Manager FactoryThe protocol manager factory used by this pooled connection factory. no protocol-manager-factory
Reconnect Attempts:exprThe reconnect attempts. By default, a pooled connection factory will try to reconnect infinitely to the messaging server(s). The default value is -1. no reconnect-attempts:expr
Retry Interval:exprThe retry interval. The default value is 2000. no retry-interval:expr
Retry Interval Multiplier:exprThe retry interval multiplier. The default value is 1.0. no retry-interval-multiplier:expr
Scheduled Thread Pool Max Size:exprThe scheduled thread pool max size. The default value is 5. no scheduled-thread-pool-max-size:expr
Setup Attempts:exprThe number of times to set up an MDB endpoint no setup-attempts:expr
Setup Interval:exprThe interval between attempts at setting up an MDB endpoint. no setup-interval:expr
Thread Pool Max Size:exprThe thread pool max size. The default value is 30. no thread-pool-max-size:expr
TransactionTODO. The default value is transaction. no transaction
Transaction Batch Size:exprThe transaction batch size. The default value is 1048576. no transaction-batch-size:expr
Use Auto RecoveryTrue to use auto recovery. The default value is true. no use-auto-recovery
Use Global PoolsTrue to use global pools. The default value is true. no use-global-pools
Use JndiUse JNDI to locate the destination for incoming connections no use-jndi
Use Local TxUse a local transaction for incoming sessions no use-local-tx
UserThe default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host. no user

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.1.7. EAP7 - Datasources Runtime Service
Overview
Table 3.3054. Overview
Description:Runtime resources exposed by data sources included in this deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3055. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.7.1. EAP7 - XA Datasource Runtime Service
Overview
Table 3.3056. Overview
Description:A JDBC XA data-source configuration
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3057. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3058. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3059. 
NameDescriptionRequiredInternal Name
Properties  no *2
Xa Datasource ClassThe fully qualified name of the javax.sql.XADataSource implementation yes xa-datasource-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
Driver NameDefines 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 yes driver-name
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. no pool-use-strict-min
InterleavingAn element to enable interleaving for XA connection factories no interleaving
No Tx Separate PoolOracle 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 context no no-tx-separate-pool
Pad XidShould the Xid be padded no pad-xid
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Wrap Xa DatasourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance no wrap-xa-datasource
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Recovery Plugin Class Namerecovery plugin implementation provided for specific purpose (i.e vendor) no recovery-plugin-class-name
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait Millishe allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Xa Resource TimeoutPassed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds no xa-resource-timeout
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm
Recovery Usernameusername used to try connection recovery no recovery-username
Recovery Passwordpassword used to try connection recovery no recovery-password
Recovery Security Domainsecurity-domain used to try connection recovery no recovery-security-domain
No Recoveryif true no recovery are tried for this connection pool no no-recovery

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3060. Metrics
NameDescription
Subsystem:flush All Connection In PoolFlushes all connections in the pool
Subsystem:flush Idle Connection In PoolFlushes all idle connections in the pool
Subsystem:test Connection In PoolTest if a connection can be obtained
Package Types
none
3.4.2.4.1.7.2. EAP7 - Datasource Runtime Service
Overview
Table 3.3061. Overview
Description:A JDBC data-source configuration
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3062. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3063. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3064. 
NameDescriptionRequiredInternal Name
Connection Property  no *1
Connection UrlThe JDBC driver connection URL yes connection-url
Driver NameName of the (existing) JDBC driver to use yes driver-name
Driver ClassThe fully qualified name of the JDBC driver class no driver-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
DriverDefines the JDBC driver the datasource should use with this format: driver-name>#major-version.minor-version where driver-name is the fully qualified name of the JDBC driver class no driver
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. no pool-use-strict-min
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait MillisIndicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3065. Metrics
NameDescription
Subsystem:flush All Connection In PoolFlushes all connections in the pool
Subsystem:flush Idle Connection In PoolFlushes all idle connections in the pool
Subsystem:test Connection In PoolTest if a connection can be obtained
Package Types
none
3.4.2.4.1.8. EAP7 - Webservices Runtime Service
Overview
Table 3.3066. Overview
Description:Runtime resources exposed by web service components in the deployment.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3067. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.1.8.1. EAP7 - Endpoint Runtime Service
Overview
Table 3.3068. Overview
Description:Webservice endpoint.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3069. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3070. Metrics
NameTypeDescriptionInternal Name
Average Processing TimemeasurementAverage endpoint processing time.average-processing-time
Fault CountmeasurementCount of faults the endpoint generated.fault-count
Max Processing TimemeasurementMaximal endpoint processing time.max-processing-time
Min Processing TimemeasurementMinimal endpoint processing time.min-processing-time
Request CountmeasurementCount of requests the endpoint processed.request-count
Response CountmeasurementCount of responses the endpoint generated.response-count
Total Processing TimemeasurementTotal endpoint processing time.total-processing-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3071. 
NameDescriptionRequiredInternal Name
ClassWebservice endpoint class. no class
ContextWebservice endpoint context. no context
NameWebservice endpoint name. no name
TypeWebservice endpoint type. no type
Wsdl UrlWebservice endpoint WSDL URL. no wsdl-url

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.2. EAP7 - Naming (Managed Server) Service
Overview
Table 3.3072. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3073. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.3074. Metrics
NameDescription
JNDIViewPeek at the JNDI tree
Package Types
none
3.4.2.4.2.1. EAP7 - Binding (Managed Server) Service
Overview
Table 3.3075. Overview
Description:JNDI bindings for primitive types
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3076. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3077. 
NameDescriptionRequiredInternal Name
Binding TypeThe type of binding to create, may be simple, lookup or object-factory yes binding-type
ClassThe object factory class name for object factory bindings no class
LookupThe entry to lookup in JNDI for lookup bindings no lookup
ModuleThe module to load the object factory from for object factory bindings no module
TypeThe type of the value to bind for simple bindings, this must be a primitive type no type
ValueThe value to bind for simple bindings no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.3. EAP7 - Webservices (Managed Server) Service
Overview
Table 3.3078. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3079. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3080. 
NameDescriptionRequiredInternal Name
Modify Wsdl AddressWhether the soap address can be modified. no modify-wsdl-address
Wsdl HostThe WSDL, that is a required deployment artifact for an endpoint, has a <soap:address> element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of <soap:address> is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of <soap:address> is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the <soap:address> no wsdl-host
Wsdl PortThe non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors. no wsdl-port
Wsdl Secure PortThe secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors. no wsdl-secure-port

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.3.1. EAP7 - Endpoint (Managed Server) Service
Overview
Table 3.3081. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3082. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.3.1.1. EAP7 - Post Handler Chain (Managed Server) Service
Overview
Table 3.3083. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3084. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3085. 
NameDescriptionRequiredInternal Name
Protocol BindingsProtocol binding no protocol-bindings

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.3.1.1.1. EAP7 - Post Handler (Managed Server) Service
Overview
Table 3.3086. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3087. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3088. 
NameDescriptionRequiredInternal Name
ClassHandler class yes class

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.3.1.2. EAP7 - Pre Handler Chain (Managed Server) Service
Overview
Table 3.3089. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3090. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3091. 
NameDescriptionRequiredInternal Name
Protocol BindingsProtocol binding no protocol-bindings

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.3.1.2.1. EAP7 - Pre Handler (Managed Server) Service
Overview
Table 3.3092. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3093. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3094. 
NameDescriptionRequiredInternal Name
ClassHandler class yes class

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.3.1.3. EAP7 - Property (Read Only) Service
Overview
Table 3.3095. Overview
Description:A property
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3096. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3097. 
NameDescriptionRequiredInternal Name
ValueThe property value. no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.4. EAP7 - IIOP-OpenJDK (Managed Server) Service
Overview
Table 3.3098. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3099. 
NameDescriptionRequiredInternal Name
Managed Runtime  yes managedRuntime
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3100. 
NameDescriptionRequiredInternal Name
Add Component Via InterceptorIndicates whether SSL components should be added by an IOR interceptor (on) or not (off). The default value is true. no add-component-via-interceptor
Auth MethodThe authentication method. Valid values are 'none' and 'username_password'. The default value is username_password. no auth-method
Caller PropagationIndicates whether the caller identity should be propagated in the SAS context or not. Valid values are 'none' and 'supported'. The default value is none. no caller-propagation
Client RequiresValue that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no client-requires
Client SupportsValue that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no client-supports
ConfidentialityIndicates whether the transport must require confidentiality protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no confidentiality
Detect MisorderingIndicates whether the transport must require misordering detection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no detect-misordering
Detect ReplayIndicates whether the transport must require replay detection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no detect-replay
Export CorbalocIndicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off). The default value is true. no export-corbaloc
Giop VersionThe GIOP version to be used. The default value is 1.2. no giop-version
High Water Mark:exprTCP connection cache parameter. Each time the number of connections exceeds this value ORB tries to reclaim connections. Number of reclaimed connections is specified by tcp-number-to-reclaim property. If this property is not set then it is configured as OpenJDK ORB default. no high-water-mark:expr
IntegrityIndicates whether the transport must require integrity protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no integrity
Number To Reclaim:exprTCP connection cache parameter. Each time number of connections exceeds tcp-high-water-mark property then ORB tries to reclaim connections. Number of reclaimed connections is specified by this property. If it is not set then it is configured as OpenJDK ORB default. no number-to-reclaim:expr
Persistent Server IdPersistent id of the server. Persistent object references are valid across many activactions of the server and they identify it using this property. As a result of that: many activations of the same server should have this property set to the same value, different server instances running on the same host should have different server ids. The default value is 1. no persistent-server-id
PropertiesA list of generic key/value properties. no properties
RealmThe authentication service (AS) realm name. no realm
RequiredIndicates if authentication is required (true) or not (false). The default value is false. no required
Root ContextThe naming service root context. The default value is JBoss/Naming/root. no root-context
SecurityIndicates whether the security interceptors are to be installed (on) or not (off). The default value is none. no security
Security DomainThe name of the security domain that holds the key and trust stores that will be used to establish SSL connections. no security-domain
Server RequiresValue that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no server-requires
Server SupportsValue that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no server-supports
Socket BindingThe name of the socket binding configuration that specifies the ORB port. The default value is iiop. no socket-binding
Ssl Socket BindingThe name of the socket binding configuration that specifies the ORB SSL port. The default value is iiop-ssl. no ssl-socket-binding
Support SslIndicates whether SSL is to be supported (on) or not (off). The default value is false. no support-ssl
TransactionsIndicates whether the transactions interceptors are to be installed (on or spec) or not (off). The value 'on' enabled JTS while 'spec' enables a spec compliant mode (non JTS) that rejects incoming transaction contexts. The default value is none. no transactions
Trust In ClientIndicates if the transport must require trust in client to be established. Valid values are 'none', 'supported' and 'required'. The default value is none. no trust-in-client
Trust In TargetIndicates if the transport must require trust in target to be established. Valid values are 'none' and 'supported'. The default value is none. no trust-in-target

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.5. EAP7 - JacORB (Managed Server) Service
Overview
Table 3.3101. Overview
Description:JacORB subsystem configuration
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3102. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3103. 
NameDescriptionRequiredInternal Name
Add Component Via InterceptorIndicates whether SSL components should be added by an IOR interceptor (on) or not (off). The default value is on. no add-component-via-interceptor
Cache Poa NamesIndicates whether POA names should be cached (on) or not (off). The default value is off. no cache-poa-names
Cache TypecodesIndicates whether typecodes should be cached (on) or not (off). The default value is off. no cache-typecodes
Chunk Custom Rmi ValuetypesIndicates whether custom RMI valuetypes should be encoded as chunks (on) or not (off). The default value is on. no chunk-custom-rmi-valuetypes
Client RequiresValue that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no client-requires
Client SupportsValue that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no client-supports
Client TimeoutThe client-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out. The default value is 0. no client-timeout
CometIndicates whether interoperability with Comet's ORB is enabled (on) or not (off). The default value is off. no comet
Export CorbalocIndicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off). The default value is on. no export-corbaloc
Giop Minor VersionThe GIOP minor version to be used. The default value is 2. no giop-minor-version
Indirection Encoding DisableIndicates whether indirection encoding for repeated typecodes should be disabled (on) or not (off). The default value is off. no indirection-encoding-disable
IonaIndicates whether interoperability with IONA's ASP is enabled (on) or not (off). The default value is off. no iona
Lax Boolean EncodingIndicates whether any non-zero CDR encoded boolean value should be interpreted as true (on) or not (off). The default value is off. no lax-boolean-encoding
Max Managed Buf SizeThe log2 of maximum size managed by the internal buffer manager. The default value is 24. no max-managed-buf-size
Max Server ConnectionsThe maximum number of connections accepted by the server. The default value is 2147483647. no max-server-connections
Max ThreadsThe maximum number of active request processor threads. Threads are first obtained from the pool and once the pool is exhausted new threads are created until the number of threads reaches this limit. New requests will wait until an active thread finishes its job. The default value is 32. no max-threads
MonitoringIndicates whether the monitoring GUI should be displayed (on) or not (off). The default value is off. no monitoring
NameThe name of the running ORB. The default value is JBoss. no name
Outbuf Cache TimeoutThe buffer cache timeout in milliseconds. The default value is -1. no outbuf-cache-timeout
Outbuf SizeThe size of the network buffers for outgoing messages. The default value is 2048. no outbuf-size
Pool SizeThe size of the request processors thread-pool. Threads that finish processing a request are placed back in the pool if the pool is not full and discarded otherwise. The default value is 5. no pool-size
Print VersionIndicates whether the version number should be printed during ORB startup (on) or not (off). The default value is off. no print-version
PropertiesA list of generic key/value properties. no properties
Queue MaxThe maximum number of requests that can be queued. The default value is 100. no queue-max
Queue MinThe size of the queue for notifying waiting requests. In other words, blocked requests are only notified when the queue has no more than queue-min requests. The default value is 10. no queue-min
Queue WaitIndicates whether requests that exceed the maximum queue size should wait (on) or not (off). When disabled, a TRANSIENT exception is thrown if the queue is full. The default value is off. no queue-wait
RetriesThe number of retries if connections cannot be promptly established. The default value is 5. no retries
Retry IntervalThe interval in milliseconds between retries. The default value is 500. no retry-interval
Root ContextThe naming service root context. The default value is JBoss/Naming/root. no root-context
SecurityIndicates whether the security interceptors are to be installed (on) or not (off). The default value is off. no security
Security DomainThe name of the security domain that holds the key and trust stores that will be used to establish SSL connections. no security-domain
Server RequiresValue that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no server-requires
Server SupportsValue that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no server-supports
Server TimeoutThe server-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out. The default value is 0. no server-timeout
Strict Check On Tc CreationIndicates whether the method create_abstract_interface_tc should perform a validation check on the name parameter (on) or not (off). The default value is off. yes strict-check-on-tc-creation
SunIndicates whether interoperability with Sun's ORB is enabled (on) or not (off). The default value is on. no sun
Support SslIndicates whether SSL is to be supported (on) or not (off). The default value is off. no support-ssl
TransactionsIndicates whether the transactions interceptors are to be installed (on or spec) or not (off). The value 'on' enabled JTS while 'spec' enables a spec compliant mode (non JTS) that rejects incoming transaction contexts. The default value is off. no transactions
Use BomIndicates whether GIOP 1.2 byte order markers should be used (on) or not (off). The default value is off. no use-bom
Use ImrIndicates whether the implementation repository should be used (on) or not (off). The default value is off. no use-imr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.6. EAP7 - JAXR (Managed Server) Service
Overview
Table 3.3104. Overview
Description:The configuration of the JAXR subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3105. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3106. 
NameDescriptionRequiredInternal Name
ClassThe JAXR ConnectionFactory implementation class no class
Jndi NameThe JNDI name under which the JAXR ConnectionFactory is bound no jndi-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.6.1. EAP7 - Property (JAXR - Managed Server) Service
Overview
Table 3.3107. Overview
Description:A JAXR property. The identity of the resource defines the property name.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3108. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3109. 
NameDescriptionRequiredInternal Name
ValueThe JAXR property value. yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.7. EAP7 - JPA (Managed Server) Service
Overview
Table 3.3110. Overview
Description:The configuration of the JPA subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3111. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3112. 
NameDescriptionRequiredInternal Name
Default DatasourceThe name of the default global datasource. no default-datasource

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.8. EAP7 - EE (Managed Server) Service
Overview
Table 3.3113. Overview
Description:The configuration of the EE subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3114. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3115. 
NameDescriptionRequiredInternal Name
Ear Subdeployments IsolatedFlag 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. The default value is false. no ear-subdeployments-isolated
Global ModulesA list of modules that should be made available to all deployments. no global-modules

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.9. EAP7 - Infinispan (Managed Server) Service
Overview
Table 3.3116. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3117. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.9.1. EAP7 - Cache Container (Managed Server) Service
Overview
Table 3.3118. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3119. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3120. Metrics
NameTypeDescriptionInternal Name
Cache Manager StatustraitThe status of the cache manager component. May return null if the cache manager is not started.cache-manager-status
Cluster NametraitThe name of the cluster this node belongs to. May return null if the cache manager is not started.cluster-name
Coordinator AddresstraitThe logical address of the cluster's coordinator. May return null if the cache manager is not started.coordinator-address
Is CoordinatortraitTrue if this node is the cluster's coordinator. May return null if the cache manager is not started.is-coordinator
Local AddresstraitThe local address of the node. May return null if the cache manager is not started.local-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3121. 
NameDescriptionRequiredInternal Name
AliasesThe list of aliases for this cache container no aliases
Default CacheThe default infinispan cache no default-cache
Jndi NameThe jndi name to which to bind this cache container no jndi-name
ModuleThe module whose class loader should be used when building this cache container's configuration. The default value is org.jboss.as.clustering.infinispan. no module
Statistics EnabledIf enabled, statistics will be collected for this cache container. no statistics-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.9.1.1. EAP7 - Cache (Managed Server) Service
Overview
Table 3.3122. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3123. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3124. Metrics
NameTypeDescriptionInternal Name
ActivationsmeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Activations per MinutemeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Average Read TimemeasurementAverage time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.average-read-time
Average Write TimemeasurementAverage time (in ms) for cache writes. May return null if the cache is not started.average-write-time
Cache StatustraitThe status of the cache component. May return null if the cache is not started.cache-status
Elapsed TimemeasurementTime (in secs) since cache started. May return null if the cache is not started.elapsed-time
Hit RatiomeasurementThe hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.hit-ratio
HitsmeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
Hits per MinutemeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
InvalidationsmeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
Invalidations per MinutemeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
MissesmeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Misses per MinutemeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Number Of EntriesmeasurementThe current number of entries in the cache. May return null if the cache is not started.number-of-entries
PassivationsmeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Passivations per MinutemeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Read Write RatiomeasurementThe read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.read-write-ratio
Remove HitsmeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove Hits per MinutemeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove MissesmeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
Remove Misses per MinutemeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
StoresmeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Stores per MinutemeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Time Since ResetmeasurementTime (in secs) since cache statistics were reset. May return null if the cache is not started.time-since-reset

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3125. 
NameDescriptionRequiredInternal Name
Jndi NameThe jndi-name to which to bind this cache instance. no jndi-name
ModeSets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. no mode
ModuleThe module whose class loader should be used when building this cache's configuration. no module
Queue Flush IntervalIn ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds. no queue-flush-interval
Queue SizeIn ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. no queue-size
Remote TimeoutIn SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown. no remote-timeout
Type of cacheType of cache no __type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.9.1.2. EAP7 - Distributed Cache (Managed Server) Service
Overview
Table 3.3126. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3127. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3128. Metrics
NameTypeDescriptionInternal Name
ActivationsmeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Activations per MinutemeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Average Read TimemeasurementAverage time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.average-read-time
Average Write TimemeasurementAverage time (in ms) for cache writes. May return null if the cache is not started.average-write-time
Cache StatustraitThe status of the cache component. May return null if the cache is not started.cache-status
Elapsed TimemeasurementTime (in secs) since cache started. May return null if the cache is not started.elapsed-time
Hit RatiomeasurementThe hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.hit-ratio
HitsmeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
Hits per MinutemeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
InvalidationsmeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
Invalidations per MinutemeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
MissesmeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Misses per MinutemeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Number Of EntriesmeasurementThe current number of entries in the cache. May return null if the cache is not started.number-of-entries
PassivationsmeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Passivations per MinutemeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Read Write RatiomeasurementThe read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.read-write-ratio
Remove HitsmeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove Hits per MinutemeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove MissesmeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
Remove Misses per MinutemeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
StoresmeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Stores per MinutemeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Time Since ResetmeasurementTime (in secs) since cache statistics were reset. May return null if the cache is not started.time-since-reset

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3129. 
NameDescriptionRequiredInternal Name
Jndi NameThe jndi-name to which to bind this cache instance. no jndi-name
L 1 LifespanMaximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored. The default value is 600000. no l1-lifespan
ModeSets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. no mode
ModuleThe module whose class loader should be used when building this cache's configuration. no module
OwnersNumber of cluster-wide replicas for each cache entry. The default value is 2. no owners
Queue Flush IntervalIn ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds. no queue-flush-interval
Queue SizeIn ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. no queue-size
Remote TimeoutIn SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown. no remote-timeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.9.1.3. EAP7 - Local Cache (Managed Server) Service
Overview
Table 3.3130. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3131. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3132. Metrics
NameTypeDescriptionInternal Name
ActivationsmeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Activations per MinutemeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Average Read TimemeasurementAverage time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.average-read-time
Average Write TimemeasurementAverage time (in ms) for cache writes. May return null if the cache is not started.average-write-time
Cache StatustraitThe status of the cache component. May return null if the cache is not started.cache-status
Elapsed TimemeasurementTime (in secs) since cache started. May return null if the cache is not started.elapsed-time
Hit RatiomeasurementThe hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.hit-ratio
HitsmeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
Hits per MinutemeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
InvalidationsmeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
Invalidations per MinutemeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
MissesmeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Misses per MinutemeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Number Of EntriesmeasurementThe current number of entries in the cache. May return null if the cache is not started.number-of-entries
PassivationsmeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Passivations per MinutemeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Read Write RatiomeasurementThe read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.read-write-ratio
Remove HitsmeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove Hits per MinutemeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove MissesmeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
Remove Misses per MinutemeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
StoresmeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Stores per MinutemeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Time Since ResetmeasurementTime (in secs) since cache statistics were reset. May return null if the cache is not started.time-since-reset

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3133. 
NameDescriptionRequiredInternal Name
Jndi NameThe jndi-name to which to bind this cache instance. no jndi-name
ModuleThe module whose class loader should be used when building this cache's configuration. no module

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.9.1.4. EAP7 - Transport (Managed Server) Service
Overview
Table 3.3134. Overview
Description:The description of the transport used by this cache container
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3135. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3136. 
NameDescriptionRequiredInternal Name
ChannelThe channel of this cache container's transport. no channel
Lock TimeoutThe timeout for locks for the transport. no lock-timeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.10. EAP7 - JGroups (Managed Server) Service
Overview
Table 3.3137. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3138. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3139. 
NameDescriptionRequiredInternal Name
Default StackDefault stack to use yes default-stack

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.11. EAP7 - Remoting (Managed Server) Service
Overview
Table 3.3140. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3141. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3142. 
NameDescriptionRequiredInternal Name
Worker Read ThreadsThe number of read threads to create for the remoting worker. The default value is 1. no worker-read-threads
Worker Task Core ThreadsThe number of core threads for the remoting worker task thread pool. The default value is 4. no worker-task-core-threads
Worker Task KeepaliveThe number of milliseconds to keep non-core remoting worker task threads alive. The default value is 60. no worker-task-keepalive
Worker Task LimitThe maximum number of remoting worker tasks to allow before rejecting. The default value is 16384. no worker-task-limit
Worker Task Max ThreadsThe maximum number of threads for the remoting worker task thread pool. The default value is 16. no worker-task-max-threads
Worker Write ThreadsThe number of write threads to create for the remoting worker. The default value is 1. no worker-write-threads

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.12. EAP7 - Mail (Managed Server) Service
Overview
Table 3.3143. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3144. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.12.1. EAP7 - Mail Session (Managed Server) Service
Overview
Table 3.3145. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3146. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3147. 
NameDescriptionRequiredInternal Name
DebugEnables javamail debugging. The default value is false. no debug
FromFrom address that is used as default from, if not set when sending no from
Jndi NameJNDI name to where mail session should be bound no jndi-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.12.1.1. EAP7 - SMTP Mail Server (Managed Server) Service
Overview
Table 3.3148. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3149. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3150. 
NameDescriptionRequiredInternal Name
Outbound Socket Binding RefOutbound Socket binding to SMTP server no outbound-socket-binding-ref
PasswordPassword to authenticate on server no password
SslDoes server requires SSL?. The default value is false. no ssl
UsernameUsername to authenticate on server no username

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.12.1.2. EAP7 - IMAP Mail Server (Managed Server) Service
Overview
Table 3.3151. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3152. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3153. 
NameDescriptionRequiredInternal Name
Outbound Socket Binding RefOutbound Socket binding to IMAP server no outbound-socket-binding-ref
PasswordPassword to authenticate on server no password
SslDoes server requires SSL?. The default value is false. no ssl
UsernameUsername to authenticate on server no username

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.12.1.3. EAP7 - POP3 Mail Server (Managed Server) Service
Overview
Table 3.3154. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3155. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3156. 
NameDescriptionRequiredInternal Name
Outbound Socket Binding RefOutbound Socket binding to POP3 server no outbound-socket-binding-ref
PasswordPassword to authenticate on server no password
SslDoes server requires SSL?. The default value is false. no ssl
UsernameUsername to authenticate on server no username

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13. EAP7 - Undertow (Managed Server) Service
Overview
Table 3.3157. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3158. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3159. 
NameDescriptionRequiredInternal Name
Default Security DomainThe default security domain used by web deployments. The default value is other. no default-security-domain
Default ServerThe default server to use for deployments. The default value is default-server. no default-server
Default Servlet ContainerThe default servlet container to use for deployments. The default value is default. no default-servlet-container
Default Virtual HostThe default virtual host to use for deployments. The default value is default-host. no default-virtual-host
Instance IdThe cluster instance id. The default value is {EXPRESSION_VALUE=${jboss.node.name}}. no instance-id
Statistics EnabledConfigures if are statistics enabled. The default value is false. no statistics-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.1. EAP7 - Filter configurations (Managed Server) Service
Overview
Table 3.3160. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3161. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.13.1.1. EAP7 - Error page (Managed Server) Service
Overview
Table 3.3162. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3163. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3164. 
NameDescriptionRequiredInternal Name
Code:exprError page code yes code:expr
PathError page path no path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.1.2. EAP7 - Expression filter (Managed Server) Service
Overview
Table 3.3165. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3166. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3167. 
NameDescriptionRequiredInternal Name
ExpressionThe expression that defines the filter yes expression
ModuleModule to use to load the filter definitions no module

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.1.3. EAP7 - GZIP (Managed Server) Service
Overview
Table 3.3168. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3169. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.13.1.4. EAP7 - Mod cluster (Managed Server) Service
Overview
Table 3.3170. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3171. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3172. 
NameDescriptionRequiredInternal Name
Advertise Frequency:exprThe frequency (in milliseconds) that mod-cluster advertises itself on the network. The default value is 10000. no advertise-frequency:expr
Advertise PathThe path that mod-cluster is registered under, defaults to /. The default value is /. no advertise-path
Advertise ProtocolThe protocol that is in use, defaults to HTTP. The default value is http. no advertise-protocol
Advertise Socket BindingThe multicast group that is used to advertise yes advertise-socket-binding
Broken Node Timeout:exprThe amount of time that must elapse before a broken node is removed from the table. The default value is 60000. no broken-node-timeout:expr
Cached Connections Per Thread:exprThe number of connections that will be kept alive indefinitely. The default value is 40. no cached-connections-per-thread:expr
Connection Idle Timeout:exprThe 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). The default value is 60. no connection-idle-timeout:expr
Connections Per Thread:exprThe number of connections that will be maintained to backend servers, per IO thread. Defaults to 10. The default value is 40. no connections-per-thread:expr
Enable Http 2If 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. The default value is false. no enable-http2
Health Check Interval:exprThe frequency of health check pings to backend nodes. The default value is 10000. no health-check-interval:expr
Management Access PredicateA 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 no management-access-predicate
Management Socket BindingThe socket binding of the mod_cluster management 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 yes management-socket-binding
Max Ajp Packet SizeThe 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. no max-ajp-packet-size
Max Request Time:exprThe max amount of time that a request to a backend node can take before it is killed. The default value is -1. no max-request-time:expr
Request Queue Size:exprThe number of requests that can be queued if the connection pool is full before requests are rejected with a 503. The default value is 1000. no request-queue-size:expr
Security KeyThe security key that is used for the mod-cluster group. All members must use the same security key. no security-key
Security RealmThe security realm that provides the SSL configuration no security-realm
Use AliasIf an alias check is performed. The default value is false. no use-alias
WorkerThe XNIO worker that is used to send the advertise notifications. The default value is default. no worker

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.1.5. EAP7 - Rewrite (Managed Server) Service
Overview
Table 3.3173. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3174. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3175. 
NameDescriptionRequiredInternal Name
RedirectIf this is true then a redirect will be done instead of a rewrite. The default value is false. no redirect
TargetThe expression that defines the target. If you are redirecting to a constant target put single quotes around the value yes target

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.1.6. EAP7 - Response header (Managed Server) Service
Overview
Table 3.3176. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3177. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3178. 
NameDescriptionRequiredInternal Name
Header NameHeader name yes header-name
Header ValueValue for header yes header-value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.1.7. EAP7 - Request limit (Managed Server) Service
Overview
Table 3.3179. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3180. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3181. 
NameDescriptionRequiredInternal Name
Max Concurrent Requests:exprMaximum number of concurrent requests no max-concurrent-requests:expr
Queue Size:exprNumber of requests to queue before they start being rejected no queue-size:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.1.8. EAP7 - Custom filter (Managed Server) Service
Overview
Table 3.3182. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3183. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3184. 
NameDescriptionRequiredInternal Name
Class NameClass name of HttpHandler yes class-name
ModuleModule name where class can be loaded from yes module
ParametersFilter parameters no parameters

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.2. EAP7 - Handler configuration (Managed Server) Service
Overview
Table 3.3185. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3186. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.13.2.1. EAP7 - File Handler - Undertow (Managed Server) Service
Overview
Table 3.3187. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3188. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3189. 
NameDescriptionRequiredInternal Name
Cache Buffer Size:exprSize of the buffers. The default value is 1024. no cache-buffer-size:expr
Cache Buffers:exprNumber of buffers. The default value is 1024. no cache-buffers:expr
Case SensitiveUse case sensitive file handling. The default value is true. no case-sensitive
Directory ListingEnable directory listing?. The default value is false. no directory-listing
Follow SymlinkEnable following symbolic links. The default value is false. no follow-symlink
PathPath on filesystem from where file handler will serve resources no path
Safe Symlink PathsPaths that are safe to be targets of symbolic links no safe-symlink-paths

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.2.2. EAP7 - Reverse proxy (Managed Server) Service
Overview
Table 3.3190. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3191. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3192. 
NameDescriptionRequiredInternal Name
Cached Connections Per Thread:exprThe number of connections that will be kept alive indefinitely. The default value is 5. no cached-connections-per-thread:expr
Connection Idle Timeout:exprThe 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). The default value is 60. no connection-idle-timeout:expr
Connections Per Thread:exprThe number of connections that will be maintained to backend servers, per IO thread. Defaults to 10. The default value is 10. no connections-per-thread:expr
Max Request Time:exprThe maximum time that a proxy request can be active for, before being killed. Defaults to unlimited. The default value is -1. no max-request-time:expr
Problem Server Retry:exprTime in seconds to wait before attempting to reconnect to a server that is down. The default value is 30. no problem-server-retry:expr
Request Queue Size:exprThe number of requests that can be queued if the connection pool is full before requests are rejected with a 503. The default value is 10. no request-queue-size:expr
Session Cookie NamesComma separated list of session cookie names. Generally this will just be JSESSIONID. The default value is JSESSIONID. no session-cookie-names

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.2.2.1. EAP7 - Reverse proxy host (Managed Server) Service
Overview
Table 3.3193. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3194. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3195. 
NameDescriptionRequiredInternal Name
Instance IdThe instance id (aka JVM route) that will be used to enable sticky sessions no instance-id
Outbound Socket BindingOutbound socket binding for this host no outbound-socket-binding
PathOptional path if host is using non root resource. The default value is /. no path
SchemeWhat kind of scheme is used. The default value is http. no scheme
Security RealmThe security realm that provides the SSL configuration for the connection to the host no security-realm

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.3. EAP7 - Buffer Cache (Managed Server) Service
Overview
Table 3.3196. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3197. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3198. 
NameDescriptionRequiredInternal Name
Buffer Size:exprThe size of an individual buffer. The default value is 1024. no buffer-size:expr
Buffers Per Region:exprThe numbers of buffers in a region. The default value is 1024. no buffers-per-region:expr
Max Regions:exprThe maximum number of regions. The default value is 10. no max-regions:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.4. EAP7 - Server (Managed Server) Service
Overview
Table 3.3199. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3200. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3201. 
NameDescriptionRequiredInternal Name
Default HostThe servers default virtual host. The default value is default-host. no default-host
Servlet ContainerThe servers default servlet container. The default value is default. no servlet-container

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.4.1. EAP7 - Ajp Listener (Managed Server) Service
Overview
Table 3.3202. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3203. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3204. Metrics
NameTypeDescriptionInternal Name
Bytes ReceivedmeasurementThe number of bytes that have been received by this listenerbytes-received
Bytes SentmeasurementThe number of bytes that have been sent out on this listenerbytes-sent
Error CountmeasurementThe number of 500 responses that have been sent by this listenererror-count
Max Processing TimemeasurementThe maximum processing time taken by a request on this listenermax-processing-time
Processing TimemeasurementThe total processing time of all requests handed by this listenerprocessing-time
Request CountmeasurementThe number of requests this listener has servedrequest-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3205. 
NameDescriptionRequiredInternal Name
Allow Encoded SlashIf a request comes in with encoded / characters (i.e. %2F), will these be decoded. The default value is false. no allow-encoded-slash
Allow Equals In Cookie ValueIf 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. The default value is false. no allow-equals-in-cookie-value
Always Set Keep AliveIf this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. no always-set-keep-alive
Buffer Pipelined DataIf we should buffer pipelined requests. The default value is true. no buffer-pipelined-data
Buffer PoolThe AJP listeners buffer pool. The default value is default. no buffer-pool
Decode UrlIf 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. The default value is true. no decode-url
Disallowed MethodsA comma separated list of HTTP methods that are not allowed no disallowed-methods
EnabledIf the listener is enabled. The default value is true. no enabled
Max Buffered Request Size:exprMaximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation. The default value is 16384. no max-buffered-request-size:expr
Max Connections:exprThe maximum number of concurrent connections. no max-connections:expr
Max Cookies:exprThe maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-cookies:expr
Max Header Size:exprThe maximum size in bytes of a http request header. The default value is 1048576. no max-header-size:expr
Max Headers:exprThe maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-headers:expr
Max Parameters:exprThe 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). The default value is 1000. no max-parameters:expr
Max Post Size:exprThe maximum size of a post that will be accepted. The default value is 10485760. no max-post-size:expr
No Request Timeout:exprThe length of time in milliseconds that the connection can be idle before it is closed by the container no no-request-timeout:expr
Read Timeout:exprConfigure 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}. no read-timeout:expr
Receive Buffer:exprThe receive buffer size. no receive-buffer:expr
Record Request Start TimeIf 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. The default value is false. no record-request-start-time
Redirect SocketIf 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. no redirect-socket
Request Parse Timeout:exprThe maximum amount of time (in milliseconds) that can be spent parsing the request no request-parse-timeout:expr
Resolve Peer AddressEnables host dns lookup. The default value is false. no resolve-peer-address
SchemeThe listener scheme, can be HTTP or HTTPS. By default the scheme will be taken from the incoming AJP request. no scheme
Send Buffer:exprThe send buffer size. no send-buffer:expr
Socket BindingThe AJP listener socket binder yes socket-binding
Tcp Backlog:exprConfigure a server with the specified backlog. no tcp-backlog:expr
Tcp Keep AliveConfigure a channel to send TCP keep-alive messages in an implementation-dependent manner. no tcp-keep-alive
Url CharsetURL charset. The default value is UTF-8. no url-charset
WorkerThe AJP listeners XNIO worker. The default value is default. no worker
Write Timeout:exprConfigure 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}. no write-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.4.2. EAP7 - Undertow Host (Managed Server) Service
Overview
Table 3.3206. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3207. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3208. 
NameDescriptionRequiredInternal Name
AliasAliases for the host no alias
Default Response Code:exprIf set, this will be response code sent back in case requested context does not exist on server. The default value is 404. no default-response-code:expr
Default Web ModuleDefault web module. The default value is ROOT.war. no default-web-module
Disable Console Redirectif set to true, /console redirect wont be enabled for this host, default is false. The default value is false. no disable-console-redirect

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.4.2.1. EAP7 - Host Filter Ref (Managed Server) Service
Overview
Table 3.3209. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3210. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3211. 
NameDescriptionRequiredInternal Name
PredicatePredicates 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. no predicate
Priority:exprDefines 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. The default value is 1. no priority:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.4.2.2. EAP7 - Undertow-Location (Managed Server) Service
Overview
Table 3.3212. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3213. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3214. 
NameDescriptionRequiredInternal Name
HandlerDefault handler for this location yes handler

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.4.2.2.1. EAP7 - Location Filter Ref (Managed Server) Service
Overview
Table 3.3215. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3216. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3217. 
NameDescriptionRequiredInternal Name
PredicatePredicates 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. no predicate
Priority:exprDefines 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. The default value is 1. no priority:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.4.3. EAP7 - Http Listener (Managed Server) Service
Overview
Table 3.3218. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3219. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3220. Metrics
NameTypeDescriptionInternal Name
Bytes ReceivedmeasurementThe number of bytes that have been received by this listenerbytes-received
Bytes SentmeasurementThe number of bytes that have been sent out on this listenerbytes-sent
Error CountmeasurementThe number of 500 responses that have been sent by this listenererror-count
Max Processing TimemeasurementThe maximum processing time taken by a request on this listenermax-processing-time
Processing TimemeasurementThe total processing time of all requests handed by this listenerprocessing-time
Request CountmeasurementThe number of requests this listener has servedrequest-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3221. 
NameDescriptionRequiredInternal Name
Allow Encoded SlashIf a request comes in with encoded / characters (i.e. %2F), will these be decoded. The default value is false. no allow-encoded-slash
Allow Equals In Cookie ValueIf 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. The default value is false. no allow-equals-in-cookie-value
Always Set Keep AliveIf this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. no always-set-keep-alive
Buffer Pipelined DataIf we should buffer pipelined requests. The default value is true. no buffer-pipelined-data
Buffer PoolThe AJP listeners buffer pool. The default value is default. no buffer-pool
Certificate ForwardingIf 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. The default value is false. no certificate-forwarding
Decode UrlIf 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. The default value is true. no decode-url
Disallowed MethodsA comma separated list of HTTP methods that are not allowed no disallowed-methods
Enable Http 2Enables HTTP2 support for this listener. The default value is false. no enable-http2
EnabledIf the listener is enabled. The default value is true. no enabled
Max Buffered Request Size:exprMaximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation. The default value is 16384. no max-buffered-request-size:expr
Max Connections:exprThe maximum number of concurrent connections. no max-connections:expr
Max Cookies:exprThe maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-cookies:expr
Max Header Size:exprThe maximum size in bytes of a http request header. The default value is 1048576. no max-header-size:expr
Max Headers:exprThe maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-headers:expr
Max Parameters:exprThe 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). The default value is 1000. no max-parameters:expr
Max Post Size:exprThe maximum size of a post that will be accepted. The default value is 10485760. no max-post-size:expr
No Request Timeout:exprThe length of time in milliseconds that the connection can be idle before it is closed by the container no no-request-timeout:expr
Proxy Address Forwardingenables x-forwarded-host and similar headers and set a remote ip address and hostname. The default value is false. no proxy-address-forwarding
Read Timeout:exprConfigure 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}. no read-timeout:expr
Receive Buffer:exprThe receive buffer size. no receive-buffer:expr
Record Request Start TimeIf 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. The default value is false. no record-request-start-time
Redirect SocketIf 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. no redirect-socket
Request Parse Timeout:exprThe maximum amount of time (in milliseconds) that can be spent parsing the request no request-parse-timeout:expr
Resolve Peer AddressEnables host dns lookup. The default value is false. no resolve-peer-address
Send Buffer:exprThe send buffer size. no send-buffer:expr
Socket BindingThe AJP listener socket binder yes socket-binding
Tcp Backlog:exprConfigure a server with the specified backlog. no tcp-backlog:expr
Tcp Keep AliveConfigure a channel to send TCP keep-alive messages in an implementation-dependent manner. no tcp-keep-alive
Url CharsetURL charset. The default value is UTF-8. no url-charset
WorkerThe AJP listeners XNIO worker. The default value is default. no worker
Write Timeout:exprConfigure 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}. no write-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.4.4. EAP7 - Https Listener (Managed Server) Service
Overview
Table 3.3222. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3223. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3224. Metrics
NameTypeDescriptionInternal Name
Bytes ReceivedmeasurementThe number of bytes that have been received by this listenerbytes-received
Bytes SentmeasurementThe number of bytes that have been sent out on this listenerbytes-sent
Error CountmeasurementThe number of 500 responses that have been sent by this listenererror-count
Max Processing TimemeasurementThe maximum processing time taken by a request on this listenermax-processing-time
Processing TimemeasurementThe total processing time of all requests handed by this listenerprocessing-time
Request CountmeasurementThe number of requests this listener has servedrequest-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3225. 
NameDescriptionRequiredInternal Name
Allow Encoded SlashIf a request comes in with encoded / characters (i.e. %2F), will these be decoded. The default value is false. no allow-encoded-slash
Allow Equals In Cookie ValueIf 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. The default value is false. no allow-equals-in-cookie-value
Always Set Keep AliveIf this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. no always-set-keep-alive
Buffer Pipelined DataIf we should buffer pipelined requests. The default value is true. no buffer-pipelined-data
Buffer PoolThe AJP listeners buffer pool. The default value is default. no buffer-pool
Decode UrlIf 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. The default value is true. no decode-url
Disallowed MethodsA comma separated list of HTTP methods that are not allowed no disallowed-methods
Enable Http 2Enables HTTP2 support for this listener. The default value is false. no enable-http2
Enable SpdyEnables SPDY support for this listener. The default value is false. no enable-spdy
EnabledIf the listener is enabled. The default value is true. no enabled
Enabled Cipher SuitesConfigures Enabled SSL cyphers no enabled-cipher-suites
Enabled ProtocolsConfigures SSL protocols no enabled-protocols
Max Buffered Request Size:exprMaximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation. The default value is 16384. no max-buffered-request-size:expr
Max Connections:exprThe maximum number of concurrent connections. no max-connections:expr
Max Cookies:exprThe maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-cookies:expr
Max Header Size:exprThe maximum size in bytes of a http request header. The default value is 1048576. no max-header-size:expr
Max Headers:exprThe maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-headers:expr
Max Parameters:exprThe 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). The default value is 1000. no max-parameters:expr
Max Post Size:exprThe maximum size of a post that will be accepted. The default value is 10485760. no max-post-size:expr
No Request Timeout:exprThe length of time in milliseconds that the connection can be idle before it is closed by the container no no-request-timeout:expr
Read Timeout:exprConfigure 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}. no read-timeout:expr
Receive Buffer:exprThe receive buffer size. no receive-buffer:expr
Record Request Start TimeIf 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. The default value is false. no record-request-start-time
Request Parse Timeout:exprThe maximum amount of time (in milliseconds) that can be spent parsing the request no request-parse-timeout:expr
Resolve Peer AddressEnables host dns lookup. The default value is false. no resolve-peer-address
Security RealmThe listeners security realm yes security-realm
Send Buffer:exprThe send buffer size. no send-buffer:expr
Socket BindingThe AJP listener socket binder yes socket-binding
Ssl Session Cache Size:exprThe maximum number of active SSL sessions no ssl-session-cache-size:expr
Ssl Session Timeout:exprThe timeout for SSL sessions, in seconds no ssl-session-timeout:expr
Tcp Backlog:exprConfigure a server with the specified backlog. no tcp-backlog:expr
Tcp Keep AliveConfigure a channel to send TCP keep-alive messages in an implementation-dependent manner. no tcp-keep-alive
Url CharsetURL charset. The default value is UTF-8. no url-charset
Verify ClientThe desired SSL client authentication mode for SSL channels. The default value is NOT_REQUESTED. no verify-client
WorkerThe AJP listeners XNIO worker. The default value is default. no worker
Write Timeout:exprConfigure 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}. no write-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.5. EAP7 - Servlet Container (Managed Server) Service
Overview
Table 3.3226. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3227. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3228. 
NameDescriptionRequiredInternal Name
Check Interval:exprCheck interval for JSP updates using a background thread. The default value is 0. no check-interval:expr
DevelopmentEnable Development mode which enables reloading JSP on-the-fly. The default value is false. no development
DisabledEnable the JSP container. The default value is false. no disabled
Display Source FragmentWhen a runtime error occurs, attempts to display corresponding JSP source fragment. The default value is true. no display-source-fragment
Dump SmapWrite SMAP data to a file. The default value is false. no dump-smap
Error On Use Bean Invalid Class AttributeEnable errors when using a bad class in useBean. The default value is false. no error-on-use-bean-invalid-class-attribute
Generate Strings As Char ArraysGenerate String constants as char arrays. The default value is false. no generate-strings-as-char-arrays
Java EncodingSpecify the encoding used for Java sources. The default value is UTF8. no java-encoding
Keep GeneratedKeep the generated Servlets. The default value is true. no keep-generated
Mapped FileMap to the JSP source. The default value is true. no mapped-file
Modification Test Interval:exprMinimum amount of time between two tests for updates, in seconds. The default value is 4. no modification-test-interval:expr
Optimize ScriptletsIf JSP scriptlets should be optimised to remove string concatenation. The default value is false. no optimize-scriptlets
Recompile On FailRetry failed JSP compilations on each request. The default value is false. no recompile-on-fail
Scratch DirSpecify a different work directory. no scratch-dir
SmapEnable SMAP. The default value is true. no smap
Source VmSource VM level for compilation. The default value is 1.8. no source-vm
Tag PoolingEnable tag pooling. The default value is true. no tag-pooling
Target VmTarget VM level for compilation. The default value is 1.8. no target-vm
Trim SpacesTrim some spaces from the generated Servlet. The default value is false. no trim-spaces
X Powered ByEnable advertising the JSP engine in x-powered-by. The default value is true. no x-powered-by
Buffer PoolThe buffer pool to use for websocket deployments. The default value is default. no buffer-pool
Dispatch To WorkerIf 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. The default value is true. no dispatch-to-worker
WorkerThe worker to use for websocket deployments. The default value is default. no worker
Allow Non Standard WrappersIf true then request and response wrappers that do not extend the standard wrapper classes can be used. The default value is false. no allow-non-standard-wrappers
Default Buffer CacheThe buffer cache to use for caching static resources. The default value is default. no default-buffer-cache
Default EncodingDefault encoding to use for all deployed applications no default-encoding
Default Session Timeout:exprThe default session timeout (in minutes) for all applications deployed in the container. The default value is 30. no default-session-timeout:expr
Directory ListingIf directory listing should be enabled for default servlets. no directory-listing
Disable Caching For Secured PagesIf 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. The default value is true. no disable-caching-for-secured-pages
Eager Filter InitializationIf true undertow calls filter init() on deployment start rather than when first requested. The default value is false. no eager-filter-initialization
Ignore FlushIgnore flushes on the servlet output stream. In most cases these just hurt performance for no good reason. The default value is false. no ignore-flush
Max Sessions:exprThe maximum number of sessions that can be active at one time no max-sessions:expr
Proactive AuthenticationIf proactive authentication should be used. If this is true a user will always be authenticated if credentials are present. The default value is true. no proactive-authentication
Session Id Length:exprThe length of the generated session ID. Longer session ID's are more secure. The default value is 30. no session-id-length:expr
Stack Trace On ErrorIf an error page with the stack trace should be generated on error. Values are all, none and local-only. The default value is local-only. no stack-trace-on-error
Use Listener EncodingUse encoding defined on listener. The default value is false. no use-listener-encoding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.5.1. EAP7 - Mime Mapping (Managed Server) Service
Overview
Table 3.3229. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3230. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3231. 
NameDescriptionRequiredInternal Name
ValueThe mime type for this mapping yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.13.5.2. EAP7 - Welcome File (Managed Server) Service
Overview
Table 3.3232. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3233. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.14. EAP7 - JCA (Managed Server) Service
Overview
Table 3.3234. Overview
Description:The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3235. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3236. 
NameDescriptionRequiredInternal Name
EnabledSpecify whether bean validation is enabled. The default value is true. no enabled:1
EnabledSpecify whether archive validation is enabled. The default value is true. no enabled:2
Fail On ErrorShould an archive validation error report fail the deployment. The default value is true. no fail-on-error
Fail On WarnShould an archive validation warning report fail the deployment. The default value is false. no fail-on-warn
DebugEnable/disable debug information logging. The default value is false. no debug
ErrorEnable/disable error information logging. The default value is false. no error
InstallEnable/disable the cached connection manager valve and interceptor. The default value is false. no install

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.14.1. EAP7 - BootstrapContext (Managed Server) Service
Overview
Table 3.3237. Overview
Description:Bootstrap context for resource adapters.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3238. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3239. 
NameDescriptionRequiredInternal Name
NameThe name of the BootstrapContext no name
WorkmanagerThe WorkManager instance for the BootstrapContext no workmanager

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.14.2. EAP7 - Workmanager (Managed Server) Service
Overview
Table 3.3240. Overview
Description:WorkManager for resource adapters.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3241. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3242. 
NameDescriptionRequiredInternal Name
NameThe name of the WorkManager no name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.14.2.1. EAP7 - Long Running Thread Pool (Managed Server) Service
Overview
Table 3.3243. Overview
Description:Long running thread pool executor with a bounded queue where threads submitting tasks may block.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3244. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3245. Metrics
NameTypeDescriptionInternal Name
Current Thread CountmeasurementThe current number of threads in the pool.current-thread-count
Largest Thread CountmeasurementThe largest number of threads that have ever simultaneously been in the pool.largest-thread-count
Rejected CountmeasurementThe number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.rejected-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3246. 
NameDescriptionRequiredInternal Name
Allow Core TimeoutWhether core threads may time out. The default value is false. no allow-core-timeout
Core ThreadsThe 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. no core-threads:expr
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. yes max-threads:expr
NameThe name of the thread pool. no name
Queue LengthThe queue length. yes queue-length:expr
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.14.2.2. EAP7 - Short Running Thread Pool (Managed Server) Service
Overview
Table 3.3247. Overview
Description:Short running thread pool executor with a bounded queue where threads submitting tasks may block.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3248. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3249. Metrics
NameTypeDescriptionInternal Name
Current Thread CountmeasurementThe current number of threads in the pool.current-thread-count
Largest Thread CountmeasurementThe largest number of threads that have ever simultaneously been in the pool.largest-thread-count
Rejected CountmeasurementThe number of tasks that have been passed to the handoff-executor (if one is specified) or discarded.rejected-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3250. 
NameDescriptionRequiredInternal Name
Allow Core TimeoutWhether core threads may time out. The default value is false. no allow-core-timeout
Core ThreadsThe 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. no core-threads:expr
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. yes max-threads:expr
NameThe name of the thread pool. no name
Queue LengthThe queue length. yes queue-length:expr
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.15. EAP7 - Osgi (Managed Server) Service
Overview
Table 3.3251. Overview
Description:The OSGi subsystem configuration.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3252. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3253. 
NameDescriptionRequiredInternal Name
ActivationActivation flag for the OSGi subsystem. Possible values: lazy, eager. The default value is LAZY. no activation
StartlevelThe current Start Level of the OSGi Framework. Changing this value will change the Start Level of the Framework accordingly. no startlevel

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3254. Metrics
NameDescription
ActivateActivate the OSGi subsystem.
Package Types
none
3.4.2.4.15.1. EAP7 - Capability (Managed Server) Service
Overview
Table 3.3255. Overview
Description:A framework capability. A capability maps to a JBoss Module in the modules directory or an OSGi bundle in the bundles directory. The identity maps to the resource identifier of the module or bundle.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3256. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3257. 
NameDescriptionRequiredInternal Name
StartlevelThe startlevel for the capability. Can only be specified for OSGi bundles. no startlevel

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.15.2. EAP7 - Bundle (Managed Server) Service
Overview
Table 3.3258. Overview
Description:Runtime bundle information.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3259. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3260. 
NameDescriptionRequiredInternal Name
IdThe bundle ID. no id
StartlevelThe bundle's start level. no startlevel
Symbolic NameThe bundle symbolic name. no symbolic-name
VersionThe bundle version. no version

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3261. Metrics
NameDescription
StartStarts the bundle.
StopStops the bundle.
Package Types
none
3.4.2.4.15.3. EAP7 - Property (Read Only) Service
Overview
Table 3.3262. Overview
Description:A property
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3263. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3264. 
NameDescriptionRequiredInternal Name
ValueThe property value. no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.16. EAP7 - JMX (Managed Server) Service
Overview
Table 3.3265. Overview
Description:The configuration of the JMX subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3266. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3267. 
NameDescriptionRequiredInternal Name
Show ModelSet to 'true' to include MBeans for the model controller resources no show-model

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.16.1. EAP7 - Remoting Connector (Managed Server) Service
Overview
Table 3.3268. Overview
Description:The configuration of a resource adapter.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3269. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3270. 
NameDescriptionRequiredInternal Name
Use Management EndpointIf true the connector will use the management endpoint, otherwise it will use the remoting subsystem one. The default value is true. no use-management-endpoint

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.17. EAP7 - Resource Adapters (Managed Server) Service
Overview
Table 3.3271. Overview
Description:Configuration of the resource adapters subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3272. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.17.1. EAP7 - Resource Adapter (Managed Server) Service
Overview
Table 3.3273. Overview
Description:The configuration of a resource adapter.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3274. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3275. 
NameDescriptionRequiredInternal Name
ArchiveSpecifies the resource adapter archive yes archive
BeanvalidationgroupsSpecifies the bean validation groups that should be used no beanvalidationgroups
BootstrapcontextSpecifies the unique name of the bootstrap context that should be used no bootstrapcontext
Transaction SupportSpecifies the transaction support level of the resource adapter yes transaction-support

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.17.1.1. EAP7 - Admin Objects (Managed Server) Service
Overview
Table 3.3276. Overview
Description:Specifies the administration objects.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3277. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3278. 
NameDescriptionRequiredInternal Name
Class NameSpecifies the fully qualified class name of a managed connection factory or admin object yes class-name
EnabledSpecifies if the resource adapter should be enabled. The default value is true. no enabled
Jndi NameSpecifies the JNDI name for the connection factory or admin object no jndi-name
Use Java ContextSetting this to false will bind the object into global JNDI. The default value is true. no use-java-context

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.17.1.2. EAP7 - Connection Definitions (Managed Server) Service
Overview
Table 3.3279. Overview
Description:Specifies the connection definitions.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3280. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3281. 
NameDescriptionRequiredInternal Name
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception no allocation-retry:expr
Allocation Retry Wait MillisThe allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection no allocation-retry-wait-millis:expr
Background ValidationAn 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. The default value is false. no background-validation
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart no background-validation-millis:expr
Blocking Timeout Wait MillisThe 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 no blocking-timeout-wait-millis:expr
Class NameSpecifies the fully qualified class name of a managed connection factory or admin object yes class-name
EnabledSpecifies if the resource adapter should be enabled. The default value is true. no enabled
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Idle Timeout MinutesThe 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 requires a server restart. no idle-timeout-minutes:expr
InterleavingAn element to enable interleaving for XA connections. The default value is false. no interleaving
Jndi NameSpecifies the JNDI name for the connection factory or admin object no jndi-name
Max Pool SizeThe max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20. no max-pool-size
Min Pool SizeThe min-pool-size element specifies the minimum number of connections for a pool. The default value is 0. no min-pool-size
No RecoverySpecifies if the connection pool should be excluded from recovery no no-recovery
No Tx Separate PoolOracle 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. The default value is false. no no-tx-separate-pool
Pad XidShould the Xid be padded. The default value is false. no pad-xid
Pool PrefillShould the pool be prefilled. Changing this value requires a server restart. The default value is false. no pool-prefill
Pool Use Strict MinSpecifies if the min-pool-size should be considered strictly. The default value is false. no pool-use-strict-min
Recovery PasswordThe password used for recovery no recovery-password
Recovery Plugin Class NameThe fully qualified class name of the recovery plugin implementation no recovery-plugin-class-name
Recovery Plugin PropertiesThe properties for the recovery plugin no recovery-plugin-properties
Recovery Security DomainThe security domain used for recovery no recovery-security-domain
Recovery UsernameThe user name used for recovery no recovery-username
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Security ApplicationIndicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool no security-application
Security DomainSpecifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool no security-domain
Security Domain and ApplicationIndicates that either app supplied parameters (such as from getConnection(user, pw)) or Subject (from security domain) are used to distinguish connections in the pool no security-domain-and-application
Use CcmEnable the use of a cached connection manager. The default value is true. no use-ccm
Use Fast FailWhether 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). The default value is false. no use-fast-fail
Use Java ContextSetting this to false will bind the object into global JNDI. The default value is true. no use-java-context
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock:expr
Wrap Xa ResourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true. no wrap-xa-resource
XA Resource TimeoutThe value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero no xa-resource-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3282. Metrics
NameDescription
Flush All Connections in PoolFlushes all connections in the pool
Flush Idle Connections in PoolFlushes all idle connections in the pool
Test Connection in PoolTest if a connection can be obtained
Package Types
none
3.4.2.4.17.1.2.1. EAP7 - Config Properties (Read Only) Service
Overview
Table 3.3283. Overview
Description:Custom defined config properties.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3284. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3285. 
NameDescriptionRequiredInternal Name
ValueCustom defined config property value no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.17.1.3. EAP7 - Config Properties (Read Only) Service
Overview
Table 3.3286. Overview
Description:Custom defined config properties.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3287. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3288. 
NameDescriptionRequiredInternal Name
ValueCustom defined config property value no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.18. EAP7 - CMP (Managed Server) Service
Overview
Table 3.3289. Overview
Description:The configuration of the cmp subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3290. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.18.1. EAP7 - HiloKeygenerator (Managed Server) Service
Overview
Table 3.3291. Overview
Description:HiLo based key generators.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3292. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3293. 
NameDescriptionRequiredInternal Name
Block SizeThe block size no block-size
Create TableBoolean to determine whether to create create the tables no create-table
Create Table DdlThe DDL used to create the table no create-table-ddl
Data SourceThe datasource used for sequence generation yes data-source
Drop TableBoolean to determine whether to create drop the tables no drop-table
Id ColumnThe ID column name yes id-column
Select Hi DdlThe DDL used to select the hi value no select-hi-ddl
Sequence ColumnThe sequence column name yes sequence-column
Sequence NameThe name of the sequence yes sequence-name
Table NameThe table name yes table-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19. EAP7 - EJB3 (Managed Server) Service
Overview
Table 3.3294. Overview
Description:The configuration of the ejb3 subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3295. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3296. 
NameDescriptionRequiredInternal Name
Default Clustered Sfsb CacheName of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level no default-clustered-sfsb-cache
Default Entity Bean Instance PoolName of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level no default-entity-bean-instance-pool
Default Entity Bean Optimistic LockingIf set to true entity beans will use optimistic locking by default no default-entity-bean-optimistic-locking
Default Mdb Instance PoolName of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level no default-mdb-instance-pool
Default Resource Adapter NameName of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level. The default value is activemq-ra. no default-resource-adapter-name
Default Sfsb CacheName of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level no default-sfsb-cache
Default Singleton Bean Access TimeoutThe default access timeout for singleton beans. The default value is 5000. no default-singleton-bean-access-timeout:expr
Default Slsb Instance PoolName of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level no default-slsb-instance-pool
Default Stateful Bean Access TimeoutThe default access timeout for stateful beans. The default value is 5000. no default-stateful-bean-access-timeout:expr
In Vm Remote Interface Invocation Pass By ValueIf 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. The default value is true. no in-vm-remote-interface-invocation-pass-by-value
Enable StatisticsIf set to true, enable the collection of invocation statistics. no enable-statistics

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.1. EAP7 - EJB3 Thread Pool (Managed Server) Service
Overview
Table 3.3297. Overview
Description:A thread pool executor with an unbounded queue. Such a thread pool has a core size and a queue with no upper bound. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, the task is placed in queue. If too many tasks are allowed to be submitted to this type of executor, an out of memory condition may occur.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3298. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3299. Metrics
NameTypeDescriptionInternal Name
Active CountmeasurementThe approximate number of threads that are actively executing tasks.active-count
Completed Task CountmeasurementThe approximate total number of tasks that have completed execution.completed-task-count
Current Thread CountmeasurementThe current number of threads in the pool.current-thread-count
Largest Thread CountmeasurementThe largest number of threads that have ever simultaneously been in the pool.largest-thread-count
Rejected CountmeasurementThe number of tasks that have been rejected.rejected-count
Task CountmeasurementThe approximate total number of tasks that have ever been scheduled for execution.task-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3300. 
NameDescriptionRequiredInternal Name
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. no max-threads:expr
NameThe name of the thread pool. no name
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.2. EAP7 - File Passivation Store (Managed Server) Service
Overview
Table 3.3301. Overview
Description:A file system based passivation store.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3302. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3303. 
NameDescriptionRequiredInternal Name
Groups Path  no groups-path
Idle TimeoutThe timeout in units specified by idle-timeout-unit, after which a bean will passivate. The default value is 300. no idle-timeout:expr
Idle Timeout UnitThe unit of idle-timeout. The default value is SECONDS. no idle-timeout-unit
Max SizeThe maximum number of beans this cache should store before forcing old beans to passivate. The default value is 10000. no max-size:expr
Relative To  no relative-to
Sessions Path  no sessions-path
Subdirectory Count  no subdirectory-count:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.3. EAP7 - MDB Delivery Group (Managed Server) Service
Overview
Table 3.3304. Overview
Description:Delivery group to manage delivery for mdbs
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3305. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3306. 
NameDescriptionRequiredInternal Name
ActiveIndicates if delivery for all MDBs belonging to this group is active. The default value is true. no active

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.4. EAP7 - Strict Max Bean Instance Pool (Managed Server) Service
Overview
Table 3.3307. Overview
Description:A bean instance pool with a strict upper limit
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3308. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3309. 
NameDescriptionRequiredInternal Name
Derive SizeSpecifies if and what the max pool size should be derived from. A value of 'none', the default, 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. The default value is none. no derive-size
Max Pool SizeThe maximum number of bean instances that the pool can hold at a given point in time. no max-pool-size
TimeoutThe maximum amount of time to wait for a bean instance to be available from the pool. The default value is 5. no timeout
Timeout UnitThe instance acquisition timeout unit. The default value is MINUTES. no timeout-unit

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.5. EAP7 - SFSB Cache (Managed Server) Service
Overview
Table 3.3310. Overview
Description:A SFSB cache.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3311. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3312. 
NameDescriptionRequiredInternal Name
AliasesThe aliases by which this cache may also be referenced yes aliases
Passivation StoreThe passivation store used by this cache no passivation-store

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.6. EAP7 - Cluster Passivation Store (Managed Server) Service
Overview
Table 3.3313. Overview
Description:A clustered passivation store.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3314. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3315. 
NameDescriptionRequiredInternal Name
Bean CacheThe name of the cache used to store bean instances. no bean-cache
Cache ContainerThe name of the cache container used for the bean and client-mappings caches. The default value is ejb. no cache-container
Client Mappings CacheThe name of the cache used to store client-mappings of the EJB remoting connector's socket-bindings. The default value is remote-connector-client-mappings. no client-mappings-cache
Idle TimeoutThe timeout in units specified by idle-timeout-unit, after which a bean will passivate. The default value is 300. no idle-timeout:expr
Idle Timeout UnitThe unit of idle-timeout. The default value is SECONDS. no idle-timeout-unit
Max SizeThe maximum number of beans this cache should store before forcing old beans to passivate. The default value is 10000. no max-size:expr
Passivate Events On ReplicateIndicates whether replication should trigger passivation events on the bean. The default value is true. no passivate-events-on-replicate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.7. EAP7 - Async Service (Managed Server) Service
Overview
Table 3.3316. Overview
Description:The EJB3 Asynchronous Invocation Service
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3317. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3318. 
NameDescriptionRequiredInternal Name
Thread Pool NameThe name of the thread pool which handles asynchronous invocations no thread-pool-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.8. EAP7 - IIOP Service (Managed Server) Service
Overview
Table 3.3319. Overview
Description:The IIOP service
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3320. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3321. 
NameDescriptionRequiredInternal Name
Enable By DefaultIf this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor no enable-by-default
Use Qualified NameIf 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) no use-qualified-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.9. EAP7 - Remote Service (Managed Server) Service
Overview
Table 3.3322. Overview
Description:The EJB3 remote service
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3323. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3324. 
NameDescriptionRequiredInternal Name
Connector RefThe name of the connector on which the EJB3 remoting channel is registered no connector-ref
Thread Pool NameThe name of the thread pool that handles remote invocations no thread-pool-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.9.1. EAP7 - Channel Creation Options (Managed Server) Service
Overview
Table 3.3325. Overview
Description:The options that will be used during the EJB remote channel creation
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3326. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3327. 
NameDescriptionRequiredInternal Name
TypeThe type of the channel creation option no type
ValueThe value for the EJB remote channel creation option no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.19.10. EAP7 - Timer Service (Managed Server) Service
Overview
Table 3.3328. Overview
Description:The EJB timer service
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3329. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3330. 
NameDescriptionRequiredInternal Name
PathThe directory to store persistent timer information in no path
Relative ToThe relative path that is used to resolve the timer data store location no relative-to
Thread Pool NameThe name of the thread pool used to run timer service invocations no thread-pool-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.20. EAP7 - Threads (Managed Server) Service
Overview
Table 3.3331. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3332. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.20.1. EAP7 - ThreadFactory (Managed Server) Service
Overview
Table 3.3333. Overview
Description:A thread factory (implementing java.util.concurrent.ThreadFactory).
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3334. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3335. 
NameDescriptionRequiredInternal Name
Group NameSpecifies the name of a thread group to create for this thread factory. no group-name
NameThe name of the created thread factory. no name
PriorityMay be used to specify the thread priority of created threads. The default value is -1. no priority:expr
Thread Name PatternThe template used to create names for threads. The following patterns may be used: %% - emit a percent sign %t - emit the per-factory thread sequence number %g - emit the global thread sequence number %f - emit the factory sequence number %i - emit the thread ID. no thread-name-pattern

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.20.2. EAP7 - ThreadPool (Managed Server) Service
Overview
Table 3.3336. Overview
Description:A thread pool executor
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3337. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3338. Metrics
NameTypeDescriptionInternal Name
Active CountmeasurementThe approximate number of threads that are actively executing tasks.active-count
Completed Task CountmeasurementThe approximate total number of tasks that have completed execution.completed-task-count
Current Thread CountmeasurementThe current number of threads in the pool.current-thread-count
Largest Thread CountmeasurementThe largest number of threads that have ever simultaneously been in the pool.largest-thread-count
Rejected CountmeasurementThe number of tasks that have been rejected.rejected-count
Task CountmeasurementThe approximate total number of tasks that have ever been scheduled for execution.task-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3339. 
NameDescriptionRequiredInternal Name
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. yes max-threads:expr
NameThe name of the thread pool. no name
Queue LengthThe queue length. Required only for Bounded and Blocking Bounded Thread Pools. no queue-length:expr
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory
Allow Core TimeoutWhether core threads may time out. The default value is false. no allow-core-timeout
Core ThreadsThe 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. no core-threads:expr
Handoff ExecutorAn 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. no handoff-executor
Thread Pool TypeThread pool type yes __type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21. EAP7 - Security (Managed Server) Service
Overview
Table 3.3340. Overview
Description:The configuration of the security subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3341. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3342. 
NameDescriptionRequiredInternal Name
Deep Copy Subject ModeSets 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. The default value is false. no deep-copy-subject-mode

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1. EAP7 - Security Domain (Managed Server) Service
Overview
Table 3.3343. Overview
Description:Configures a security domain. Authentication, authorization, ACL, mapping, auditing and identity trust are configured here.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3344. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3345. 
NameDescriptionRequiredInternal Name
Cache TypeAdds 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. no cache-type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3346. Metrics
NameDescription
Flush CacheRemove entries stored in the authentication cache for this security domain. A single entry can be flushed by using the principal argument with the username as the value. If no argument is passed to the operation, all entries are flushed.
List Cached PrincipalsLists the principals stored in the authentication cache for this security domain.
Package Types
none
3.4.2.4.21.1.1. EAP7 - ACL (Managed Server) Service
Overview
Table 3.3347. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3348. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3349. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.1.1. EAP7 - Acl Modules (Managed Server) Service
Overview
Table 3.3350. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3351. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3352. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.1.1.1. EAP7 - Module Options (Acl - Managed Server) Service
Overview
Table 3.3353. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3354. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3355. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.2. EAP7 - Audit (Managed Server) Service
Overview
Table 3.3356. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3357. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3358. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.2.1. EAP7 - Provider Modules (Managed Server) Service
Overview
Table 3.3359. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3360. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3361. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.2.1.1. EAP7 - Module Options (Provider Modules - Managed Server) Service
Overview
Table 3.3362. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3363. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3364. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.3. EAP7 - Authentication (Classic - Managed Server) Service
Overview
Table 3.3365. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3366. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.21.1.3.1. EAP7 - Login Modules (Classic - Managed Server) Service
Overview
Table 3.3367. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3368. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3369. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.3.1.1. EAP7 - Module Options (Classic - Managed Server) Service
Overview
Table 3.3370. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3371. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3372. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.4. EAP7 - Authentication (Jaspi - Managed Server) Service
Overview
Table 3.3373. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3374. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3375. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.4.1. EAP7 - Login Module Stack (Managed Server) Service
Overview
Table 3.3376. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3377. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3378. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.4.1.1. EAP7 - Module Options (Login Module Stack (Managed Server)) Service
Overview
Table 3.3379. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3380. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3381. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.5. EAP7 - Authorization (Managed Server) Service
Overview
Table 3.3382. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3383. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3384. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.5.1. EAP7 - Authorization Modules (Managed Server) Service
Overview
Table 3.3385. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3386. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3387. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.5.1.1. EAP7 - Module Options (Authorization - Managed Server) Service
Overview
Table 3.3388. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3389. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3390. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.6. EAP7 - Identity Trust (Managed Server) Service
Overview
Table 3.3391. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3392. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3393. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.6.1. EAP7 - Identity Trust Modules (Managed Server) Service
Overview
Table 3.3394. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3395. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3396. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.6.1.1. EAP7 - Module Options (Identity Trust - Managed Server) Service
Overview
Table 3.3397. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3398. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3399. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.7. EAP7 - JSSE (Managed Server) Service
Overview
Table 3.3400. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3401. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3402. 
NameDescriptionRequiredInternal Name
Cipher SuitesComma separated list of cipher suites to enable on SSLSockets. no cipher-suites
Client AliasPreferred alias to use when the KeyManager chooses the client alias. no client-alias
Client AuthBoolean attribute to indicate if client's certificates should also be authenticated on the server side. no client-auth
Key ManagerJSEE Key Manager factory no key-manager
KeystoreConfigures a JSSE key store no keystore
ProtocolsComma separated list of protocols to enable on SSLSockets. no protocols
Server AliasPreferred alias to use when the KeyManager chooses the server alias. no server-alias
Service Auth TokenToken to retrieve PrivateKeys from the KeyStore. no service-auth-token
Trust ManagerJSEE Trust Manager factory no trust-manager
TruststoreConfigures a JSSE trust store no truststore

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.8. EAP7 - Mapping (Managed Server) Service
Overview
Table 3.3403. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3404. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3405. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
TypeType of mapping this module performs. Allowed values are principal, role, attribute or credential.. yes type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.8.1. EAP7 - Mapping Modules (Managed Server) Service
Overview
Table 3.3406. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3407. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3408. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
TypeType of mapping this module performs. Allowed values are principal, role, attribute or credential.. yes type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.1.8.1.1. EAP7 - Module Options (Mapping - Managed Server) Service
Overview
Table 3.3409. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3410. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3411. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.21.2. EAP7 - Vault (Managed Server) Service
Overview
Table 3.3412. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3413. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3414. 
NameDescriptionRequiredInternal Name
CodeFully Qualified Name of the Security Vault Implementation. no code

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22. EAP7 - ActiveMQ Messaging (Managed Server) Service
Overview
Table 3.3415. Overview
Description:The messaging subsystems
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3416. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.22.1. EAP7 - ActiveMQ Artemis (Managed Server) Service
Overview
Table 3.3417. Overview
Description:The ActiveMQ Artemis based messaging subsystem
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3418. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3419. Metrics
NameTypeDescriptionInternal Name
ActivetraitWhether the server is active (and accepting connections) or passive (in backup mode, waiting for failover).active
StartedtraitWhether this server is started.started
VersiontraitThe server's version.version

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3420. 
NameDescriptionRequiredInternal Name
Async Connection Execution EnabledWhether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread. The default value is true. no async-connection-execution-enabled
Cluster PasswordThe password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!. no cluster-password
Cluster UserThe user used by cluster connections to communicate between the clustered nodes. The default value is ACTIVEMQ.CLUSTER.ADMIN.USER. no cluster-user
Connection Ttl Override:exprIf set, this will override how long (in ms) to keep a connection alive without receiving a ping. The default value is -1. no connection-ttl-override:expr
Create Bindings DirWhether the server should create the bindings directory on start up. The default value is true. no create-bindings-dir
Create Journal DirWhether the server should create the journal directory on start up. The default value is true. no create-journal-dir
Id Cache Size:exprThe size of the cache for pre-creating message IDs. The default value is 20000. no id-cache-size:expr
Incoming InterceptorsThe list of incoming interceptor classes used by this server. no incoming-interceptors
Jmx DomainThe JMX domain used to register internal ActiveMQ MBeans in the MBeanServer. The default value is org.apache.activemq.artemis. no jmx-domain
Jmx Management EnabledWhether ActiveMQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration. The default value is false. no jmx-management-enabled
Journal Buffer Size:exprThe size of the internal buffer on the journal. no journal-buffer-size:expr
Journal Buffer Timeout:exprThe timeout (in nanoseconds) used to flush internal buffers on the journal. no journal-buffer-timeout:expr
Journal Compact Min Files:exprThe minimal number of journal data files before we can start compacting. The default value is 10. no journal-compact-min-files:expr
Journal Compact Percentage:exprThe percentage of live data on which we consider compacting the journal. The default value is 30. no journal-compact-percentage:expr
Journal File Size:exprThe size (in bytes) of each journal file. The default value is 10485760. no journal-file-size:expr
Journal Max Io:exprThe maximum number of write requests that can be in the AIO queue at any one time. no journal-max-io:expr
Journal Min Files:exprHow many journal files to pre-create. The default value is 2. no journal-min-files:expr
Journal Pool Files:exprThe number of journal files that can be reused. ActiveMQ will create as many files as needed however when reclaiming files it will shrink back to the value (-1 means no limit). The default value is -1. no journal-pool-files:expr
Journal Sync Non TransactionalWhether to wait for non transaction data to be synced to the journal before returning a response to the client. The default value is true. no journal-sync-non-transactional
Journal Sync TransactionalWhether to wait for transaction data to be synchronized to the journal before returning a response to the client. The default value is true. no journal-sync-transactional
Journal TypeThe type of journal to use. The default value is ASYNCIO. no journal-type
Log Journal Write RateWhether to periodically log the journal's write rate and flush rate. The default value is false. no log-journal-write-rate
Management AddressAddress to send management messages to. The default value is jms.queue.activemq.management. no management-address
Management Notification AddressThe name of the address that consumers bind to to receive management notifications. The default value is activemq.notifications. no management-notification-address
Memory Measure Interval:exprFrequency to sample JVM memory in ms (or -1 to disable memory sampling). The default value is -1. no memory-measure-interval:expr
Memory Warning Threshold:exprPercentage of available memory which if exceeded results in a warning log. The default value is 25. no memory-warning-threshold:expr
Message Counter Max Day History:exprHow many days to keep message counter history. The default value is 10. no message-counter-max-day-history:expr
Message Counter Sample Period:exprThe sample period (in ms) to use for message counters. The default value is 10000. no message-counter-sample-period:expr
Message Expiry Scan Period:exprHow often (in ms) to scan for expired messages. The default value is 30000. no message-expiry-scan-period:expr
Message Expiry Thread Priority:exprThe priority of the thread expiring messages. The default value is 3. no message-expiry-thread-priority:expr
Outgoing InterceptorsThe list of outgoing interceptor classes used by this server. no outgoing-interceptors
Override In Vm SecurityWhether the ActiveMQ server will override security credentials for in-vm connections. The default value is true. no override-in-vm-security
Page Max Concurrent Io:exprThe maximum number of concurrent reads allowed on paging. The default value is 5. no page-max-concurrent-io:expr
Perf Blast Pages:exprTODO. The default value is -1. no perf-blast-pages:expr
Persist Delivery Count Before DeliveryWhether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. The default value is false. no persist-delivery-count-before-delivery
Persist Id CacheWhether IDs are persisted to the journal. The default value is true. no persist-id-cache
Persistence EnabledWhether the server will use the file based journal for persistence. The default value is true. no persistence-enabled
Run Sync Speed TestWhether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues. The default value is false. no run-sync-speed-test
Scheduled Thread Pool Max Size:exprThe number of threads that the main scheduled thread pool has. The default value is 5. no scheduled-thread-pool-max-size:expr
Security DomainThe security domain to use to verify user and role information. The default value is other. no security-domain
Security EnabledWhether security is enabled. The default value is true. no security-enabled
Security Invalidation Interval:exprHow long (in ms) to wait before invalidating the security cache. The default value is 10000. no security-invalidation-interval:expr
Server Dump Interval:exprHow often to dump basic runtime information to the server log. A value less than 1 disables this feature. The default value is -1. no server-dump-interval:expr
Statistics EnabledWhether gathering of statistics such as message counters are enabled. The default value is false. no statistics-enabled
Thread Pool Max Size:exprThe number of threads that the main thread pool has. -1 means no limit. The default value is 30. no thread-pool-max-size:expr
Transaction Timeout:exprHow long (in ms) before a transaction can be removed from the resource manager after create time. The default value is 300000. no transaction-timeout:expr
Transaction Timeout Scan Period:exprHow often (in ms) to scan for timeout transactions. The default value is 1000. no transaction-timeout-scan-period:expr
Wild Card Routing EnabledWhether the server supports wild card routing. The default value is true. no wild-card-routing-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3421. Metrics
NameDescription
Close Connections for AddressCloses all the connections of clients connected to this server whose remote address contains the specified IP address.
Close Connections for UserCloses all the connections of clients connected to this server under the specified user name.
Close Consumer Connections for AddressCloses all the connections of consumers that are consuming from queues bound to the specified address.
Commit Prepared TransactionHeuristically commits a prepared transaction.
Export JournalExport the journal to a XML file
Force FailoverForce the messaging server to stop and notify clients to failover.
Get address settings as JSONReturns the address settings as a JSON string for an address match.
Get connectors as JSONReturns the connectors configured for this server in a JSON string containing the connectors information.
Get last sent message IDReturns the ID of the last message sent from the given session to the given address.
Get rolesGet the security roles for a specific address match.
Get roles as JSONGets the roles (as a JSON string) for a specific address match.
Get session creation timeGets the session's creation time.
Import JournalImport an XML file to the journal
List addAdd entry to list attribute
List all consumers as JSONLists all the consumers.
List clearClear all entries from list attribute
List connection IDsLists the IDs of all the connections connected to this server.
List connections as JSONLists all JMS connections.
List consumers as JSONLists all the consumers which belongs to the JMS Connection specified by the connection id.
List getGet entry from list attribute
List heuristic committed transactionsLists transactions which have been heuristically committed.
List heuristic rolled back transactionsLists transactions which have been heuristically rolled back.
List prepared transaction details as HTMLLists all the prepared transaction, sorted by date, oldest first, with details, in HTML format.
List prepared transaction details as JSONLists all the prepared transaction, sorted by date, oldest first, with details, in JSON format.
List prepared transaction JMS details as HTMLLists all the prepared transactions, sorted by date, oldest first, in a HTML format.
List prepared transaction JMS details as JSONLists all the prepared transactions, sorted by date, oldest first, in a JSON format.
List prepared transactionsLists all the prepared transaction, sorted by date, oldest first.
List producers info as JSONFor all sessions, lists information about message producers using JSON serialization.
List remote addressesLists the addresses of all the clients connected to the given address. If an ip-address argument is supplied, only those clients whose remote address string includes the given ip-address string will be returned.
List removeRemove entry from list attribute
List sessionsLists all the sessions IDs for the specified connection ID.
List sessions as JSONLists all the sessions IDs for the specified connection id.
List target destinationsLists all addresses to which the designated session has sent messages.
Map clearClear all entries from map attribute
Map getGet entry from map attribute
Map putAdd entry to map attribute
Map removeRemove entry from map attribute
QueryQuery a resource
Reset all message counter historiesResets all message counters history.
Reset All Message CountersResets all message counters.
Resolve address settingResolve the address settings using ActiveMQ hierarchy of address settings.
Rollback prepared transactionHeuristically rolls back a prepared transaction.
Package Types
none
3.4.2.4.22.1.1. EAP7 - JMS Queue (Managed Server) Service
Overview
Table 3.3422. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3423. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3424. Metrics
NameTypeDescriptionInternal Name
Consumer CountmeasurementThe number of consumers consuming messages from this queue.consumer-count
Dead Letter AddresstraitThe address to send dead messages to.dead-letter-address
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Expiry AddresstraitThe address to send expired messages to.expiry-address
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
PausedtraitWhether the queue is paused.paused
Scheduled CountmeasurementThe number of scheduled messages in this queue.scheduled-count
TemporarytraitWhether the queue is temporary.temporary
Queue AddresstraitThe queue address defines what address is used for routing messages.queue-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3425. 
NameDescriptionRequiredInternal Name
DurableWhether the queue is durable or not. The default value is true. no durable
EntriesThe jndi names the queue will be bound to. yes entries
SelectorThe queue selector. no selector

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3426. Metrics
NameDescription
Change Message PriorityChange the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages PriorityChange the priority of the messages corresponding to the given filter. Returns the number of removed messages.
Count MessagesReturns the number of the messages in the queue matching the given filter.
Expire MessageExpire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire MessagesExpire the messages matching the given filter.
List Consumers as JSONA string in JSON format.
List Message Counter as HTMLList the message counter as a string in HTML format.
List Message Counter as JSONList the message counter as a string in JSON format.
List Message Counter History as HTMLList the message counter history.
List Message Counter History as JSONList the message counter history as a string in JSON format.
List MessagesList all messages in the queue that match the filter
List Messages as JSONList all messages in the queue that match the filter and return them as a string in JSON format.
Move MessageMove the message corresponding to the given message-id to another queue
Move MessagesMove the messages corresponding to the given filter to another queue.
PausePause the queue.
Remove MessageRemove the message corresponding to the given message-id.
Remove MessagesRemove messages matching the given filter from the destination.
Reset Message CounterReset the message counters.
ResumeResume the queue.
Send Message to Dead Letter AddressSend the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter AddressSend the messages corresponding to the given filter to this queue's Dead Letter Address.
Package Types
none
3.4.2.4.22.1.2. EAP7 - JMS Topic (Managed Server) Service
Overview
Table 3.3427. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3428. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3429. Metrics
NameTypeDescriptionInternal Name
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
Durable Message CountmeasurementThe number of messages for all durable subscribers for this topic.durable-message-count
Durable Subscription CountmeasurementThe number of durable subscribers for this topic.durable-subscription-count
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
Non Durable Message CountmeasurementThe number of messages for all non-durable subscribers for this topic.non-durable-message-count
Non Durable Subscription CountmeasurementThe number of non-durable subscribers for this topic.non-durable-subscription-count
Subscription CountmeasurementThe number of (durable and non-durable) subscribers for this topic.subscription-count
TemporarytraitWhether the topic is temporary.temporary
Topic AddresstraitThe address the topic points to.topic-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3430. 
NameDescriptionRequiredInternal Name
JNDI NamesThe jndi names the queue will be bound to. yes entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3431. Metrics
NameDescription
Count Messages for SubscriptionCount the number of messages matching the filter for the given subscription.
Drop All SubscriptionsDrop all subscriptions from this topic.
Drop Durable SubscriptionDrop a durable subscription
List All SubscriptionsList all subscriptions.
List All Subscriptions as JSONList all subscriptions as a string in JSON format.
List Durable SubscriptionsList only the durable subscriptions.
List Durable Subscriptions as JSONList only the durable subscriptions, as a string in JSON format.
List Messages for SubscriptionList all the messages for the given subscription.
List Messages for Subscription as JSONList all the messages for the given subscription as a string in JSON format.
List Non-Durable SubscriptionsList only the non-durable subscriptions.
List Non-Durable Subscriptions as JSONList only the non-durable subscriptions, as a string in JSON format.
Remove MessagesRemove messages matching the given filter from the destination.
Package Types
none
3.4.2.4.22.1.3. EAP7 - Connection Factory (Managed Server) Service
Overview
Table 3.3432. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3433. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3434. 
NameDescriptionRequiredInternal Name
Auto GroupWhether or not message grouping is automatically used. The default value is false. no auto-group
Block On AcknowledgeTrue to set block on acknowledge. The default value is false. no block-on-acknowledge
Block On Durable SendTrue to set block on durable send. The default value is true. no block-on-durable-send
Block On Non Durable SendTrue to set block on non durable send. The default value is false. no block-on-non-durable-send
Cache Large Message ClientTrue to cache large messages. The default value is false. no cache-large-message-client
Call Failover Timeout:exprThe timeout to use when fail over is in process (in ms). The default value is -1. no call-failover-timeout:expr
Call Timeout:exprThe call time out. The default value is 30000. no call-timeout:expr
Client Failure Check Period:exprThe client failure check period. The default value is 30000. no client-failure-check-period:expr
Client IdThe client id. no client-id
Compress Large MessagesWhether large messages should be compressed. The default value is false. no compress-large-messages
Confirmation Window Size:exprThe confirmation window size. The default value is -1. no confirmation-window-size:expr
Connection Load Balancing Policy Class NameName of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. no connection-load-balancing-policy-class-name
Connection Ttl:exprThe connection ttl. The default value is 60000. no connection-ttl:expr
ConnectorsDefines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. no connectors
Consumer Max Rate:exprThe consumer max rate. The default value is -1. no consumer-max-rate:expr
Consumer Window Size:exprThe consumer window size. The default value is 1048576. no consumer-window-size:expr
Discovery GroupThe discovery group name. no discovery-group
Dups Ok Batch Size:exprThe dups ok batch size. The default value is 1048576. no dups-ok-batch-size:expr
EntriesThe jndi names the connection factory should be bound to. yes entries
Factory TypeThe type of connection factory. The default value is GENERIC. no factory-type
Failover On Initial ConnectionTrue to fail over on initial connection. The default value is false. no failover-on-initial-connection
Group IdThe group id. no group-id
HaWhether the connection factory supports High Availability. The default value is false. no ha
Max Retry Interval:exprThe max retry interval. The default value is 2000. no max-retry-interval:expr
Min Large Message Size:exprThe min large message size. The default value is 102400. no min-large-message-size:expr
Pre AcknowledgeTrue to pre-acknowledge. The default value is false. no pre-acknowledge
Producer Max Rate:exprThe producer max rate. The default value is -1. no producer-max-rate:expr
Producer Window Size:exprThe producer window size. The default value is 65536. no producer-window-size:expr
Reconnect Attempts:exprThe reconnect attempts. The default value is 0. no reconnect-attempts:expr
Retry Interval:exprThe retry interval. The default value is 2000. no retry-interval:expr
Retry Interval Multiplier:exprThe retry interval multiplier. The default value is 1.0. no retry-interval-multiplier:expr
Scheduled Thread Pool Max Size:exprThe scheduled thread pool max size. The default value is 5. no scheduled-thread-pool-max-size:expr
Thread Pool Max Size:exprThe thread pool max size. The default value is 30. no thread-pool-max-size:expr
Transaction Batch Size:exprThe transaction batch size. The default value is 1048576. no transaction-batch-size:expr
Use Global PoolsTrue to use global pools. The default value is true. no use-global-pools

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.4. EAP7 - Pooled Connection Factory (Managed Server) Service
Overview
Table 3.3435. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3436. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3437. 
NameDescriptionRequiredInternal Name
Auto GroupWhether or not message grouping is automatically used. The default value is false. no auto-group
Block On AcknowledgeTrue to set block on acknowledge. The default value is false. no block-on-acknowledge
Block On Durable SendTrue to set block on durable send. The default value is true. no block-on-durable-send
Block On Non Durable SendTrue to set block on non durable send. The default value is false. no block-on-non-durable-send
Cache Large Message ClientTrue to cache large messages. The default value is false. no cache-large-message-client
Call Failover Timeout:exprThe timeout to use when fail over is in process (in ms). The default value is -1. no call-failover-timeout:expr
Call Timeout:exprThe call time out. The default value is 30000. no call-timeout:expr
Client Failure Check Period:exprThe client failure check period. The default value is 30000. no client-failure-check-period:expr
Client IdThe client id. no client-id
Compress Large MessagesWhether large messages should be compressed. The default value is false. no compress-large-messages
Confirmation Window Size:exprThe confirmation window size. The default value is -1. no confirmation-window-size:expr
Connection Load Balancing Policy Class NameName of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. no connection-load-balancing-policy-class-name
Connection Ttl:exprThe connection ttl. The default value is 60000. no connection-ttl:expr
ConnectorsDefines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. no connectors
Consumer Max Rate:exprThe consumer max rate. The default value is -1. no consumer-max-rate:expr
Consumer Window Size:exprThe consumer window size. The default value is 1048576. no consumer-window-size:expr
Discovery GroupThe discovery group name. no discovery-group
Dups Ok Batch Size:exprThe dups ok batch size. The default value is 1048576. no dups-ok-batch-size:expr
EntriesThe jndi names the connection factory should be bound to. yes entries
Failover On Initial ConnectionTrue to fail over on initial connection. The default value is false. no failover-on-initial-connection
Group IdThe group id. no group-id
HaWhether the connection factory supports High Availability. The default value is false. no ha
Max Retry Interval:exprThe max retry interval. The default value is 2000. no max-retry-interval:expr
Min Large Message Size:exprThe min large message size. The default value is 102400. no min-large-message-size:expr
Pre AcknowledgeTrue to pre-acknowledge. The default value is false. no pre-acknowledge
Producer Max Rate:exprThe producer max rate. The default value is -1. no producer-max-rate:expr
Producer Window Size:exprThe producer window size. The default value is 65536. no producer-window-size:expr
Protocol Manager FactoryThe protocol manager factory used by this connection factory. no protocol-manager-factory
Reconnect Attempts:exprThe reconnect attempts. The default value is 0. no reconnect-attempts:expr
Retry Interval:exprThe retry interval. The default value is 2000. no retry-interval:expr
Retry Interval Multiplier:exprThe retry interval multiplier. The default value is 1.0. no retry-interval-multiplier:expr
Scheduled Thread Pool Max Size:exprThe scheduled thread pool max size. The default value is 5. no scheduled-thread-pool-max-size:expr
Thread Pool Max Size:exprThe thread pool max size. The default value is 30. no thread-pool-max-size:expr
Transaction Batch Size:exprThe transaction batch size. The default value is 1048576. no transaction-batch-size:expr
Use Global PoolsTrue to use global pools. The default value is true. no use-global-pools

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.5. EAP7 - Security Setting (Managed Server) Service
Overview
Table 3.3438. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3439. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.22.1.5.1. EAP7 - Role (Managed Server) Service
Overview
Table 3.3440. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3441. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3442. 
NameDescriptionRequiredInternal Name
Consumehis permission allows the user to consume a message from a queue bound to matching addresses. The default value is false. yes consume
Create Durable QueueThis permission allows the user to create a durable queue. The default value is false. yes create-durable-queue
Create Non Durable QueueThis permission allows the user to create a temporary queue. The default value is false. yes create-non-durable-queue
Delete Durable QueueThis permission allows the user to delete a durable queue. The default value is false. yes delete-durable-queue
Delete Non Durable QueueThis permission allows the user to delete a temporary queue. The default value is false. yes delete-non-durable-queue
ManageThis permission allows the user to invoke management operations by sending management messages to the management address. The default value is false. yes manage
SendThis permission allows the user to send a message to matching addresses. The default value is false. yes send

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.6. EAP7 - Address Setting (Managed Server) Service
Overview
Table 3.3443. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3444. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3445. 
NameDescriptionRequiredInternal Name
Address Full PolicyDetermines what happens when an address where max-size-bytes is specified becomes full. (PAGE, DROP or BLOCK). The default value is PAGE. no address-full-policy
Dead Letter AddressThe dead letter address no dead-letter-address
Expiry AddressDefines where to send a message that has expired. no expiry-address
Last Value QueueDefines whether a queue only uses last values or not. The default value is false. no last-value-queue
Max Delivery AttemptsDefines how many time a cancelled message can be redelivered before sending to the dead-letter-address. The default value is 10. no max-delivery-attempts
Max Size BytesThe max bytes size. The default value is -1. no max-size-bytes
Message Counter History Day LimitDay limit for the message counter history. The default value is 0. no message-counter-history-day-limit
Page Max Cache SizeThe number of page files to keep in memory to optimize IO during paging navigation. The default value is 5. no page-max-cache-size
Page Size BytesThe paging size. The default value is 10485760. no page-size-bytes
Redelivery DelayDefines how long to wait before attempting redelivery of a cancelled message. The default value is 0. no redelivery-delay
Redistribution DelayDefines how long to wait when the last consumer is closed on a queue before redistributing any messages. The default value is -1. no redistribution-delay
Send To Dla On No RouteIf this parameter is set to true for that address, if the message is not routed to any queues it will instead be sent to the dead letter address (DLA) for that address, if it exists. The default value is false. no send-to-dla-on-no-route
Auto Create Jms QueuesDetermines whether ActiveMQ should automatically create a JMS queue corresponding to the address-settings match when a JMS producer or a consumer is tries to use such a queue. no auto-create-jms-queues
Auto Delete Jms QueuesDetermines Whether ActiveMQ should automatically delete auto-created JMS queues when they have no consumers and no messages. no auto-delete-jms-queues
Expiry DelayDefines the expiration time that will be used for messages using the default expiration time. no expiry-delay
Max Redelivery DelayMaximum value for the redelivery-delay (in ms). no max-redelivery-delay
Redelivery MultiplierMultiplier to apply to the redelivery-delay parameter. no redelivery-multiplier

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.7. EAP7 - Grouping Handler (Managed Server) Service
Overview
Table 3.3446. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3447. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3448. 
NameDescriptionRequiredInternal Name
Grouping Handler AddressA reference to a cluster connection and the address it uses. yes grouping-handler-address
TimeoutHow long to wait for a handling decision to be made; an exception will be thrown during the send if this timeout is reached, ensuring that strict ordering is kept. The default value is 5000. no timeout
TypeWhether the handler is the single 'Local' handler for the cluster, which makes handling decisions, or a 'Remote' handler which converses with the local handler. no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.8. EAP7 - Acceptor (Managed Server) Service
Overview
Table 3.3449. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3450. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3451. Metrics
NameTypeDescriptionInternal Name
StartedtraitWhether this acceptor is started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3452. 
NameDescriptionRequiredInternal Name
Factory ClassThe factory class. yes factory-class
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3453. Metrics
NameDescription
StartStarts the acceptor.
StopStops the acceptor.
Package Types
none
3.4.2.4.22.1.8.1. EAP7 - Param (Read Only) Service
Overview
Table 3.3454. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3455. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3456. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.9. EAP7 - Connector (ActiveMQ - Managed Server) Service
Overview
Table 3.3457. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3458. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3459. 
NameDescriptionRequiredInternal Name
Factory ClassThe factory class. yes factory-class
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.9.1. EAP7 - Param (Read Only) Service
Overview
Table 3.3460. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3461. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3462. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.10. EAP7 - In VM Acceptor (Managed Server) Service
Overview
Table 3.3463. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3464. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3465. Metrics
NameTypeDescriptionInternal Name
StartedtraitWhether it's stopped or started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3466. 
NameDescriptionRequiredInternal Name
Server IdThe server id. yes server-id

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3467. Metrics
NameDescription
StartStarts the acceptor.
StopStops the acceptor.
Package Types
none
3.4.2.4.22.1.10.1. EAP7 - Param (Read Only) Service
Overview
Table 3.3468. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3469. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3470. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.11. EAP7 - In VM Connector (Managed Server) Service
Overview
Table 3.3471. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3472. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3473. 
NameDescriptionRequiredInternal Name
Server IdThe server id. yes server-id

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.11.1. EAP7 - Param (Read Only) Service
Overview
Table 3.3474. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3475. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3476. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.12. EAP7 - Remote Acceptor (Managed Server) Service
Overview
Table 3.3477. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3478. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3479. Metrics
NameTypeDescriptionInternal Name
StartedtraitWhether this acceptor is started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3480. 
NameDescriptionRequiredInternal Name
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3481. Metrics
NameDescription
StartStarts the acceptor.
StopStops the acceptor.
Package Types
none
3.4.2.4.22.1.12.1. EAP7 - Param (Read Only) Service
Overview
Table 3.3482. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3483. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3484. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.13. EAP7 - Remote Connector (Managed Server) Service
Overview
Table 3.3485. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3486. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3487. 
NameDescriptionRequiredInternal Name
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.13.1. EAP7 - Param (Read Only) Service
Overview
Table 3.3488. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3489. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3490. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.14. EAP7 - Divert (Managed Server) Service
Overview
Table 3.3491. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3492. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3493. 
NameDescriptionRequiredInternal Name
Divert AddressAddress to divert from yes divert-address
ExclusiveWhether the divert is exclusive, meaning that the message is diverted to the new address, and does not go to the old address at all. The default value is false. no exclusive
FilterAn optional filter string. If specified then only messages which match the filter expression specified will be diverted. The filter string follows the ActiveMQ Artemis filter expression syntax described in the ActiveMQ Artemis documentation. no filter
Forwarding AddressAddress to divert to yes forwarding-address
Routing NameRouting name of the divert no routing-name
Transformer Class NameThe name of a class used to transform the message's body or properties before it is diverted. no transformer-class-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.15. EAP7 - Queue (Managed Server) Service
Overview
Table 3.3494. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3495. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3496. Metrics
NameTypeDescriptionInternal Name
IdtraitThe id of the queue.id
PausedtraitWhether the queue is paused.paused
TemporarytraitWhether the queue is temporary.temporary

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3497. 
NameDescriptionRequiredInternal Name
DurableDefines whether the queue is durable. The default value is true. no durable
FilterA queue message filter definition. An undefined or empty filter will match all messages. no filter
Queue AddressThe queue address defines what address is used for routing messages. yes queue-address

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3498. Metrics
NameDescription
Change Message PriorityChange the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Change Messages PriorityChange the priority of the messages corresponding to the given filter.
Count MessagesReturns the number of the messages in the queue matching the given filter.
Expire MessageExpire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise.
Expire MessagesExpire the messages matching the given filter.
List Consumers as JSONA string in JSON format.
List Message Counter as HTMLList the message counter as a string in HTML format.
List Message Counter as JSONList the message counter as a string in JSON format.
List Message Counter History as HTMLList the message counter history.
List Message Counter History as JSONList the message counter history as a string in JSON format.
List MessagesList all messages in the queue that match the filter
List Messages as JSONList all messages in the queue that match the filter and return them as a string in JSON format.
List Scheduled MessagesList the messages scheduled for delivery.
List Scheduled Messages as JSONList the messages scheduled for delivery as a string in JSON format.
Move MessageMove the message corresponding to the given message-id to another queue
Move MessagesMove the messages corresponding to the given filter to another queue.
PausePause the queue.
Remove MessageRemove the message corresponding to the given message-id.
Remove MessagesRemove messages matching the given filter from the destination.
Reset Message CounterReset the message counters.
ResumeResume the queue.
Send Message to Dead Letter AddressSend the message corresponding to the given message-id to this queue's Dead Letter Address.
Send Messages to Dead Letter AddressSend the messages corresponding to the given filter to this queue's Dead Letter Address.
Package Types
none
3.4.2.4.22.1.16. EAP7 - Core Address (Managed Server) Service
Overview
Table 3.3499. Overview
Description:A runtime-only resource representing a ActiveMQ Artemis address. Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3500. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3501. 
NameDescriptionRequiredInternal Name
Binding NamesThe names of all bindings (both queues and diverts) bound to this address. yes binding-names
Number Of Bytes Per PageThe number of bytes used by each page for this address. yes number-of-bytes-per-page
Number Of PagesThe number of pages used by this address. yes number-of-pages
Queue NamesThe names of the queues associated with the address. yes queue-names
RolesA list of the security roles (name and permissions) associated with the address. yes roles

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.17. EAP7 - Cluster Connection (Managed Server) Service
Overview
Table 3.3502. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3503. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3504. Metrics
NameTypeDescriptionInternal Name
Node IdtraitThe node ID used by this cluster connection.node-id
StartedtraitWhether the cluster connection is started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3505. 
NameDescriptionRequiredInternal Name
Call TimeoutThe timeout (in ms) for remote calls made by the cluster connection. The default value is 30000. no call-timeout
Check PeriodThe period (in milliseconds) between client failure check. The default value is 30000. no check-period
Cluster Connection AddressEach cluster connection only applies to messages sent to an address that starts with this value. yes cluster-connection-address
Confirmation Window SizeThe confirmation-window-size to use for the connection used to forward messages to a target node. The default value is 1048576. no confirmation-window-size
Connection TtlThe maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat). The default value is 60000. no connection-ttl
Connector RefThe confirmation-window-size to use for the connection used to forward messages to a target node. yes connector-ref
Discovery Group NameThe discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined. no discovery-group-name
Forward When No ConsumersWhether messages will be distributed round robin between other nodes of the cluster irrespective of whether there are matching or indeed any consumers on other nodes. If this is set to false (the default) then ActiveMQ Artemis will only forward messages to other nodes of the cluster if the address to which they are being forwarded has queues which have consumers, and if those consumers have message filters (selectors) at least one of those selectors must match the message. The default value is false. no forward-when-no-consumers
Max HopsThe maximum number of times a message can be forwarded. ActiveMQ Artemis can be configured to also load balance messages to nodes which might be connected to it only indirectly with other ActiveMQ Artemis servers as intermediates in a chain. The default value is 1. no max-hops
Max Retry IntervalThe maximum interval of time used to retry connections. The default value is 2000. no max-retry-interval
Min Large Message SizeThe minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400. no min-large-message-size
Reconnect AttemptsThe total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1. no reconnect-attempts
Retry IntervalThe period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 500. no retry-interval
Retry Interval MultiplierA multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0. no retry-interval-multiplier
Static ConnectorsThe statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined. no static-connectors:nullable
Use Duplicate DetectionWhether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. no use-duplicate-detection

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3506. Metrics
NameDescription
Get NodesReturns a map of the nodes connected to this cluster connection, where keys are node IDs and values are the addresses used to connect to the nodes.
StartStarts the cluster connection.
StopStops the cluster connection.
Package Types
none
3.4.2.4.22.1.18. EAP7 - Broadcast Group (Managed Server) Service
Overview
Table 3.3507. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3508. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3509. Metrics
NameTypeDescriptionInternal Name
StartedtraitWhether the broadcast group is started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3510. 
NameDescriptionRequiredInternal Name
Broadcast PeriodThe period in milliseconds between consecutive broadcasts. The default value is 2000. no broadcast-period
ConnectorsSpecifies the names of connectors that will be broadcast. no connectors
Socket BindingThe broadcast group socket binding. yes socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3511. Metrics
NameDescription
Get Connector Pairs as JSONReturns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization.
StartStarts the broadcast group.
StopStops the broadcast group.
Package Types
none
3.4.2.4.22.1.19. EAP7 - Path (Managed Server) Service
Overview
Table 3.3512. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3513. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3514. 
NameDescriptionRequiredInternal Name
PathThe actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.
If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:
If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.
yes path
Relative ToThe 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. The standard paths provided by the system include:
  • jboss.home - the root directory of the JBoss AS distribution
  • user.home - user's home directory
  • user.dir - user's current working directory
  • java.home - java installation directory
  • jboss.server.base.dir - root directory for an individual server instance
  • jboss.server.data.dir - directory the server will use for persistent data file storage
  • jboss.server.log.dir - directory the server will use for log file storage
  • jboss.server.tmp.dir - directory the server will use for temporary file storage
  • jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances
no relative-to
Path TypePath Type yes __name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.20. EAP7 - Bridge (Managed Server) Service
Overview
Table 3.3515. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3516. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3517. Metrics
NameTypeDescriptionInternal Name
StartedtraitWhether the bridge is started.started

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3518. 
NameDescriptionRequiredInternal Name
Check PeriodThe period (in milliseconds) between client failure check. The default value is 30000. no check-period
Confirmation Window SizeThe confirmation-window-size to use for the connection used to forward messages to the target node. The default value is 1048576. no confirmation-window-size
Connection TtlThe maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat). The default value is 60000. no connection-ttl
Discovery Group NameThe name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined. no discovery-group-name
Failover On Server ShutdownWhether the bridge will attempt to failover onto a backup server (if specified) when the target server is cleanly shutdown rather than crashed. no failover-on-server-shutdown
FilterAn optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the ActiveMQ Artemis filter expression syntax described in the ActiveMQ Artemis documentation. no filter
Forwarding AddressThe address on the target server that the message will be forwarded to. If a forwarding address is not specified then the original destination of the message will be retained. no forwarding-address
HaWhether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover. The default value is false. no ha
Max Retry IntervalThe maximum interval of time used to retry connections. The default value is 2000. no max-retry-interval
Min Large Message SizeThe minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400. no min-large-message-size
PasswordThe password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used. The default value is CHANGE ME!!. no password
Queue NameThe unique name of the local queue that the bridge consumes from. yes queue-name
Reconnect AttemptsThe total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1. no reconnect-attempts
Retry IntervalThe period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 2000. no retry-interval
Retry Interval MultiplierA multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0. no retry-interval-multiplier
Static ConnectorsA list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined. no static-connectors:nullable
Transformer Class NameThe name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface. no transformer-class-name
Use Duplicate DetectionWhether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. no use-duplicate-detection
UserThe user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used. The default value is ACTIVEMQ.CLUSTER.ADMIN.USER. no user

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3519. Metrics
NameDescription
StartStarts the bridge.
StopStops the bridge.
Package Types
none
3.4.2.4.22.1.21. EAP7 - Discovery Group (Managed Server) Service
Overview
Table 3.3520. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3521. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3522. 
NameDescriptionRequiredInternal Name
Initial Wait TimeoutPeriod, in ms, to wait for an initial broadcast to give us at least one node in the cluster. The default value is 10000. no initial-wait-timeout
Refresh TimeoutPeriod the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list. The default value is 10000. no refresh-timeout
Socket BindingThe discovery group socket binding. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.22. EAP7 - Connector Service (Managed Server) Service
Overview
Table 3.3523. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3524. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3525. 
NameDescriptionRequiredInternal Name
Factory ClassClass name of the factory class that can instantiate the connector service. yes factory-class

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.22.1. EAP7 - Param (Read Only) Service
Overview
Table 3.3526. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3527. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3528. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.22.1.23. EAP7 - Runtime Queue (Managed Server) Service
Overview
Table 3.3529. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3530. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3531. Metrics
NameTypeDescriptionInternal Name
Consumer CountmeasurementThe number of consumers consuming messages from this queue.consumer-count
Dead Letter AddresstraitThe address to send the queue's dead messages to.dead-letter-address
Delivering CountmeasurementThe number of messages that this queue is currently delivering to its consumers.delivering-count
DurabletraitDefines whether the queue is durable.durable
Expiry AddresstraitThe address to send the queue's expired messages to.expiry-address
FiltertraitA queue message filter definition. An undefined or empty filter will match all messages.filter
Message CountmeasurementThe number of messages currently in this queue.message-count
Messages AddedmeasurementThe number of messages added to this queue since it was created.messages-added
PausedtraitWhether the queue is paused.paused
Queue AddresstraitThe queue address defines what address is used for routing messages.queue-address
Scheduled CountmeasurementThe number of scheduled messages in this queue.scheduled-count
TemporarytraitWhether the queue is temporary.temporary

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.3532. Metrics
NameDescription
List Scheduled Messages as JSONList the messages scheduled for delivery as a string in JSON format.
List Messages as JSONList all messages in the queue that match the filter and return them as a string in JSON format.
Count MessagesReturns the number of the messages in the queue matching the given filter.
List Consumers as JSONLists consumers.
Change Messages PriorityChange the priority of the messages corresponding to the given filter.
PausePause the queue.
List Message Counter History as JSONList the message counter history as a string in JSON format.
Expire MessagesExpire the messages matching the given filter.
List MessagesList all messages in the queue that match the filter
Send message To Dead Letter AddressSend the message corresponding to the given message-id to this queue's Dead Letter Address.
Reset Message CountersReset the message counters.
Move MessageMove the message corresponding to the given message-id to another queue
Expire MessageExpire the message corresponding to the given message-id.
List Message Counter as JSONList the message counter as a string in JSON format.
List Message Counter as HTMLList the message counter as a string in HTML format.
Remove MessagesRemove messages matching the given filter from the destination.
Move MessagesMove the messages corresponding to the given filter to another queue.
List Message Counter as HTMLList the message counter history.
List Scheduled MessagesList the messages scheduled for delivery.
ResumeResume the queue.
Send Messages to Dead Letter AddressSend the messages corresponding to the given filter to this queue's Dead Letter Address.
Remove MessageRemove the message corresponding to the given message-id.
Change Message PriorityChange the priority of the message corresponding to the given message-id.
Package Types
none
3.4.2.4.23. EAP7 - Logging (Managed Server) Service
Overview
Table 3.3533. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3534. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3535. 
NameDescriptionRequiredInternal Name
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
HandlersThe Handlers associated with this Logger. yes handlers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.23.1. EAP7 - Async Handler (Managed Server) Service
Overview
Table 3.3536. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3537. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3538. 
NameDescriptionRequiredInternal Name
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
Overflow ActionSpecify what action to take when the overflowing. The valid options are 'block' and 'discard'. The default value is BLOCK. yes overflow-action
Queue LengthThe queue length to use before flushing writing yes queue-length
SubhandlersThe Handlers associated with this async handler. no subhandlers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.23.2. EAP7 - Console Handler (Managed Server) Service
Overview
Table 3.3539. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3540. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3541. 
NameDescriptionRequiredInternal Name
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
TargetDefines the target of the console handler. The value can either be SYSTEM_OUT or SYSTEM_ERR. The default value is System.out. no target

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.23.3. EAP7 - Custom Handler (Managed Server) Service
Overview
Table 3.3542. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3543. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3544. 
NameDescriptionRequiredInternal Name
ClassThe logging handler class to be used. yes class
EncodingThe character encoding used by this Handler. no encoding
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
ModuleThe module that the logging handler depends on. yes module
Properties  yes properties

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.23.4. EAP7 - File Handler (Managed Server) Service
Overview
Table 3.3545. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3546. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3547. 
NameDescriptionRequiredInternal Name
AppendSpecify whether to append to the target file. The default value is true. no append
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FileThe file description consisting of the path and optional relative to path. no file
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.23.5. EAP7 - Logger (Managed Server) Service
Overview
Table 3.3548. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3549. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3550. 
NameDescriptionRequiredInternal Name
HandlersThe Handlers associated with this Logger. no handlers
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
Use Parent HandlersSpecifies whether or not this logger should send its output to it's parent Logger. The default value is true. no use-parent-handlers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.23.6. EAP7 - Periodic Rotating File Handler (Managed Server) Service
Overview
Table 3.3551. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3552. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3553. 
NameDescriptionRequiredInternal Name
AppendSpecify whether to append to the target file. The default value is true. no append
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FileThe file description consisting of the path and optional relative to path. no file
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
SuffixSet 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. yes suffix

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.23.7. EAP7 - Size Rotating File Handler (Managed Server) Service
Overview
Table 3.3554. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3555. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3556. 
NameDescriptionRequiredInternal Name
AppendSpecify whether to append to the target file. The default value is true. no append
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FileThe file description consisting of the path and optional relative to path. no file
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
Max Backup IndexThe maximum number of backups to keep. The default value is 1. yes max-backup-index
Rotate SizeThe size at which to rotate the log file. The default value is 2m. yes rotate-size

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.24. EAP7 - JVM Service
Overview
Table 3.3557. Overview
Description:Information about the underlying JVM
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3558. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.24.1. EAP7 - Operating System Service
Overview
Table 3.3559. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3560. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3561. Metrics
NameTypeDescriptionInternal Name
Available ProcessorsmeasurementThe number of processors available to the Java virtual machine.available-processors
System Load AveragemeasurementThe system load average for the last minute. The load average may not be available on some platforms; if the load average is not available, a negative value is returned.system-load-average

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.24.2. EAP7 - Memory Service
Overview
Table 3.3562. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3563. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3564. Metrics
NameTypeDescriptionInternal Name
Object Pending Finalization CountmeasurementThe approximate number of objects for which finalization is pending.object-pending-finalization-count
Initial heap usagemeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.heap-memory-usage:init
Used heapmeasurementThe amount of used memory in bytes.heap-memory-usage:used
Committed heapmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.heap-memory-usage:committed
Maximum heap usagemeasurementThe maximum amount of memory in bytes that can be used for memory management.heap-memory-usage:max
Initial non-heap usagemeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.non-heap-memory-usage:init
Used non-heap memorymeasurementThe amount of used memory in bytes.non-heap-memory-usage:used
Committed non-heap memorymeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.non-heap-memory-usage:committed
Maximum non-heap usagemeasurementThe maximum amount of memory in bytes that can be used for memory management.non-heap-memory-usage:max

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.3565. Metrics
NameDescription
Trigger GCRuns the garbage collector.
Package Types
none
3.4.2.4.24.3. EAP7 - Runtime Service
Overview
Table 3.3566. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3567. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3568. Metrics
NameTypeDescriptionInternal Name
UptimemeasurementThe uptime of the Java virtual machine in milliseconds.uptime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.24.4. EAP7 - Threading Service
Overview
Table 3.3569. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3570. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3571. Metrics
NameTypeDescriptionInternal Name
Thread CountmeasurementThe current number of live threads including both daemon and non-daemon threads.thread-count
Peak Thread CountmeasurementThe peak live thread count since the Java virtual machine started or peak was reset.peak-thread-count
Total Started Thread CountmeasurementThe total number of threads created and also started since the Java virtual machine started.total-started-thread-count
Daemon Thread CountmeasurementThe current number of live daemon threads.daemon-thread-count
Current Thread Cpu TimemeasurementThe total CPU time for the current thread in nanoseconds, or -1 if 'thread-cpu-time-enabled' is 'false'. A Java virtual machine implementation may not support CPU time measurement. If 'thread-cpu-time-supported', is 'false' undefined.current-thread-cpu-time
Current Thread User TimemeasurementThe CPU time that the current thread has executed in user mode in nanoseconds, or -1 if 'thread-cpu-time-enabled' is 'false'. A Java virtual machine implementation may not support CPU time measurement. If 'thread-cpu-time-supported', is 'false' the result will be undefined current-thread-user-time

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3572. 
NameDescriptionRequiredInternal Name
Thread Contention Monitoring EnabledWhether thread contention monitoring is enabled. no thread-contention-monitoring-enabled
Thread Cpu Time EnabledWhether thread CPU time measurement is enabled. no thread-cpu-time-enabled
Thread Contention Monitoring SupportedWhether the Java virtual machine supports thread contention monitoring. no thread-contention-monitoring-supported
Thread Cpu Time SupportedWhether the Java virtual machine implementation supports CPU time measurement for any thread. no thread-cpu-time-supported
Current Thread Cpu Time SupportedWhether the Java virtual machine supports CPU time measurement for the current thread. no current-thread-cpu-time-supported
Object Monitor Usage SupportedWhether the Java virtual machine supports monitoring of object monitor usage. no object-monitor-usage-supported
Synchronizer Usage SupportedWhether the Java virtual machine supports monitoring of ownable synchronizer usage. no synchronizer-usage-supported

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3573. Metrics
NameDescription
Dump All ThreadsReturns the thread info for all live threads with stack trace and synchronization information.
Find Deadlocked ThreadsFinds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers.
Find Monitor Deadlocked ThreadsFinds cycles of threads that are in deadlock waiting to acquire object monitors.
Get Thread Cpu TimeReturns the total CPU time for a thread of the specified ID in nanoseconds.
Get Thread InfoReturns the thread info for a thread of the specified id. The stack trace, locked monitors, and locked synchronizers in the returned reply object will be empty.
Get Thread InfosReturns the thread info for each thread whose ID is in the input list.
Get Thread User TimeReturns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds.
Reset Peak Thread CountResets the peak thread count to the current number of live threads.
Get All thread idsGet all live thread IDs. If a security manager is installed and the caller does not have ManagementPermission('monitor'), the result will be undefined.
Package Types
none
3.4.2.4.24.5. EAP7 - Garbage Collector Service
Overview
Table 3.3574. Overview
Description:Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3575. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.24.5.1. EAP7 - Garbage Collector Resource Service
Overview
Table 3.3576. Overview
Description:The management interface for one of the garbage collectors in the Java virtual machine.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3577. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3578. Metrics
NameTypeDescriptionInternal Name
Collection CountmeasurementThe total number of collections that have occurred.collection-count
Collection Count per MinutemeasurementThe total number of collections that have occurred.collection-count
Collection TimemeasurementThe approximate accumulated collection elapsed time in milliseconds.collection-time
Collection Time per MinutemeasurementThe approximate accumulated collection elapsed time in milliseconds.collection-time
NametraitThe name representing this garbage collectorname
ValidtraitWhether this this memory manager is valid in the Java virtual machine.valid

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3579. 
NameDescriptionRequiredInternal Name
Memory Pool NamesThe name of memory pools that this garbage collector manages. yes memory-pool-names

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.24.6. EAP7 - Memory Pool Service
Overview
Table 3.3580. Overview
Description:Parent resource for the resources providing the management interface for the Java virtual machine's memory pools.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3581. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.24.6.1. EAP7 - Memory Pool Resource Service
Overview
Table 3.3582. Overview
Description:The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3583. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3584. Metrics
NameTypeDescriptionInternal Name
Collection Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.collection-usage:init
Collection Usage - UsedmeasurementThe amount of used memory in bytes.collection-usage:used
Collection Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.collection-usage:committed
Collection Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.collection-usage:max
Collection Usage Threshold CountmeasurementThe number of times that the Java virtual machine has detected that the memory usage has reached or exceeded the collection usage threshold. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.collection-usage-threshold-count
Collection Usage Threshold ExceededtraitWhether the memory usage of this memory pool after the most recent collection on which the Java virtual machine has expended effort has reached or exceeded its collection usage threshold. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.collection-usage-threshold-exceeded
Collection Usage Threshold SupportedtraitWhether this memory pool supports a collection usage threshold.collection-usage-threshold-supported
NametraitThe name representing this memory pool.name
Peak Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.peak-usage:init
Peak Usage - UsedmeasurementThe amount of used memory in bytes.peak-usage:used
Peak Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.peak-usage:committed
Peak Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.peak-usage:max
TypetraitThe type of this memory pool.type
Usage - InitmeasurementThe amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management.usage:init
Usage - UsedmeasurementThe amount of used memory in bytes.usage:used
Usage - CommittedmeasurementThe amount of memory in bytes that is committed for the Java virtual machine to use.usage:committed
Usage - MaxmeasurementThe maximum amount of memory in bytes that can be used for memory management.usage:max
Usage Threshold CountmeasurementThe number of times that the memory usage has crossed the usage threshold. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.usage-threshold-count
Usage Threshold ExceededtraitWhether the memory usage of this memory pool reaches or exceeds its usage threshold value. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'.usage-threshold-exceeded
Usage Threshold SupportedtraitWhether this memory pool supports usage threshold.usage-threshold-supported
ValidtraitWhether this memory pool is valid in the Java virtual machine. A memory pool becomes invalid once the Java virtual machine removes it from the memory system.valid

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3585. 
NameDescriptionRequiredInternal Name
Collection Usage ThresholdThe collection usage threshold value of this memory pool in bytes. A memory pool may not support a collection usage threshold. If 'collection-usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'. no collection-usage-threshold
Memory Manager NamesThe names of the memory managers that manage this memory pool. yes memory-manager-names
Usage ThresholdThe usage threshold value of this memory pool in bytes. A memory pool may not support a usage threshold. If 'usage-threshold-supported', is 'false' trying to read this attribute via the 'read-attribute' operation will result in failure, and the value of this attribute in the result of a 'read-resource' operation will be 'undefined'. no usage-threshold

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3586. Metrics
NameDescription
Reset Peak UsageResets the peak memory usage statistic of this memory pool to the current memory usage.
Package Types
none
3.4.2.4.25. EAP7 - Datasources (Managed) Service
Overview
Table 3.3587. Overview
Description:Datasources subsystem for Managed servers.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3588. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3589. 
NameDescriptionRequiredInternal Name
Available drivers  yes *4

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.25.1. EAP7 - DataSource (Managed) Service
Overview
Table 3.3590. Overview
Description:A non-XA data source
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3591. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3592. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3593. 
NameDescriptionRequiredInternal Name
Connection Property  no *1
Connection UrlThe JDBC driver connection URL yes connection-url
Driver NameName of the (existing) JDBC driver to use yes driver-name
Driver ClassThe fully qualified name of the JDBC driver class no driver-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
DriverDefines the JDBC driver the datasource should use with this format: driver-name>#major-version.minor-version where driver-name is the fully qualified name of the JDBC driver class no driver
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. no pool-use-strict-min
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait MillisIndicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3594. Metrics
NameDescription
Flush All Connection In PoolFlushes the pool for all connections
Flush Idle Connection In PoolFlushes the pool for idle connections
Test Connection In PoolTests if a connection can be obtained
Package Types
none
3.4.2.4.25.2. EAP7 - XADataSource (Managed) Service
Overview
Table 3.3595. Overview
Description:An XA data source
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3596. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3597. Metrics
NameTypeDescriptionInternal Name
Prepared Statement Cache Current SizemeasurementThe number of prepared and callable statements currently cached in the statement cachePreparedStatementCacheCurrentSize
Prepared Statement Cache Miss CountmeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Miss Count per MinutemeasurementThe number of times that a statement request could not be satisfied with a statement from the cachePreparedStatementCacheMissCount
Prepared Statement Cache Add CountmeasurementThe number of statements added to the statement cachePreparedStatementCacheAddCount
Prepared Statement Cache Access CountmeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Access Count per MinutemeasurementThe number of times that the statement cache was accessedPreparedStatementCacheAccessCount
Prepared Statement Cache Delete CountmeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Delete Count per MinutemeasurementThe number of statements discarded from the cachePreparedStatementCacheDeleteCount
Prepared Statement Cache Hit CountmeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Prepared Statement Cache Hit Count per MinutemeasurementThe number of times that statements from the cache were usedPreparedStatementCacheHitCount
Active CountmeasurementThe active countActiveCount
Available CountmeasurementThe available countAvailableCount
Average Blocking TimemeasurementThe average time spent blocking for a connectionAverageBlockingTime
Average Creation TimemeasurementThe average time spent creating a physical connectionAverageCreationTime
Created CountmeasurementThe created countCreatedCount
Created Count per MinutemeasurementThe created countCreatedCount
Destroyed CountmeasurementThe destroyed countDestroyedCount
Destroyed Count per MinutemeasurementThe destroyed countDestroyedCount
Max Creation TimemeasurementThe maximum time for creating a physical connectionMaxCreationTime
Max Used CountmeasurementThe maximum number of connections usedMaxUsedCount
Max Wait TimemeasurementThe maximum wait time for a connectionMaxWaitTime
Timed OutmeasurementThe timed out countTimedOut
Timed Out per MinutemeasurementThe timed out countTimedOut
Total Creation TimemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Creation Time per MinutemeasurementThe total time spent creating physical connectionsTotalCreationTime
Total Blocking TimemeasurementThe total blocking timeTotalBlockingTime
Total Blocking Time per MinutemeasurementThe total blocking timeTotalBlockingTime
Connection Available?traitConnection Available?connectionAvailable
Min Pool Size settingmeasurementThe min pool size settingmin-pool-size
Max Pool Size settingmeasurementThe max pool size settingmax-pool-size

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3598. 
NameDescriptionRequiredInternal Name
Properties  no *2
Xa Datasource ClassThe fully qualified name of the javax.sql.XADataSource implementation yes xa-datasource-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
Driver NameDefines 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 yes driver-name
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. no pool-use-strict-min
InterleavingAn element to enable interleaving for XA connection factories no interleaving
No Tx Separate PoolOracle 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 context no no-tx-separate-pool
Pad XidShould the Xid be padded no pad-xid
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Wrap Xa DatasourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance no wrap-xa-datasource
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Recovery Plugin Class Namerecovery plugin implementation provided for specific purpose (i.e vendor) no recovery-plugin-class-name
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait Millishe allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Xa Resource TimeoutPassed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds no xa-resource-timeout
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm
Recovery Usernameusername used to try connection recovery no recovery-username
Recovery Passwordpassword used to try connection recovery no recovery-password
Recovery Security Domainsecurity-domain used to try connection recovery no recovery-security-domain
No Recoveryif true no recovery are tried for this connection pool no no-recovery

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3599. Metrics
NameDescription
Flush All Connection In PoolFlushes the pool for all connections
Flush Idle Connection In PoolFlushes the pool for idle connections
Test Connection In PoolTests if a connection can be obtained
Package Types
none
3.4.2.4.26. EAP7 - JVM Definition Service
Overview
Table 3.3600. Overview
Description:A JVM definition that can override host and server group level definitions with the same name
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3601. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3602. 
NameDescriptionRequiredInternal Name
Base DefinitionThe definition from host level to use/override yes baseDefinition
Agent LibThe JVM agent lib. no agent-lib
Agent PathThe JVM agent path. no agent-path
Env Classpath IgnoredIgnore the environment classpath. no env-classpath-ignored
Environment VariablesThe JVM environment variables. no environment-variables
Heap SizeThe initial heap size allocated by the JVM. no heap-size
Java AgentThe java agent. no java-agent
Java HomeThe java home no java-home
Jvm OptionsThe JVM options. Those can not be changed after initial creation of the definition. no jvm-options
Max Heap SizeThe maximum heap size that can be allocated by the JVM. no max-heap-size
Max Permgen SizeThe maximum size of the permanent generation. no max-permgen-size
Permgen SizeThe initial permanent generation size. no permgen-size
Stack SizeThe JVM stack size settings. no stack-size
TypeThe JVM type can be either SUN or IBM no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.27. EAP7 - Transactions Subsystem (Managed) Service
Overview
Table 3.3603. Overview
Description:The transactions subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3604. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3605. Metrics
NameTypeDescriptionInternal Name
Number Of Nested TransactionsmeasurementThe total number of nested (sub) transactions created.number-of-nested-transactions
Number Of Nested Transactions per MinutemeasurementThe total number of nested (sub) transactions created.number-of-nested-transactions
Number Of Timed Out TransactionsmeasurementThe number of transactions that have rolled back due to timeout.number-of-timed-out-transactions
Number Of Timed Out Transactions per MinutemeasurementThe number of transactions that have rolled back due to timeout.number-of-timed-out-transactions
Number Of Committed TransactionsmeasurementThe number of committed transactions.number-of-committed-transactions
Number Of Committed Transactions per MinutemeasurementThe number of committed transactions.number-of-committed-transactions
Number Of TransactionsmeasurementThe total number of transactions (top-level and nested) creatednumber-of-transactions
Number Of Transactions per MinutemeasurementThe total number of transactions (top-level and nested) creatednumber-of-transactions
Number Of HeuristicsmeasurementThe number of transactions which have terminated with heuristic outcomes.number-of-heuristics
Number Of Heuristics per MinutemeasurementThe number of transactions which have terminated with heuristic outcomes.number-of-heuristics
Number Of Aborted TransactionsmeasurementThe number of aborted (i.e. rolledback) transactions.number-of-aborted-transactions
Number Of Aborted Transactions per MinutemeasurementThe number of aborted (i.e. rolledback) transactions.number-of-aborted-transactions
Number Of Inflight TransactionsmeasurementThe number of transactions that have begun but not yet terminated.number-of-inflight-transactions
Number Of Inflight Transactions per MinutemeasurementThe number of transactions that have begun but not yet terminated.number-of-inflight-transactions
Number Of Application RollbacksmeasurementThe number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behaviour is considered an attribute of the application configuration.number-of-application-rollbacks
Number Of Application Rollbacks per MinutemeasurementThe number of transactions that have been rolled back by application request. This includes those that timeout, since the timeout behaviour is considered an attribute of the application configuration.number-of-application-rollbacks
Number Of Resource RollbacksmeasurementThe number of transactions that rolled back due to resource (participant) failure.number-of-resource-rollbacks
Number Of Resource Rollbacks per MinutemeasurementThe number of transactions that rolled back due to resource (participant) failure.number-of-resource-rollbacks

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.4.27.1. EAP7 - Log Store (Managed) Service
Overview
Table 3.3606. Overview
Description:Representation of the transaction logging storage mechanism.
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3607. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3608. 
NameDescriptionRequiredInternal Name
TypeSpecifies the implementation type of the logging store. no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.27.1.1. EAP7 - Transactions (Managed) Service
Overview
Table 3.3609. Overview
Description:The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3610. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3611. 
NameDescriptionRequiredInternal Name
Age In SecondsThe time since this transaction was prepared or when the recovery system last tried to recover it. no age-in-seconds
IdThe id of this transaction. no id
Jmx NameThe JMX name of this transaction. no jmx-name
TypeThe type name under which this record is stored. no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.27.1.1.1. EAP7 - Participants (Managed) Service
Overview
Table 3.3612. Overview
Description:The resources that did work in a transaction.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3613. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3614. 
NameDescriptionRequiredInternal Name
Eis Product NameThe JCA enterprise information system's product name. no eis-product-name
Eis Product VersionThe JCA enterprise information system's product version no eis-product-version
Jmx NameThe JMX name of this participant. no jmx-name
Jndi NameJNDI name of this participant. no jndi-name
StatusReports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly). no status
TypeThe type name under which this record is stored. no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.4.28. EAP7 - JDR Service
Overview
Table 3.3615. Overview
Description:JBoss Diagnostic Reporter (JDR) Subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3616. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.3617. Metrics
NameDescription
Generate JDR ReportRequest the generation of a JDR report.
Package Types
none

3.4.2.5. EAP7 - Profile Service

Overview
Table 3.3618. Overview
Description:A profile in a domain. Profiles are assigned to server groups.
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3619. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.1. EAP7 - ModCluster Domain Service
Overview
Table 3.3620. Overview
Description:Mod_cluster support
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3621. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.1.1. EAP7 - Domain Service Configuration Service
Overview
Table 3.3622. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3623. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3624. 
NameDescriptionRequiredInternal Name
Proxy ListList of proxies, Format (hostname:port) separated with commas. no proxy-list
Proxy UrlBase URL for MCMP requests. no proxy-url
Advertise SocketName of Socket binding to use for the Advertise socket. no advertise-socket
AdvertiseUse Advertise logic or not. no advertise
Advertise Security KeyString containing the security key for the Advertise logic. no advertise-security-key
BalancerThe balancer name. no balancer
ConnectorName of the web connector used to communicate with the load balancer. yes connector
Load Balancing GrouploadBalancingGroup name. no load-balancing-group
Excluded ContextsList of contexts mod_cluster should ignore, Format String separated with commas. no excluded-contexts
Auto Enable ContextsEnable contexts even if disabled in mod_cluster_manger (httpd). no auto-enable-contexts
Sticky SessionUse sticky sessions for requests. no sticky-session
Sticky Session RemoveRemove session information on failover. no sticky-session-remove
Sticky Session ForceDon't failover a request with session information. no sticky-session-force
Worker TimeoutTimeout to wait in httpd for an available worker to process the requests. no worker-timeout
Max AttemptsMax attempts to process an idempotent request. no max-attempts
Flush PacketsEnables/disables packet flushing in httpd. no flush-packets
Flush WaitTime to wait before flushing packets in httpd. no flush-wait
PingTime (in seconds) in which to wait for a pong answer to a ping. no ping
SmaxSoft maximum idle connection count in httpd no smax
TtlTime to live (in seconds) for idle connections above smax no ttl
Node TimeoutTimeout (in seconds) for proxy connections to a node. no node-timeout
Stop Context TimeoutMax time to wait for context to process pending requests. no stop-context-timeout
Socket TimeoutTimeout to wait for httpd to answer a MCMP message. no socket-timeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3625. Metrics
NameDescription
Add Custom MetricAdd new custom metric to the load balancer provider.
Add MetricAdd new metric to the load balancer provider.
Remove Custom MetricRemove a custom metric from the load balancer provider.
Remove MetricAdd new metric to the load balancer provider.
Package Types
none
3.4.2.5.1.1.1. EAP7 - Domain Dynamic Load Provider Service
Overview
Table 3.3626. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3627. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3628. 
NameDescriptionRequiredInternal Name
DecayDecay. The default value is 2. no decay
HistoryHistory. The default value is 9. no history

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.1.1.1.1. EAP7 - Domain Custom Load Metric Service
Overview
Table 3.3629. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3630. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3631. 
NameDescriptionRequiredInternal Name
CapacityCapacity of the metric. The default value is 1 no capacity
ClassClass name of the custom metric. yes class
WeightWeight of the metric. The default value is 1. no weight

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.1.1.1.2. EAP7 - Domain Load Metric Service
Overview
Table 3.3632. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3633. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3634. 
NameDescriptionRequiredInternal Name
CapacityCapacity of the metric. The default value is 1. no capacity
TypeType of the metric yes type
WeightWeight of the metric. The default value is 1. no weight

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.1.1.2. EAP7 - Domain Ssl Service
Overview
Table 3.3635. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3636. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3637. 
NameDescriptionRequiredInternal Name
Ca Certificate FileCertificate authority. no ca-certificate-file
Ca Revocation UrCertificate authority revocation list. no ca-revocation-ur
Certificate Key FileKey file for the certificate. no certificate-key-file
Cipher SuiteThe allowed cipher suite. no cipher-suite
Key AliasThe key alias. no key-alias
PasswordPassword. no password
ProtocolThe SSL protocols that are enabled. no protocol

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.2. EAP7 - Naming (Profile) Service
Overview
Table 3.3638. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3639. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.2.1. EAP7 - Binding (Profile) Service
Overview
Table 3.3640. Overview
Description:JNDI bindings for primitive types
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3641. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3642. 
NameDescriptionRequiredInternal Name
Binding TypeThe type of binding to create, may be simple, lookup or object-factory yes binding-type
ClassThe object factory class name for object factory bindings no class
LookupThe entry to lookup in JNDI for lookup bindings no lookup
ModuleThe module to load the object factory from for object factory bindings no module
TypeThe type of the value to bind for simple bindings, this must be a primitive type no type
ValueThe value to bind for simple bindings no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3. EAP7 - Undertow (Profile) Service
Overview
Table 3.3643. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3644. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3645. 
NameDescriptionRequiredInternal Name
Default Security DomainThe default security domain used by web deployments. The default value is other. no default-security-domain
Default ServerThe default server to use for deployments. The default value is default-server. no default-server
Default Servlet ContainerThe default servlet container to use for deployments. The default value is default. no default-servlet-container
Default Virtual HostThe default virtual host to use for deployments. The default value is default-host. no default-virtual-host
Instance IdThe cluster instance id. The default value is {EXPRESSION_VALUE=${jboss.node.name}}. no instance-id
Statistics EnabledConfigures if are statistics enabled. The default value is false. no statistics-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.1. EAP7 - Filter configurations (Profile) Service
Overview
Table 3.3646. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3647. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.3.1.1. EAP7 - Error page (Profile) Service
Overview
Table 3.3648. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3649. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3650. 
NameDescriptionRequiredInternal Name
Code:exprError page code yes code:expr
PathError page path no path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.1.2. EAP7 - Expression filter (Profile) Service
Overview
Table 3.3651. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3652. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3653. 
NameDescriptionRequiredInternal Name
ExpressionThe expression that defines the filter yes expression
ModuleModule to use to load the filter definitions no module

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.1.3. EAP7 - GZIP (Profile) Service
Overview
Table 3.3654. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3655. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.3.1.4. EAP7 - Mod cluster (Profile) Service
Overview
Table 3.3656. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3657. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3658. 
NameDescriptionRequiredInternal Name
Advertise Frequency:exprThe frequency (in milliseconds) that mod-cluster advertises itself on the network. The default value is 10000. no advertise-frequency:expr
Advertise PathThe path that mod-cluster is registered under, defaults to /. The default value is /. no advertise-path
Advertise ProtocolThe protocol that is in use, defaults to HTTP. The default value is http. no advertise-protocol
Advertise Socket BindingThe multicast group that is used to advertise yes advertise-socket-binding
Broken Node Timeout:exprThe amount of time that must elapse before a broken node is removed from the table. The default value is 60000. no broken-node-timeout:expr
Cached Connections Per Thread:exprThe number of connections that will be kept alive indefinitely. The default value is 40. no cached-connections-per-thread:expr
Connection Idle Timeout:exprThe 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). The default value is 60. no connection-idle-timeout:expr
Connections Per Thread:exprThe number of connections that will be maintained to backend servers, per IO thread. Defaults to 10. The default value is 40. no connections-per-thread:expr
Enable Http 2If 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. The default value is false. no enable-http2
Health Check Interval:exprThe frequency of health check pings to backend nodes. The default value is 10000. no health-check-interval:expr
Management Access PredicateA 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 no management-access-predicate
Management Socket BindingThe socket binding of the mod_cluster management 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 yes management-socket-binding
Max Ajp Packet SizeThe 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. no max-ajp-packet-size
Max Request Time:exprThe max amount of time that a request to a backend node can take before it is killed. The default value is -1. no max-request-time:expr
Request Queue Size:exprThe number of requests that can be queued if the connection pool is full before requests are rejected with a 503. The default value is 1000. no request-queue-size:expr
Security KeyThe security key that is used for the mod-cluster group. All members must use the same security key. no security-key
Security RealmThe security realm that provides the SSL configuration no security-realm
Use AliasIf an alias check is performed. The default value is false. no use-alias
WorkerThe XNIO worker that is used to send the advertise notifications. The default value is default. no worker

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.1.5. EAP7 - Rewrite (Profile) Service
Overview
Table 3.3659. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3660. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3661. 
NameDescriptionRequiredInternal Name
RedirectIf this is true then a redirect will be done instead of a rewrite. The default value is false. no redirect
TargetThe expression that defines the target. If you are redirecting to a constant target put single quotes around the value yes target

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.1.6. EAP7 - Response header (Profile) Service
Overview
Table 3.3662. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3663. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3664. 
NameDescriptionRequiredInternal Name
Header NameHeader name yes header-name
Header ValueValue for header yes header-value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.1.7. EAP7 - Request limit (Profile) Service
Overview
Table 3.3665. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3666. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3667. 
NameDescriptionRequiredInternal Name
Max Concurrent Requests:exprMaximum number of concurrent requests no max-concurrent-requests:expr
Queue Size:exprNumber of requests to queue before they start being rejected no queue-size:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.1.8. EAP7 - Custom filter (Profile) Service
Overview
Table 3.3668. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3669. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3670. 
NameDescriptionRequiredInternal Name
Class NameClass name of HttpHandler yes class-name
ModuleModule name where class can be loaded from yes module
ParametersFilter parameters no parameters

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.2. EAP7 - Handler configuration (Profile) Service
Overview
Table 3.3671. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3672. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.3.2.1. EAP7 - File Handler - Undertow (Profile) Service
Overview
Table 3.3673. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3674. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3675. 
NameDescriptionRequiredInternal Name
Cache Buffer Size:exprSize of the buffers. The default value is 1024. no cache-buffer-size:expr
Cache Buffers:exprNumber of buffers. The default value is 1024. no cache-buffers:expr
Case SensitiveUse case sensitive file handling. The default value is true. no case-sensitive
Directory ListingEnable directory listing?. The default value is false. no directory-listing
Follow SymlinkEnable following symbolic links. The default value is false. no follow-symlink
PathPath on filesystem from where file handler will serve resources no path
Safe Symlink PathsPaths that are safe to be targets of symbolic links no safe-symlink-paths

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.2.2. EAP7 - Reverse proxy (Profile) Service
Overview
Table 3.3676. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3677. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3678. 
NameDescriptionRequiredInternal Name
Cached Connections Per Thread:exprThe number of connections that will be kept alive indefinitely. The default value is 5. no cached-connections-per-thread:expr
Connection Idle Timeout:exprThe 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). The default value is 60. no connection-idle-timeout:expr
Connections Per Thread:exprThe number of connections that will be maintained to backend servers, per IO thread. Defaults to 10. The default value is 10. no connections-per-thread:expr
Max Request Time:exprThe maximum time that a proxy request can be active for, before being killed. Defaults to unlimited. The default value is -1. no max-request-time:expr
Problem Server Retry:exprTime in seconds to wait before attempting to reconnect to a server that is down. The default value is 30. no problem-server-retry:expr
Request Queue Size:exprThe number of requests that can be queued if the connection pool is full before requests are rejected with a 503. The default value is 10. no request-queue-size:expr
Session Cookie NamesComma separated list of session cookie names. Generally this will just be JSESSIONID. The default value is JSESSIONID. no session-cookie-names

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.2.2.1. EAP7 - Reverse proxy host (Profile) Service
Overview
Table 3.3679. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3680. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3681. 
NameDescriptionRequiredInternal Name
Instance IdThe instance id (aka JVM route) that will be used to enable sticky sessions no instance-id
Outbound Socket BindingOutbound socket binding for this host no outbound-socket-binding
PathOptional path if host is using non root resource. The default value is /. no path
SchemeWhat kind of scheme is used. The default value is http. no scheme
Security RealmThe security realm that provides the SSL configuration for the connection to the host no security-realm

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.3. EAP7 - Buffer Cache (Profile) Service
Overview
Table 3.3682. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3683. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3684. 
NameDescriptionRequiredInternal Name
Buffer Size:exprThe size of an individual buffer. The default value is 1024. no buffer-size:expr
Buffers Per Region:exprThe numbers of buffers in a region. The default value is 1024. no buffers-per-region:expr
Max Regions:exprThe maximum number of regions. The default value is 10. no max-regions:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.4. EAP7 - Server (Profile) Service
Overview
Table 3.3685. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3686. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3687. 
NameDescriptionRequiredInternal Name
Default HostThe servers default virtual host. The default value is default-host. no default-host
Servlet ContainerThe servers default servlet container. The default value is default. no servlet-container

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.4.1. EAP7 - Ajp Listener (Profile) Service
Overview
Table 3.3688. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3689. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3690. Metrics
NameTypeDescriptionInternal Name
Bytes ReceivedmeasurementThe number of bytes that have been received by this listenerbytes-received
Bytes SentmeasurementThe number of bytes that have been sent out on this listenerbytes-sent
Error CountmeasurementThe number of 500 responses that have been sent by this listenererror-count
Max Processing TimemeasurementThe maximum processing time taken by a request on this listenermax-processing-time
Processing TimemeasurementThe total processing time of all requests handed by this listenerprocessing-time
Request CountmeasurementThe number of requests this listener has servedrequest-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3691. 
NameDescriptionRequiredInternal Name
Allow Encoded SlashIf a request comes in with encoded / characters (i.e. %2F), will these be decoded. The default value is false. no allow-encoded-slash
Allow Equals In Cookie ValueIf 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. The default value is false. no allow-equals-in-cookie-value
Always Set Keep AliveIf this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. no always-set-keep-alive
Buffer Pipelined DataIf we should buffer pipelined requests. The default value is true. no buffer-pipelined-data
Buffer PoolThe AJP listeners buffer pool. The default value is default. no buffer-pool
Decode UrlIf 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. The default value is true. no decode-url
Disallowed MethodsA comma separated list of HTTP methods that are not allowed no disallowed-methods
EnabledIf the listener is enabled. The default value is true. no enabled
Max Buffered Request Size:exprMaximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation. The default value is 16384. no max-buffered-request-size:expr
Max Connections:exprThe maximum number of concurrent connections. no max-connections:expr
Max Cookies:exprThe maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-cookies:expr
Max Header Size:exprThe maximum size in bytes of a http request header. The default value is 1048576. no max-header-size:expr
Max Headers:exprThe maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-headers:expr
Max Parameters:exprThe 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). The default value is 1000. no max-parameters:expr
Max Post Size:exprThe maximum size of a post that will be accepted. The default value is 10485760. no max-post-size:expr
No Request Timeout:exprThe length of time in milliseconds that the connection can be idle before it is closed by the container no no-request-timeout:expr
Read Timeout:exprConfigure 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}. no read-timeout:expr
Receive Buffer:exprThe receive buffer size. no receive-buffer:expr
Record Request Start TimeIf 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. The default value is false. no record-request-start-time
Redirect SocketIf 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. no redirect-socket
Request Parse Timeout:exprThe maximum amount of time (in milliseconds) that can be spent parsing the request no request-parse-timeout:expr
Resolve Peer AddressEnables host dns lookup. The default value is false. no resolve-peer-address
SchemeThe listener scheme, can be HTTP or HTTPS. By default the scheme will be taken from the incoming AJP request. no scheme
Send Buffer:exprThe send buffer size. no send-buffer:expr
Socket BindingThe AJP listener socket binder yes socket-binding
Tcp Backlog:exprConfigure a server with the specified backlog. no tcp-backlog:expr
Tcp Keep AliveConfigure a channel to send TCP keep-alive messages in an implementation-dependent manner. no tcp-keep-alive
Url CharsetURL charset. The default value is UTF-8. no url-charset
WorkerThe AJP listeners XNIO worker. The default value is default. no worker
Write Timeout:exprConfigure 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}. no write-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.4.2. EAP7 - Undertow Host (Profile) Service
Overview
Table 3.3692. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3693. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3694. 
NameDescriptionRequiredInternal Name
AliasAliases for the host no alias
Default Response Code:exprIf set, this will be response code sent back in case requested context does not exist on server. The default value is 404. no default-response-code:expr
Default Web ModuleDefault web module. The default value is ROOT.war. no default-web-module
Disable Console Redirectif set to true, /console redirect wont be enabled for this host, default is false. The default value is false. no disable-console-redirect

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.4.2.1. EAP7 - Host Filter Ref (Profile) Service
Overview
Table 3.3695. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3696. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3697. 
NameDescriptionRequiredInternal Name
PredicatePredicates 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. no predicate
Priority:exprDefines 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. The default value is 1. no priority:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.4.2.2. EAP7 - Undertow-Location (Profile) Service
Overview
Table 3.3698. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3699. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3700. 
NameDescriptionRequiredInternal Name
HandlerDefault handler for this location yes handler

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.4.2.2.1. EAP7 - Location Filter Ref (Profile) Service
Overview
Table 3.3701. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3702. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3703. 
NameDescriptionRequiredInternal Name
PredicatePredicates 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. no predicate
Priority:exprDefines 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. The default value is 1. no priority:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.4.3. EAP7 - Http Listener (Profile) Service
Overview
Table 3.3704. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3705. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3706. Metrics
NameTypeDescriptionInternal Name
Bytes ReceivedmeasurementThe number of bytes that have been received by this listenerbytes-received
Bytes SentmeasurementThe number of bytes that have been sent out on this listenerbytes-sent
Error CountmeasurementThe number of 500 responses that have been sent by this listenererror-count
Max Processing TimemeasurementThe maximum processing time taken by a request on this listenermax-processing-time
Processing TimemeasurementThe total processing time of all requests handed by this listenerprocessing-time
Request CountmeasurementThe number of requests this listener has servedrequest-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3707. 
NameDescriptionRequiredInternal Name
Allow Encoded SlashIf a request comes in with encoded / characters (i.e. %2F), will these be decoded. The default value is false. no allow-encoded-slash
Allow Equals In Cookie ValueIf 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. The default value is false. no allow-equals-in-cookie-value
Always Set Keep AliveIf this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. no always-set-keep-alive
Buffer Pipelined DataIf we should buffer pipelined requests. The default value is true. no buffer-pipelined-data
Buffer PoolThe AJP listeners buffer pool. The default value is default. no buffer-pool
Certificate ForwardingIf 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. The default value is false. no certificate-forwarding
Decode UrlIf 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. The default value is true. no decode-url
Disallowed MethodsA comma separated list of HTTP methods that are not allowed no disallowed-methods
Enable Http 2Enables HTTP2 support for this listener. The default value is false. no enable-http2
EnabledIf the listener is enabled. The default value is true. no enabled
Max Buffered Request Size:exprMaximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation. The default value is 16384. no max-buffered-request-size:expr
Max Connections:exprThe maximum number of concurrent connections. no max-connections:expr
Max Cookies:exprThe maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-cookies:expr
Max Header Size:exprThe maximum size in bytes of a http request header. The default value is 1048576. no max-header-size:expr
Max Headers:exprThe maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-headers:expr
Max Parameters:exprThe 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). The default value is 1000. no max-parameters:expr
Max Post Size:exprThe maximum size of a post that will be accepted. The default value is 10485760. no max-post-size:expr
No Request Timeout:exprThe length of time in milliseconds that the connection can be idle before it is closed by the container no no-request-timeout:expr
Proxy Address Forwardingenables x-forwarded-host and similar headers and set a remote ip address and hostname. The default value is false. no proxy-address-forwarding
Read Timeout:exprConfigure 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}. no read-timeout:expr
Receive Buffer:exprThe receive buffer size. no receive-buffer:expr
Record Request Start TimeIf 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. The default value is false. no record-request-start-time
Redirect SocketIf 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. no redirect-socket
Request Parse Timeout:exprThe maximum amount of time (in milliseconds) that can be spent parsing the request no request-parse-timeout:expr
Resolve Peer AddressEnables host dns lookup. The default value is false. no resolve-peer-address
Send Buffer:exprThe send buffer size. no send-buffer:expr
Socket BindingThe AJP listener socket binder yes socket-binding
Tcp Backlog:exprConfigure a server with the specified backlog. no tcp-backlog:expr
Tcp Keep AliveConfigure a channel to send TCP keep-alive messages in an implementation-dependent manner. no tcp-keep-alive
Url CharsetURL charset. The default value is UTF-8. no url-charset
WorkerThe AJP listeners XNIO worker. The default value is default. no worker
Write Timeout:exprConfigure 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}. no write-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.4.4. EAP7 - Https Listener (Profile) Service
Overview
Table 3.3708. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3709. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.3710. Metrics
NameTypeDescriptionInternal Name
Bytes ReceivedmeasurementThe number of bytes that have been received by this listenerbytes-received
Bytes SentmeasurementThe number of bytes that have been sent out on this listenerbytes-sent
Error CountmeasurementThe number of 500 responses that have been sent by this listenererror-count
Max Processing TimemeasurementThe maximum processing time taken by a request on this listenermax-processing-time
Processing TimemeasurementThe total processing time of all requests handed by this listenerprocessing-time
Request CountmeasurementThe number of requests this listener has servedrequest-count

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.3711. 
NameDescriptionRequiredInternal Name
Allow Encoded SlashIf a request comes in with encoded / characters (i.e. %2F), will these be decoded. The default value is false. no allow-encoded-slash
Allow Equals In Cookie ValueIf 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. The default value is false. no allow-equals-in-cookie-value
Always Set Keep AliveIf this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. no always-set-keep-alive
Buffer Pipelined DataIf we should buffer pipelined requests. The default value is true. no buffer-pipelined-data
Buffer PoolThe AJP listeners buffer pool. The default value is default. no buffer-pool
Decode UrlIf 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. The default value is true. no decode-url
Disallowed MethodsA comma separated list of HTTP methods that are not allowed no disallowed-methods
Enable Http 2Enables HTTP2 support for this listener. The default value is false. no enable-http2
Enable SpdyEnables SPDY support for this listener. The default value is false. no enable-spdy
EnabledIf the listener is enabled. The default value is true. no enabled
Enabled Cipher SuitesConfigures Enabled SSL cyphers no enabled-cipher-suites
Enabled ProtocolsConfigures SSL protocols no enabled-protocols
Max Buffered Request Size:exprMaximum size of a buffered request, in bytesRequests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fullybuffered in order to perform the renegotiation. The default value is 16384. no max-buffered-request-size:expr
Max Connections:exprThe maximum number of concurrent connections. no max-connections:expr
Max Cookies:exprThe maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-cookies:expr
Max Header Size:exprThe maximum size in bytes of a http request header. The default value is 1048576. no max-header-size:expr
Max Headers:exprThe maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities. The default value is 200. no max-headers:expr
Max Parameters:exprThe 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). The default value is 1000. no max-parameters:expr
Max Post Size:exprThe maximum size of a post that will be accepted. The default value is 10485760. no max-post-size:expr
No Request Timeout:exprThe length of time in milliseconds that the connection can be idle before it is closed by the container no no-request-timeout:expr
Read Timeout:exprConfigure 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}. no read-timeout:expr
Receive Buffer:exprThe receive buffer size. no receive-buffer:expr
Record Request Start TimeIf 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. The default value is false. no record-request-start-time
Request Parse Timeout:exprThe maximum amount of time (in milliseconds) that can be spent parsing the request no request-parse-timeout:expr
Resolve Peer AddressEnables host dns lookup. The default value is false. no resolve-peer-address
Security RealmThe listeners security realm yes security-realm
Send Buffer:exprThe send buffer size. no send-buffer:expr
Socket BindingThe AJP listener socket binder yes socket-binding
Ssl Session Cache Size:exprThe maximum number of active SSL sessions no ssl-session-cache-size:expr
Ssl Session Timeout:exprThe timeout for SSL sessions, in seconds no ssl-session-timeout:expr
Tcp Backlog:exprConfigure a server with the specified backlog. no tcp-backlog:expr
Tcp Keep AliveConfigure a channel to send TCP keep-alive messages in an implementation-dependent manner. no tcp-keep-alive
Url CharsetURL charset. The default value is UTF-8. no url-charset
Verify ClientThe desired SSL client authentication mode for SSL channels. The default value is NOT_REQUESTED. no verify-client
WorkerThe AJP listeners XNIO worker. The default value is default. no worker
Write Timeout:exprConfigure 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}. no write-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.5. EAP7 - Servlet Container (Profile) Service
Overview
Table 3.3712. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3713. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3714. 
NameDescriptionRequiredInternal Name
Check Interval:exprCheck interval for JSP updates using a background thread. The default value is 0. no check-interval:expr
DevelopmentEnable Development mode which enables reloading JSP on-the-fly. The default value is false. no development
DisabledEnable the JSP container. The default value is false. no disabled
Display Source FragmentWhen a runtime error occurs, attempts to display corresponding JSP source fragment. The default value is true. no display-source-fragment
Dump SmapWrite SMAP data to a file. The default value is false. no dump-smap
Error On Use Bean Invalid Class AttributeEnable errors when using a bad class in useBean. The default value is false. no error-on-use-bean-invalid-class-attribute
Generate Strings As Char ArraysGenerate String constants as char arrays. The default value is false. no generate-strings-as-char-arrays
Java EncodingSpecify the encoding used for Java sources. The default value is UTF8. no java-encoding
Keep GeneratedKeep the generated Servlets. The default value is true. no keep-generated
Mapped FileMap to the JSP source. The default value is true. no mapped-file
Modification Test Interval:exprMinimum amount of time between two tests for updates, in seconds. The default value is 4. no modification-test-interval:expr
Optimize ScriptletsIf JSP scriptlets should be optimised to remove string concatenation. The default value is false. no optimize-scriptlets
Recompile On FailRetry failed JSP compilations on each request. The default value is false. no recompile-on-fail
Scratch DirSpecify a different work directory. no scratch-dir
SmapEnable SMAP. The default value is true. no smap
Source VmSource VM level for compilation. The default value is 1.8. no source-vm
Tag PoolingEnable tag pooling. The default value is true. no tag-pooling
Target VmTarget VM level for compilation. The default value is 1.8. no target-vm
Trim SpacesTrim some spaces from the generated Servlet. The default value is false. no trim-spaces
X Powered ByEnable advertising the JSP engine in x-powered-by. The default value is true. no x-powered-by
Buffer PoolThe buffer pool to use for websocket deployments. The default value is default. no buffer-pool
Dispatch To WorkerIf 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. The default value is true. no dispatch-to-worker
WorkerThe worker to use for websocket deployments. The default value is default. no worker
Allow Non Standard WrappersIf true then request and response wrappers that do not extend the standard wrapper classes can be used. The default value is false. no allow-non-standard-wrappers
Default Buffer CacheThe buffer cache to use for caching static resources. The default value is default. no default-buffer-cache
Default EncodingDefault encoding to use for all deployed applications no default-encoding
Default Session Timeout:exprThe default session timeout (in minutes) for all applications deployed in the container. The default value is 30. no default-session-timeout:expr
Directory ListingIf directory listing should be enabled for default servlets. no directory-listing
Disable Caching For Secured PagesIf 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. The default value is true. no disable-caching-for-secured-pages
Eager Filter InitializationIf true undertow calls filter init() on deployment start rather than when first requested. The default value is false. no eager-filter-initialization
Ignore FlushIgnore flushes on the servlet output stream. In most cases these just hurt performance for no good reason. The default value is false. no ignore-flush
Max Sessions:exprThe maximum number of sessions that can be active at one time no max-sessions:expr
Proactive AuthenticationIf proactive authentication should be used. If this is true a user will always be authenticated if credentials are present. The default value is true. no proactive-authentication
Session Id Length:exprThe length of the generated session ID. Longer session ID's are more secure. The default value is 30. no session-id-length:expr
Stack Trace On ErrorIf an error page with the stack trace should be generated on error. Values are all, none and local-only. The default value is local-only. no stack-trace-on-error
Use Listener EncodingUse encoding defined on listener. The default value is false. no use-listener-encoding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.5.1. EAP7 - Mime Mapping (Profile) Service
Overview
Table 3.3715. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3716. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3717. 
NameDescriptionRequiredInternal Name
ValueThe mime type for this mapping yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.3.5.2. EAP7 - Welcome File (Profile) Service
Overview
Table 3.3718. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3719. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.4. EAP7 - JCA (Profile) Service
Overview
Table 3.3720. Overview
Description:The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3721. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3722. 
NameDescriptionRequiredInternal Name
EnabledSpecify whether bean validation is enabled. The default value is true. no enabled:1
EnabledSpecify whether archive validation is enabled. The default value is true. no enabled:2
Fail On ErrorShould an archive validation error report fail the deployment. The default value is true. no fail-on-error
Fail On WarnShould an archive validation warning report fail the deployment. The default value is false. no fail-on-warn
DebugEnable/disable debug information logging. The default value is false. no debug
ErrorEnable/disable error information logging. The default value is false. no error
InstallEnable/disable the cached connection manager valve and interceptor. The default value is false. no install

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.4.1. EAP7 - BootstrapContext (Profile) Service
Overview
Table 3.3723. Overview
Description:Bootstrap context for resource adapters.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3724. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3725. 
NameDescriptionRequiredInternal Name
NameThe name of the BootstrapContext no name
WorkmanagerThe WorkManager instance for the BootstrapContext no workmanager

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.4.2. EAP7 - Workmanager (Profile) Service
Overview
Table 3.3726. Overview
Description:WorkManager for resource adapters.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3727. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3728. 
NameDescriptionRequiredInternal Name
NameThe name of the WorkManager no name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.4.2.1. EAP7 - Long Running Thread Pool (Profile) Service
Overview
Table 3.3729. Overview
Description:Long running thread pool executor with a bounded queue where threads submitting tasks may block.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3730. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3731. 
NameDescriptionRequiredInternal Name
Allow Core TimeoutWhether core threads may time out. The default value is false. no allow-core-timeout
Core ThreadsThe 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. no core-threads:expr
Handoff ExecutorAn 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. no handoff-executor
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. yes max-threads:expr
NameThe name of the thread pool. no name
Queue LengthThe queue length. yes queue-length:expr
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.4.2.2. EAP7 - Short Running Thread Pool (Profile) Service
Overview
Table 3.3732. Overview
Description:Short running thread pool executor with a bounded queue where threads submitting tasks may block.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3733. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3734. 
NameDescriptionRequiredInternal Name
Allow Core TimeoutWhether core threads may time out. The default value is false. no allow-core-timeout
Core ThreadsThe 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. no core-threads:expr
Handoff ExecutorAn 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. no handoff-executor
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. yes max-threads:expr
NameThe name of the thread pool. no name
Queue LengthThe queue length. yes queue-length:expr
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.5. EAP7 - Osgi (Profile) Service
Overview
Table 3.3735. Overview
Description:The OSGi subsystem configuration.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3736. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3737. 
NameDescriptionRequiredInternal Name
ActivationActivation flag for the OSGi subsystem. Possible values: lazy, eager. The default value is LAZY. no activation
StartlevelThe current Start Level of the OSGi Framework. Changing this value will change the Start Level of the Framework accordingly. no startlevel

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.5.1. EAP7 - Capability (Profile) Service
Overview
Table 3.3738. Overview
Description:A framework capability. A capability maps to a JBoss Module in the modules directory or an OSGi bundle in the bundles directory. The identity maps to the resource identifier of the module or bundle.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3739. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3740. 
NameDescriptionRequiredInternal Name
StartlevelThe startlevel for the capability. Can only be specified for OSGi bundles. no startlevel

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.5.2. EAP7 - Property Service
Overview
Table 3.3741. Overview
Description:A property
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3742. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3743. 
NameDescriptionRequiredInternal Name
ValueThe property value. no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.6. EAP7 - Resource Adapters (Profile) Service
Overview
Table 3.3744. Overview
Description:Configuration of the resource adapters subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3745. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.6.1. EAP7 - Resource Adapter (Profile) Service
Overview
Table 3.3746. Overview
Description:The configuration of a resource adapter.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3747. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3748. 
NameDescriptionRequiredInternal Name
ArchiveSpecifies the resource adapter archive yes archive
BeanvalidationgroupsSpecifies the bean validation groups that should be used no beanvalidationgroups
BootstrapcontextSpecifies the unique name of the bootstrap context that should be used no bootstrapcontext
Transaction SupportSpecifies the transaction support level of the resource adapter yes transaction-support

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.6.1.1. EAP7 - Admin Objects (Profile) Service
Overview
Table 3.3749. Overview
Description:Specifies the administration objects.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3750. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3751. 
NameDescriptionRequiredInternal Name
Class NameSpecifies the fully qualified class name of a managed connection factory or admin object yes class-name
EnabledSpecifies if the resource adapter should be enabled. The default value is true. no enabled
Jndi NameSpecifies the JNDI name for the connection factory or admin object no jndi-name
Use Java ContextSetting this to false will bind the object into global JNDI. The default value is true. no use-java-context

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.6.1.2. EAP7 - Connection Definitions (Profile) Service
Overview
Table 3.3752. Overview
Description:Specifies the connection definitions.
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3753. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3754. 
NameDescriptionRequiredInternal Name
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception no allocation-retry:expr
Allocation Retry Wait MillisThe allocation retry wait millis element specifies the amount of time, in milliseconds, to wait between retrying to allocate a connection no allocation-retry-wait-millis:expr
Background ValidationAn 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. The default value is false. no background-validation
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart no background-validation-millis:expr
Blocking Timeout Wait MillisThe 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 no blocking-timeout-wait-millis:expr
Class NameSpecifies the fully qualified class name of a managed connection factory or admin object yes class-name
EnabledSpecifies if the resource adapter should be enabled. The default value is true. no enabled
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Idle Timeout MinutesThe 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 requires a server restart. no idle-timeout-minutes:expr
InterleavingAn element to enable interleaving for XA connections. The default value is false. no interleaving
Jndi NameSpecifies the JNDI name for the connection factory or admin object no jndi-name
Max Pool SizeThe max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20. no max-pool-size:expr
Min Pool SizeThe min-pool-size element specifies the minimum number of connections for a pool. The default value is 0. no min-pool-size:expr
No RecoverySpecifies if the connection pool should be excluded from recovery no no-recovery
No Tx Separate PoolOracle 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. The default value is false. no no-tx-separate-pool
Pad XidShould the Xid be padded. The default value is false. no pad-xid
Pool PrefillShould the pool be prefilled. Changing this value requires a server restart. The default value is false. no pool-prefill
Pool Use Strict MinSpecifies if the min-pool-size should be considered strictly. The default value is false. no pool-use-strict-min
Recovery PasswordThe password used for recovery no recovery-password
Recovery Plugin Class NameThe fully qualified class name of the recovery plugin implementation no recovery-plugin-class-name
Recovery Plugin PropertiesThe properties for the recovery plugin no recovery-plugin-properties
Recovery Security DomainThe security domain used for recovery no recovery-security-domain
Recovery UsernameThe user name used for recovery no recovery-username
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Security ApplicationIndicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool no security-application
Security DomainSpecifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool no security-domain
Security Domain and ApplicationIndicates that either app supplied parameters (such as from getConnection(user, pw)) or Subject (from security domain) are used to distinguish connections in the pool no security-domain-and-application
Use CcmEnable the use of a cached connection manager. The default value is true. no use-ccm
Use Fast FailWhether 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). The default value is false. no use-fast-fail
Use Java ContextSetting this to false will bind the object into global JNDI. The default value is true. no use-java-context
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock:expr
Wrap Xa ResourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true. no wrap-xa-resource
XA Resource TimeoutThe value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero no xa-resource-timeout:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.6.1.2.1. EAP7 - Config Properties Service
Overview
Table 3.3755. Overview
Description:Custom defined config properties.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3756. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3757. 
NameDescriptionRequiredInternal Name
ValueCustom defined config property value no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.6.1.3. EAP7 - Config Properties Service
Overview
Table 3.3758. Overview
Description:Custom defined config properties.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3759. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3760. 
NameDescriptionRequiredInternal Name
ValueCustom defined config property value no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7. EAP7 - EJB3 (Profile) Service
Overview
Table 3.3761. Overview
Description:The configuration of the ejb3 subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3762. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3763. 
NameDescriptionRequiredInternal Name
Default Clustered Sfsb CacheName of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level no default-clustered-sfsb-cache
Default Entity Bean Instance PoolName of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level no default-entity-bean-instance-pool
Default Entity Bean Optimistic LockingIf set to true entity beans will use optimistic locking by default no default-entity-bean-optimistic-locking
Default Mdb Instance PoolName of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level no default-mdb-instance-pool
Default Resource Adapter NameName of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level. The default value is activemq-ra. no default-resource-adapter-name
Default Sfsb CacheName of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level no default-sfsb-cache
Default Singleton Bean Access TimeoutThe default access timeout for singleton beans. The default value is 5000. no default-singleton-bean-access-timeout:expr
Default Slsb Instance PoolName of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level no default-slsb-instance-pool
Default Stateful Bean Access TimeoutThe default access timeout for stateful beans. The default value is 5000. no default-stateful-bean-access-timeout:expr
In Vm Remote Interface Invocation Pass By ValueIf 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. The default value is true. no in-vm-remote-interface-invocation-pass-by-value
Enable StatisticsIf set to true, enable the collection of invocation statistics. no enable-statistics

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.1. EAP7 - EJB3 Thread Pool (Profile) Service
Overview
Table 3.3764. Overview
Description:A thread pool executor with an unbounded queue. Such a thread pool has a core size and a queue with no upper bound. When a task is submitted, if the number of running threads is less than the core size, a new thread is created. Otherwise, the task is placed in queue. If too many tasks are allowed to be submitted to this type of executor, an out of memory condition may occur.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3765. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3766. 
NameDescriptionRequiredInternal Name
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. no max-threads:expr
NameThe name of the thread pool. no name
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.2. EAP7 - File Passivation Store (Profile) Service
Overview
Table 3.3767. Overview
Description:A file system based passivation store.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3768. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3769. 
NameDescriptionRequiredInternal Name
Groups Path  no groups-path
Idle TimeoutThe timeout in units specified by idle-timeout-unit, after which a bean will passivate. The default value is 300. no idle-timeout:expr
Idle Timeout UnitThe unit of idle-timeout. The default value is SECONDS. no idle-timeout-unit
Max SizeThe maximum number of beans this cache should store before forcing old beans to passivate. The default value is 10000. no max-size:expr
Relative To  no relative-to
Sessions Path  no sessions-path
Subdirectory Count  no subdirectory-count:expr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.3. EAP7 - MDB Delivery Group (Profile) Service
Overview
Table 3.3770. Overview
Description:Delivery group to manage delivery for mdbs
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3771. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3772. 
NameDescriptionRequiredInternal Name
ActiveIndicates if delivery for all MDBs belonging to this group is active. The default value is true. no active

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.4. EAP7 - Strict Max Bean Instance Pool (Profile) Service
Overview
Table 3.3773. Overview
Description:A bean instance pool with a strict upper limit
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3774. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3775. 
NameDescriptionRequiredInternal Name
Derive SizeSpecifies if and what the max pool size should be derived from. A value of 'none', the default, 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. The default value is none. no derive-size
Max Pool SizeThe maximum number of bean instances that the pool can hold at a given point in time. no max-pool-size
TimeoutThe maximum amount of time to wait for a bean instance to be available from the pool. The default value is 5. no timeout
Timeout UnitThe instance acquisition timeout unit. The default value is MINUTES. no timeout-unit

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.5. EAP7 - SFSB Cache (Profile) Service
Overview
Table 3.3776. Overview
Description:A SFSB cache.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3777. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3778. 
NameDescriptionRequiredInternal Name
AliasesThe aliases by which this cache may also be referenced yes aliases
Passivation StoreThe passivation store used by this cache no passivation-store

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.6. EAP7 - Cluster Passivation Store (Profile) Service
Overview
Table 3.3779. Overview
Description:A clustered passivation store.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3780. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3781. 
NameDescriptionRequiredInternal Name
Bean CacheThe name of the cache used to store bean instances. no bean-cache
Cache ContainerThe name of the cache container used for the bean and client-mappings caches. The default value is ejb. no cache-container
Client Mappings CacheThe name of the cache used to store client-mappings of the EJB remoting connector's socket-bindings. The default value is remote-connector-client-mappings. no client-mappings-cache
Idle TimeoutThe timeout in units specified by idle-timeout-unit, after which a bean will passivate. The default value is 300. no idle-timeout:expr
Idle Timeout UnitThe unit of idle-timeout. The default value is SECONDS. no idle-timeout-unit
Max SizeThe maximum number of beans this cache should store before forcing old beans to passivate. The default value is 10000. no max-size:expr
Passivate Events On ReplicateIndicates whether replication should trigger passivation events on the bean. The default value is true. no passivate-events-on-replicate

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.7. EAP7 - Async Service (Profile) Service
Overview
Table 3.3782. Overview
Description:The EJB3 Asynchronous Invocation Service
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3783. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3784. 
NameDescriptionRequiredInternal Name
Thread Pool NameThe name of the thread pool which handles asynchronous invocations no thread-pool-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.8. EAP7 - IIOP Service (Profile) Service
Overview
Table 3.3785. Overview
Description:The IIOP service
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3786. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3787. 
NameDescriptionRequiredInternal Name
Enable By DefaultIf this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor no enable-by-default
Use Qualified NameIf 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) no use-qualified-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.9. EAP7 - Remote Service (Profile) Service
Overview
Table 3.3788. Overview
Description:The EJB3 remote service
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3789. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3790. 
NameDescriptionRequiredInternal Name
Connector RefThe name of the connector on which the EJB3 remoting channel is registered no connector-ref
Thread Pool NameThe name of the thread pool that handles remote invocations no thread-pool-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.9.1. EAP7 - Channel Creation Options (Profile) Service
Overview
Table 3.3791. Overview
Description:The options that will be used during the EJB remote channel creation
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3792. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3793. 
NameDescriptionRequiredInternal Name
TypeThe type of the channel creation option no type
ValueThe value for the EJB remote channel creation option no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.7.10. EAP7 - Timer Service (Profile) Service
Overview
Table 3.3794. Overview
Description:The EJB timer service
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3795. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3796. 
NameDescriptionRequiredInternal Name
PathThe directory to store persistent timer information in no path
Relative ToThe relative path that is used to resolve the timer data store location no relative-to
Thread Pool NameThe name of the thread pool used to run timer service invocations no thread-pool-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.8. EAP7 - Threads (Profile) Service
Overview
Table 3.3797. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3798. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.8.1. EAP7 - ThreadFactory (Profile) Service
Overview
Table 3.3799. Overview
Description:A thread factory (implementing java.util.concurrent.ThreadFactory).
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3800. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3801. 
NameDescriptionRequiredInternal Name
Group NameSpecifies the name of a thread group to create for this thread factory. no group-name
NameThe name of the created thread factory. no name
PriorityMay be used to specify the thread priority of created threads. The default value is -1. no priority:expr
Thread Name PatternThe template used to create names for threads. The following patterns may be used: %% - emit a percent sign %t - emit the per-factory thread sequence number %g - emit the global thread sequence number %f - emit the factory sequence number %i - emit the thread ID. no thread-name-pattern

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.8.2. EAP7 - ThreadPool (Profile) Service
Overview
Table 3.3802. Overview
Description:A thread pool executor
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3803. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3804. 
NameDescriptionRequiredInternal Name
Keepalive TimeUsed 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. no keepalive-time
Max ThreadsThe maximum thread pool size. yes max-threads:expr
NameThe name of the thread pool. no name
Queue LengthThe queue length. Required only for Bounded and Blocking Bounded Thread Pools. no queue-length:expr
Thread FactorySpecifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. no thread-factory
Allow Core TimeoutWhether core threads may time out. The default value is false. no allow-core-timeout
Core ThreadsThe 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. no core-threads:expr
Handoff ExecutorAn 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. no handoff-executor
Thread Pool TypeThread pool type yes __type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9. EAP7 - Security (Profile) Service
Overview
Table 3.3805. Overview
Description:The configuration of the security subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3806. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3807. 
NameDescriptionRequiredInternal Name
Deep Copy Subject ModeSets 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. The default value is false. no deep-copy-subject-mode

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1. EAP7 - Security Domain (Profile) Service
Overview
Table 3.3808. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3809. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3810. 
NameDescriptionRequiredInternal Name
Cache TypeAdds 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. no cache-type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.1. EAP7 - ACL (Profile) Service
Overview
Table 3.3811. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3812. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3813. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.1.1. EAP7 - Acl Modules (Profile) Service
Overview
Table 3.3814. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3815. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3816. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.1.1.1. EAP7 - Module Options (Acl - Profile) Service
Overview
Table 3.3817. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3818. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3819. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.2. EAP7 - Audit (Profile) Service
Overview
Table 3.3820. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3821. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3822. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.2.1. EAP7 - Provider Modules (Profile) Service
Overview
Table 3.3823. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3824. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3825. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.2.1.1. EAP7 - Module Options (Provider Modules - Profile) Service
Overview
Table 3.3826. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3827. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3828. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.3. EAP7 - Authentication (Classic - Profile) Service
Overview
Table 3.3829. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3830. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.9.1.3.1. EAP7 - Login Modules (Classic - Profile) Service
Overview
Table 3.3831. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3832. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3833. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.3.1.1. EAP7 - Module Options (Classic - Profile) Service
Overview
Table 3.3834. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3835. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3836. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.4. EAP7 - Authentication (Jaspi - Profile) Service
Overview
Table 3.3837. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3838. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3839. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.4.1. EAP7 - Login Module Stack (Profile) Service
Overview
Table 3.3840. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3841. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3842. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.4.1.1. EAP7 - Module Options (Login Module Stack (Profile)) Service
Overview
Table 3.3843. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3844. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3845. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.5. EAP7 - Authorization (Profile) Service
Overview
Table 3.3846. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3847. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3848. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.5.1. EAP7 - Authorization Modules (Profile) Service
Overview
Table 3.3849. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3850. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3851. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.5.1.1. EAP7 - Module Options (Authorization - Profile) Service
Overview
Table 3.3852. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3853. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3854. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.6. EAP7 - Identity Trust (Profile) Service
Overview
Table 3.3855. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3856. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3857. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.6.1. EAP7 - Identity Trust Modules (Profile) Service
Overview
Table 3.3858. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3859. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3860. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
FlagThe flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. yes flag

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.6.1.1. EAP7 - Module Options (Identity Trust - Profile) Service
Overview
Table 3.3861. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3862. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3863. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.7. EAP7 - JSSE (Profile) Service
Overview
Table 3.3864. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3865. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3866. 
NameDescriptionRequiredInternal Name
Cipher SuitesComma separated list of cipher suites to enable on SSLSockets. no cipher-suites
Client AliasPreferred alias to use when the KeyManager chooses the client alias. no client-alias
Client AuthBoolean attribute to indicate if client's certificates should also be authenticated on the server side. no client-auth
Key ManagerJSEE Key Manager factory no key-manager
KeystoreConfigures a JSSE key store no keystore
ProtocolsComma separated list of protocols to enable on SSLSockets. no protocols
Server AliasPreferred alias to use when the KeyManager chooses the server alias. no server-alias
Service Auth TokenToken to retrieve PrivateKeys from the KeyStore. no service-auth-token
Trust ManagerJSEE Trust Manager factory no trust-manager
TruststoreConfigures a JSSE trust store no truststore

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.8. EAP7 - Mapping (Profile) Service
Overview
Table 3.3867. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3868. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3869. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
TypeType of mapping this module performs. Allowed values are principal, role, attribute or credential.. yes type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.8.1. EAP7 - Mapping Modules (Profile) Service
Overview
Table 3.3870. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3871. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3872. 
NameDescriptionRequiredInternal Name
CodeClass name of the module to be instantiated. yes code
TypeType of mapping this module performs. Allowed values are principal, role, attribute or credential.. yes type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.1.8.1.1. EAP7 - Module Options (Mapping - Profile) Service
Overview
Table 3.3873. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3874. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3875. 
NameDescriptionRequiredInternal Name
Module Options  no Module Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.9.2. EAP7 - Vault (Profile) Service
Overview
Table 3.3876. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3877. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3878. 
NameDescriptionRequiredInternal Name
CodeFully Qualified Name of the Security Vault Implementation. no code

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10. EAP7 - ActiveMQMessaging (Profile) Service
Overview
Table 3.3879. Overview
Description:The messaging subsystems
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3880. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.10.1. EAP7 - ActiveMQ Artemis (Profile) Service
Overview
Table 3.3881. Overview
Description:The ActiveMQ Artemis based messaging subsystem
Singleton: no
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3882. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3883. 
NameDescriptionRequiredInternal Name
Async Connection Execution EnabledWhether incoming packets on the server should be handed off to a thread from the thread pool for processing. False if they should be handled on the remoting thread. The default value is true. no async-connection-execution-enabled
Cluster PasswordThe password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!. no cluster-password
Cluster UserThe user used by cluster connections to communicate between the clustered nodes. The default value is ACTIVEMQ.CLUSTER.ADMIN.USER. no cluster-user
Connection Ttl Override:exprIf set, this will override how long (in ms) to keep a connection alive without receiving a ping. The default value is -1. no connection-ttl-override:expr
Create Bindings DirWhether the server should create the bindings directory on start up. The default value is true. no create-bindings-dir
Create Journal DirWhether the server should create the journal directory on start up. The default value is true. no create-journal-dir
Id Cache Size:exprThe size of the cache for pre-creating message IDs. The default value is 20000. no id-cache-size:expr
Incoming InterceptorsThe list of incoming interceptor classes used by this server. no incoming-interceptors
Jmx DomainThe JMX domain used to register internal ActiveMQ MBeans in the MBeanServer. The default value is org.apache.activemq.artemis. no jmx-domain
Jmx Management EnabledWhether ActiveMQ should expose its internal management API via JMX. This is not recommended, as accessing these MBeans can lead to inconsistent configuration. The default value is false. no jmx-management-enabled
Journal Buffer Size:exprThe size of the internal buffer on the journal. no journal-buffer-size:expr
Journal Buffer Timeout:exprThe timeout (in nanoseconds) used to flush internal buffers on the journal. no journal-buffer-timeout:expr
Journal Compact Min Files:exprThe minimal number of journal data files before we can start compacting. The default value is 10. no journal-compact-min-files:expr
Journal Compact Percentage:exprThe percentage of live data on which we consider compacting the journal. The default value is 30. no journal-compact-percentage:expr
Journal File Size:exprThe size (in bytes) of each journal file. The default value is 10485760. no journal-file-size:expr
Journal Max Io:exprThe maximum number of write requests that can be in the AIO queue at any one time. no journal-max-io:expr
Journal Min Files:exprHow many journal files to pre-create. The default value is 2. no journal-min-files:expr
Journal Pool Files:exprThe number of journal files that can be reused. ActiveMQ will create as many files as needed however when reclaiming files it will shrink back to the value (-1 means no limit). The default value is -1. no journal-pool-files:expr
Journal Sync Non TransactionalWhether to wait for non transaction data to be synced to the journal before returning a response to the client. The default value is true. no journal-sync-non-transactional
Journal Sync TransactionalWhether to wait for transaction data to be synchronized to the journal before returning a response to the client. The default value is true. no journal-sync-transactional
Journal TypeThe type of journal to use. The default value is ASYNCIO. no journal-type
Log Journal Write RateWhether to periodically log the journal's write rate and flush rate. The default value is false. no log-journal-write-rate
Management AddressAddress to send management messages to. The default value is jms.queue.activemq.management. no management-address
Management Notification AddressThe name of the address that consumers bind to to receive management notifications. The default value is activemq.notifications. no management-notification-address
Memory Measure Interval:exprFrequency to sample JVM memory in ms (or -1 to disable memory sampling). The default value is -1. no memory-measure-interval:expr
Memory Warning Threshold:exprPercentage of available memory which if exceeded results in a warning log. The default value is 25. no memory-warning-threshold:expr
Message Counter Max Day History:exprHow many days to keep message counter history. The default value is 10. no message-counter-max-day-history:expr
Message Counter Sample Period:exprThe sample period (in ms) to use for message counters. The default value is 10000. no message-counter-sample-period:expr
Message Expiry Scan Period:exprHow often (in ms) to scan for expired messages. The default value is 30000. no message-expiry-scan-period:expr
Message Expiry Thread Priority:exprThe priority of the thread expiring messages. The default value is 3. no message-expiry-thread-priority:expr
Outgoing InterceptorsThe list of outgoing interceptor classes used by this server. no outgoing-interceptors
Override In Vm SecurityWhether the ActiveMQ server will override security credentials for in-vm connections. The default value is true. no override-in-vm-security
Page Max Concurrent Io:exprThe maximum number of concurrent reads allowed on paging. The default value is 5. no page-max-concurrent-io:expr
Perf Blast Pages:exprTODO. The default value is -1. no perf-blast-pages:expr
Persist Delivery Count Before DeliveryWhether the delivery count is persisted before delivery. False means that this only happens after a message has been cancelled. The default value is false. no persist-delivery-count-before-delivery
Persist Id CacheWhether IDs are persisted to the journal. The default value is true. no persist-id-cache
Persistence EnabledWhether the server will use the file based journal for persistence. The default value is true. no persistence-enabled
Run Sync Speed TestWhether on startup to perform a diagnostic test on how fast your disk can sync. Useful when determining performance issues. The default value is false. no run-sync-speed-test
Scheduled Thread Pool Max Size:exprThe number of threads that the main scheduled thread pool has. The default value is 5. no scheduled-thread-pool-max-size:expr
Security DomainThe security domain to use to verify user and role information. The default value is other. no security-domain
Security EnabledWhether security is enabled. The default value is true. no security-enabled
Security Invalidation Interval:exprHow long (in ms) to wait before invalidating the security cache. The default value is 10000. no security-invalidation-interval:expr
Server Dump Interval:exprHow often to dump basic runtime information to the server log. A value less than 1 disables this feature. The default value is -1. no server-dump-interval:expr
Statistics EnabledWhether gathering of statistics such as message counters are enabled. The default value is false. no statistics-enabled
Thread Pool Max Size:exprThe number of threads that the main thread pool has. -1 means no limit. The default value is 30. no thread-pool-max-size:expr
Transaction Timeout:exprHow long (in ms) before a transaction can be removed from the resource manager after create time. The default value is 300000. no transaction-timeout:expr
Transaction Timeout Scan Period:exprHow often (in ms) to scan for timeout transactions. The default value is 1000. no transaction-timeout-scan-period:expr
Wild Card Routing EnabledWhether the server supports wild card routing. The default value is true. no wild-card-routing-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.1. EAP7 - JMS Queue (Profile) Service
Overview
Table 3.3884. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3885. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3886. 
NameDescriptionRequiredInternal Name
DurableWhether the queue is durable or not. The default value is true. no durable
EntriesThe jndi names the queue will be bound to. yes entries
SelectorThe queue selector. no selector

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.2. EAP7 - JMS Topic (Profile) Service
Overview
Table 3.3887. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3888. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3889. 
NameDescriptionRequiredInternal Name
JNDI NamesThe jndi names the queue will be bound to. yes entries

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.3. EAP7 - Connection Factory (Profile) Service
Overview
Table 3.3890. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3891. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3892. 
NameDescriptionRequiredInternal Name
Auto GroupWhether or not message grouping is automatically used. The default value is false. no auto-group
Block On AcknowledgeTrue to set block on acknowledge. The default value is false. no block-on-acknowledge
Block On Durable SendTrue to set block on durable send. The default value is true. no block-on-durable-send
Block On Non Durable SendTrue to set block on non durable send. The default value is false. no block-on-non-durable-send
Cache Large Message ClientTrue to cache large messages. The default value is false. no cache-large-message-client
Call Failover Timeout:exprThe timeout to use when fail over is in process (in ms). The default value is -1. no call-failover-timeout:expr
Call Timeout:exprThe call time out. The default value is 30000. no call-timeout:expr
Client Failure Check Period:exprThe client failure check period. The default value is 30000. no client-failure-check-period:expr
Client IdThe client id. no client-id
Compress Large MessagesWhether large messages should be compressed. The default value is false. no compress-large-messages
Confirmation Window Size:exprThe confirmation window size. The default value is -1. no confirmation-window-size:expr
Connection Load Balancing Policy Class NameName of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. no connection-load-balancing-policy-class-name
Connection Ttl:exprThe connection ttl. The default value is 60000. no connection-ttl:expr
ConnectorsDefines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. no connectors
Consumer Max Rate:exprThe consumer max rate. The default value is -1. no consumer-max-rate:expr
Consumer Window Size:exprThe consumer window size. The default value is 1048576. no consumer-window-size:expr
Discovery GroupThe discovery group name. no discovery-group
Dups Ok Batch Size:exprThe dups ok batch size. The default value is 1048576. no dups-ok-batch-size:expr
EntriesThe jndi names the connection factory should be bound to. yes entries
Factory TypeThe type of connection factory. The default value is GENERIC. no factory-type
Failover On Initial ConnectionTrue to fail over on initial connection. The default value is false. no failover-on-initial-connection
Group IdThe group id. no group-id
HaWhether the connection factory supports High Availability. The default value is false. no ha
Max Retry Interval:exprThe max retry interval. The default value is 2000. no max-retry-interval:expr
Min Large Message Size:exprThe min large message size. The default value is 102400. no min-large-message-size:expr
Pre AcknowledgeTrue to pre-acknowledge. The default value is false. no pre-acknowledge
Producer Max Rate:exprThe producer max rate. The default value is -1. no producer-max-rate:expr
Producer Window Size:exprThe producer window size. The default value is 65536. no producer-window-size:expr
Reconnect Attempts:exprThe reconnect attempts. The default value is 0. no reconnect-attempts:expr
Retry Interval:exprThe retry interval. The default value is 2000. no retry-interval:expr
Retry Interval Multiplier:exprThe retry interval multiplier. The default value is 1.0. no retry-interval-multiplier:expr
Scheduled Thread Pool Max Size:exprThe scheduled thread pool max size. The default value is 5. no scheduled-thread-pool-max-size:expr
Thread Pool Max Size:exprThe thread pool max size. The default value is 30. no thread-pool-max-size:expr
Transaction Batch Size:exprThe transaction batch size. The default value is 1048576. no transaction-batch-size:expr
Use Global PoolsTrue to use global pools. The default value is true. no use-global-pools

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.4. EAP7 - Pooled Connection Factory (Profile) Service
Overview
Table 3.3893. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3894. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3895. 
NameDescriptionRequiredInternal Name
Auto GroupWhether or not message grouping is automatically used. The default value is false. no auto-group
Block On AcknowledgeTrue to set block on acknowledge. The default value is false. no block-on-acknowledge
Block On Durable SendTrue to set block on durable send. The default value is true. no block-on-durable-send
Block On Non Durable SendTrue to set block on non durable send. The default value is false. no block-on-non-durable-send
Cache Large Message ClientTrue to cache large messages. The default value is false. no cache-large-message-client
Call Failover Timeout:exprThe timeout to use when fail over is in process (in ms). The default value is -1. no call-failover-timeout:expr
Call Timeout:exprThe call time out. The default value is 30000. no call-timeout:expr
Client Failure Check Period:exprThe client failure check period. The default value is 30000. no client-failure-check-period:expr
Client IdThe client id. no client-id
Compress Large MessagesWhether large messages should be compressed. The default value is false. no compress-large-messages
Confirmation Window Size:exprThe confirmation window size. The default value is -1. no confirmation-window-size:expr
Connection Load Balancing Policy Class NameName of a class implementing a client-side load balancing policy that a client can use to load balance sessions across different nodes in a cluster. The default value is org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. no connection-load-balancing-policy-class-name
Connection Ttl:exprThe connection ttl. The default value is 60000. no connection-ttl:expr
ConnectorsDefines the connectors. These are stored in a map by connector name (with an undefined value). It is possible to pass a list of connector names when writing this attribute. no connectors
Consumer Max Rate:exprThe consumer max rate. The default value is -1. no consumer-max-rate:expr
Consumer Window Size:exprThe consumer window size. The default value is 1048576. no consumer-window-size:expr
Discovery GroupThe discovery group name. no discovery-group
Dups Ok Batch Size:exprThe dups ok batch size. The default value is 1048576. no dups-ok-batch-size:expr
EntriesThe jndi names the connection factory should be bound to. yes entries
Failover On Initial ConnectionTrue to fail over on initial connection. The default value is false. no failover-on-initial-connection
Group IdThe group id. no group-id
HaWhether the connection factory supports High Availability. The default value is false. no ha
Max Retry Interval:exprThe max retry interval. The default value is 2000. no max-retry-interval:expr
Min Large Message Size:exprThe min large message size. The default value is 102400. no min-large-message-size:expr
Pre AcknowledgeTrue to pre-acknowledge. The default value is false. no pre-acknowledge
Producer Max Rate:exprThe producer max rate. The default value is -1. no producer-max-rate:expr
Producer Window Size:exprThe producer window size. The default value is 65536. no producer-window-size:expr
Protocol Manager FactoryThe protocol manager factory used by this connection factory. no protocol-manager-factory
Reconnect Attempts:exprThe reconnect attempts. The default value is 0. no reconnect-attempts:expr
Retry Interval:exprThe retry interval. The default value is 2000. no retry-interval:expr
Retry Interval Multiplier:exprThe retry interval multiplier. The default value is 1.0. no retry-interval-multiplier:expr
Scheduled Thread Pool Max Size:exprThe scheduled thread pool max size. The default value is 5. no scheduled-thread-pool-max-size:expr
Thread Pool Max Size:exprThe thread pool max size. The default value is 30. no thread-pool-max-size:expr
Transaction Batch Size:exprThe transaction batch size. The default value is 1048576. no transaction-batch-size:expr
Use Global PoolsTrue to use global pools. The default value is true. no use-global-pools

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.5. EAP7 - Security Setting (Profile) Service
Overview
Table 3.3896. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3897. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.10.1.5.1. EAP7 - Role (Profile) Service
Overview
Table 3.3898. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3899. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3900. 
NameDescriptionRequiredInternal Name
Consumehis permission allows the user to consume a message from a queue bound to matching addresses. The default value is false. yes consume
Create Durable QueueThis permission allows the user to create a durable queue. The default value is false. yes create-durable-queue
Create Non Durable QueueThis permission allows the user to create a temporary queue. The default value is false. yes create-non-durable-queue
Delete Durable QueueThis permission allows the user to delete a durable queue. The default value is false. yes delete-durable-queue
Delete Non Durable QueueThis permission allows the user to delete a temporary queue. The default value is false. yes delete-non-durable-queue
ManageThis permission allows the user to invoke management operations by sending management messages to the management address. The default value is false. yes manage
SendThis permission allows the user to send a message to matching addresses. The default value is false. yes send

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.6. EAP7 - Address Setting (Profile) Service
Overview
Table 3.3901. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3902. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3903. 
NameDescriptionRequiredInternal Name
Address Full PolicyDetermines what happens when an address where max-size-bytes is specified becomes full. (PAGE, DROP or BLOCK). The default value is PAGE. no address-full-policy
Dead Letter AddressThe dead letter address no dead-letter-address
Expiry AddressDefines where to send a message that has expired. no expiry-address
Last Value QueueDefines whether a queue only uses last values or not. The default value is false. no last-value-queue
Max Delivery AttemptsDefines how many time a cancelled message can be redelivered before sending to the dead-letter-address. The default value is 10. no max-delivery-attempts
Max Size BytesThe max bytes size. The default value is -1. no max-size-bytes
Message Counter History Day LimitDay limit for the message counter history. The default value is 0. no message-counter-history-day-limit
Page Max Cache SizeThe number of page files to keep in memory to optimize IO during paging navigation. The default value is 5. no page-max-cache-size
Page Size BytesThe paging size. The default value is 10485760. no page-size-bytes
Redelivery DelayDefines how long to wait before attempting redelivery of a cancelled message. The default value is 0. no redelivery-delay
Redistribution DelayDefines how long to wait when the last consumer is closed on a queue before redistributing any messages. The default value is -1. no redistribution-delay
Send To Dla On No RouteIf this parameter is set to true for that address, if the message is not routed to any queues it will instead be sent to the dead letter address (DLA) for that address, if it exists. The default value is false. no send-to-dla-on-no-route
Auto Create Jms QueuesDetermines whether ActiveMQ should automatically create a JMS queue corresponding to the address-settings match when a JMS producer or a consumer is tries to use such a queue. no auto-create-jms-queues
Auto Delete Jms QueuesDetermines Whether ActiveMQ should automatically delete auto-created JMS queues when they have no consumers and no messages. no auto-delete-jms-queues
Expiry DelayDefines the expiration time that will be used for messages using the default expiration time. no expiry-delay
Max Redelivery DelayMaximum value for the redelivery-delay (in ms). no max-redelivery-delay
Redelivery MultiplierMultiplier to apply to the redelivery-delay parameter. no redelivery-multiplier

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.7. EAP7 - Grouping Handler (Profile) Service
Overview
Table 3.3904. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3905. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3906. 
NameDescriptionRequiredInternal Name
Grouping Handler AddressA reference to a cluster connection and the address it uses. yes grouping-handler-address
TimeoutHow long to wait for a handling decision to be made; an exception will be thrown during the send if this timeout is reached, ensuring that strict ordering is kept. The default value is 5000. no timeout
TypeWhether the handler is the single 'Local' handler for the cluster, which makes handling decisions, or a 'Remote' handler which converses with the local handler. no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.8. EAP7 - Acceptor (Profile) Service
Overview
Table 3.3907. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3908. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3909. 
NameDescriptionRequiredInternal Name
Factory ClassThe factory class. yes factory-class
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.8.1. EAP7 - Param Service
Overview
Table 3.3910. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3911. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3912. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.9. EAP7 - Connector (ActiveMQ - Profile) Service
Overview
Table 3.3913. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3914. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3915. 
NameDescriptionRequiredInternal Name
Factory ClassThe factory class. yes factory-class
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.9.1. EAP7 - Param Service
Overview
Table 3.3916. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3917. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3918. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.10. EAP7 - In VM Acceptor (Profile) Service
Overview
Table 3.3919. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3920. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3921. 
NameDescriptionRequiredInternal Name
Server IdThe server id. yes server-id

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.10.1. EAP7 - Param Service
Overview
Table 3.3922. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3923. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3924. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.11. EAP7 - In VM Connector (Profile) Service
Overview
Table 3.3925. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3926. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3927. 
NameDescriptionRequiredInternal Name
Server IdThe server id. yes server-id

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.11.1. EAP7 - Param Service
Overview
Table 3.3928. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3929. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3930. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.12. EAP7 - Remote Acceptor (Profile) Service
Overview
Table 3.3931. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3932. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3933. 
NameDescriptionRequiredInternal Name
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.12.1. EAP7 - Param Service
Overview
Table 3.3934. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3935. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3936. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.13. EAP7 - Remote Connector (Profile) Service
Overview
Table 3.3937. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3938. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3939. 
NameDescriptionRequiredInternal Name
Socket BindingThe socket binding reference. no socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.13.1. EAP7 - Param Service
Overview
Table 3.3940. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3941. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3942. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.14. EAP7 - Divert (Profile) Service
Overview
Table 3.3943. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3944. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3945. 
NameDescriptionRequiredInternal Name
Divert AddressAddress to divert from yes divert-address
ExclusiveWhether the divert is exclusive, meaning that the message is diverted to the new address, and does not go to the old address at all. The default value is false. no exclusive
FilterAn optional filter string. If specified then only messages which match the filter expression specified will be diverted. The filter string follows the ActiveMQ Artemis filter expression syntax described in the ActiveMQ Artemis documentation. no filter
Forwarding AddressAddress to divert to yes forwarding-address
Routing NameRouting name of the divert no routing-name
Transformer Class NameThe name of a class used to transform the message's body or properties before it is diverted. no transformer-class-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.14.1. EAP7 - Module Option Service
Overview
Table 3.3946. Overview
Description:The module options to be used.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3947. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3948. 
NameDescriptionRequiredInternal Name
Modules OptionsList of module options. no Modules Options

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.15. EAP7 - Queue (Profile) Service
Overview
Table 3.3949. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3950. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3951. 
NameDescriptionRequiredInternal Name
DurableDefines whether the queue is durable. The default value is true. no durable
FilterA queue message filter definition. An undefined or empty filter will match all messages. no filter
Queue AddressThe queue address defines what address is used for routing messages. yes queue-address

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.16. EAP7 - Core Address (Profile) Service
Overview
Table 3.3952. Overview
Description:A runtime-only resource representing a ActiveMQ Artemis address. Zero or more queues can be bound to a single address. When a message is routed, it is routed to the set of queues bound to the message's address.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3953. 
NameDescriptionRequiredInternal Name
Path  yes path
Include Runtime  yes includeRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3954. 
NameDescriptionRequiredInternal Name
Binding NamesThe names of all bindings (both queues and diverts) bound to this address. yes binding-names
Number Of Bytes Per PageThe number of bytes used by each page for this address. yes number-of-bytes-per-page
Number Of PagesThe number of pages used by this address. yes number-of-pages
Queue NamesThe names of the queues associated with the address. yes queue-names
RolesA list of the security roles (name and permissions) associated with the address. yes roles

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.17. EAP7 - Cluster Connection (Profile) Service
Overview
Table 3.3955. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3956. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3957. 
NameDescriptionRequiredInternal Name
Call TimeoutThe timeout (in ms) for remote calls made by the cluster connection. The default value is 30000. no call-timeout
Check PeriodThe period (in milliseconds) between client failure check. The default value is 30000. no check-period
Cluster Connection AddressEach cluster connection only applies to messages sent to an address that starts with this value. yes cluster-connection-address
Confirmation Window SizeThe confirmation-window-size to use for the connection used to forward messages to a target node. The default value is 1048576. no confirmation-window-size
Connection TtlThe maximum time (in milliseconds) for which the connections used by the cluster connections are considered alive (in the absence of heartbeat). The default value is 60000. no connection-ttl
Connector RefThe confirmation-window-size to use for the connection used to forward messages to a target node. yes connector-ref
Discovery Group NameThe discovery group used to obtain the list of other servers in the cluster to which this cluster connection will make connections. Must be undefined (null) if 'static-connectors' is defined. no discovery-group-name
Forward When No ConsumersWhether messages will be distributed round robin between other nodes of the cluster irrespective of whether there are matching or indeed any consumers on other nodes. If this is set to false (the default) then ActiveMQ Artemis will only forward messages to other nodes of the cluster if the address to which they are being forwarded has queues which have consumers, and if those consumers have message filters (selectors) at least one of those selectors must match the message. The default value is false. no forward-when-no-consumers
Max HopsThe maximum number of times a message can be forwarded. ActiveMQ Artemis can be configured to also load balance messages to nodes which might be connected to it only indirectly with other ActiveMQ Artemis servers as intermediates in a chain. The default value is 1. no max-hops
Max Retry IntervalThe maximum interval of time used to retry connections. The default value is 2000. no max-retry-interval
Min Large Message SizeThe minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400. no min-large-message-size
Reconnect AttemptsThe total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1. no reconnect-attempts
Retry IntervalThe period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 500. no retry-interval
Retry Interval MultiplierA multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0. no retry-interval-multiplier
Static ConnectorsThe statically defined list of connectors to which this cluster connection will make connections. Must be undefined (null) if 'discovery-group-name' is defined. no static-connectors:nullable
Use Duplicate DetectionWhether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. no use-duplicate-detection

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.18. EAP7 - Broadcast Group (Profile) Service
Overview
Table 3.3958. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3959. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3960. 
NameDescriptionRequiredInternal Name
Broadcast PeriodThe period in milliseconds between consecutive broadcasts. The default value is 2000. no broadcast-period
ConnectorsSpecifies the names of connectors that will be broadcast. no connectors
Socket BindingThe broadcast group socket binding. yes socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.19. EAP7 - Path (Profile) Service
Overview
Table 3.3961. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3962. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3963. 
NameDescriptionRequiredInternal Name
PathThe actual filesystem path. Treated as an absolute path, unless the 'relative-to' attribute is specified, in which case the value is treated as relative to that path.
If treated as an absolute path, the actual runtime pathname specified by the value of this attribute will be determined as follows:
If this value is already absolute, then the value is directly used. Otherwise the runtime pathname is resolved in a system-dependent way. On UNIX systems, a relative pathname is made absolute by resolving it against the current user directory. On Microsoft Windows systems, a relative pathname is made absolute by resolving it against the current directory of the drive named by the pathname, if any; if not, it is resolved against the current user directory.
yes path
Relative ToThe 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. The standard paths provided by the system include:
  • jboss.home - the root directory of the JBoss AS distribution
  • user.home - user's home directory
  • user.dir - user's current working directory
  • java.home - java installation directory
  • jboss.server.base.dir - root directory for an individual server instance
  • jboss.server.data.dir - directory the server will use for persistent data file storage
  • jboss.server.log.dir - directory the server will use for log file storage
  • jboss.server.tmp.dir - directory the server will use for temporary file storage
  • jboss.domain.servers.dir - directory under which a host controller will create the working area for individual server instances
no relative-to
Path TypePath Type yes __name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.20. EAP7 - Bridge (Profile) Service
Overview
Table 3.3964. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3965. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3966. 
NameDescriptionRequiredInternal Name
Check PeriodThe period (in milliseconds) between client failure check. The default value is 30000. no check-period
Confirmation Window SizeThe confirmation-window-size to use for the connection used to forward messages to the target node. The default value is 1048576. no confirmation-window-size
Connection TtlThe maximum time (in milliseconds) for which the connections used by the bridges are considered alive (in the absence of heartbeat). The default value is 60000. no connection-ttl
Discovery Group NameThe name of the discovery group used by this bridge. Must be undefined (null) if 'static-connectors' is defined. no discovery-group-name
Failover On Server ShutdownWhether the bridge will attempt to failover onto a backup server (if specified) when the target server is cleanly shutdown rather than crashed. no failover-on-server-shutdown
FilterAn optional filter string. If specified then only messages which match the filter expression specified will be forwarded. The filter string follows the ActiveMQ Artemis filter expression syntax described in the ActiveMQ Artemis documentation. no filter
Forwarding AddressThe address on the target server that the message will be forwarded to. If a forwarding address is not specified then the original destination of the message will be retained. no forwarding-address
HaWhether or not this bridge should support high availability. True means it will connect to any available server in a cluster and support failover. The default value is false. no ha
Max Retry IntervalThe maximum interval of time used to retry connections. The default value is 2000. no max-retry-interval
Min Large Message SizeThe minimum size (in bytes) for a message before it is considered as a large message. The default value is 102400. no min-large-message-size
PasswordThe password to use when creating the bridge connection to the remote server. If it is not specified the default cluster password specified by the cluster-password attribute in the root messaging subsystem resource will be used. The default value is CHANGE ME!!. no password
Queue NameThe unique name of the local queue that the bridge consumes from. yes queue-name
Reconnect AttemptsThe total number of reconnect attempts the bridge will make before giving up and shutting down. A value of -1 signifies an unlimited number of attempts. The default value is -1. no reconnect-attempts
Retry IntervalThe period in milliseconds between subsequent reconnection attempts, if the connection to the target server has failed. The default value is 2000. no retry-interval
Retry Interval MultiplierA multiplier to apply to the time since the last retry to compute the time to the next retry. This allows you to implement an exponential backoff between retry attempts. The default value is 1.0. no retry-interval-multiplier
Static ConnectorsA list of names of statically defined connectors used by this bridge. Must be undefined (null) if 'discovery-group-name' is defined. no static-connectors:nullable
Transformer Class NameThe name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface. no transformer-class-name
Use Duplicate DetectionWhether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. no use-duplicate-detection
UserThe user name to use when creating the bridge connection to the remote server. If it is not specified the default cluster user specified by the cluster-user attribute in the root messaging subsystem resource will be used. The default value is ACTIVEMQ.CLUSTER.ADMIN.USER. no user

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.21. EAP7 - Discovery Group (Profile) Service
Overview
Table 3.3967. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3968. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3969. 
NameDescriptionRequiredInternal Name
Initial Wait TimeoutPeriod, in ms, to wait for an initial broadcast to give us at least one node in the cluster. The default value is 10000. no initial-wait-timeout
Refresh TimeoutPeriod the discovery group waits after receiving the last broadcast from a particular server before removing that server's connector pair entry from its list. The default value is 10000. no refresh-timeout
Socket BindingThe discovery group socket binding. yes socket-binding

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.22. EAP7 - Connector Service (Profile) Service
Overview
Table 3.3970. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.3971. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3972. 
NameDescriptionRequiredInternal Name
Factory ClassClass name of the factory class that can instantiate the connector service. yes factory-class

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.10.1.22.1. EAP7 - Param Service
Overview
Table 3.3973. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3974. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3975. 
NameDescriptionRequiredInternal Name
ValueThe parameter value yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.11. EAP7 - IIOP-OpenJDK Service
Overview
Table 3.3976. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3977. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3978. 
NameDescriptionRequiredInternal Name
Add Component Via InterceptorIndicates whether SSL components should be added by an IOR interceptor (on) or not (off). The default value is true. no add-component-via-interceptor
Auth MethodThe authentication method. Valid values are 'none' and 'username_password'. The default value is username_password. no auth-method
Caller PropagationIndicates whether the caller identity should be propagated in the SAS context or not. Valid values are 'none' and 'supported'. The default value is none. no caller-propagation
Client RequiresValue that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no client-requires
Client SupportsValue that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no client-supports
ConfidentialityIndicates whether the transport must require confidentiality protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no confidentiality
Detect MisorderingIndicates whether the transport must require misordering detection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no detect-misordering
Detect ReplayIndicates whether the transport must require replay detection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no detect-replay
Export CorbalocIndicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off). The default value is true. no export-corbaloc
Giop VersionThe GIOP version to be used. The default value is 1.2. no giop-version
High Water Mark:exprTCP connection cache parameter. Each time the number of connections exceeds this value ORB tries to reclaim connections. Number of reclaimed connections is specified by tcp-number-to-reclaim property. If this property is not set then it is configured as OpenJDK ORB default. no high-water-mark:expr
IntegrityIndicates whether the transport must require integrity protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. no integrity
Number To Reclaim:exprTCP connection cache parameter. Each time number of connections exceeds tcp-high-water-mark property then ORB tries to reclaim connections. Number of reclaimed connections is specified by this property. If it is not set then it is configured as OpenJDK ORB default. no number-to-reclaim:expr
Persistent Server IdPersistent id of the server. Persistent object references are valid across many activactions of the server and they identify it using this property. As a result of that: many activations of the same server should have this property set to the same value, different server instances running on the same host should have different server ids. The default value is 1. no persistent-server-id
PropertiesA list of generic key/value properties. no properties
RealmThe authentication service (AS) realm name. no realm
RequiredIndicates if authentication is required (true) or not (false). The default value is false. no required
Root ContextThe naming service root context. The default value is JBoss/Naming/root. no root-context
SecurityIndicates whether the security interceptors are to be installed (on) or not (off). The default value is none. no security
Security DomainThe name of the security domain that holds the key and trust stores that will be used to establish SSL connections. no security-domain
Server RequiresValue that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no server-requires
Server SupportsValue that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no server-supports
Socket BindingThe name of the socket binding configuration that specifies the ORB port. The default value is iiop. no socket-binding
Ssl Socket BindingThe name of the socket binding configuration that specifies the ORB SSL port. The default value is iiop-ssl. no ssl-socket-binding
Support SslIndicates whether SSL is to be supported (on) or not (off). The default value is false. no support-ssl
TransactionsIndicates whether the transactions interceptors are to be installed (on or spec) or not (off). The value 'on' enabled JTS while 'spec' enables a spec compliant mode (non JTS) that rejects incoming transaction contexts. The default value is none. no transactions
Trust In ClientIndicates if the transport must require trust in client to be established. Valid values are 'none', 'supported' and 'required'. The default value is none. no trust-in-client
Trust In TargetIndicates if the transport must require trust in target to be established. Valid values are 'none' and 'supported'. The default value is none. no trust-in-target

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.12. EAP7 - Datasources (Profile) Service
Overview
Table 3.3979. Overview
Description:Datasources subsystem for profile.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3980. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.12.1. EAP7 - DataSource (Profile) Service
Overview
Table 3.3981. Overview
Description:A non-XA data source
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3982. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3983. 
NameDescriptionRequiredInternal Name
Connection Property  no *1
Connection UrlThe JDBC driver connection URL yes connection-url
Driver NameName of the (existing) JDBC driver to use yes driver-name
Driver ClassThe fully qualified name of the JDBC driver class no driver-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
DriverDefines the JDBC driver the datasource should use with this format: driver-name>#major-version.minor-version where driver-name is the fully qualified name of the JDBC driver class no driver
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
JtaEnable JTA integration no jta
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. Existing value cannot be unset. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. Existing value cannot be unset. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. Existing value cannot be unset. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. Existing value cannot be unset. no pool-use-strict-min
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Allow Multiple UsersSpecifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that no allow-multiple-users
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait MillisIndicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. Existing value cannot be unset. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. Existing value cannot be unset. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. Existing value cannot be unset. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. Existing value cannot be unset. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3984. Metrics
NameDescription
EnableEnables the data-source. Note this operation will not be supported runtime in next versions.
DisableDisables the data-source. Note this operation will not be supported runtime in next versions.
Package Types
none
3.4.2.5.12.2. EAP7 - XADataSource (Profile) Service
Overview
Table 3.3985. Overview
Description:An XA data source
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3986. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3987. 
NameDescriptionRequiredInternal Name
Properties  yes *2
Xa Datasource ClassThe fully qualified name of the javax.sql.XADataSource implementation yes xa-datasource-class
Jndi NameSpecifies the JNDI name for the datasource yes jndi-name
Driver NameDefines 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 yes driver-name
User NameSpecify the username used when creating a new connection. no user-name
PasswordSpecify the password used when creating a new connection. no password
New Connection SqlSpecifies an SQL statement to execute whenever a connection is added to the connection pool. no new-connection-sql
Url DelimiterSpecifies the delimiter for URLs in connection-url for HA datasources no url-delimiter
Url Selector Strategy Class NameA class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy no url-selector-strategy-class-name
Use Java ContextSetting this to false will bind the DataSource into global JNDI; no use-java-context
EnabledSpecifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. no enabled
Max Pool SizeThe max-pool-size element indicates the maximum number of connections for a pool. No more connections will be created in each sub-pool. Existing value cannot be unset. no max-pool-size
Min Pool SizeThe min-pool-size element indicates the minimum number of connections a pool should hold. These are not created until a Subject is known from a request for a connection. Existing value cannot be unset. no min-pool-size
Pool PrefillWhether to attempt to prefill the connection pool. Changing this value require a server restart. Existing value cannot be unset. no pool-prefill
Pool Use Strict MinDefine if the min-pool-size should be considered a strictly. Existing value cannot be unset. no pool-use-strict-min
InterleavingAn element to enable interleaving for XA connection factories no interleaving
No Tx Separate PoolOracle 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 context no no-tx-separate-pool
Pad XidShould the Xid be padded no pad-xid
Same Rm OverrideThe is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false no same-rm-override
Wrap Xa DatasourceShould the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance no wrap-xa-datasource
Security DomainIndicates Subject (from security domain) are used to distinguish connections in the pool. The content of the security-domain is the name of the JAAS security manager that will handleauthentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. no security-domain
Recovery Plugin Class Namerecovery plugin implementation provided for specific purpose (i.e vendor) no recovery-plugin-class-name
Reauth Plugin Class Namere-authentication plugin implementation provided for specific purpose (i.e vendor) no reauth-plugin-class-name
Flush StrategySpecifies how the pool should be flush in case of an error. no flush-strategy
Prepared Statements Cache SizeThe number of prepared statements per connection in an LRU cache no prepared-statements-cache-size
Share Prepared StatementsWhether to share prepare statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement no share-prepared-statements
Track StatementsWhether to check for unclosed statements when a connection is returned to the pool and result sets are closed when a statement is closed/return to the prepared statement cache. valid values are: false - do not track statements and results true - track statements and result sets and warn when they are not closed nowarn - track statements but do no warn about them being unclosed no track-statements
Allocation RetryThe allocation retry element indicates the number of times that allocating a connection should be tried before throwing an exception. no allocation-retry
Allocation Retry Wait Millishe allocation retry wait millis element indicates the time in milliseconds to wait between retrying to allocate a connection. no allocation-retry-wait-millis
Blocking Timeout Wait MillisThe blocking-timeout-millis element indicates the maximum time in milliseconds to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for a permit for a connection, and will never throw an exception if creating a new connection takes an inordinately long time. Existing value cannot be unset. no blocking-timeout-wait-millis
Idle Timeout MinutesThe idle-timeout-minutes elements indicates 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 1/2 the smallest idle-timeout-minutes of any pool. Changing this value require a server restart. Existing value cannot be unset. no idle-timeout-minutes
Query TimeoutAny configured query timeout in seconds The default is no timeout no query-timeout
Use Try LockAny configured timeout for internal locks on the resource adapter objects in seconds no use-try-lock
Set Tx Query TimeoutWhether 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. no set-tx-query-timeout
Transaction IsolationSet java.sql.Connection transaction isolation level to use. The constants defined by transaction-isolation-values are the possible transaction isolation levels. no transaction-isolation
Check Valid Connection SqlSpecify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use. no check-valid-connection-sql
Exception Sorter Class NameAn org.jboss.jca.adapters.jdbc.ExceptionSorter that provides a boolean isExceptionFatal(SQLException e) method to validate is an exception should be broadcast to all javax.resource.spi.ConnectionEventListener as a connectionErrorOccurred no exception-sorter-class-name
Stale Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides a boolean isStaleConnection(SQLException e) method which if it it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException no stale-connection-checker-class-name
Valid Connection Checker Class NameAn org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides a SQLException isValidConnection(Connection e) method to validate is a connection is valid. An exception means the connection is destroyed. This overrides the check-valid-connection-sql when present. no valid-connection-checker-class-name
Background Validation MillisThe background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value require a server restart. Existing value cannot be unset. no background-validation-millis
Background ValidationAn element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value require a server restart. Existing value cannot be unset. no background-validation
Use Fast FailWhether fail a connection allocation on the first connection if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false) no use-fast-fail
Validate On MatchThe validate-on-match element indicates whether or not connection level validation should be done when a connection factory attempts to match a managed connection for a given set. This is typically exclusive to the use of background validation no validate-on-match
Xa Resource TimeoutPassed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds no xa-resource-timeout
Spywhatever spy or not the jdbc connection no spy
Use CcmEnable the use of a cached connection manager no use-ccm
Recovery Usernameusername used to try connection recovery no recovery-username
Recovery Passwordpassword used to try connection recovery no recovery-password
Recovery Security Domainsecurity-domain used to try connection recovery no recovery-security-domain
No Recoveryif true no recovery are tried for this connection pool no no-recovery

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3988. Metrics
NameDescription
EnableEnables the data-source. Note this operation will not be supported runtime in next versions.
DisableDisables the data-source. Note this operation will not be supported runtime in next versions.
Package Types
none
3.4.2.5.13. EAP7 - Logging Service
Overview
Table 3.3989. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.3990. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3991. 
NameDescriptionRequiredInternal Name
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
HandlersThe Handlers associated with this Logger. yes handlers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.13.1. EAP7 - Async Handler Service
Overview
Table 3.3992. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3993. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3994. 
NameDescriptionRequiredInternal Name
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
Overflow ActionSpecify what action to take when the overflowing. The valid options are 'block' and 'discard'. The default value is BLOCK. yes overflow-action
Queue LengthThe queue length to use before flushing writing yes queue-length
SubhandlersThe Handlers associated with this async handler. no subhandlers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3995. Metrics
NameDescription
Assign SubhandlerAssign a subhandler to the ASYNC handler.
DisableDisable a logging handler.
EnableEnable a logging handler.
Unassign SubhandlerUnassign a subhandler from the ASYNC handler.
Package Types
none
3.4.2.5.13.2. EAP7 - Console Handler Service
Overview
Table 3.3996. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.3997. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.3998. 
NameDescriptionRequiredInternal Name
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
TargetDefines the target of the console handler. The value can either be SYSTEM_OUT or SYSTEM_ERR. The default value is System.out. no target

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.3999. Metrics
NameDescription
DisableDisable a logging handler.
EnableEnable a logging handler.
Package Types
none
3.4.2.5.13.3. EAP7 - Custom Handler Service
Overview
Table 3.4000. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4001. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4002. 
NameDescriptionRequiredInternal Name
ClassThe logging handler class to be used. yes class
EncodingThe character encoding used by this Handler. no encoding
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
ModuleThe module that the logging handler depends on. yes module
Properties  yes properties

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.4003. Metrics
NameDescription
DisableDisable a logging handler.
EnableEnable a logging handler.
Package Types
none
3.4.2.5.13.4. EAP7 - File Handler Service
Overview
Table 3.4004. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4005. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4006. 
NameDescriptionRequiredInternal Name
AppendSpecify whether to append to the target file. The default value is true. no append
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FileThe file description consisting of the path and optional relative to path. no file
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.4007. Metrics
NameDescription
DisableDisable a logging handler.
EnableEnable a logging handler.
Package Types
none
3.4.2.5.13.5. EAP7 - Logger Service
Overview
Table 3.4008. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4009. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4010. 
NameDescriptionRequiredInternal Name
HandlersThe Handlers associated with this Logger. no handlers
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
Use Parent HandlersSpecifies whether or not this logger should send its output to it's parent Logger. The default value is true. no use-parent-handlers

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.4011. Metrics
NameDescription
Change Log LevelChange the logging level for a logger category.
Package Types
none
3.4.2.5.13.6. EAP7 - Periodic Rotating File Handler Service
Overview
Table 3.4012. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4013. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4014. 
NameDescriptionRequiredInternal Name
AppendSpecify whether to append to the target file. The default value is true. no append
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FileThe file description consisting of the path and optional relative to path. no file
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
SuffixSet 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. yes suffix

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.4015. Metrics
NameDescription
DisableDisable a logging handler.
EnableEnable a logging handler.
Package Types
none
3.4.2.5.13.7. EAP7 - Size Rotating File Handler Service
Overview
Table 3.4016. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4017. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4018. 
NameDescriptionRequiredInternal Name
AppendSpecify whether to append to the target file. The default value is true. no append
AutoflushAutomatically flush after each write. The default value is true. no autoflush
EncodingThe character encoding used by this Handler. no encoding
FileThe file description consisting of the path and optional relative to path. no file
FormatterDefines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. no formatter
LevelThe log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. no level
Max Backup IndexThe maximum number of backups to keep. The default value is 1. yes max-backup-index
Rotate SizeThe size at which to rotate the log file. The default value is 2m. yes rotate-size

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.4019. Metrics
NameDescription
DisableDisable a logging handler.
EnableEnable a logging handler.
Package Types
none
3.4.2.5.14. EAP7 - Webservices Service
Overview
Table 3.4020. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.4021. 
NameDescriptionRequiredInternal Name
Path  yes path
Managed Runtime  yes managedRuntime

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4022. 
NameDescriptionRequiredInternal Name
Modify Wsdl AddressWhether the soap address can be modified. no modify-wsdl-address
Wsdl HostThe WSDL, that is a required deployment artifact for an endpoint, has a <soap:address> element which points to the location of the endpoint. JBoss supports rewriting of that SOAP address. If the content of <soap:address> is a valid URL, JBossWS will not rewrite it unless 'modify-wsdl-address' is true. If the content of <soap:address> is not a valid URL, JBossWS will rewrite it using the attribute values given below. If 'wsdl-host' is set to 'jbossws.undefined.host', JBossWS uses requesters host when rewriting the <soap:address> no wsdl-host
Wsdl PortThe non-secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors. no wsdl-port
Wsdl Secure PortThe secure port that will be used for rewriting the SOAP address. If absent the port will be identified by querying the list of installed connectors. no wsdl-secure-port

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.14.1. EAP7 - Endpoint Service
Overview
Table 3.4023. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.4024. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.14.1.1. EAP7 - Post Handler Chain Service
Overview
Table 3.4025. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.4026. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4027. 
NameDescriptionRequiredInternal Name
Protocol BindingsProtocol binding no protocol-bindings

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.14.1.1.1. EAP7 - Post Handler Service
Overview
Table 3.4028. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4029. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4030. 
NameDescriptionRequiredInternal Name
ClassHandler class yes class

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.14.1.2. EAP7 - Pre Handler Chain Service
Overview
Table 3.4031. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.4032. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4033. 
NameDescriptionRequiredInternal Name
Protocol BindingsProtocol binding no protocol-bindings

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.14.1.2.1. EAP7 - Pre Handler Service
Overview
Table 3.4034. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4035. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4036. 
NameDescriptionRequiredInternal Name
ClassHandler class yes class

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.14.1.3. EAP7 - Property Service
Overview
Table 3.4037. Overview
Description:A property
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4038. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4039. 
NameDescriptionRequiredInternal Name
ValueThe property value. no value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.15. EAP7 - Transactions Subsystem (Profile) Service
Overview
Table 3.4040. Overview
Description:The transactions subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.4041. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4042. 
NameDescriptionRequiredInternal Name
Process Id UuidIndicates whether the transaction manager should use a UUID based process id. no process-id-uuid
Socket BindingUsed to reference the correct socket binding to use for the recovery environment. yes socket-binding
JtsIf true this enables the Java Transaction Service. The default value is false. no jts
Object Store PathDenotes 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. The default value is tx-object-store. no object-store-path
Process Id Socket BindingThe 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. no process-id-socket-binding
Default TimeoutThe default timeout. The default value is 300. no default-timeout
Process Id Socket Max PortsThe 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'. The default value is 10. no process-id-socket-max-ports
Recovery ListenerUsed to specify if the recovery system should listen on a network socket or not. The default value is false. no recovery-listener
Status Socket BindingUsed to reference the correct socket binding to use for the transaction status manager. no status-socket-binding
Node IdentifierUsed to set the node identifier on the core environment. The default value is 1. no node-identifier
Enable Tsm StatusWhether the transaction status manager (TSM) service, needed for out of process recovery, should be provided or not. The default value is false. no enable-tsm-status
Object Store Relative ToReferences a global path configuration in the domain model, defaulting to the JBoss Application Server data directory (jboss.server.data.dir). The value of the 'path' attribute will treated as relative to this path. Use an empty string to disable the default behavior and force the value of the 'path' attribute to be treated as an absolute path. The default value is jboss.server.data.dir. no object-store-relative-to
Enable StatisticsWhether statistics should be enabled. The default value is false. no enable-statistics

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.15.1. EAP7 - Log Store (Profile) Service
Overview
Table 3.4043. Overview
Description:Representation of the transaction logging storage mechanism.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4044. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4045. 
NameDescriptionRequiredInternal Name
TypeSpecifies the implementation type of the logging store. no type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.4046. Metrics
NameDescription
ProbeScan for new transaction logs. This operation will creates a child for each pending transaction.
Package Types
none
3.4.2.5.16. EAP7 - JacORB Service
Overview
Table 3.4047. Overview
Description:JacORB subsystem configuration
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4048. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4049. 
NameDescriptionRequiredInternal Name
Add Component Via InterceptorIndicates whether SSL components should be added by an IOR interceptor (on) or not (off). The default value is on. no add-component-via-interceptor
Cache Poa NamesIndicates whether POA names should be cached (on) or not (off). The default value is off. no cache-poa-names
Cache TypecodesIndicates whether typecodes should be cached (on) or not (off). The default value is off. no cache-typecodes
Chunk Custom Rmi ValuetypesIndicates whether custom RMI valuetypes should be encoded as chunks (on) or not (off). The default value is on. no chunk-custom-rmi-valuetypes
Client RequiresValue that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no client-requires
Client SupportsValue that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no client-supports
Client TimeoutThe client-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out. The default value is 0. no client-timeout
CometIndicates whether interoperability with Comet's ORB is enabled (on) or not (off). The default value is off. no comet
Export CorbalocIndicates whether the root context should be exported as corbaloc::address:port/NameService (on) or not (off). The default value is on. no export-corbaloc
Giop Minor VersionThe GIOP minor version to be used. The default value is 2. no giop-minor-version
Indirection Encoding DisableIndicates whether indirection encoding for repeated typecodes should be disabled (on) or not (off). The default value is off. no indirection-encoding-disable
IonaIndicates whether interoperability with IONA's ASP is enabled (on) or not (off). The default value is off. no iona
Lax Boolean EncodingIndicates whether any non-zero CDR encoded boolean value should be interpreted as true (on) or not (off). The default value is off. no lax-boolean-encoding
Max Managed Buf SizeThe log2 of maximum size managed by the internal buffer manager. The default value is 24. no max-managed-buf-size
Max Server ConnectionsThe maximum number of connections accepted by the server. The default value is 2147483647. no max-server-connections
Max ThreadsThe maximum number of active request processor threads. Threads are first obtained from the pool and once the pool is exhausted new threads are created until the number of threads reaches this limit. New requests will wait until an active thread finishes its job. The default value is 32. no max-threads
MonitoringIndicates whether the monitoring GUI should be displayed (on) or not (off). The default value is off. no monitoring
NameThe name of the running ORB. The default value is JBoss. no name
Outbuf Cache TimeoutThe buffer cache timeout in milliseconds. The default value is -1. no outbuf-cache-timeout
Outbuf SizeThe size of the network buffers for outgoing messages. The default value is 2048. no outbuf-size
Pool SizeThe size of the request processors thread-pool. Threads that finish processing a request are placed back in the pool if the pool is not full and discarded otherwise. The default value is 5. no pool-size
Print VersionIndicates whether the version number should be printed during ORB startup (on) or not (off). The default value is off. no print-version
PropertiesA list of generic key/value properties. no properties
Queue MaxThe maximum number of requests that can be queued. The default value is 100. no queue-max
Queue MinThe size of the queue for notifying waiting requests. In other words, blocked requests are only notified when the queue has no more than queue-min requests. The default value is 10. no queue-min
Queue WaitIndicates whether requests that exceed the maximum queue size should wait (on) or not (off). When disabled, a TRANSIENT exception is thrown if the queue is full. The default value is off. no queue-wait
RetriesThe number of retries if connections cannot be promptly established. The default value is 5. no retries
Retry IntervalThe interval in milliseconds between retries. The default value is 500. no retry-interval
Root ContextThe naming service root context. The default value is JBoss/Naming/root. no root-context
SecurityIndicates whether the security interceptors are to be installed (on) or not (off). The default value is off. no security
Security DomainThe name of the security domain that holds the key and trust stores that will be used to establish SSL connections. no security-domain
Server RequiresValue that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. no server-requires
Server SupportsValue that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. no server-supports
Server TimeoutThe server-side connection timeout value in milliseconds. A value of zero indicates that the connection never times out. The default value is 0. no server-timeout
Strict Check On Tc CreationIndicates whether the method create_abstract_interface_tc should perform a validation check on the name parameter (on) or not (off). The default value is off. no strict-check-on-tc-creation
SunIndicates whether interoperability with Sun's ORB is enabled (on) or not (off). The default value is on. no sun
Support SslIndicates whether SSL is to be supported (on) or not (off). The default value is off. no support-ssl
TransactionsIndicates whether the transactions interceptors are to be installed (on or spec) or not (off). The value 'on' enabled JTS while 'spec' enables a spec compliant mode (non JTS) that rejects incoming transaction contexts. The default value is off. no transactions
Use BomIndicates whether GIOP 1.2 byte order markers should be used (on) or not (off). The default value is off. no use-bom
Use ImrIndicates whether the implementation repository should be used (on) or not (off). The default value is off. no use-imr

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.17. EAP7 - JAXR Service
Overview
Table 3.4050. Overview
Description:The configuration of the JAXR subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.4051. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4052. 
NameDescriptionRequiredInternal Name
ClassThe JAXR ConnectionFactory implementation class no class
Jndi NameThe JNDI name under which the JAXR ConnectionFactory is bound no jndi-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.17.1. EAP7 - Property (JAXR) Service
Overview
Table 3.4053. Overview
Description:A JAXR property. The identity of the resource defines the property name.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4054. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4055. 
NameDescriptionRequiredInternal Name
ValueThe JAXR property value. yes value

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.18. EAP7 - JPA Service
Overview
Table 3.4056. Overview
Description:The configuration of the JPA subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4057. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4058. 
NameDescriptionRequiredInternal Name
Default DatasourceThe name of the default global datasource. no default-datasource

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.19. EAP7 - CMP Service
Overview
Table 3.4059. Overview
Description:The configuration of the cmp subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.4060. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.19.1. EAP7 - HiloKeygenerator Service
Overview
Table 3.4061. Overview
Description:HiLo based key generators.
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4062. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4063. 
NameDescriptionRequiredInternal Name
Block SizeThe block size no block-size
Create TableBoolean to determine whether to create create the tables no create-table
Create Table DdlThe DDL used to create the table no create-table-ddl
Data SourceThe datasource used for sequence generation yes data-source
Drop TableBoolean to determine whether to create drop the tables no drop-table
Id ColumnThe ID column name yes id-column
Select Hi DdlThe DDL used to select the hi value no select-hi-ddl
Sequence ColumnThe sequence column name yes sequence-column
Sequence NameThe name of the sequence yes sequence-name
Table NameThe table name yes table-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.20. EAP7 - EE Service
Overview
Table 3.4064. Overview
Description:The configuration of the EE subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4065. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4066. 
NameDescriptionRequiredInternal Name
Ear Subdeployments IsolatedFlag 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. The default value is false. no ear-subdeployments-isolated
Global ModulesA list of modules that should be made available to all deployments. no global-modules

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.21. EAP7 - JMX Service
Overview
Table 3.4067. Overview
Description:The configuration of the JMX subsystem.
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.4068. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4069. 
NameDescriptionRequiredInternal Name
Show ModelSet to 'true' to include MBeans for the model controller resources no show-model

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.21.1. EAP7 - Remoting Connector Service
Overview
Table 3.4070. Overview
Description:The configuration of a resource adapter.
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4071. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4072. 
NameDescriptionRequiredInternal Name
Use Management EndpointIf true the connector will use the management endpoint, otherwise it will use the remoting subsystem one. The default value is true. no use-management-endpoint

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.22. EAP7 - Infinispan Service
Overview
Table 3.4073. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.4074. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.22.1. EAP7 - Cache Container Service
Overview
Table 3.4075. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.4076. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.4077. Metrics
NameTypeDescriptionInternal Name
Cache Manager StatustraitThe status of the cache manager component. May return null if the cache manager is not started.cache-manager-status
Cluster NametraitThe name of the cluster this node belongs to. May return null if the cache manager is not started.cluster-name
Coordinator AddresstraitThe logical address of the cluster's coordinator. May return null if the cache manager is not started.coordinator-address
Is CoordinatortraitTrue if this node is the cluster's coordinator. May return null if the cache manager is not started.is-coordinator
Local AddresstraitThe local address of the node. May return null if the cache manager is not started.local-address

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.4078. 
NameDescriptionRequiredInternal Name
AliasesThe list of aliases for this cache container no aliases
Default CacheThe default infinispan cache no default-cache
Jndi NameThe jndi name to which to bind this cache container no jndi-name
ModuleThe module whose class loader should be used when building this cache container's configuration. The default value is org.jboss.as.clustering.infinispan. no module
Statistics EnabledIf enabled, statistics will be collected for this cache container. no statistics-enabled

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.22.1.1. EAP7 - Cache Service
Overview
Table 3.4079. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4080. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.4081. Metrics
NameTypeDescriptionInternal Name
ActivationsmeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Activations per MinutemeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Average Read TimemeasurementAverage time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.average-read-time
Average Write TimemeasurementAverage time (in ms) for cache writes. May return null if the cache is not started.average-write-time
Cache StatustraitThe status of the cache component. May return null if the cache is not started.cache-status
Elapsed TimemeasurementTime (in secs) since cache started. May return null if the cache is not started.elapsed-time
Hit RatiomeasurementThe hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.hit-ratio
HitsmeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
Hits per MinutemeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
InvalidationsmeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
Invalidations per MinutemeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
MissesmeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Misses per MinutemeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Number Of EntriesmeasurementThe current number of entries in the cache. May return null if the cache is not started.number-of-entries
PassivationsmeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Passivations per MinutemeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Read Write RatiomeasurementThe read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.read-write-ratio
Remove HitsmeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove Hits per MinutemeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove MissesmeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
Remove Misses per MinutemeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
StoresmeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Stores per MinutemeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Time Since ResetmeasurementTime (in secs) since cache statistics were reset. May return null if the cache is not started.time-since-reset

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.4082. 
NameDescriptionRequiredInternal Name
Jndi NameThe jndi-name to which to bind this cache instance. no jndi-name
ModeSets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. yes mode
ModuleThe module whose class loader should be used when building this cache's configuration. no module
Queue Flush IntervalIn ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds. no queue-flush-interval
Queue SizeIn ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. no queue-size
Remote TimeoutIn SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown. no remote-timeout
Type of cacheType of cache yes __type

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.22.1.2. EAP7 - Distributed Cache Service
Overview
Table 3.4083. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4084. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.4085. Metrics
NameTypeDescriptionInternal Name
ActivationsmeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Activations per MinutemeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Average Read TimemeasurementAverage time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.average-read-time
Average Write TimemeasurementAverage time (in ms) for cache writes. May return null if the cache is not started.average-write-time
Cache StatustraitThe status of the cache component. May return null if the cache is not started.cache-status
Elapsed TimemeasurementTime (in secs) since cache started. May return null if the cache is not started.elapsed-time
Hit RatiomeasurementThe hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.hit-ratio
HitsmeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
Hits per MinutemeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
InvalidationsmeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
Invalidations per MinutemeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
MissesmeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Misses per MinutemeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Number Of EntriesmeasurementThe current number of entries in the cache. May return null if the cache is not started.number-of-entries
PassivationsmeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Passivations per MinutemeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Read Write RatiomeasurementThe read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.read-write-ratio
Remove HitsmeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove Hits per MinutemeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove MissesmeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
Remove Misses per MinutemeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
StoresmeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Stores per MinutemeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Time Since ResetmeasurementTime (in secs) since cache statistics were reset. May return null if the cache is not started.time-since-reset

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.4086. 
NameDescriptionRequiredInternal Name
Jndi NameThe jndi-name to which to bind this cache instance. no jndi-name
L 1 LifespanMaximum lifespan of an entry placed in the L1 cache. This element configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored. The default value is 600000. no l1-lifespan
ModeSets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. yes mode
ModuleThe module whose class loader should be used when building this cache's configuration. no module
OwnersNumber of cluster-wide replicas for each cache entry. The default value is 2. no owners
Queue Flush IntervalIn ASYNC mode, this attribute controls how often the asynchronous thread used to flush the replication queue runs. This should be a positive integer which represents thread wakeup time in milliseconds. no queue-flush-interval
Queue SizeIn ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. no queue-size
Remote TimeoutIn SYNC mode, the timeout (in ms) used to wait for an acknowledgment when making a remote call, after which the call is aborted and an exception is thrown. no remote-timeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.22.1.3. EAP7 - Local Cache Service
Overview
Table 3.4087. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4088. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.4089. Metrics
NameTypeDescriptionInternal Name
ActivationsmeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Activations per MinutemeasurementThe number of cache node activations (bringing a node into memory from a cache store). May return null if the cache is not started.activations
Average Read TimemeasurementAverage time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started.average-read-time
Average Write TimemeasurementAverage time (in ms) for cache writes. May return null if the cache is not started.average-write-time
Cache StatustraitThe status of the cache component. May return null if the cache is not started.cache-status
Elapsed TimemeasurementTime (in secs) since cache started. May return null if the cache is not started.elapsed-time
Hit RatiomeasurementThe hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started.hit-ratio
HitsmeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
Hits per MinutemeasurementThe number of cache attribute hits. May return null if the cache is not started.hits
InvalidationsmeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
Invalidations per MinutemeasurementThe number of cache invalidations. May return null if the cache is not started.invalidations
MissesmeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Misses per MinutemeasurementThe number of cache attribute misses. May return null if the cache is not started.misses
Number Of EntriesmeasurementThe current number of entries in the cache. May return null if the cache is not started.number-of-entries
PassivationsmeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Passivations per MinutemeasurementThe number of cache node passivations (passivating a node from memory to a cache store). May return null if the cache is not started.passivations
Read Write RatiomeasurementThe read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started.read-write-ratio
Remove HitsmeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove Hits per MinutemeasurementThe number of cache attribute remove hits. May return null if the cache is not started.remove-hits
Remove MissesmeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
Remove Misses per MinutemeasurementThe number of cache attribute remove misses. May return null if the cache is not started.remove-misses
StoresmeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Stores per MinutemeasurementThe number of cache attribute put operations. May return null if the cache is not started.stores
Time Since ResetmeasurementTime (in secs) since cache statistics were reset. May return null if the cache is not started.time-since-reset

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.4090. 
NameDescriptionRequiredInternal Name
Jndi NameThe jndi-name to which to bind this cache instance. no jndi-name
ModuleThe module whose class loader should be used when building this cache's configuration. no module

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.22.1.4. EAP7 - Transport Service
Overview
Table 3.4091. Overview
Description:The description of the transport used by this cache container
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4092. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4093. 
NameDescriptionRequiredInternal Name
ChannelThe channel of this cache container's transport. no channel
Lock TimeoutThe timeout for locks for the transport. The default value is 240000. no lock-timeout

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.23. EAP7 - JGroups Service
Overview
Table 3.4094. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4095. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4096. 
NameDescriptionRequiredInternal Name
Default StackDefault stack to use yes default-stack

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.24. EAP7 - Remoting Service
Overview
Table 3.4097. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4098. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4099. 
NameDescriptionRequiredInternal Name
Worker Read ThreadsThe number of read threads to create for the remoting worker. The default value is 1. no worker-read-threads
Worker Task Core ThreadsThe number of core threads for the remoting worker task thread pool. The default value is 4. no worker-task-core-threads
Worker Task KeepaliveThe number of milliseconds to keep non-core remoting worker task threads alive. The default value is 60. no worker-task-keepalive
Worker Task LimitThe maximum number of remoting worker tasks to allow before rejecting. The default value is 16384. no worker-task-limit
Worker Task Max ThreadsThe maximum number of threads for the remoting worker task thread pool. The default value is 16. no worker-task-max-threads
Worker Write ThreadsThe number of write threads to create for the remoting worker. The default value is 1. no worker-write-threads

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.25. EAP7 - Mail Service
Overview
Table 3.4100. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
Connection Properties
Table 3.4101. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.5.25.1. EAP7 - Mail Session Service
Overview
Table 3.4102. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource TypesConnection Properties
Table 3.4103. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4104. 
NameDescriptionRequiredInternal Name
DebugEnables javamail debugging. The default value is false. no debug
FromFrom address that is used as default from, if not set when sending no from
Jndi NameJNDI name to where mail session should be bound no jndi-name

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.25.1.1. EAP7 - SMTP Mail Server Service
Overview
Table 3.4105. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4106. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4107. 
NameDescriptionRequiredInternal Name
Outbound Socket Binding RefOutbound Socket binding to SMTP server yes outbound-socket-binding-ref
PasswordPassword to authenticate on server no password
SslDoes server requires SSL?. The default value is false. no ssl
UsernameUsername to authenticate on server no username

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.25.1.2. EAP7 - IMAP Mail Server Service
Overview
Table 3.4108. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4109. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4110. 
NameDescriptionRequiredInternal Name
Outbound Socket Binding RefOutbound Socket binding to IMAP server yes outbound-socket-binding-ref
PasswordPassword to authenticate on server no password
SslDoes server requires SSL?. The default value is false. no ssl
UsernameUsername to authenticate on server no username

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.5.25.1.3. EAP7 - POP3 Mail Server Service
Overview
Table 3.4111. Overview
Description: 
Singleton: yes
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4112. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4113. 
NameDescriptionRequiredInternal Name
Outbound Socket Binding RefOutbound Socket binding to POP3 server yes outbound-socket-binding-ref
PasswordPassword to authenticate on server no password
SslDoes server requires SSL?. The default value is false. no ssl
UsernameUsername to authenticate on server no username

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.2.6. EAP7 - Network Interface Service

Overview
Table 3.4114. Overview
Description:A named network interface, along with required criteria for determining the IP address to associate with that interface
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4115. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4116. 
NameDescriptionRequiredInternal Name
Any AddressAttribute indicating that sockets using this interface should be bound to a wildcard address. The IPv6 wildcard address (::) will be used unless the java.net.preferIpV4Stack system property is set to true, in which case the IPv4 wildcard address (0.0.0.0) will be used. If a socket is bound to an IPv6 anylocal address on a dual-stack machine, it can accept both IPv6 and IPv4 traffic; if it is bound to an IPv4 (IPv4-mapped) anylocal address, it can only accept IPv4 traffic. no any-address
Link Local AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address is link-local. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no link-local-address
LoopbackAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a loopback address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no loopback
Loopback AddressAttribute indicating that the IP address for this interface should be the given value, if a loopback interface exists on the machine. A 'loopback address' may not actually be configured on the machine's loopback interface. Differs from inet-address in that the given value will be used even if no NIC can be found that has the IP specified address associated with it. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no loopback-address
MulticastAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface supports multicast. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection. no multicast
NicAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has the given name. The name of a network interface (e.g. eth0, eth1, lo). An 'undefined' value means this attribute is not relevant to the IP address selection. no nic
Nic MatchAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface has a name that matches the given regular expression. Value is a regular expression against which the names of the network interfaces available on the machine can be matched to find an acceptable interface. An 'undefined' value means this attribute is not relevant to the IP address selection. no nic-match
Point To PointAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not its network interface is a point-to-point interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no point-to-point
Public AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not it is a publicly routable address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no public-address
Site Local AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it is a site-local address. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no site-local-address
Subnet MatchAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or it the address fits in the given subnet definition. Value is a network IP address and the number of bits in the address' network prefix, written in 'slash notation'; e.g. '192.168.0.0/16'. An 'undefined' value means this attribute is not relevant to the IP address selection. no subnet-match
UpAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is currently up. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no up
VirtualAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether its network interface is a virtual interface. An 'undefined' or 'false' value means this attribute is not relevant to the IP address selection no virtual
Inet AddressAttribute indicating that part of the selection criteria for choosing an IP address for this interface should be whether or not the address matches the given value. Value is either a IP address in IPv6 or IPv4 dotted decimal notation, or a hostname that can be resolved to an IP address. An 'undefined' value means this attribute is not relevant to the IP address selection. no inet-address

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.2.7. EAP7 - SocketBindingGroup Service

Overview
Table 3.4117. Overview
Description: 
Singleton: no
Plugin:EAP7
Child Resource Types
none
Connection Properties
Table 3.4118. 
NameDescriptionRequiredInternal Name
Path  yes path

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.4119. 
NameDescriptionRequiredInternal Name
Bindings  yes *
Bindings  yes *1
Bindings  yes *2
Default InterfaceDefault Interface for these bindings. See Network Interfaces for its definition yes default-interface
Port OffsetOffset from standard ports for this group. This is only available in standalone mode no port-offset

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none

3.4.3. EAP7 - Wildfly 10/EAP 7 Patch Handler Service

Overview

Table 3.4120. Overview
Description:Handles installation of patches of Wildfly or JBoss EAP application servers and their variants
Singleton: yes
Plugin:EAP7

Child Resource Types

none

Connection Properties

none

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.