3.4. Enterprise Application Server 7 Plugin
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
Description: | Standalone AS7 server |
Singleton: | no |
Plugin: | EAP7 |
Note
Child Resource Types
Autodiscovery Process Scans
Name | Query |
---|---|
StandaloneAS | process|basename|match=^java.*,arg|org.jboss.as.standalone|match=.* |
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Start Script Path | The 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 Prefix | A 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 Variables | The 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 Arguments | The 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_OPTS | Property 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 Authentication | Specifies 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 Strategy | Defines the trust strategy to use when reading the server certificate:
| yes | trustStrategy |
Hostname Verification | Defines the hostname verification logic:
| yes | hostnameVerification |
Truststore | Path to a truststore file. If undefined, the JVM default truststore is used. | no | truststore |
Truststore Type | Truststore file format (required when the Truststore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats. | no | truststoreType |
Truststore Password | Password protecting the truststore file. | no | truststorePassword |
Client Certificate Authentication | yes | clientcertAuthentication | |
Keystore | Path to a keystore file. Required when Client Certificate Authentication is on. | no | keystore |
Keystore Type | Keystore file format (required when the Keystore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats. | no | keystoreType |
Keystore Password | Password protecting the keystore file. | no | keystorePassword |
Key Password | Password protecting the secret key in the keystore file. | no | keyPassword |
Hostname | yes | hostname | |
Port | yes | port | |
Secure | Encrypted transport indicator | yes | secure |
User | Management user for a secured AS | no | user |
Password | Password for the management user | no | password |
Management Connection Timeout | Maximum 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 Directory | Root directory of the server installation | no | homeDir |
Base Directory | Base directory for server content | no | baseDir |
Configuration Directory | Base configuration directory | no | configDir |
Log Directory | the directory where log files will be written for this server | no | logDir |
Product Type | Server product type (e.g. AS or EAP) | no | productType |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Number of management requests | measurement | Number of requests sent to the controller | _internal:mgmtRequests |
Number of management requests per Minute | measurement | Number of requests sent to the controller | _internal:mgmtRequests |
Time used for management requests | measurement | Total time for requests | _internal:requestTime |
Time used for management requests per Minute | measurement | Total time for requests | _internal:requestTime |
Maximum request time | measurement | Max time for a request since last metric get | _internal:maxTime |
Server State | trait | Detailed server state | server-state |
Server Code Name | trait | Server Code Name | _skm:release-codename |
Server Version | trait | Server Version | _skm:release-version |
Product Name | trait | Product Name | _skm:product-name |
Product Version | trait | Product Version | _skm:product-version |
Server Start Time | trait | Server Start Time | startTime |
JGroups Multicast Address | trait | the host and port used by JGroups for multicast | multicastAddress |
Server Config File | trait | The name of the server configuration file this server is using | config-file |
Deploy Directory | trait | The deployment directory for file based bundles (usually 'standalone/deployments') | deployDir |
Temporary Directory | trait | The temporary directory (usually 'standalone/tmp'). May serve as deployment directory for handover only bundles' | temp-dir |
Active Patches | trait | The 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
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | no | *2 | |
Path | 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 | *3 |
Installed extensions | no | *1 | |
Base Dir | The base directory for JBoss Application Server. | yes | base-dir |
Config Dir | The directory where the configurations are stored. | yes | config-dir |
Config File | The configuration file used to launch JBoss Application Server. | yes | config-file |
Content Dir | The directory where user content (e.g. deployments) that is managed by the server is stored. | yes | content-dir |
Data Dir | The data directory. | yes | data-dir |
Deploy Dir | Deprecated variant of 'content-dir'. | yes | deploy-dir |
Ext Dirs | A list of ext directories. | yes | ext-dirs |
Home Dir | The home directory for JBoss Application Server. | yes | home-dir |
Host Name | The host name. | yes | host-name |
Initial Running Mode | The 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 Type | The type of the running server. | yes | launch-type |
Log Dir | The directory where log files are sent. | yes | log-dir |
Modules Dir | The directory where modules are found. | yes | modules-dir |
Node Name | The name of the server node. | yes | node-name |
Qualified Host Name | The qualified host name. | yes | qualified-host-name |
Server Name | The name of the server. | yes | server-name |
Temp Dir | The temporary directory. | yes | temp-dir |
Note
Operations
Name | Description |
---|---|
Reload | Make the server re-load the (changed) configuration. To load a different startup config use 'restart' |
Start | Start the server by invoking its start script |
Restart | Restart the server by shutting it down and invoking its start script |
Shutdown | Shut down the server. |
Install RHQ user | Installs a user in the server for management |
Execute CLI commands | Executes command via jboss-cli |
Execute CLI script | Executes script via jboss-cli |
Setup CLI | Setup 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
3.4.1.1. EAP7 - ModCluster Standalone Service
Overview
Description: | Mod_cluster support |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Name | Description |
---|---|
Add Proxy | Add the proxy to the list of httpd connected to the node. |
List Proxies | Read the list of httpd connected to the node. |
Read Proxies Configuration | Send a DUMP to httpd and display the result. |
Read Proxies Info | Send a INFO to httpd and display the result. |
Refresh | Refresh the node sending a new CONFIG message to Apache httpd. |
Remove Proxy | Remove the proxy to the list of httpd connected to the node. |
Reset | Reset the node connection to Apache httpd. |
Package Types
3.4.1.1.1. EAP7 - Service Configuration Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Proxy List | List of proxies, Format (hostname:port) separated with commas. | no | proxy-list |
Proxy Url | Base URL for MCMP requests. | no | proxy-url |
Advertise Socket | Name of Socket binding to use for the Advertise socket. | no | advertise-socket |
Advertise | Use Advertise logic or not. | no | advertise |
Advertise Security Key | String containing the security key for the Advertise logic. | no | advertise-security-key |
Balancer | The balancer name. | no | balancer |
Connector | Name of the web connector used to communicate with the load balancer. | yes | connector |
Load Balancing Group | loadBalancingGroup name. | no | load-balancing-group |
Excluded Contexts | List of contexts mod_cluster should ignore, Format String separated with commas. | no | excluded-contexts |
Auto Enable Contexts | Enable contexts even if disabled in mod_cluster_manger (httpd). | no | auto-enable-contexts |
Sticky Session | Use sticky sessions for requests. | no | sticky-session |
Sticky Session Remove | Remove session information on failover. | no | sticky-session-remove |
Sticky Session Force | Don't failover a request with session information. | no | sticky-session-force |
Worker Timeout | Timeout to wait in httpd for an available worker to process the requests. | no | worker-timeout |
Max Attempts | Max attempts to process an idempotent request. | no | max-attempts |
Flush Packets | Enables/disables packet flushing in httpd. | no | flush-packets |
Flush Wait | Time to wait before flushing packets in httpd. | no | flush-wait |
Ping | Time (in seconds) in which to wait for a pong answer to a ping. | no | ping |
Smax | Soft maximum idle connection count in httpd | no | smax |
Ttl | Time to live (in seconds) for idle connections above smax | no | ttl |
Node Timeout | Timeout (in seconds) for proxy connections to a node. | no | node-timeout |
Stop Context Timeout | Max time to wait for context to process pending requests. | no | stop-context-timeout |
Socket Timeout | Timeout to wait for httpd to answer a MCMP message. | no | socket-timeout |
Note
Operations
Name | Description |
---|---|
Add Custom Metric | Add new custom metric to the load balancer provider. |
Add Metric | Add new metric to the load balancer provider. |
Remove Custom Metric | Remove a custom metric from the load balancer provider. |
Remove Metric | Add new metric to the load balancer provider. |
Package Types
3.4.1.1.1.1. EAP7 - Dynamic Load Provider Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Decay | Decay. The default value is 2. | no | decay |
History | History. The default value is 9. | no | history |
Note
3.4.1.1.1.1.1. EAP7 - Custom Load Metric Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Capacity | Capacity of the metric. The default value is 1 | no | capacity |
Class | Class name of the custom metric. | yes | class |
Weight | Weight of the metric. The default value is 1. | no | weight |
Note
3.4.1.1.1.1.2. EAP7 - Load Metric Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Capacity | Capacity of the metric. The default value is 1. | no | capacity |
Type | Type of the metric | yes | type |
Weight | Weight of the metric. The default value is 1. | no | weight |
Note
3.4.1.1.1.2. EAP7 - Ssl Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Ca Certificate File | Certificate authority. | no | ca-certificate-file |
Ca Revocation Ur | Certificate authority revocation list. | no | ca-revocation-ur |
Certificate Key File | Key file for the certificate. | no | certificate-key-file |
Cipher Suite | The allowed cipher suite. | no | cipher-suite |
Key Alias | The key alias. | no | key-alias |
Password | Password. | no | password |
Protocol | The SSL protocols that are enabled. | no | protocol |
Note
3.4.1.2. EAP7 - IIOP-OpenJDK Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Add Component Via Interceptor | Indicates 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 Method | The authentication method. Valid values are 'none' and 'username_password'. The default value is username_password. | no | auth-method |
Caller Propagation | Indicates 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 Requires | Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | client-requires |
Client Supports | Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | client-supports |
Confidentiality | Indicates whether the transport must require confidentiality protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. | no | confidentiality |
Detect Misordering | Indicates 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 Replay | Indicates 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 Corbaloc | Indicates 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 Version | The GIOP version to be used. The default value is 1.2. | no | giop-version |
High Water Mark:expr | TCP 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 |
Integrity | Indicates 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:expr | TCP 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 Id | Persistent 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 |
Properties | A list of generic key/value properties. | no | properties |
Realm | The authentication service (AS) realm name. | no | realm |
Required | Indicates if authentication is required (true) or not (false). The default value is false. | no | required |
Root Context | The naming service root context. The default value is JBoss/Naming/root. | no | root-context |
Security | Indicates whether the security interceptors are to be installed (on) or not (off). The default value is none. | no | security |
Security Domain | The name of the security domain that holds the key and trust stores that will be used to establish SSL connections. | no | security-domain |
Server Requires | Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | server-requires |
Server Supports | Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | server-supports |
Socket Binding | The name of the socket binding configuration that specifies the ORB port. The default value is iiop. | no | socket-binding |
Ssl Socket Binding | The name of the socket binding configuration that specifies the ORB SSL port. The default value is iiop-ssl. | no | ssl-socket-binding |
Support Ssl | Indicates whether SSL is to be supported (on) or not (off). The default value is false. | no | support-ssl |
Transactions | Indicates 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 Client | Indicates 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 Target | Indicates 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
Operations
Package Types
3.4.1.3. EAP7 - JVM Service
Overview
Description: | Information about the underlying JVM |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.3.1. EAP7 - Operating System Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Available Processors | measurement | The number of processors available to the Java virtual machine. | available-processors |
System Load Average | measurement | The 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
Configuration Properties
Operations
Package Types
3.4.1.3.2. EAP7 - Memory Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Object Pending Finalization Count | measurement | The approximate number of objects for which finalization is pending. | object-pending-finalization-count |
Initial heap usage | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | heap-memory-usage:init |
Used heap | measurement | The amount of used memory in bytes. | heap-memory-usage:used |
Committed heap | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | heap-memory-usage:committed |
Maximum heap usage | measurement | The maximum amount of memory in bytes that can be used for memory management. | heap-memory-usage:max |
Initial non-heap usage | measurement | The 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 memory | measurement | The amount of used memory in bytes. | non-heap-memory-usage:used |
Committed non-heap memory | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | non-heap-memory-usage:committed |
Maximum non-heap usage | measurement | The maximum amount of memory in bytes that can be used for memory management. | non-heap-memory-usage:max |
Note
Configuration Properties
Operations
Name | Description |
---|---|
Trigger GC | Runs the garbage collector. |
Package Types
3.4.1.3.3. EAP7 - Runtime Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Uptime | measurement | The uptime of the Java virtual machine in milliseconds. | uptime |
Note
Configuration Properties
Operations
Package Types
3.4.1.3.4. EAP7 - Threading Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Thread Count | measurement | The current number of live threads including both daemon and non-daemon threads. | thread-count |
Peak Thread Count | measurement | The peak live thread count since the Java virtual machine started or peak was reset. | peak-thread-count |
Total Started Thread Count | measurement | The total number of threads created and also started since the Java virtual machine started. | total-started-thread-count |
Daemon Thread Count | measurement | The current number of live daemon threads. | daemon-thread-count |
Current Thread Cpu Time | measurement | The 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 Time | measurement | The 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
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Thread Contention Monitoring Enabled | Whether thread contention monitoring is enabled. | no | thread-contention-monitoring-enabled |
Thread Cpu Time Enabled | Whether thread CPU time measurement is enabled. | no | thread-cpu-time-enabled |
Thread Contention Monitoring Supported | Whether the Java virtual machine supports thread contention monitoring. | no | thread-contention-monitoring-supported |
Thread Cpu Time Supported | Whether the Java virtual machine implementation supports CPU time measurement for any thread. | no | thread-cpu-time-supported |
Current Thread Cpu Time Supported | Whether the Java virtual machine supports CPU time measurement for the current thread. | no | current-thread-cpu-time-supported |
Object Monitor Usage Supported | Whether the Java virtual machine supports monitoring of object monitor usage. | no | object-monitor-usage-supported |
Synchronizer Usage Supported | Whether the Java virtual machine supports monitoring of ownable synchronizer usage. | no | synchronizer-usage-supported |
Note
Operations
Name | Description |
---|---|
Dump All Threads | Returns the thread info for all live threads with stack trace and synchronization information. |
Find Deadlocked Threads | Finds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers. |
Find Monitor Deadlocked Threads | Finds cycles of threads that are in deadlock waiting to acquire object monitors. |
Get Thread Cpu Time | Returns the total CPU time for a thread of the specified ID in nanoseconds. |
Get Thread Info | Returns 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 Infos | Returns the thread info for each thread whose ID is in the input list. |
Get Thread User Time | Returns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds. |
Reset Peak Thread Count | Resets the peak thread count to the current number of live threads. |
Get All thread ids | Get 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
3.4.1.3.5. EAP7 - Garbage Collector Service
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
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.3.5.1. EAP7 - Garbage Collector Resource Service
Description: | The management interface for one of the garbage collectors in the Java virtual machine. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Collection Count | measurement | The total number of collections that have occurred. | collection-count |
Collection Count per Minute | measurement | The total number of collections that have occurred. | collection-count |
Collection Time | measurement | The approximate accumulated collection elapsed time in milliseconds. | collection-time |
Collection Time per Minute | measurement | The approximate accumulated collection elapsed time in milliseconds. | collection-time |
Name | trait | The name representing this garbage collector | name |
Valid | trait | Whether this this memory manager is valid in the Java virtual machine. | valid |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Memory Pool Names | The name of memory pools that this garbage collector manages. | yes | memory-pool-names |
Note
3.4.1.3.6. EAP7 - Memory Pool Service
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
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.3.6.1. EAP7 - Memory Pool Resource Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Collection Usage - Init | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | collection-usage:init |
Collection Usage - Used | measurement | The amount of used memory in bytes. | collection-usage:used |
Collection Usage - Committed | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | collection-usage:committed |
Collection Usage - Max | measurement | The maximum amount of memory in bytes that can be used for memory management. | collection-usage:max |
Collection Usage Threshold Count | measurement | The 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 Exceeded | trait | Whether 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 Supported | trait | Whether this memory pool supports a collection usage threshold. | collection-usage-threshold-supported |
Name | trait | The name representing this memory pool. | name |
Peak Usage - Init | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | peak-usage:init |
Peak Usage - Used | measurement | The amount of used memory in bytes. | peak-usage:used |
Peak Usage - Committed | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | peak-usage:committed |
Peak Usage - Max | measurement | The maximum amount of memory in bytes that can be used for memory management. | peak-usage:max |
Type | trait | The type of this memory pool. | type |
Usage - Init | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | usage:init |
Usage - Used | measurement | The amount of used memory in bytes. | usage:used |
Usage - Committed | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | usage:committed |
Usage - Max | measurement | The maximum amount of memory in bytes that can be used for memory management. | usage:max |
Usage Threshold Count | measurement | The 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 Exceeded | trait | Whether 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 Supported | trait | Whether this memory pool supports usage threshold. | usage-threshold-supported |
Valid | trait | Whether 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
Name | Description | Required | Internal Name |
---|---|---|---|
Collection Usage Threshold | The 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 Names | The names of the memory managers that manage this memory pool. | yes | memory-manager-names |
Usage Threshold | The 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
Name | Description |
---|---|
Reset Peak Usage | Resets the peak memory usage statistic of this memory pool to the current memory usage. |
3.4.1.4. EAP7 - Undertow Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Security Domain | The default security domain used by web deployments. The default value is other. | no | default-security-domain |
Default Server | The default server to use for deployments. The default value is default-server. | no | default-server |
Default Servlet Container | The default servlet container to use for deployments. The default value is default. | no | default-servlet-container |
Default Virtual Host | The default virtual host to use for deployments. The default value is default-host. | no | default-virtual-host |
Instance Id | The cluster instance id. The default value is {EXPRESSION_VALUE=${jboss.node.name}}. | no | instance-id |
Statistics Enabled | Configures if are statistics enabled. The default value is false. | no | statistics-enabled |
Note
Operations
Package Types
3.4.1.4.1. EAP7 - Filter configurations Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.4.1.1. EAP7 - Error page Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code:expr | Error page code | yes | code:expr |
Path | Error page path | no | path |
Note
3.4.1.4.1.2. EAP7 - Expression filter Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Expression | The expression that defines the filter | yes | expression |
Module | Module to use to load the filter definitions | no | module |
Note
3.4.1.4.1.3. EAP7 - GZIP Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.4.1.4. EAP7 - Mod cluster Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Advertise Frequency:expr | The frequency (in milliseconds) that mod-cluster advertises itself on the network. The default value is 10000. | no | advertise-frequency:expr |
Advertise Path | The path that mod-cluster is registered under, defaults to /. The default value is /. | no | advertise-path |
Advertise Protocol | The protocol that is in use, defaults to HTTP. The default value is http. | no | advertise-protocol |
Advertise Socket Binding | The multicast group that is used to advertise | yes | advertise-socket-binding |
Broken Node Timeout:expr | The 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:expr | The number of connections that will be kept alive indefinitely. The default value is 40. | no | cached-connections-per-thread:expr |
Connection Idle Timeout:expr | The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread). The default value is 60. | no | connection-idle-timeout:expr |
Connections Per Thread:expr | The 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 2 | If the load balancer should attempt to upgrade back end connections to HTTP2. If HTTP2 is not supported HTTP or HTTPS will be used as normal. The default value is false. | no | enable-http2 |
Health Check Interval:expr | The frequency of health check pings to backend nodes. The default value is 10000. | no | health-check-interval:expr |
Management Access Predicate | A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands. Provides additional security on top of what is provided by limiting management to requests that originate from the management-socket-binding | no | management-access-predicate |
Management Socket Binding | The 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 Size | The maximum size for AJP packets. Increasing this will allow AJP to work for requests/responses that have a large amount of headers. This is an advanced option, and must be the same between load balancers and backend servers. | no | max-ajp-packet-size |
Max Request Time:expr | The 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:expr | The 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 Key | The security key that is used for the mod-cluster group. All members must use the same security key. | no | security-key |
Security Realm | The security realm that provides the SSL configuration | no | security-realm |
Use Alias | If an alias check is performed. The default value is false. | no | use-alias |
Worker | The XNIO worker that is used to send the advertise notifications. The default value is default. | no | worker |
Note
3.4.1.4.1.5. EAP7 - Rewrite Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Redirect | If this is true then a redirect will be done instead of a rewrite. The default value is false. | no | redirect |
Target | The expression that defines the target. If you are redirecting to a constant target put single quotes around the value | yes | target |
Note
3.4.1.4.1.6. EAP7 - Response header Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Header Name | Header name | yes | header-name |
Header Value | Value for header | yes | header-value |
Note
3.4.1.4.1.7. EAP7 - Request limit Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Max Concurrent Requests:expr | Maximum number of concurrent requests | no | max-concurrent-requests:expr |
Queue Size:expr | Number of requests to queue before they start being rejected | no | queue-size:expr |
Note
3.4.1.4.1.8. EAP7 - Custom filter Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class Name | Class name of HttpHandler | yes | class-name |
Module | Module name where class can be loaded from | yes | module |
Parameters | Filter parameters | no | parameters |
Note
3.4.1.4.2. EAP7 - Handler configuration Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.4.2.1. EAP7 - File Handler - Undertow Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cache Buffer Size:expr | Size of the buffers. The default value is 1024. | no | cache-buffer-size:expr |
Cache Buffers:expr | Number of buffers. The default value is 1024. | no | cache-buffers:expr |
Case Sensitive | Use case sensitive file handling. The default value is true. | no | case-sensitive |
Directory Listing | Enable directory listing?. The default value is false. | no | directory-listing |
Follow Symlink | Enable following symbolic links. The default value is false. | no | follow-symlink |
Path | Path on filesystem from where file handler will serve resources | no | path |
Safe Symlink Paths | Paths that are safe to be targets of symbolic links | no | safe-symlink-paths |
Note
3.4.1.4.2.2. EAP7 - Reverse proxy Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cached Connections Per Thread:expr | The number of connections that will be kept alive indefinitely. The default value is 5. | no | cached-connections-per-thread:expr |
Connection Idle Timeout:expr | The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread). The default value is 60. | no | connection-idle-timeout:expr |
Connections Per Thread:expr | The 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:expr | The 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:expr | Time 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:expr | The 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 Names | Comma separated list of session cookie names. Generally this will just be JSESSIONID. The default value is JSESSIONID. | no | session-cookie-names |
Note
3.4.1.4.2.2.1. EAP7 - Reverse proxy host Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Instance Id | The instance id (aka JVM route) that will be used to enable sticky sessions | no | instance-id |
Outbound Socket Binding | Outbound socket binding for this host | no | outbound-socket-binding |
Path | Optional path if host is using non root resource. The default value is /. | no | path |
Scheme | What kind of scheme is used. The default value is http. | no | scheme |
Security Realm | The security realm that provides the SSL configuration for the connection to the host | no | security-realm |
Note
3.4.1.4.3. EAP7 - Buffer Cache Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Buffer Size:expr | The size of an individual buffer. The default value is 1024. | no | buffer-size:expr |
Buffers Per Region:expr | The numbers of buffers in a region. The default value is 1024. | no | buffers-per-region:expr |
Max Regions:expr | The maximum number of regions. The default value is 10. | no | max-regions:expr |
Note
Operations
Package Types
3.4.1.4.4. EAP7 - Server Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Host | The servers default virtual host. The default value is default-host. | no | default-host |
Servlet Container | The servers default servlet container. The default value is default. | no | servlet-container |
Note
Operations
Package Types
3.4.1.4.4.1. EAP7 - Ajp Listener Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Bytes Received | measurement | The number of bytes that have been received by this listener | bytes-received |
Bytes Sent | measurement | The number of bytes that have been sent out on this listener | bytes-sent |
Error Count | measurement | The number of 500 responses that have been sent by this listener | error-count |
Max Processing Time | measurement | The maximum processing time taken by a request on this listener | max-processing-time |
Processing Time | measurement | The total processing time of all requests handed by this listener | processing-time |
Request Count | measurement | The number of requests this listener has served | request-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Encoded Slash | If 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 Value | If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped. The default value is false. | no | allow-equals-in-cookie-value |
Always Set Keep Alive | If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. | no | always-set-keep-alive |
Buffer Pipelined Data | If we should buffer pipelined requests. The default value is true. | no | buffer-pipelined-data |
Buffer Pool | The AJP listeners buffer pool. The default value is default. | no | buffer-pool |
Decode Url | If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired. The default value is true. | no | decode-url |
Disallowed Methods | A comma separated list of HTTP methods that are not allowed | no | disallowed-methods |
Enabled | If the listener is enabled. The default value is true. | no | enabled |
Max Buffered Request Size:expr | Maximum 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:expr | The maximum number of concurrent connections. | no | max-connections:expr |
Max Cookies:expr | The 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:expr | The maximum size in bytes of a http request header. The default value is 1048576. | no | max-header-size:expr |
Max Headers:expr | The 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:expr | The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters). The default value is 1000. | no | max-parameters:expr |
Max Post Size:expr | The maximum size of a post that will be accepted. The default value is 10485760. | no | max-post-size:expr |
No Request Timeout:expr | The 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:expr | Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}. | no | read-timeout:expr |
Receive Buffer:expr | The receive buffer size. | no | receive-buffer:expr |
Record Request Start Time | If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact. The default value is false. | no | record-request-start-time |
Redirect Socket | If this listener is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here. | no | redirect-socket |
Request Parse Timeout:expr | The maximum amount of time (in milliseconds) that can be spent parsing the request | no | request-parse-timeout:expr |
Resolve Peer Address | Enables host dns lookup. The default value is false. | no | resolve-peer-address |
Scheme | The listener scheme, can be HTTP or HTTPS. By default the scheme will be taken from the incoming AJP request. | no | scheme |
Send Buffer:expr | The send buffer size. | no | send-buffer:expr |
Socket Binding | The AJP listener socket binder | yes | socket-binding |
Tcp Backlog:expr | Configure a server with the specified backlog. | no | tcp-backlog:expr |
Tcp Keep Alive | Configure a channel to send TCP keep-alive messages in an implementation-dependent manner. | no | tcp-keep-alive |
Url Charset | URL charset. The default value is UTF-8. | no | url-charset |
Worker | The AJP listeners XNIO worker. The default value is default. | no | worker |
Write Timeout:expr | Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}. | no | write-timeout:expr |
Note
3.4.1.4.4.2. EAP7 - Undertow Host Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Alias | Aliases for the host | no | alias |
Default Response Code:expr | If 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 Module | Default web module. The default value is ROOT.war. | no | default-web-module |
Disable Console Redirect | if set to true, /console redirect wont be enabled for this host, default is false. The default value is false. | no | disable-console-redirect |
Note
3.4.1.4.4.2.1. EAP7 - Host Filter Ref Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Predicate | Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition. | no | predicate |
Priority:expr | Defines filter order, it should be set to 1 or more, higher number instructs server to be included earlier in handler chain than others under same context. The default value is 1. | no | priority:expr |
Note
3.4.1.4.4.2.2. EAP7 - Undertow-Location Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Handler | Default handler for this location | yes | handler |
Note
3.4.1.4.4.2.2.1. EAP7 - Location Filter Ref Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Predicate | Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition. | no | predicate |
Priority:expr | Defines filter order, it should be set to 1 or more, higher number instructs server to be included earlier in handler chain than others under same context. The default value is 1. | no | priority:expr |
Note
3.4.1.4.4.3. EAP7 - Http Listener Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Bytes Received | measurement | The number of bytes that have been received by this listener | bytes-received |
Bytes Sent | measurement | The number of bytes that have been sent out on this listener | bytes-sent |
Error Count | measurement | The number of 500 responses that have been sent by this listener | error-count |
Max Processing Time | measurement | The maximum processing time taken by a request on this listener | max-processing-time |
Processing Time | measurement | The total processing time of all requests handed by this listener | processing-time |
Request Count | measurement | The number of requests this listener has served | request-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Encoded Slash | If 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 Value | If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped. The default value is false. | no | allow-equals-in-cookie-value |
Always Set Keep Alive | If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. | no | always-set-keep-alive |
Buffer Pipelined Data | If we should buffer pipelined requests. The default value is true. | no | buffer-pipelined-data |
Buffer Pool | The AJP listeners buffer pool. The default value is default. | no | buffer-pool |
Certificate Forwarding | If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers. The default value is false. | no | certificate-forwarding |
Decode Url | If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired. The default value is true. | no | decode-url |
Disallowed Methods | A comma separated list of HTTP methods that are not allowed | no | disallowed-methods |
Enable Http 2 | Enables HTTP2 support for this listener. The default value is false. | no | enable-http2 |
Enabled | If the listener is enabled. The default value is true. | no | enabled |
Max Buffered Request Size:expr | Maximum 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:expr | The maximum number of concurrent connections. | no | max-connections:expr |
Max Cookies:expr | The 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:expr | The maximum size in bytes of a http request header. The default value is 1048576. | no | max-header-size:expr |
Max Headers:expr | The 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:expr | The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters). The default value is 1000. | no | max-parameters:expr |
Max Post Size:expr | The maximum size of a post that will be accepted. The default value is 10485760. | no | max-post-size:expr |
No Request Timeout:expr | The 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 Forwarding | enables 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:expr | Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}. | no | read-timeout:expr |
Receive Buffer:expr | The receive buffer size. | no | receive-buffer:expr |
Record Request Start Time | If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact. The default value is false. | no | record-request-start-time |
Redirect Socket | If this listener is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here. | no | redirect-socket |
Request Parse Timeout:expr | The maximum amount of time (in milliseconds) that can be spent parsing the request | no | request-parse-timeout:expr |
Resolve Peer Address | Enables host dns lookup. The default value is false. | no | resolve-peer-address |
Send Buffer:expr | The send buffer size. | no | send-buffer:expr |
Socket Binding | The AJP listener socket binder | yes | socket-binding |
Tcp Backlog:expr | Configure a server with the specified backlog. | no | tcp-backlog:expr |
Tcp Keep Alive | Configure a channel to send TCP keep-alive messages in an implementation-dependent manner. | no | tcp-keep-alive |
Url Charset | URL charset. The default value is UTF-8. | no | url-charset |
Worker | The AJP listeners XNIO worker. The default value is default. | no | worker |
Write Timeout:expr | Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}. | no | write-timeout:expr |
Note
3.4.1.4.4.4. EAP7 - Https Listener Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Bytes Received | measurement | The number of bytes that have been received by this listener | bytes-received |
Bytes Sent | measurement | The number of bytes that have been sent out on this listener | bytes-sent |
Error Count | measurement | The number of 500 responses that have been sent by this listener | error-count |
Max Processing Time | measurement | The maximum processing time taken by a request on this listener | max-processing-time |
Processing Time | measurement | The total processing time of all requests handed by this listener | processing-time |
Request Count | measurement | The number of requests this listener has served | request-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Encoded Slash | If 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 Value | If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped. The default value is false. | no | allow-equals-in-cookie-value |
Always Set Keep Alive | If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. | no | always-set-keep-alive |
Buffer Pipelined Data | If we should buffer pipelined requests. The default value is true. | no | buffer-pipelined-data |
Buffer Pool | The AJP listeners buffer pool. The default value is default. | no | buffer-pool |
Decode Url | If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired. The default value is true. | no | decode-url |
Disallowed Methods | A comma separated list of HTTP methods that are not allowed | no | disallowed-methods |
Enable Http 2 | Enables HTTP2 support for this listener. The default value is false. | no | enable-http2 |
Enable Spdy | Enables SPDY support for this listener. The default value is false. | no | enable-spdy |
Enabled | If the listener is enabled. The default value is true. | no | enabled |
Enabled Cipher Suites | Configures Enabled SSL cyphers | no | enabled-cipher-suites |
Enabled Protocols | Configures SSL protocols | no | enabled-protocols |
Max Buffered Request Size:expr | Maximum 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:expr | The maximum number of concurrent connections. | no | max-connections:expr |
Max Cookies:expr | The 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:expr | The maximum size in bytes of a http request header. The default value is 1048576. | no | max-header-size:expr |
Max Headers:expr | The 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:expr | The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters). The default value is 1000. | no | max-parameters:expr |
Max Post Size:expr | The maximum size of a post that will be accepted. The default value is 10485760. | no | max-post-size:expr |
No Request Timeout:expr | The 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:expr | Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}. | no | read-timeout:expr |
Receive Buffer:expr | The receive buffer size. | no | receive-buffer:expr |
Record Request Start Time | If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact. The default value is false. | no | record-request-start-time |
Request Parse Timeout:expr | The maximum amount of time (in milliseconds) that can be spent parsing the request | no | request-parse-timeout:expr |
Resolve Peer Address | Enables host dns lookup. The default value is false. | no | resolve-peer-address |
Security Realm | The listeners security realm | yes | security-realm |
Send Buffer:expr | The send buffer size. | no | send-buffer:expr |
Socket Binding | The AJP listener socket binder | yes | socket-binding |
Ssl Session Cache Size:expr | The maximum number of active SSL sessions | no | ssl-session-cache-size:expr |
Ssl Session Timeout:expr | The timeout for SSL sessions, in seconds | no | ssl-session-timeout:expr |
Tcp Backlog:expr | Configure a server with the specified backlog. | no | tcp-backlog:expr |
Tcp Keep Alive | Configure a channel to send TCP keep-alive messages in an implementation-dependent manner. | no | tcp-keep-alive |
Url Charset | URL charset. The default value is UTF-8. | no | url-charset |
Verify Client | The desired SSL client authentication mode for SSL channels. The default value is NOT_REQUESTED. | no | verify-client |
Worker | The AJP listeners XNIO worker. The default value is default. | no | worker |
Write Timeout:expr | Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}. | no | write-timeout:expr |
Note
3.4.1.4.5. EAP7 - Servlet Container Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Check Interval:expr | Check interval for JSP updates using a background thread. The default value is 0. | no | check-interval:expr |
Development | Enable Development mode which enables reloading JSP on-the-fly. The default value is false. | no | development |
Disabled | Enable the JSP container. The default value is false. | no | disabled |
Display Source Fragment | When a runtime error occurs, attempts to display corresponding JSP source fragment. The default value is true. | no | display-source-fragment |
Dump Smap | Write SMAP data to a file. The default value is false. | no | dump-smap |
Error On Use Bean Invalid Class Attribute | Enable 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 Arrays | Generate String constants as char arrays. The default value is false. | no | generate-strings-as-char-arrays |
Java Encoding | Specify the encoding used for Java sources. The default value is UTF8. | no | java-encoding |
Keep Generated | Keep the generated Servlets. The default value is true. | no | keep-generated |
Mapped File | Map to the JSP source. The default value is true. | no | mapped-file |
Modification Test Interval:expr | Minimum amount of time between two tests for updates, in seconds. The default value is 4. | no | modification-test-interval:expr |
Optimize Scriptlets | If JSP scriptlets should be optimised to remove string concatenation. The default value is false. | no | optimize-scriptlets |
Recompile On Fail | Retry failed JSP compilations on each request. The default value is false. | no | recompile-on-fail |
Scratch Dir | Specify a different work directory. | no | scratch-dir |
Smap | Enable SMAP. The default value is true. | no | smap |
Source Vm | Source VM level for compilation. The default value is 1.8. | no | source-vm |
Tag Pooling | Enable tag pooling. The default value is true. | no | tag-pooling |
Target Vm | Target VM level for compilation. The default value is 1.8. | no | target-vm |
Trim Spaces | Trim some spaces from the generated Servlet. The default value is false. | no | trim-spaces |
X Powered By | Enable advertising the JSP engine in x-powered-by. The default value is true. | no | x-powered-by |
Buffer Pool | The buffer pool to use for websocket deployments. The default value is default. | no | buffer-pool |
Dispatch To Worker | If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations. The default value is true. | no | dispatch-to-worker |
Worker | The worker to use for websocket deployments. The default value is default. | no | worker |
Allow Non Standard Wrappers | If 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 Cache | The buffer cache to use for caching static resources. The default value is default. | no | default-buffer-cache |
Default Encoding | Default encoding to use for all deployed applications | no | default-encoding |
Default Session Timeout:expr | The default session timeout (in minutes) for all applications deployed in the container. The default value is 30. | no | default-session-timeout:expr |
Directory Listing | If directory listing should be enabled for default servlets. | no | directory-listing |
Disable Caching For Secured Pages | If Undertow should set headers to disable caching for secured paged. Disabling this can cause security problems, as sensitive pages may be cached by an intermediary. The default value is true. | no | disable-caching-for-secured-pages |
Eager Filter Initialization | If true undertow calls filter init() on deployment start rather than when first requested. The default value is false. | no | eager-filter-initialization |
Ignore Flush | Ignore 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:expr | The maximum number of sessions that can be active at one time | no | max-sessions:expr |
Proactive Authentication | If 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:expr | The 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 Error | If 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 Encoding | Use encoding defined on listener. The default value is false. | no | use-listener-encoding |
Note
Operations
Package Types
3.4.1.4.5.1. EAP7 - Mime Mapping Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The mime type for this mapping | yes | value |
Note
3.4.1.4.5.2. EAP7 - Welcome File Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.5. EAP7 - General JCA connectors Service
Overview
Description: | General settings of the JCA engine. Not necessarily for end-users |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Workmanager Short Running Thread Pool | Specify the name of short running thread pool | yes | default-workmanager-short-running-thread-pool |
Default Workmanager Long Running Thread Pool | Specify the name of long running thread pool | yes | default-workmanager-long-running-thread-pool |
Bean Validation Enabled | Specify whether bean validation is enabled | yes | bean-validation-enabled |
Archive Validation Enabled | Enabling the validation | yes | archive-validation-enabled |
Archive Validation Fail On Error | Should an archive validation error report fail the deployment. Default: true | yes | archive-validation-fail-on-error |
Archive Validation Fail On Warn | Should an archive validation warning report fail the deployment. Default: false | yes | archive-validation-fail-on-warn |
Cached Connection Manager Debug | enable/disable debug information logging for cached connection manager | yes | cached-connection-manager-debug |
Cached Connection Manager Error | enable/disable error information logging for cached connection manager | yes | cached-connection-manager-error |
Note
Operations
Package Types
3.4.1.6. EAP7 - Datasources (Standalone) Service
Overview
Description: | Datasources subsystem for Standalone servers. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Available drivers | yes | *4 |
Note
Operations
Package Types
3.4.1.6.1. EAP7 - DataSource (Standalone) Service
Overview
Description: | A non-XA data source |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Connection Property | no | *1 | |
Connection Url | The JDBC driver connection URL | yes | connection-url |
Driver Name | Name of the (existing) JDBC driver to use | yes | driver-name |
Driver Class | The fully qualified name of the JDBC driver class | no | driver-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver | Defines 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 Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Jta | Enable JTA integration | no | jta |
Max Pool Size | The 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 Size | The 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 Prefill | Whether 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 Min | Define if the min-pool-size should be considered a strictly. Existing value cannot be unset. | no | pool-use-strict-min |
Security Domain | Indicates 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 Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Allow Multiple Users | Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that | no | allow-multiple-users |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | Indicates the time in milliseconds to wait between retrying to allocate a connection. | no | allocation-retry-wait-millis |
Blocking Timeout Wait Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Note
Operations
Name | Description |
---|---|
Enable | Enables the data-source. Note this operation will not be supported runtime in next versions. |
Disable | Disables the data-source. Note this operation will not be supported runtime in next versions. |
Flush All Connection In Pool | Flushes the pool for all connections |
Flush Idle Connection In Pool | Flushes the pool for idle connections |
Test Connection In Pool | Tests if a connection can be obtained |
Package Types
3.4.1.6.2. EAP7 - XADataSource (Standalone) Service
Overview
Description: | An XA data source |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | yes | *2 | |
Xa Datasource Class | The fully qualified name of the javax.sql.XADataSource implementation | yes | xa-datasource-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver Name | Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit | yes | driver-name |
User Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether 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 Min | Define if the min-pool-size should be considered a strictly. Existing value cannot be unset. | no | pool-use-strict-min |
Interleaving | An element to enable interleaving for XA connection factories | no | interleaving |
No Tx Separate Pool | Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different context | no | no-tx-separate-pool |
Pad Xid | Should the Xid be padded | no | pad-xid |
Same Rm Override | The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false | no | same-rm-override |
Wrap Xa Datasource | Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance | no | wrap-xa-datasource |
Security Domain | Indicates 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 Name | recovery plugin implementation provided for specific purpose (i.e vendor) | no | recovery-plugin-class-name |
Reauth Plugin Class Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | he 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 Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 Timeout | Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds | no | xa-resource-timeout |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Recovery Username | username used to try connection recovery | no | recovery-username |
Recovery Password | password used to try connection recovery | no | recovery-password |
Recovery Security Domain | security-domain used to try connection recovery | no | recovery-security-domain |
No Recovery | if true no recovery are tried for this connection pool | no | no-recovery |
Note
Operations
Name | Description |
---|---|
Enable | Enables the data-source. Note this operation will not be supported runtime in next versions. |
Disable | Disables the data-source. Note this operation will not be supported runtime in next versions. |
Flush All Connection In Pool | Flushes the pool for all connections |
Flush Idle Connection In Pool | Flushes the pool for idle connections |
Test Connection In Pool | Tests if a connection can be obtained |
Package Types
3.4.1.7. EAP7 - Logging Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Handlers | The Handlers associated with this Logger. | yes | handlers |
Note
Operations
Package Types
3.4.1.7.1. EAP7 - Async Handler Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Overflow Action | Specify what action to take when the overflowing. The valid options are 'block' and 'discard'. The default value is BLOCK. | yes | overflow-action |
Queue Length | The queue length to use before flushing writing | yes | queue-length |
Subhandlers | The Handlers associated with this async handler. | no | subhandlers |
Note
Operations
Name | Description |
---|---|
Assign Subhandler | Assign a subhandler to the ASYNC handler. |
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
Unassign Subhandler | Unassign a subhandler from the ASYNC handler. |
Package Types
3.4.1.7.2. EAP7 - Console Handler Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Target | Defines 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
Operations
Name | Description |
---|---|
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
Package Types
3.4.1.7.3. EAP7 - Custom Handler Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Class | The logging handler class to be used. | yes | class |
Encoding | The character encoding used by this Handler. | no | encoding |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Module | The module that the logging handler depends on. | yes | module |
Properties | yes | properties |
Note
Operations
Name | Description |
---|---|
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
Package Types
3.4.1.7.4. EAP7 - File Handler Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Append | Specify whether to append to the target file. The default value is true. | no | append |
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
File | The file description consisting of the path and optional relative to path. | no | file |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Note
Operations
Name | Description |
---|---|
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
Package Types
3.4.1.7.5. EAP7 - Logger Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Handlers | The Handlers associated with this Logger. | no | handlers |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Use Parent Handlers | Specifies whether or not this logger should send its output to it's parent Logger. The default value is true. | no | use-parent-handlers |
Note
Operations
Name | Description |
---|---|
Change Log Level | Change the logging level for a logger category. |
Package Types
3.4.1.7.6. EAP7 - Periodic Rotating File Handler Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Append | Specify whether to append to the target file. The default value is true. | no | append |
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
File | The file description consisting of the path and optional relative to path. | no | file |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Suffix | Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix. | yes | suffix |
Note
Operations
Name | Description |
---|---|
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
Package Types
3.4.1.7.7. EAP7 - Size Rotating File Handler Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Append | Specify whether to append to the target file. The default value is true. | no | append |
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
File | The file description consisting of the path and optional relative to path. | no | file |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Max Backup Index | The maximum number of backups to keep. The default value is 1. | yes | max-backup-index |
Rotate Size | The size at which to rotate the log file. The default value is 2m. | yes | rotate-size |
Note
Operations
Name | Description |
---|---|
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
Package Types
3.4.1.8. EAP7 - Webservices Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Modify Wsdl Address | Whether the soap address can be modified. | no | modify-wsdl-address |
Wsdl Host | The 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 Port | The 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 Port | The 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
Operations
Package Types
3.4.1.8.1. EAP7 - Endpoint Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.8.1.1. EAP7 - Post Handler Chain Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
3.4.1.8.1.1.1. EAP7 - Post Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | Handler class | yes | class |
Note
3.4.1.8.1.2. EAP7 - Pre Handler Chain Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
3.4.1.8.1.2.1. EAP7 - Pre Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | Handler class | yes | class |
Note
3.4.1.8.1.3. EAP7 - Property Service
Description: | A property |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The property value. | no | value |
Note
3.4.1.9. EAP7 - Naming Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Name | Description |
---|---|
JNDIView | Peek at the JNDI tree |
Package Types
3.4.1.9.1. EAP7 - Binding Service
Overview
Description: | JNDI bindings for primitive types |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Binding Type | The type of binding to create, may be simple, lookup or object-factory | yes | binding-type |
Class | The object factory class name for object factory bindings | no | class |
Lookup | The entry to lookup in JNDI for lookup bindings | no | lookup |
Module | The module to load the object factory from for object factory bindings | no | module |
Type | The type of the value to bind for simple bindings, this must be a primitive type | no | type |
Value | The value to bind for simple bindings | no | value |
Note
Operations
Package Types
3.4.1.10. EAP7 - Transactions Subsystem (Standalone) Service
Overview
Description: | The transactions subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Number Of Nested Transactions | measurement | The total number of nested (sub) transactions created. | number-of-nested-transactions |
Number Of Nested Transactions per Minute | measurement | The total number of nested (sub) transactions created. | number-of-nested-transactions |
Number Of Timed Out Transactions | measurement | The number of transactions that have rolled back due to timeout. | number-of-timed-out-transactions |
Number Of Timed Out Transactions per Minute | measurement | The number of transactions that have rolled back due to timeout. | number-of-timed-out-transactions |
Number Of Committed Transactions | measurement | The number of committed transactions. | number-of-committed-transactions |
Number Of Committed Transactions per Minute | measurement | The number of committed transactions. | number-of-committed-transactions |
Number Of Transactions | measurement | The total number of transactions (top-level and nested) created | number-of-transactions |
Number Of Transactions per Minute | measurement | The total number of transactions (top-level and nested) created | number-of-transactions |
Number Of Heuristics | measurement | The number of transactions which have terminated with heuristic outcomes. | number-of-heuristics |
Number Of Heuristics per Minute | measurement | The number of transactions which have terminated with heuristic outcomes. | number-of-heuristics |
Number Of Aborted Transactions | measurement | The number of aborted (i.e. rolledback) transactions. | number-of-aborted-transactions |
Number Of Aborted Transactions per Minute | measurement | The number of aborted (i.e. rolledback) transactions. | number-of-aborted-transactions |
Number Of Inflight Transactions | measurement | The number of transactions that have begun but not yet terminated. | number-of-inflight-transactions |
Number Of Inflight Transactions per Minute | measurement | The number of transactions that have begun but not yet terminated. | number-of-inflight-transactions |
Number Of Application Rollbacks | measurement | The 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 Minute | measurement | The 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 Rollbacks | measurement | The number of transactions that rolled back due to resource (participant) failure. | number-of-resource-rollbacks |
Number Of Resource Rollbacks per Minute | measurement | The number of transactions that rolled back due to resource (participant) failure. | number-of-resource-rollbacks |
Note
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Process Id Uuid | Indicates whether the transaction manager should use a UUID based process id. | no | process-id-uuid |
Socket Binding | Used to reference the correct socket binding to use for the recovery environment. | yes | socket-binding |
Jts | If true this enables the Java Transaction Service. The default value is false. | no | jts |
Object Store Path | Denotes a relative or absolute filesystem path denoting where the transaction manager object store should store data. By default the value is treated as relative to the path denoted by the 'relative-to' attribute. The default value is tx-object-store. | no | object-store-path |
Process Id Socket Binding | The name of the socket binding configuration to use if the transaction manager should use a socket-based process id. Will be 'undefined' if 'process-id-uuid' is 'true'; otherwise must be set. | no | process-id-socket-binding |
Default Timeout | The default timeout. The default value is 300. | no | default-timeout |
Process Id Socket Max Ports | The maximum number of ports to search for an open port if the transaction manager should use a socket-based process id. If the port specified by the socket binding referenced in 'process-id-socket-binding' is occupied, the next higher port will be tried until an open port is found or the number of ports specified by this attribute have been tried. Will be 'undefined' if 'process-id-uuid' is 'true'. The default value is 10. | no | process-id-socket-max-ports |
Recovery Listener | Used to specify if the recovery system should listen on a network socket or not. The default value is false. | no | recovery-listener |
Status Socket Binding | Used to reference the correct socket binding to use for the transaction status manager. | no | status-socket-binding |
Node Identifier | Used to set the node identifier on the core environment. The default value is 1. | no | node-identifier |
Enable Tsm Status | Whether 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 To | References 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 Statistics | Whether statistics should be enabled. The default value is false. | no | enable-statistics |
Note
Operations
Package Types
3.4.1.10.1. EAP7 - Log Store (Standalone) Service
Overview
Description: | Representation of the transaction logging storage mechanism. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Type | Specifies the implementation type of the logging store. | no | type |
Note
Operations
Name | Description |
---|---|
Probe | Scan for new transaction logs. This operation will creates a child for each pending transaction. |
Package Types
3.4.1.10.1.1. EAP7 - Transactions (Standalone) Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Age In Seconds | The time since this transaction was prepared or when the recovery system last tried to recover it. | no | age-in-seconds |
Id | The id of this transaction. | no | id |
Jmx Name | The JMX name of this transaction. | no | jmx-name |
Type | The type name under which this record is stored. | no | type |
Note
Name | Description |
---|---|
Delete | Remove 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. |
3.4.1.10.1.1.1. EAP7 - Participants (Standalone) Service
Description: | The resources that did work in a transaction. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Eis Product Name | The JCA enterprise information system's product name. | no | eis-product-name |
Eis Product Version | The JCA enterprise information system's product version | no | eis-product-version |
Jmx Name | The JMX name of this participant. | no | jmx-name |
Jndi Name | JNDI name of this participant. | no | jndi-name |
Status | Reports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly). | no | status |
Type | The type name under which this record is stored. | no | type |
Note
Name | Description |
---|---|
Recover | If this record is in a heuristic state then attempt to replay the commit phase of the 2PC transaction. |
Refresh | Refresh 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). |
3.4.1.11. EAP7 - Network Interface Service
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
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Any Address | Attribute 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 Address | Attribute 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 |
Loopback | Attribute 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 Address | Attribute 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 |
Multicast | Attribute 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 |
Nic | Attribute 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 Match | Attribute 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 Point | Attribute 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 Address | Attribute 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 Address | Attribute 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 Match | Attribute 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 |
Up | Attribute 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 |
Virtual | Attribute 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 Address | Attribute 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
Operations
Package Types
3.4.1.12. EAP7 - SocketBindingGroup Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Bindings | yes | * | |
Bindings | yes | *1 | |
Bindings | yes | *2 | |
Default Interface | Default Interface for these bindings. See Network Interfaces for its definition | yes | default-interface |
Port Offset | Offset from standard ports for this group. This is only available in standalone mode | no | port-offset |
Note
Operations
Package Types
3.4.1.13. EAP7 - Deployment Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Status | trait | The 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
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Content | List of pieces of content that comprise the deployment. | yes | content |
Enabled | Boolean 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 |
Name | Unique identifier of the deployment. Must be unique across all deployments. | no | name |
Persistent | Boolean 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 Name | Name 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
Operations
Name | Description |
---|---|
Enable | |
Disable | |
Restart |
Package Types
Name | Category | Description |
---|---|---|
File | Deployable | Deployments on this server group |
3.4.1.13.1. EAP7 - EJB3 Runtime Service
Overview
Description: | Runtime resources exposed by EJBs components included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.13.1.1. EAP7 - Message Driven Bean Runtime Service
Description: | Bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.1.13.1.2. EAP7 - Singleton Bean Runtime Service
Description: | Singleton bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.1.13.1.3. EAP7 - Stateless Session Bean Runtime Service
Description: | Stateless session bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.1.13.1.4. EAP7 - Entity Bean Runtime Service
Description: | Entity bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Note
3.4.1.13.1.5. EAP7 - Stateful Session Bean Runtime Service
Description: | Stateful session bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Note
3.4.1.13.2. EAP7 - Subdeployment Service
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
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.13.2.1. EAP7 - EJB3 Runtime Service
Description: | Runtime resources exposed by EJBs components included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.13.2.1.1. EAP7 - Message Driven Bean Runtime Service
Description: | Bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.1.13.2.1.2. EAP7 - Singleton Bean Runtime Service
Description: | Singleton bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.1.13.2.1.3. EAP7 - Stateless Session Bean Runtime Service
Description: | Stateless session bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.1.13.2.1.4. EAP7 - Entity Bean Runtime Service
Description: | Entity bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Note
3.4.1.13.2.1.5. EAP7 - Stateful Session Bean Runtime Service
Description: | Stateful session bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Note
3.4.1.13.2.2. EAP7 - Resource Adapters Runtime Service
Description: | Configuration of the resource adapters subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.13.2.2.1. EAP7 - Connection Definition Runtime Service
Description: | Specifies the connection definitions. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Note
3.4.1.13.2.3. EAP7 - Web Runtime Service
Description: | Runtime resources exposed by web components in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Response Time Log File | the full path to the log file containing response-time stats for this webapp | no | responseTimeLogFile |
Response Time Url Excludes | a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection | no | responseTimeUrlExcludes |
Response Time Url Transforms | a 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
Name | Type | Description | Internal Name |
---|---|---|---|
Virtual Host | trait | the virtual host this webapp is deployed to | virtual-host |
Context Root | trait | the context root of this webapp | context-root |
Server | trait | The name of server this application belongs to | server |
Response Time | calltime | the minimum, maximum, and average response times for requests serviced by this webapp | responseTime |
Currently Active Sessions | measurement | The number of sessions that are currently active | active-sessions |
Expired Sessions | measurement | The number of expired sessions | expired-sessions |
Expired Sessions per Minute | measurement | The number of expired sessions | expired-sessions |
Maximum Active Sessions | measurement | The maximum number of sessions that have been active | max-active-sessions |
Rejected Sessions | measurement | The number of sessions rejected | rejected-sessions |
Rejected Sessions per Minute | measurement | The number of sessions rejected | rejected-sessions |
Average Session Alive Time | measurement | The average alive time of sessions | session-avg-alive-time |
Max Session Alive Time | measurement | The maximum alive time of sessions | session-max-alive-time |
Created Sessions | measurement | The number of sessions created | sessions-created |
Created Sessions per Minute | measurement | The number of sessions created | sessions-created |
Note
3.4.1.13.2.4. EAP7 - JPA Runtime Service
Description: | The configuration of the JPA subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.13.2.4.1. EAP7 - Hibernate Persistence Unit Service
Description: | Runtime information about JPA use in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Close Statement Count | measurement | Number of released prepared statements. | close-statement-count |
Close Statement Count per Minute | measurement | Number of released prepared statements. | close-statement-count |
Collection Fetch Count | measurement | Number of collections fetched. | collection-fetch-count |
Collection Fetch Count per Minute | measurement | Number of collections fetched. | collection-fetch-count |
Collection Load Count | measurement | Number of collections loaded. | collection-load-count |
Collection Load Count per Minute | measurement | Number of collections loaded. | collection-load-count |
Collection Recreated Count | measurement | Number of collections recreated. | collection-recreated-count |
Collection Recreated Count per Minute | measurement | Number of collections recreated. | collection-recreated-count |
Collection Remove Count | measurement | Number of collections removed. | collection-remove-count |
Collection Remove Count per Minute | measurement | Number of collections removed. | collection-remove-count |
Collection Update Count | measurement | Number of collections updated. | collection-update-count |
Collection Update Count per Minute | measurement | Number of collections updated. | collection-update-count |
Completed Transaction Count | measurement | Number of completed transactions. | completed-transaction-count |
Completed Transaction Count per Minute | measurement | Number of completed transactions. | completed-transaction-count |
Connect Count | measurement | Get the number of connections asked for by the sessions. | connect-count |
Connect Count per Minute | measurement | Get the number of connections asked for by the sessions. | connect-count |
Entity Delete Count | measurement | Get number of entity deletes. | entity-delete-count |
Entity Delete Count per Minute | measurement | Get number of entity deletes. | entity-delete-count |
Entity Fetch Count | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Fetch Count per Minute | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Insert Count | measurement | Get number of entity inserts. | entity-insert-count |
Entity Insert Count per Minute | measurement | Get number of entity inserts. | entity-insert-count |
Entity Load Count | measurement | Get number of entity loads. | entity-load-count |
Entity Load Count per Minute | measurement | Get number of entity loads. | entity-load-count |
Entity Update Count | measurement | Get number of entity updates. | entity-update-count |
Entity Update Count per Minute | measurement | Get number of entity updates. | entity-update-count |
Flush Count | measurement | Get the number of flushes executed by sessions (either implicit or explicit). | flush-count |
Flush Count per Minute | measurement | Get the number of flushes executed by sessions (either implicit or explicit). | flush-count |
Optimistic Failure Count | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Optimistic Failure Count per Minute | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Prepared Statement Count | measurement | Number of acquired prepared statements. | prepared-statement-count |
Prepared Statement Count per Minute | measurement | Number of acquired prepared statements. | prepared-statement-count |
Query Cache Hit Count | measurement | Get the number of cached queries successfully retrieved from cache. | query-cache-hit-count |
Query Cache Hit Count per Minute | measurement | Get the number of cached queries successfully retrieved from cache. | query-cache-hit-count |
Query Cache Miss Count | measurement | Get the number of cached queries not found in cache. | query-cache-miss-count |
Query Cache Miss Count per Minute | measurement | Get the number of cached queries not found in cache. | query-cache-miss-count |
Query Cache Put Count | measurement | Get the number of cacheable queries put in cache. | query-cache-put-count |
Query Cache Put Count per Minute | measurement | Get the number of cacheable queries put in cache. | query-cache-put-count |
Query Execution Count | measurement | Get number of executed queries. | query-execution-count |
Query Execution Count per Minute | measurement | Get number of executed queries. | query-execution-count |
Query Execution Max Time | measurement | Get the time in milliseconds of the slowest query. | query-execution-max-time |
Query Execution Max Time Query String | trait | Get the query string for the slowest query. | query-execution-max-time-query-string |
Second Level Cache Hit Count | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | second-level-cache-hit-count |
Second Level Cache Hit Count per Minute | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | second-level-cache-hit-count |
Second Level Cache Miss Count | measurement | Number of cacheable entities/collections not found in the cache and loaded. | second-level-cache-miss-count |
Second Level Cache Miss Count per Minute | measurement | Number of cacheable entities/collections not found in the cache and loaded. | second-level-cache-miss-count |
Second Level Cache Put Count | measurement | Number of cacheable entities/collections put in the cache. | second-level-cache-put-count |
Second Level Cache Put Count per Minute | measurement | Number of cacheable entities/collections put in the cache. | second-level-cache-put-count |
Session Close Count | measurement | Number of sessions closed. | session-close-count |
Session Close Count per Minute | measurement | Number of sessions closed. | session-close-count |
Session Open Count | measurement | Number of sessions opened. | session-open-count |
Session Open Count per Minute | measurement | Number of sessions opened. | session-open-count |
Successful Transaction Count | measurement | Number of successful transactions. | successful-transaction-count |
Successful Transaction Count per Minute | measurement | Number of successful transactions. | successful-transaction-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Enabled | Determine if statistics are enabled. | no | enabled |
Note
Name | Description |
---|---|
Subsystem:clear | Clear statistics. |
Subsystem:evict All | Evict all entities from second level cache. |
Subsystem:summary | Log the statistics. |
View Queries | View statistical information about queries executed by Hibernate |
3.4.1.13.2.4.1.1. EAP7 - Entity Cache Service
Description: | Statistics for a Hibernate Second Level Cache region. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Element Count In Memory | measurement | Number of cacheable entities/collections currently stored in memory. | element-count-in-memory |
Hit Count | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | hit-count |
Miss Count | measurement | Number of cacheable entities/collections not found in the cache and loaded. | miss-count |
Put Count | measurement | Number of cacheable entities/collections put in the cache. | put-count |
Note
3.4.1.13.2.4.1.2. EAP7 - Entity Service
Description: | Statistics for individual entities. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Entity Delete Count | measurement | Get number of entity deletes. | entity-delete-count |
Entity Delete Count per Minute | measurement | Get number of entity deletes. | entity-delete-count |
Entity Fetch Count | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Fetch Count per Minute | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Insert Count | measurement | Get number of entity inserts. | entity-insert-count |
Entity Insert Count per Minute | measurement | Get number of entity inserts. | entity-insert-count |
Entity Load Count | measurement | Get number of entity loads. | entity-load-count |
Entity Load Count per Minute | measurement | Get number of entity loads. | entity-load-count |
Entity Update Count | measurement | Get number of entity updates. | entity-update-count |
Entity Update Count per Minute | measurement | Get number of entity updates. | entity-update-count |
Optimistic Failure Count | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Optimistic Failure Count per Minute | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Note
3.4.1.13.2.4.1.3. EAP7 - Collection Service
Description: | Statistics for individual collections. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Collection Fetch Count | measurement | Number of times collection was fetched. | collection-fetch-count |
Collection Fetch Count per Minute | measurement | Number of times collection was fetched. | collection-fetch-count |
Collection Load Count | measurement | Number of times collection was loaded. | collection-load-count |
Collection Load Count per Minute | measurement | Number of times collection was loaded. | collection-load-count |
Collection Recreated Count | measurement | Number of times collection was recreated. | collection-recreated-count |
Collection Recreated Count per Minute | measurement | Number of times collection was recreated. | collection-recreated-count |
Collection Remove Count | measurement | Number of times collection was removed. | collection-remove-count |
Collection Remove Count per Minute | measurement | Number of times collection was removed. | collection-remove-count |
Collection Update Count | measurement | Number of times collection was updated. | collection-update-count |
Collection Update Count per Minute | measurement | Number of times collection was updated. | collection-update-count |
Note
3.4.1.13.2.5. EAP7 - Messaging Runtime Service
Description: | Runtime resources exposed by messaging resources included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.13.2.5.1. EAP7 - ActiveMQ Artemis Server Runtime Service
Description: | A ActiveMQ Artemis server instance. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.13.2.5.1.1. EAP7 - JMS Queue Runtime Service
Description: | Defines a JMS queue. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Consumer Count | measurement | The number of consumers consuming messages from this queue. | consumer-count |
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Dead Letter Address | trait | The address to send dead messages to. | dead-letter-address |
Durable | trait | Whether the queue is durable or not. The default value is true. | durable |
Expiry Address | trait | The address to send expired messages to. | expiry-address |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Paused | trait | Whether the queue is paused. | paused |
Queue Address | trait | The queue address defines what address is used for routing messages. | queue-address |
Scheduled Count | measurement | The number of scheduled messages in this queue. | scheduled-count |
Selector | trait | The queue selector. | selector |
Temporary | trait | Whether the queue is temporary. | temporary |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Entries | The jndi names the queue will be bound to. | no | entries |
Note
Name | Description |
---|---|
Change Message Priority | Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Change Messages Priority | Change the priority of the messages corresponding to the given filter. Returns the number of removed messages. |
Count Messages | Returns the number of the messages in the queue matching the given filter. |
Expire Message | Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Expire Messages | Expire the messages matching the given filter. |
List Consumers as JSON | A string in JSON format. |
Subsystem:list Delivering Messages | List the messages are currently being delivered. |
Subsystem:list Delivering Messages As Json | List the messages are currently being delivered as a string in JSON format |
List Message Counter as HTML | List the message counter as a string in HTML format. |
List Message Counter as JSON | List the message counter as a string in JSON format. |
List Message Counter History as HTML | List the message counter history. |
List Message Counter History as JSON | List the message counter history as a string in JSON format. |
List Messages | List all messages in the queue that match the filter |
List Messages as JSON | List all messages in the queue that match the filter and return them as a string in JSON format. |
Move Message | Move the message corresponding to the given message-id to another queue |
Move Messages | Move the messages corresponding to the given filter to another queue. |
Pause | Pause the queue. |
Remove Message | Remove the message corresponding to the given message-id. |
Remove Messages | Remove messages matching the given filter from the destination. |
Reset Message Counter | Reset the message counters. |
Resume | Resume the queue. |
Send Message to Dead Letter Address | Send the message corresponding to the given message-id to this queue's Dead Letter Address. |
Send Messages to Dead Letter Address | Send the messages corresponding to the given filter to this queue's Dead Letter Address. |
3.4.1.13.2.5.1.2. EAP7 - JMS Topic Runtime Service
Description: | Defines a JMS queue. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Durable Message Count | measurement | The number of messages for all durable subscribers for this topic. | durable-message-count |
Durable Subscription Count | measurement | The number of durable subscribers for this topic. | durable-subscription-count |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Non Durable Message Count | measurement | The number of messages for all non-durable subscribers for this topic. | non-durable-message-count |
Non Durable Subscription Count | measurement | The number of non-durable subscribers for this topic. | non-durable-subscription-count |
Subscription Count | measurement | The number of (durable and non-durable) subscribers for this topic. | subscription-count |
Temporary | trait | Whether the topic is temporary. | temporary |
Topic Address | trait | The address the topic points to. | topic-address |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
JNDI Names | The jndi names the queue will be bound to. | no | entries |
Note
Name | Description |
---|---|
Count Messages for Subscription | Count the number of messages matching the filter for the given subscription. |
Drop All Subscriptions | Drop all subscriptions from this topic. |
Drop Durable Subscription | Drop a durable subscription |
List All Subscriptions | List all subscriptions. |
List All Subscriptions as JSON | List all subscriptions as a string in JSON format. |
List Durable Subscriptions | List only the durable subscriptions. |
List Durable Subscriptions as JSON | List only the durable subscriptions, as a string in JSON format. |
List Messages for Subscription | List all the messages for the given subscription. |
List Messages for Subscription as JSON | List all the messages for the given subscription as a string in JSON format. |
List Non-Durable Subscriptions | List only the non-durable subscriptions. |
List Non-Durable Subscriptions as JSON | List only the non-durable subscriptions, as a string in JSON format. |
Remove Messages | Remove messages matching the given filter from the destination. |
3.4.1.13.2.5.1.3. EAP7 - Pooled Connection Factory Runtime Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Auto Group | The autogroup. The default value is false. | no | auto-group |
Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
Call Failover Timeout:expr | The timeout to use when fail over is in process (in ms). The default value is -1. | no | call-failover-timeout:expr |
Call Timeout:expr | The call time out. The default value is 30000. | no | call-timeout:expr |
Client Failure Check Period:expr | The client failure check period. The default value is 30000. | no | client-failure-check-period:expr |
Client Id | The client id. | no | client-id |
Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
Confirmation Window Size:expr | The confirmation window size. The default value is -1. | no | confirmation-window-size:expr |
Connection Load Balancing Policy Class Name | Name 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:expr | The connection ttl. The default value is 60000. | no | connection-ttl:expr |
Connectors | Defines 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:expr | The consumer max rate. The default value is -1. | no | consumer-max-rate:expr |
Consumer Window Size:expr | The consumer window size. The default value is 1048576. | no | consumer-window-size:expr |
Discovery Group | The discovery group name. | no | discovery-group |
Dups Ok Batch Size:expr | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size:expr |
Enlistment Trace | Enables 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 |
Entries | The jndi names the connection factory should be bound to. | yes | entries |
Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
Group Id | The group id. | no | group-id |
Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
Initial Connect Attempts:expr | The number of attempts to connect initially with this factory. The default value is 1. | no | initial-connect-attempts:expr |
Initial Message Packet Size:expr | The initial size of messages created through this factory. The default value is 1500. | no | initial-message-packet-size:expr |
Jndi Params | The JNDI params to use for locating the destination for incoming connections. | no | jndi-params |
Managed Connection Pool | The class name of the managed connection pool used by this pooled-connection-factory. | no | managed-connection-pool |
Max Pool Size:expr | The maximum size for the pool. The default value is -1. | no | max-pool-size:expr |
Max Retry Interval:expr | The max retry interval. The default value is 2000. | no | max-retry-interval:expr |
Min Large Message Size:expr | The min large message size. The default value is 102400. | no | min-large-message-size:expr |
Min Pool Size:expr | The minimum size for the pool. The default value is -1. | no | min-pool-size:expr |
Password | The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host. | no | password |
Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
Producer Max Rate:expr | The producer max rate. The default value is -1. | no | producer-max-rate:expr |
Producer Window Size:expr | The producer window size. The default value is 65536. | no | producer-window-size:expr |
Protocol Manager Factory | The protocol manager factory used by this pooled connection factory. | no | protocol-manager-factory |
Reconnect Attempts:expr | The 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:expr | The retry interval. The default value is 2000. | no | retry-interval:expr |
Retry Interval Multiplier:expr | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier:expr |
Scheduled Thread Pool Max Size:expr | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Setup Attempts:expr | The number of times to set up an MDB endpoint | no | setup-attempts:expr |
Setup Interval:expr | The interval between attempts at setting up an MDB endpoint. | no | setup-interval:expr |
Thread Pool Max Size:expr | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
Transaction | TODO. The default value is transaction. | no | transaction |
Transaction Batch Size:expr | The transaction batch size. The default value is 1048576. | no | transaction-batch-size:expr |
Use Auto Recovery | True to use auto recovery. The default value is true. | no | use-auto-recovery |
Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Use Jndi | Use JNDI to locate the destination for incoming connections | no | use-jndi |
Use Local Tx | Use a local transaction for incoming sessions | no | use-local-tx |
User | The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host. | no | user |
Note
3.4.1.13.2.6. EAP7 - Datasources Runtime Service
Description: | Runtime resources exposed by data sources included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.13.2.6.1. EAP7 - XA Datasource Runtime Service
Description: | A JDBC XA data-source configuration |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | no | *2 | |
Xa Datasource Class | The fully qualified name of the javax.sql.XADataSource implementation | yes | xa-datasource-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver Name | Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit | yes | driver-name |
User Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether to attempt to prefill the connection pool. Changing this value require a server restart. | no | pool-prefill |
Pool Use Strict Min | Define if the min-pool-size should be considered a strictly. | no | pool-use-strict-min |
Interleaving | An element to enable interleaving for XA connection factories | no | interleaving |
No Tx Separate Pool | Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different context | no | no-tx-separate-pool |
Pad Xid | Should the Xid be padded | no | pad-xid |
Same Rm Override | The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false | no | same-rm-override |
Wrap Xa Datasource | Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance | no | wrap-xa-datasource |
Security Domain | Indicates 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 Name | recovery plugin implementation provided for specific purpose (i.e vendor) | no | recovery-plugin-class-name |
Reauth Plugin Class Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | he 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 Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 Timeout | Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds | no | xa-resource-timeout |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Recovery Username | username used to try connection recovery | no | recovery-username |
Recovery Password | password used to try connection recovery | no | recovery-password |
Recovery Security Domain | security-domain used to try connection recovery | no | recovery-security-domain |
No Recovery | if true no recovery are tried for this connection pool | no | no-recovery |
Note
Name | Description |
---|---|
Subsystem:flush All Connection In Pool | Flushes all connections in the pool |
Subsystem:flush Idle Connection In Pool | Flushes all idle connections in the pool |
Subsystem:test Connection In Pool | Test if a connection can be obtained |
3.4.1.13.2.6.2. EAP7 - Datasource Runtime Service
Description: | A JDBC data-source configuration |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Connection Property | no | *1 | |
Connection Url | The JDBC driver connection URL | yes | connection-url |
Driver Name | Name of the (existing) JDBC driver to use | yes | driver-name |
Driver Class | The fully qualified name of the JDBC driver class | no | driver-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver | Defines 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 Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether to attempt to prefill the connection pool. Changing this value require a server restart. | no | pool-prefill |
Pool Use Strict Min | Define if the min-pool-size should be considered a strictly. | no | pool-use-strict-min |
Security Domain | Indicates 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 Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | Indicates the time in milliseconds to wait between retrying to allocate a connection. | no | allocation-retry-wait-millis |
Blocking Timeout Wait Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Note
Name | Description |
---|---|
Subsystem:flush All Connection In Pool | Flushes all connections in the pool |
Subsystem:flush Idle Connection In Pool | Flushes all idle connections in the pool |
Subsystem:test Connection In Pool | Test if a connection can be obtained |
3.4.1.13.2.7. EAP7 - Webservices Runtime Service
Description: | Runtime resources exposed by web service components in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.13.2.7.1. EAP7 - Endpoint Runtime Service
Description: | Webservice endpoint. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Average Processing Time | measurement | Average endpoint processing time. | average-processing-time |
Fault Count | measurement | Count of faults the endpoint generated. | fault-count |
Max Processing Time | measurement | Maximal endpoint processing time. | max-processing-time |
Min Processing Time | measurement | Minimal endpoint processing time. | min-processing-time |
Request Count | measurement | Count of requests the endpoint processed. | request-count |
Response Count | measurement | Count of responses the endpoint generated. | response-count |
Total Processing Time | measurement | Total endpoint processing time. | total-processing-time |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | Webservice endpoint class. | no | class |
Context | Webservice endpoint context. | no | context |
Name | Webservice endpoint name. | no | name |
Type | Webservice endpoint type. | no | type |
Wsdl Url | Webservice endpoint WSDL URL. | no | wsdl-url |
Note
3.4.1.13.3. EAP7 - Resource Adapters Runtime Service
Overview
Description: | Configuration of the resource adapters subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.13.3.1. EAP7 - Connection Definition Runtime Service
Description: | Specifies the connection definitions. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Note
3.4.1.13.4. EAP7 - Web Runtime Service
Overview
Description: | Runtime resources exposed by web components in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Response Time Log File | the full path to the log file containing response-time stats for this webapp | no | responseTimeLogFile |
Response Time Url Excludes | a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection | no | responseTimeUrlExcludes |
Response Time Url Transforms | a 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
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Virtual Host | trait | the virtual host this webapp is deployed to | virtual-host |
Context Root | trait | the context root of this webapp | context-root |
Server | trait | The name of server this application belongs to | server |
Response Time | calltime | the minimum, maximum, and average response times for requests serviced by this webapp | responseTime |
Currently Active Sessions | measurement | The number of sessions that are currently active | active-sessions |
Expired Sessions | measurement | The number of expired sessions | expired-sessions |
Expired Sessions per Minute | measurement | The number of expired sessions | expired-sessions |
Maximum Active Sessions | measurement | The maximum number of sessions that have been active | max-active-sessions |
Rejected Sessions | measurement | The number of sessions rejected | rejected-sessions |
Rejected Sessions per Minute | measurement | The number of sessions rejected | rejected-sessions |
Average Session Alive Time | measurement | The average alive time of sessions | session-avg-alive-time |
Max Session Alive Time | measurement | The maximum alive time of sessions | session-max-alive-time |
Created Sessions | measurement | The number of sessions created | sessions-created |
Created Sessions per Minute | measurement | The number of sessions created | sessions-created |
Note
Configuration Properties
Operations
Package Types
3.4.1.13.5. EAP7 - JPA Runtime Service
Overview
Description: | The configuration of the JPA subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.13.5.1. EAP7 - Hibernate Persistence Unit Service
Description: | Runtime information about JPA use in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Close Statement Count | measurement | Number of released prepared statements. | close-statement-count |
Close Statement Count per Minute | measurement | Number of released prepared statements. | close-statement-count |
Collection Fetch Count | measurement | Number of collections fetched. | collection-fetch-count |
Collection Fetch Count per Minute | measurement | Number of collections fetched. | collection-fetch-count |
Collection Load Count | measurement | Number of collections loaded. | collection-load-count |
Collection Load Count per Minute | measurement | Number of collections loaded. | collection-load-count |
Collection Recreated Count | measurement | Number of collections recreated. | collection-recreated-count |
Collection Recreated Count per Minute | measurement | Number of collections recreated. | collection-recreated-count |
Collection Remove Count | measurement | Number of collections removed. | collection-remove-count |
Collection Remove Count per Minute | measurement | Number of collections removed. | collection-remove-count |
Collection Update Count | measurement | Number of collections updated. | collection-update-count |
Collection Update Count per Minute | measurement | Number of collections updated. | collection-update-count |
Completed Transaction Count | measurement | Number of completed transactions. | completed-transaction-count |
Completed Transaction Count per Minute | measurement | Number of completed transactions. | completed-transaction-count |
Connect Count | measurement | Get the number of connections asked for by the sessions. | connect-count |
Connect Count per Minute | measurement | Get the number of connections asked for by the sessions. | connect-count |
Entity Delete Count | measurement | Get number of entity deletes. | entity-delete-count |
Entity Delete Count per Minute | measurement | Get number of entity deletes. | entity-delete-count |
Entity Fetch Count | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Fetch Count per Minute | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Insert Count | measurement | Get number of entity inserts. | entity-insert-count |
Entity Insert Count per Minute | measurement | Get number of entity inserts. | entity-insert-count |
Entity Load Count | measurement | Get number of entity loads. | entity-load-count |
Entity Load Count per Minute | measurement | Get number of entity loads. | entity-load-count |
Entity Update Count | measurement | Get number of entity updates. | entity-update-count |
Entity Update Count per Minute | measurement | Get number of entity updates. | entity-update-count |
Flush Count | measurement | Get the number of flushes executed by sessions (either implicit or explicit). | flush-count |
Flush Count per Minute | measurement | Get the number of flushes executed by sessions (either implicit or explicit). | flush-count |
Optimistic Failure Count | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Optimistic Failure Count per Minute | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Prepared Statement Count | measurement | Number of acquired prepared statements. | prepared-statement-count |
Prepared Statement Count per Minute | measurement | Number of acquired prepared statements. | prepared-statement-count |
Query Cache Hit Count | measurement | Get the number of cached queries successfully retrieved from cache. | query-cache-hit-count |
Query Cache Hit Count per Minute | measurement | Get the number of cached queries successfully retrieved from cache. | query-cache-hit-count |
Query Cache Miss Count | measurement | Get the number of cached queries not found in cache. | query-cache-miss-count |
Query Cache Miss Count per Minute | measurement | Get the number of cached queries not found in cache. | query-cache-miss-count |
Query Cache Put Count | measurement | Get the number of cacheable queries put in cache. | query-cache-put-count |
Query Cache Put Count per Minute | measurement | Get the number of cacheable queries put in cache. | query-cache-put-count |
Query Execution Count | measurement | Get number of executed queries. | query-execution-count |
Query Execution Count per Minute | measurement | Get number of executed queries. | query-execution-count |
Query Execution Max Time | measurement | Get the time in milliseconds of the slowest query. | query-execution-max-time |
Query Execution Max Time Query String | trait | Get the query string for the slowest query. | query-execution-max-time-query-string |
Second Level Cache Hit Count | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | second-level-cache-hit-count |
Second Level Cache Hit Count per Minute | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | second-level-cache-hit-count |
Second Level Cache Miss Count | measurement | Number of cacheable entities/collections not found in the cache and loaded. | second-level-cache-miss-count |
Second Level Cache Miss Count per Minute | measurement | Number of cacheable entities/collections not found in the cache and loaded. | second-level-cache-miss-count |
Second Level Cache Put Count | measurement | Number of cacheable entities/collections put in the cache. | second-level-cache-put-count |
Second Level Cache Put Count per Minute | measurement | Number of cacheable entities/collections put in the cache. | second-level-cache-put-count |
Session Close Count | measurement | Number of sessions closed. | session-close-count |
Session Close Count per Minute | measurement | Number of sessions closed. | session-close-count |
Session Open Count | measurement | Number of sessions opened. | session-open-count |
Session Open Count per Minute | measurement | Number of sessions opened. | session-open-count |
Successful Transaction Count | measurement | Number of successful transactions. | successful-transaction-count |
Successful Transaction Count per Minute | measurement | Number of successful transactions. | successful-transaction-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Enabled | Determine if statistics are enabled. | no | enabled |
Note
Name | Description |
---|---|
Subsystem:clear | Clear statistics. |
Subsystem:evict All | Evict all entities from second level cache. |
Subsystem:summary | Log the statistics. |
View Queries | View statistical information about queries executed by Hibernate |
3.4.1.13.5.1.1. EAP7 - Entity Cache Service
Description: | Statistics for a Hibernate Second Level Cache region. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Element Count In Memory | measurement | Number of cacheable entities/collections currently stored in memory. | element-count-in-memory |
Hit Count | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | hit-count |
Miss Count | measurement | Number of cacheable entities/collections not found in the cache and loaded. | miss-count |
Put Count | measurement | Number of cacheable entities/collections put in the cache. | put-count |
Note
3.4.1.13.5.1.2. EAP7 - Entity Service
Description: | Statistics for individual entities. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Entity Delete Count | measurement | Get number of entity deletes. | entity-delete-count |
Entity Delete Count per Minute | measurement | Get number of entity deletes. | entity-delete-count |
Entity Fetch Count | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Fetch Count per Minute | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Insert Count | measurement | Get number of entity inserts. | entity-insert-count |
Entity Insert Count per Minute | measurement | Get number of entity inserts. | entity-insert-count |
Entity Load Count | measurement | Get number of entity loads. | entity-load-count |
Entity Load Count per Minute | measurement | Get number of entity loads. | entity-load-count |
Entity Update Count | measurement | Get number of entity updates. | entity-update-count |
Entity Update Count per Minute | measurement | Get number of entity updates. | entity-update-count |
Optimistic Failure Count | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Optimistic Failure Count per Minute | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Note
3.4.1.13.5.1.3. EAP7 - Collection Service
Description: | Statistics for individual collections. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Collection Fetch Count | measurement | Number of times collection was fetched. | collection-fetch-count |
Collection Fetch Count per Minute | measurement | Number of times collection was fetched. | collection-fetch-count |
Collection Load Count | measurement | Number of times collection was loaded. | collection-load-count |
Collection Load Count per Minute | measurement | Number of times collection was loaded. | collection-load-count |
Collection Recreated Count | measurement | Number of times collection was recreated. | collection-recreated-count |
Collection Recreated Count per Minute | measurement | Number of times collection was recreated. | collection-recreated-count |
Collection Remove Count | measurement | Number of times collection was removed. | collection-remove-count |
Collection Remove Count per Minute | measurement | Number of times collection was removed. | collection-remove-count |
Collection Update Count | measurement | Number of times collection was updated. | collection-update-count |
Collection Update Count per Minute | measurement | Number of times collection was updated. | collection-update-count |
Note
3.4.1.13.6. EAP7 - Messaging Runtime Service
Overview
Description: | Runtime resources exposed by messaging resources included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.13.6.1. EAP7 - ActiveMQ Artemis Server Runtime Service
Description: | A ActiveMQ Artemis server instance. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.13.6.1.1. EAP7 - JMS Queue Runtime Service
Description: | Defines a JMS queue. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Consumer Count | measurement | The number of consumers consuming messages from this queue. | consumer-count |
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Dead Letter Address | trait | The address to send dead messages to. | dead-letter-address |
Durable | trait | Whether the queue is durable or not. The default value is true. | durable |
Expiry Address | trait | The address to send expired messages to. | expiry-address |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Paused | trait | Whether the queue is paused. | paused |
Queue Address | trait | The queue address defines what address is used for routing messages. | queue-address |
Scheduled Count | measurement | The number of scheduled messages in this queue. | scheduled-count |
Selector | trait | The queue selector. | selector |
Temporary | trait | Whether the queue is temporary. | temporary |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Entries | The jndi names the queue will be bound to. | no | entries |
Note
Name | Description |
---|---|
Change Message Priority | Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Change Messages Priority | Change the priority of the messages corresponding to the given filter. Returns the number of removed messages. |
Count Messages | Returns the number of the messages in the queue matching the given filter. |
Expire Message | Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Expire Messages | Expire the messages matching the given filter. |
List Consumers as JSON | A string in JSON format. |
Subsystem:list Delivering Messages | List the messages are currently being delivered. |
Subsystem:list Delivering Messages As Json | List the messages are currently being delivered as a string in JSON format |
List Message Counter as HTML | List the message counter as a string in HTML format. |
List Message Counter as JSON | List the message counter as a string in JSON format. |
List Message Counter History as HTML | List the message counter history. |
List Message Counter History as JSON | List the message counter history as a string in JSON format. |
List Messages | List all messages in the queue that match the filter |
List Messages as JSON | List all messages in the queue that match the filter and return them as a string in JSON format. |
Move Message | Move the message corresponding to the given message-id to another queue |
Move Messages | Move the messages corresponding to the given filter to another queue. |
Pause | Pause the queue. |
Remove Message | Remove the message corresponding to the given message-id. |
Remove Messages | Remove messages matching the given filter from the destination. |
Reset Message Counter | Reset the message counters. |
Resume | Resume the queue. |
Send Message to Dead Letter Address | Send the message corresponding to the given message-id to this queue's Dead Letter Address. |
Send Messages to Dead Letter Address | Send the messages corresponding to the given filter to this queue's Dead Letter Address. |
3.4.1.13.6.1.2. EAP7 - JMS Topic Runtime Service
Description: | Defines a JMS queue. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Durable Message Count | measurement | The number of messages for all durable subscribers for this topic. | durable-message-count |
Durable Subscription Count | measurement | The number of durable subscribers for this topic. | durable-subscription-count |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Non Durable Message Count | measurement | The number of messages for all non-durable subscribers for this topic. | non-durable-message-count |
Non Durable Subscription Count | measurement | The number of non-durable subscribers for this topic. | non-durable-subscription-count |
Subscription Count | measurement | The number of (durable and non-durable) subscribers for this topic. | subscription-count |
Temporary | trait | Whether the topic is temporary. | temporary |
Topic Address | trait | The address the topic points to. | topic-address |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
JNDI Names | The jndi names the queue will be bound to. | no | entries |
Note
Name | Description |
---|---|
Count Messages for Subscription | Count the number of messages matching the filter for the given subscription. |
Drop All Subscriptions | Drop all subscriptions from this topic. |
Drop Durable Subscription | Drop a durable subscription |
List All Subscriptions | List all subscriptions. |
List All Subscriptions as JSON | List all subscriptions as a string in JSON format. |
List Durable Subscriptions | List only the durable subscriptions. |
List Durable Subscriptions as JSON | List only the durable subscriptions, as a string in JSON format. |
List Messages for Subscription | List all the messages for the given subscription. |
List Messages for Subscription as JSON | List all the messages for the given subscription as a string in JSON format. |
List Non-Durable Subscriptions | List only the non-durable subscriptions. |
List Non-Durable Subscriptions as JSON | List only the non-durable subscriptions, as a string in JSON format. |
Remove Messages | Remove messages matching the given filter from the destination. |
3.4.1.13.6.1.3. EAP7 - Pooled Connection Factory Runtime Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Auto Group | The autogroup. The default value is false. | no | auto-group |
Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
Call Failover Timeout:expr | The timeout to use when fail over is in process (in ms). The default value is -1. | no | call-failover-timeout:expr |
Call Timeout:expr | The call time out. The default value is 30000. | no | call-timeout:expr |
Client Failure Check Period:expr | The client failure check period. The default value is 30000. | no | client-failure-check-period:expr |
Client Id | The client id. | no | client-id |
Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
Confirmation Window Size:expr | The confirmation window size. The default value is -1. | no | confirmation-window-size:expr |
Connection Load Balancing Policy Class Name | Name 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:expr | The connection ttl. The default value is 60000. | no | connection-ttl:expr |
Connectors | Defines 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:expr | The consumer max rate. The default value is -1. | no | consumer-max-rate:expr |
Consumer Window Size:expr | The consumer window size. The default value is 1048576. | no | consumer-window-size:expr |
Discovery Group | The discovery group name. | no | discovery-group |
Dups Ok Batch Size:expr | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size:expr |
Enlistment Trace | Enables 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 |
Entries | The jndi names the connection factory should be bound to. | yes | entries |
Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
Group Id | The group id. | no | group-id |
Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
Initial Connect Attempts:expr | The number of attempts to connect initially with this factory. The default value is 1. | no | initial-connect-attempts:expr |
Initial Message Packet Size:expr | The initial size of messages created through this factory. The default value is 1500. | no | initial-message-packet-size:expr |
Jndi Params | The JNDI params to use for locating the destination for incoming connections. | no | jndi-params |
Managed Connection Pool | The class name of the managed connection pool used by this pooled-connection-factory. | no | managed-connection-pool |
Max Pool Size:expr | The maximum size for the pool. The default value is -1. | no | max-pool-size:expr |
Max Retry Interval:expr | The max retry interval. The default value is 2000. | no | max-retry-interval:expr |
Min Large Message Size:expr | The min large message size. The default value is 102400. | no | min-large-message-size:expr |
Min Pool Size:expr | The minimum size for the pool. The default value is -1. | no | min-pool-size:expr |
Password | The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host. | no | password |
Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
Producer Max Rate:expr | The producer max rate. The default value is -1. | no | producer-max-rate:expr |
Producer Window Size:expr | The producer window size. The default value is 65536. | no | producer-window-size:expr |
Protocol Manager Factory | The protocol manager factory used by this pooled connection factory. | no | protocol-manager-factory |
Reconnect Attempts:expr | The 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:expr | The retry interval. The default value is 2000. | no | retry-interval:expr |
Retry Interval Multiplier:expr | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier:expr |
Scheduled Thread Pool Max Size:expr | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Setup Attempts:expr | The number of times to set up an MDB endpoint | no | setup-attempts:expr |
Setup Interval:expr | The interval between attempts at setting up an MDB endpoint. | no | setup-interval:expr |
Thread Pool Max Size:expr | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
Transaction | TODO. The default value is transaction. | no | transaction |
Transaction Batch Size:expr | The transaction batch size. The default value is 1048576. | no | transaction-batch-size:expr |
Use Auto Recovery | True to use auto recovery. The default value is true. | no | use-auto-recovery |
Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Use Jndi | Use JNDI to locate the destination for incoming connections | no | use-jndi |
Use Local Tx | Use a local transaction for incoming sessions | no | use-local-tx |
User | The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host. | no | user |
Note
3.4.1.13.7. EAP7 - Datasources Runtime Service
Overview
Description: | Runtime resources exposed by data sources included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.13.7.1. EAP7 - XA Datasource Runtime Service
Description: | A JDBC XA data-source configuration |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | no | *2 | |
Xa Datasource Class | The fully qualified name of the javax.sql.XADataSource implementation | yes | xa-datasource-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver Name | Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit | yes | driver-name |
User Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether to attempt to prefill the connection pool. Changing this value require a server restart. | no | pool-prefill |
Pool Use Strict Min | Define if the min-pool-size should be considered a strictly. | no | pool-use-strict-min |
Interleaving | An element to enable interleaving for XA connection factories | no | interleaving |
No Tx Separate Pool | Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different context | no | no-tx-separate-pool |
Pad Xid | Should the Xid be padded | no | pad-xid |
Same Rm Override | The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false | no | same-rm-override |
Wrap Xa Datasource | Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance | no | wrap-xa-datasource |
Security Domain | Indicates 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 Name | recovery plugin implementation provided for specific purpose (i.e vendor) | no | recovery-plugin-class-name |
Reauth Plugin Class Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | he 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 Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 Timeout | Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds | no | xa-resource-timeout |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Recovery Username | username used to try connection recovery | no | recovery-username |
Recovery Password | password used to try connection recovery | no | recovery-password |
Recovery Security Domain | security-domain used to try connection recovery | no | recovery-security-domain |
No Recovery | if true no recovery are tried for this connection pool | no | no-recovery |
Note
Name | Description |
---|---|
Subsystem:flush All Connection In Pool | Flushes all connections in the pool |
Subsystem:flush Idle Connection In Pool | Flushes all idle connections in the pool |
Subsystem:test Connection In Pool | Test if a connection can be obtained |
3.4.1.13.7.2. EAP7 - Datasource Runtime Service
Description: | A JDBC data-source configuration |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Connection Property | no | *1 | |
Connection Url | The JDBC driver connection URL | yes | connection-url |
Driver Name | Name of the (existing) JDBC driver to use | yes | driver-name |
Driver Class | The fully qualified name of the JDBC driver class | no | driver-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver | Defines 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 Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether to attempt to prefill the connection pool. Changing this value require a server restart. | no | pool-prefill |
Pool Use Strict Min | Define if the min-pool-size should be considered a strictly. | no | pool-use-strict-min |
Security Domain | Indicates 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 Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | Indicates the time in milliseconds to wait between retrying to allocate a connection. | no | allocation-retry-wait-millis |
Blocking Timeout Wait Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Note
Name | Description |
---|---|
Subsystem:flush All Connection In Pool | Flushes all connections in the pool |
Subsystem:flush Idle Connection In Pool | Flushes all idle connections in the pool |
Subsystem:test Connection In Pool | Test if a connection can be obtained |
3.4.1.13.8. EAP7 - Webservices Runtime Service
Overview
Description: | Runtime resources exposed by web service components in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.13.8.1. EAP7 - Endpoint Runtime Service
Description: | Webservice endpoint. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Average Processing Time | measurement | Average endpoint processing time. | average-processing-time |
Fault Count | measurement | Count of faults the endpoint generated. | fault-count |
Max Processing Time | measurement | Maximal endpoint processing time. | max-processing-time |
Min Processing Time | measurement | Minimal endpoint processing time. | min-processing-time |
Request Count | measurement | Count of requests the endpoint processed. | request-count |
Response Count | measurement | Count of responses the endpoint generated. | response-count |
Total Processing Time | measurement | Total endpoint processing time. | total-processing-time |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | Webservice endpoint class. | no | class |
Context | Webservice endpoint context. | no | context |
Name | Webservice endpoint name. | no | name |
Type | Webservice endpoint type. | no | type |
Wsdl Url | Webservice endpoint WSDL URL. | no | wsdl-url |
Note
3.4.1.14. EAP7 - DeploymentScanner Service
Overview
Description: | Management of the deployment scanner |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Scanners | List of scanners | yes | * |
Note
Operations
Package Types
3.4.1.15. EAP7 - JacORB Service
Overview
Description: | JacORB subsystem configuration |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Add Component Via Interceptor | Indicates 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 Names | Indicates whether POA names should be cached (on) or not (off). The default value is off. | no | cache-poa-names |
Cache Typecodes | Indicates whether typecodes should be cached (on) or not (off). The default value is off. | no | cache-typecodes |
Chunk Custom Rmi Valuetypes | Indicates whether custom RMI valuetypes should be encoded as chunks (on) or not (off). The default value is on. | no | chunk-custom-rmi-valuetypes |
Client Requires | Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | client-requires |
Client Supports | Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | client-supports |
Client Timeout | The 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 |
Comet | Indicates whether interoperability with Comet's ORB is enabled (on) or not (off). The default value is off. | no | comet |
Export Corbaloc | Indicates 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 Version | The GIOP minor version to be used. The default value is 2. | no | giop-minor-version |
Indirection Encoding Disable | Indicates whether indirection encoding for repeated typecodes should be disabled (on) or not (off). The default value is off. | no | indirection-encoding-disable |
Iona | Indicates whether interoperability with IONA's ASP is enabled (on) or not (off). The default value is off. | no | iona |
Lax Boolean Encoding | Indicates 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 Size | The log2 of maximum size managed by the internal buffer manager. The default value is 24. | no | max-managed-buf-size |
Max Server Connections | The maximum number of connections accepted by the server. The default value is 2147483647. | no | max-server-connections |
Max Threads | The 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 |
Monitoring | Indicates whether the monitoring GUI should be displayed (on) or not (off). The default value is off. | no | monitoring |
Name | The name of the running ORB. The default value is JBoss. | no | name |
Outbuf Cache Timeout | The buffer cache timeout in milliseconds. The default value is -1. | no | outbuf-cache-timeout |
Outbuf Size | The size of the network buffers for outgoing messages. The default value is 2048. | no | outbuf-size |
Pool Size | The 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 Version | Indicates whether the version number should be printed during ORB startup (on) or not (off). The default value is off. | no | print-version |
Properties | A list of generic key/value properties. | no | properties |
Queue Max | The maximum number of requests that can be queued. The default value is 100. | no | queue-max |
Queue Min | The 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 Wait | Indicates 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 |
Retries | The number of retries if connections cannot be promptly established. The default value is 5. | no | retries |
Retry Interval | The interval in milliseconds between retries. The default value is 500. | no | retry-interval |
Root Context | The naming service root context. The default value is JBoss/Naming/root. | no | root-context |
Security | Indicates whether the security interceptors are to be installed (on) or not (off). The default value is off. | no | security |
Security Domain | The name of the security domain that holds the key and trust stores that will be used to establish SSL connections. | no | security-domain |
Server Requires | Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | server-requires |
Server Supports | Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | server-supports |
Server Timeout | The 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 Creation | Indicates 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 |
Sun | Indicates whether interoperability with Sun's ORB is enabled (on) or not (off). The default value is on. | no | sun |
Support Ssl | Indicates whether SSL is to be supported (on) or not (off). The default value is off. | no | support-ssl |
Transactions | Indicates 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 Bom | Indicates whether GIOP 1.2 byte order markers should be used (on) or not (off). The default value is off. | no | use-bom |
Use Imr | Indicates whether the implementation repository should be used (on) or not (off). The default value is off. | no | use-imr |
Note
Operations
Package Types
3.4.1.16. EAP7 - JDR Service
Overview
Description: | JBoss Diagnostic Reporter (JDR) Subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Operations
Name | Description |
---|---|
Generate JDR Report | Request the generation of a JDR report. |
Package Types
3.4.1.17. EAP7 - JCA Service
Overview
Description: | The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Enabled | Specify whether bean validation is enabled. The default value is true. | no | enabled:1 |
Enabled | Specify whether archive validation is enabled. The default value is true. | no | enabled:2 |
Fail On Error | Should an archive validation error report fail the deployment. The default value is true. | no | fail-on-error |
Fail On Warn | Should an archive validation warning report fail the deployment. The default value is false. | no | fail-on-warn |
Debug | Enable/disable debug information logging. The default value is false. | no | debug |
Error | Enable/disable error information logging. The default value is false. | no | error |
Install | Enable/disable the cached connection manager valve and interceptor. The default value is false. | no | install |
Note
Operations
Package Types
3.4.1.17.1. EAP7 - BootstrapContext Service
Overview
Description: | Bootstrap context for resource adapters. |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Name | The name of the BootstrapContext | no | name |
Workmanager | The WorkManager instance for the BootstrapContext | no | workmanager |
Note
Operations
Package Types
3.4.1.17.2. EAP7 - Workmanager Service
Overview
Description: | WorkManager for resource adapters. |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Name | The name of the WorkManager | no | name |
Note
Operations
Package Types
3.4.1.17.2.1. EAP7 - Long Running Thread Pool Service
Description: | Long running thread pool executor with a bounded queue where threads submitting tasks may block. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
Largest Thread Count | measurement | The largest number of threads that have ever simultaneously been in the pool. | largest-thread-count |
Rejected Count | measurement | The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded. | rejected-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Core Timeout | Whether core threads may time out. The default value is false. | no | allow-core-timeout |
Core Threads | The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size. | no | core-threads:expr |
Handoff Executor | An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded. | no | handoff-executor |
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | yes | max-threads:expr |
Name | The name of the thread pool. | no | name |
Queue Length | The queue length. | yes | queue-length:expr |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Note
3.4.1.17.2.2. EAP7 - Short Running Thread Pool Service
Description: | Short running thread pool executor with a bounded queue where threads submitting tasks may block. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
Largest Thread Count | measurement | The largest number of threads that have ever simultaneously been in the pool. | largest-thread-count |
Rejected Count | measurement | The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded. | rejected-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Core Timeout | Whether core threads may time out. The default value is false. | no | allow-core-timeout |
Core Threads | The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size. | no | core-threads:expr |
Handoff Executor | An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded. | no | handoff-executor |
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | yes | max-threads:expr |
Name | The name of the thread pool. | no | name |
Queue Length | The queue length. | yes | queue-length:expr |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Note
3.4.1.18. EAP7 - JAXR Service
Overview
Description: | The configuration of the JAXR subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Class | The JAXR ConnectionFactory implementation class | no | class |
Jndi Name | The JNDI name under which the JAXR ConnectionFactory is bound | no | jndi-name |
Note
Operations
Package Types
3.4.1.18.1. EAP7 - Property (JAXR) Service
Overview
Description: | A JAXR property. The identity of the resource defines the property name. |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The JAXR property value. | yes | value |
Note
Operations
Package Types
3.4.1.19. EAP7 - JPA Service
Overview
Description: | The configuration of the JPA subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Datasource | The name of the default global datasource. | no | default-datasource |
Note
Operations
Package Types
3.4.1.20. EAP7 - CMP Service
Overview
Description: | The configuration of the cmp subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.20.1. EAP7 - HiloKeygenerator Service
Overview
Description: | HiLo based key generators. |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Block Size | The block size | no | block-size |
Create Table | Boolean to determine whether to create create the tables | no | create-table |
Create Table Ddl | The DDL used to create the table | no | create-table-ddl |
Data Source | The datasource used for sequence generation | yes | data-source |
Drop Table | Boolean to determine whether to create drop the tables | no | drop-table |
Id Column | The ID column name | yes | id-column |
Select Hi Ddl | The DDL used to select the hi value | no | select-hi-ddl |
Sequence Column | The sequence column name | yes | sequence-column |
Sequence Name | The name of the sequence | yes | sequence-name |
Table Name | The table name | yes | table-name |
Note
Operations
Package Types
3.4.1.21. EAP7 - EE Service
Overview
Description: | The configuration of the EE subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Ear Subdeployments Isolated | Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear. The default value is false. | no | ear-subdeployments-isolated |
Global Modules | A list of modules that should be made available to all deployments. | no | global-modules |
Note
Operations
Package Types
3.4.1.22. EAP7 - Security Service
Overview
Description: | The configuration of the security subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Deep Copy Subject Mode | Sets the copy mode of subjects done by the security managers to be deep copies that makes copies of the subject principals and credentials if they are cloneable. It should be set to true if subject include mutable content that can be corrupted when multiple threads have the same identity and cache flushes/logout clearing the subject in one thread results in subject references affecting other threads. The default value is false. | no | deep-copy-subject-mode |
Note
Operations
Package Types
3.4.1.22.1. EAP7 - Security Domain Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Cache Type | Adds a cache to speed up authentication checks. Allowed values are 'default' to use simple map as the cache and 'infinispan' to use an Infinispan cache. | no | cache-type |
Note
Operations
Name | Description |
---|---|
Flush Cache | Remove 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 Principals | Lists the principals stored in the authentication cache for this security domain. |
Package Types
3.4.1.22.1.1. EAP7 - ACL Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.1.22.1.1.1. EAP7 - Acl Modules Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.1.22.1.1.1.1. EAP7 - Module Options (Acl) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.1.22.1.2. EAP7 - Audit Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Note
3.4.1.22.1.2.1. EAP7 - Provider Modules Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Note
3.4.1.22.1.2.1.1. EAP7 - Module Options (Provider Modules) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.1.22.1.3. EAP7 - Authentication (Classic) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.1.22.1.3.1. EAP7 - Login Modules (Classic) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.1.22.1.3.1.1. EAP7 - Module Options (Classic) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.1.22.1.4. EAP7 - Authentication (Jaspi) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.1.22.1.4.1. EAP7 - Login Module Stack Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.1.22.1.4.1.1. EAP7 - Module Options (Login Module Stack) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.1.22.1.5. EAP7 - Authorization Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.1.22.1.5.1. EAP7 - Authorization Modules Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.1.22.1.5.1.1. EAP7 - Module Options (Authorization) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.1.22.1.6. EAP7 - Identity Trust Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.1.22.1.6.1. EAP7 - Identity Trust Modules Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.1.22.1.6.1.1. EAP7 - Module Options (Identity Trust) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.1.22.1.7. EAP7 - JSSE Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cipher Suites | Comma separated list of cipher suites to enable on SSLSockets. | no | cipher-suites |
Client Alias | Preferred alias to use when the KeyManager chooses the client alias. | no | client-alias |
Client Auth | Boolean attribute to indicate if client's certificates should also be authenticated on the server side. | no | client-auth |
Key Manager | JSEE Key Manager factory | no | key-manager |
Keystore | Configures a JSSE key store | no | keystore |
Protocols | Comma separated list of protocols to enable on SSLSockets. | no | protocols |
Server Alias | Preferred alias to use when the KeyManager chooses the server alias. | no | server-alias |
Service Auth Token | Token to retrieve PrivateKeys from the KeyStore. | no | service-auth-token |
Trust Manager | JSEE Trust Manager factory | no | trust-manager |
Truststore | Configures a JSSE trust store | no | truststore |
Note
3.4.1.22.1.8. EAP7 - Mapping Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Type | Type of mapping this module performs. Allowed values are principal, role, attribute or credential.. | yes | type |
Note
3.4.1.22.1.8.1. EAP7 - Mapping Modules Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Type | Type of mapping this module performs. Allowed values are principal, role, attribute or credential.. | yes | type |
Note
3.4.1.22.1.8.1.1. EAP7 - Module Options (Mapping) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.1.22.2. EAP7 - Vault Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Fully Qualified Name of the Security Vault Implementation. | no | code |
Note
Operations
Package Types
3.4.1.23. EAP7 - Threads Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.23.1. EAP7 - ThreadFactory Service
Overview
Description: | A thread factory (implementing java.util.concurrent.ThreadFactory). |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Group Name | Specifies the name of a thread group to create for this thread factory. | no | group-name |
Name | The name of the created thread factory. | no | name |
Priority | May be used to specify the thread priority of created threads. The default value is -1. | no | priority:expr |
Thread Name Pattern | The 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
Operations
Package Types
3.4.1.23.2. EAP7 - ThreadPool Service
Overview
Description: | A thread pool executor |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Active Count | measurement | The approximate number of threads that are actively executing tasks. | active-count |
Completed Task Count | measurement | The approximate total number of tasks that have completed execution. | completed-task-count |
Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
Largest Thread Count | measurement | The largest number of threads that have ever simultaneously been in the pool. | largest-thread-count |
Rejected Count | measurement | The number of tasks that have been rejected. | rejected-count |
Task Count | measurement | The approximate total number of tasks that have ever been scheduled for execution. | task-count |
Note
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | yes | max-threads:expr |
Name | The name of the thread pool. | no | name |
Queue Length | The queue length. Required only for Bounded and Blocking Bounded Thread Pools. | no | queue-length:expr |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Allow Core Timeout | Whether core threads may time out. The default value is false. | no | allow-core-timeout |
Core Threads | The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size. | no | core-threads:expr |
Handoff Executor | An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded. | no | handoff-executor |
Thread Pool Type | Thread pool type | yes | __type |
Note
Operations
Package Types
3.4.1.24. EAP7 - EJB3 Service
Overview
Description: | The configuration of the ejb3 subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Clustered Sfsb Cache | Name of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level | no | default-clustered-sfsb-cache |
Default Entity Bean Instance Pool | Name of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level | no | default-entity-bean-instance-pool |
Default Entity Bean Optimistic Locking | If set to true entity beans will use optimistic locking by default | no | default-entity-bean-optimistic-locking |
Default Mdb Instance Pool | Name of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level | no | default-mdb-instance-pool |
Default Resource Adapter Name | Name of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level. The default value is activemq-ra. | no | default-resource-adapter-name |
Default Sfsb Cache | Name of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level | no | default-sfsb-cache |
Default Singleton Bean Access Timeout | The default access timeout for singleton beans. The default value is 5000. | no | default-singleton-bean-access-timeout:expr |
Default Slsb Instance Pool | Name of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level | no | default-slsb-instance-pool |
Default Stateful Bean Access Timeout | The 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 Value | If set to false, the parameters to invocations on remote interface of an EJB, will be passed by reference. Else, the parameters will be passed by value. The default value is true. | no | in-vm-remote-interface-invocation-pass-by-value |
Enable Statistics | If set to true, enable the collection of invocation statistics. | no | enable-statistics |
Note
Operations
Package Types
3.4.1.24.1. EAP7 - EJB3 Thread Pool Service
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
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Active Count | measurement | The approximate number of threads that are actively executing tasks. | active-count |
Completed Task Count | measurement | The approximate total number of tasks that have completed execution. | completed-task-count |
Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
Largest Thread Count | measurement | The largest number of threads that have ever simultaneously been in the pool. | largest-thread-count |
Rejected Count | measurement | The number of tasks that have been rejected. | rejected-count |
Task Count | measurement | The approximate total number of tasks that have ever been scheduled for execution. | task-count |
Note
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | no | max-threads:expr |
Name | The name of the thread pool. | no | name |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Note
Operations
Package Types
3.4.1.24.2. EAP7 - File Passivation Store Service
Overview
Description: | A file system based passivation store. |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Groups Path | no | groups-path | |
Idle Timeout | The 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 Unit | The unit of idle-timeout. The default value is SECONDS. | no | idle-timeout-unit |
Max Size | The 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
Operations
Package Types
3.4.1.24.3. EAP7 - MDB Delivery Group Service
Overview
Description: | Delivery group to manage delivery for mdbs |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Active | Indicates if delivery for all MDBs belonging to this group is active. The default value is true. | no | active |
Note
Operations
Package Types
3.4.1.24.4. EAP7 - Strict Max Bean Instance Pool Service
Overview
Description: | A bean instance pool with a strict upper limit |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Derive Size | Specifies 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 Size | The maximum number of bean instances that the pool can hold at a given point in time. | no | max-pool-size |
Timeout | The maximum amount of time to wait for a bean instance to be available from the pool. The default value is 5. | no | timeout |
Timeout Unit | The instance acquisition timeout unit. The default value is MINUTES. | no | timeout-unit |
Note
Operations
Package Types
3.4.1.24.5. EAP7 - SFSB Cache Service
Overview
Description: | A SFSB cache. |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Aliases | The aliases by which this cache may also be referenced | yes | aliases |
Passivation Store | The passivation store used by this cache | no | passivation-store |
Note
Operations
Package Types
3.4.1.24.6. EAP7 - Cluster Passivation Store Service
Overview
Description: | A clustered passivation store. |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Bean Cache | The name of the cache used to store bean instances. | no | bean-cache |
Cache Container | The name of the cache container used for the bean and client-mappings caches. The default value is ejb. | no | cache-container |
Client Mappings Cache | The 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 Timeout | The 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 Unit | The unit of idle-timeout. The default value is SECONDS. | no | idle-timeout-unit |
Max Size | The 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 Replicate | Indicates whether replication should trigger passivation events on the bean. The default value is true. | no | passivate-events-on-replicate |
Note
Operations
Package Types
3.4.1.24.7. EAP7 - Async Service
Overview
Description: | The EJB3 Asynchronous Invocation Service |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Thread Pool Name | The name of the thread pool which handles asynchronous invocations | no | thread-pool-name |
Note
Operations
Package Types
3.4.1.24.8. EAP7 - IIOP Service
Overview
Description: | The IIOP service |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Enable By Default | If this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor | no | enable-by-default |
Use Qualified Name | If true EJB names will be bound into the naming service with the application and module name prepended to the name (e.g. myapp/mymodule/MyEjb) | no | use-qualified-name |
Note
Operations
Package Types
3.4.1.24.9. EAP7 - Remote Service
Overview
Description: | The EJB3 remote service |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Connector Ref | The name of the connector on which the EJB3 remoting channel is registered | no | connector-ref |
Thread Pool Name | The name of the thread pool that handles remote invocations | no | thread-pool-name |
Note
Operations
Package Types
3.4.1.24.9.1. EAP7 - Channel Creation Options Service
Description: | The options that will be used during the EJB remote channel creation |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Type | The type of the channel creation option | no | type |
Value | The value for the EJB remote channel creation option | no | value |
Note
3.4.1.24.10. EAP7 - Timer Service
Overview
Description: | The EJB timer service |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | The directory to store persistent timer information in | no | path |
Relative To | The relative path that is used to resolve the timer data store location | no | relative-to |
Thread Pool Name | The name of the thread pool used to run timer service invocations | no | thread-pool-name |
Note
Operations
Package Types
3.4.1.25. EAP7 - JMX Service
Overview
Description: | The configuration of the JMX subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Show Model | Set to 'true' to include MBeans for the model controller resources | no | show-model |
Note
Operations
Package Types
3.4.1.25.1. EAP7 - Remoting Connector Service
Overview
Description: | The configuration of a resource adapter. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Use Management Endpoint | If 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
Operations
Package Types
3.4.1.26. EAP7 - Resource Adapters Service
Overview
Description: | Configuration of the resource adapters subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.26.1. EAP7 - Resource Adapter Service
Overview
Description: | The configuration of a resource adapter. |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Archive | Specifies the resource adapter archive | yes | archive |
Beanvalidationgroups | Specifies the bean validation groups that should be used | no | beanvalidationgroups |
Bootstrapcontext | Specifies the unique name of the bootstrap context that should be used | no | bootstrapcontext |
Transaction Support | Specifies the transaction support level of the resource adapter | yes | transaction-support |
Note
Operations
Package Types
3.4.1.26.1.1. EAP7 - Admin Objects Service
Description: | Specifies the administration objects. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class Name | Specifies the fully qualified class name of a managed connection factory or admin object | yes | class-name |
Enabled | Specifies if the resource adapter should be enabled. The default value is true. | no | enabled |
Jndi Name | Specifies the JNDI name for the connection factory or admin object | no | jndi-name |
Use Java Context | Setting this to false will bind the object into global JNDI. The default value is true. | no | use-java-context |
Note
3.4.1.26.1.2. EAP7 - Connection Definitions Service
Description: | Specifies the connection definitions. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allocation Retry | The 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 Millis | The 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 Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart. The default value is false. | no | background-validation |
Background Validation Millis | The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart | no | background-validation-millis:expr |
Blocking Timeout Wait Millis | The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time | no | blocking-timeout-wait-millis:expr |
Class Name | Specifies the fully qualified class name of a managed connection factory or admin object | yes | class-name |
Enabled | Specifies if the resource adapter should be enabled. The default value is true. | no | enabled |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Idle Timeout Minutes | The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value requires a server restart. | no | idle-timeout-minutes:expr |
Interleaving | An element to enable interleaving for XA connections. The default value is false. | no | interleaving |
Jndi Name | Specifies the JNDI name for the connection factory or admin object | no | jndi-name |
Max Pool Size | The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20. | no | max-pool-size:expr |
Min Pool Size | The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0. | no | min-pool-size:expr |
No Recovery | Specifies if the connection pool should be excluded from recovery | no | no-recovery |
No Tx Separate Pool | Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts. The default value is false. | no | no-tx-separate-pool |
Pad Xid | Should the Xid be padded. The default value is false. | no | pad-xid |
Pool Prefill | Should the pool be prefilled. Changing this value requires a server restart. The default value is false. | no | pool-prefill |
Pool Use Strict Min | Specifies if the min-pool-size should be considered strictly. The default value is false. | no | pool-use-strict-min |
Recovery Password | The password used for recovery | no | recovery-password |
Recovery Plugin Class Name | The fully qualified class name of the recovery plugin implementation | no | recovery-plugin-class-name |
Recovery Plugin Properties | The properties for the recovery plugin | no | recovery-plugin-properties |
Recovery Security Domain | The security domain used for recovery | no | recovery-security-domain |
Recovery Username | The user name used for recovery | no | recovery-username |
Same Rm Override | The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false | no | same-rm-override |
Security Application | Indicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool | no | security-application |
Security Domain | Specifies 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 Application | Indicates 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 Ccm | Enable the use of a cached connection manager. The default value is true. | no | use-ccm |
Use Fast Fail | Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false. | no | use-fast-fail |
Use Java Context | Setting this to false will bind the object into global JNDI. The default value is true. | no | use-java-context |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock:expr |
Wrap Xa Resource | Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true. | no | wrap-xa-resource |
XA Resource Timeout | The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero | no | xa-resource-timeout:expr |
Note
Name | Description |
---|---|
Flush All Connections in Pool | Flushes all connections in the pool |
Flush Idle Connections in Pool | Flushes all idle connections in the pool |
Test Connection in Pool | Test if a connection can be obtained |
3.4.1.26.1.2.1. EAP7 - Config Properties Service
Description: | Custom defined config properties. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | Custom defined config property value | no | value |
Note
3.4.1.26.1.3. EAP7 - Config Properties Service
Description: | Custom defined config properties. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | Custom defined config property value | no | value |
Note
3.4.1.27. EAP7 - Infinispan Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.27.1. EAP7 - Cache Container Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Cache Manager Status | trait | The status of the cache manager component. May return null if the cache manager is not started. | cache-manager-status |
Cluster Name | trait | The name of the cluster this node belongs to. May return null if the cache manager is not started. | cluster-name |
Coordinator Address | trait | The logical address of the cluster's coordinator. May return null if the cache manager is not started. | coordinator-address |
Is Coordinator | trait | True if this node is the cluster's coordinator. May return null if the cache manager is not started. | is-coordinator |
Local Address | trait | The local address of the node. May return null if the cache manager is not started. | local-address |
Note
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Aliases | The list of aliases for this cache container | no | aliases |
Default Cache | The default infinispan cache | no | default-cache |
Jndi Name | The jndi name to which to bind this cache container | no | jndi-name |
Module | The 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 Enabled | If enabled, statistics will be collected for this cache container. | no | statistics-enabled |
Note
Operations
Package Types
3.4.1.27.1.1. EAP7 - Cache Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Activations | measurement | The 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 Minute | measurement | The 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 Time | measurement | Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started. | average-read-time |
Average Write Time | measurement | Average time (in ms) for cache writes. May return null if the cache is not started. | average-write-time |
Cache Status | trait | The status of the cache component. May return null if the cache is not started. | cache-status |
Elapsed Time | measurement | Time (in secs) since cache started. May return null if the cache is not started. | elapsed-time |
Hit Ratio | measurement | The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started. | hit-ratio |
Hits | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Hits per Minute | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Invalidations | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Invalidations per Minute | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Misses | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Misses per Minute | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Number Of Entries | measurement | The current number of entries in the cache. May return null if the cache is not started. | number-of-entries |
Passivations | measurement | The 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 Minute | measurement | The 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 Ratio | measurement | The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started. | read-write-ratio |
Remove Hits | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Hits per Minute | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Misses | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Remove Misses per Minute | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Stores | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Stores per Minute | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Time Since Reset | measurement | Time (in secs) since cache statistics were reset. May return null if the cache is not started. | time-since-reset |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Jndi Name | The jndi-name to which to bind this cache instance. | no | jndi-name |
Mode | Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. | yes | mode |
Module | The module whose class loader should be used when building this cache's configuration. | no | module |
Queue Flush Interval | In 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 Size | In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. | no | queue-size |
Remote Timeout | In 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 cache | Type of cache | yes | __type |
Note
3.4.1.27.1.2. EAP7 - Distributed Cache Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Activations | measurement | The 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 Minute | measurement | The 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 Time | measurement | Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started. | average-read-time |
Average Write Time | measurement | Average time (in ms) for cache writes. May return null if the cache is not started. | average-write-time |
Cache Status | trait | The status of the cache component. May return null if the cache is not started. | cache-status |
Elapsed Time | measurement | Time (in secs) since cache started. May return null if the cache is not started. | elapsed-time |
Hit Ratio | measurement | The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started. | hit-ratio |
Hits | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Hits per Minute | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Invalidations | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Invalidations per Minute | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Misses | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Misses per Minute | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Number Of Entries | measurement | The current number of entries in the cache. May return null if the cache is not started. | number-of-entries |
Passivations | measurement | The 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 Minute | measurement | The 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 Ratio | measurement | The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started. | read-write-ratio |
Remove Hits | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Hits per Minute | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Misses | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Remove Misses per Minute | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Stores | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Stores per Minute | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Time Since Reset | measurement | Time (in secs) since cache statistics were reset. May return null if the cache is not started. | time-since-reset |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Jndi Name | The jndi-name to which to bind this cache instance. | no | jndi-name |
L 1 Lifespan | Maximum 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 |
Mode | Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. | yes | mode |
Module | The module whose class loader should be used when building this cache's configuration. | no | module |
Owners | Number of cluster-wide replicas for each cache entry. The default value is 2. | no | owners |
Queue Flush Interval | In 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 Size | In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. | no | queue-size |
Remote Timeout | In 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
3.4.1.27.1.3. EAP7 - Local Cache Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Activations | measurement | The 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 Minute | measurement | The 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 Time | measurement | Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started. | average-read-time |
Average Write Time | measurement | Average time (in ms) for cache writes. May return null if the cache is not started. | average-write-time |
Cache Status | trait | The status of the cache component. May return null if the cache is not started. | cache-status |
Elapsed Time | measurement | Time (in secs) since cache started. May return null if the cache is not started. | elapsed-time |
Hit Ratio | measurement | The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started. | hit-ratio |
Hits | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Hits per Minute | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Invalidations | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Invalidations per Minute | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Misses | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Misses per Minute | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Number Of Entries | measurement | The current number of entries in the cache. May return null if the cache is not started. | number-of-entries |
Passivations | measurement | The 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 Minute | measurement | The 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 Ratio | measurement | The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started. | read-write-ratio |
Remove Hits | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Hits per Minute | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Misses | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Remove Misses per Minute | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Stores | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Stores per Minute | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Time Since Reset | measurement | Time (in secs) since cache statistics were reset. May return null if the cache is not started. | time-since-reset |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Jndi Name | The jndi-name to which to bind this cache instance. | no | jndi-name |
Module | The module whose class loader should be used when building this cache's configuration. | no | module |
Note
3.4.1.27.1.4. EAP7 - Transport Service
Description: | The description of the transport used by this cache container |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Channel | The channel of this cache container's transport. | no | channel |
Lock Timeout | The timeout for locks for the transport. The default value is 240000. | no | lock-timeout |
Note
3.4.1.28. EAP7 - JGroups Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Stack | Default stack to use | yes | default-stack |
Note
Operations
Package Types
3.4.1.29. EAP7 - Remoting Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Worker Read Threads | The number of read threads to create for the remoting worker. The default value is 1. | no | worker-read-threads |
Worker Task Core Threads | The number of core threads for the remoting worker task thread pool. The default value is 4. | no | worker-task-core-threads |
Worker Task Keepalive | The number of milliseconds to keep non-core remoting worker task threads alive. The default value is 60. | no | worker-task-keepalive |
Worker Task Limit | The maximum number of remoting worker tasks to allow before rejecting. The default value is 16384. | no | worker-task-limit |
Worker Task Max Threads | The maximum number of threads for the remoting worker task thread pool. The default value is 16. | no | worker-task-max-threads |
Worker Write Threads | The number of write threads to create for the remoting worker. The default value is 1. | no | worker-write-threads |
Note
Operations
Package Types
3.4.1.30. EAP7 - Osgi Service
Overview
Description: | The OSGi subsystem configuration. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Activation | Activation flag for the OSGi subsystem. Possible values: lazy, eager. The default value is LAZY. | no | activation |
Startlevel | The current Start Level of the OSGi Framework. Changing this value will change the Start Level of the Framework accordingly. | no | startlevel |
Note
Operations
Name | Description |
---|---|
Activate | Activate the OSGi subsystem. |
Package Types
3.4.1.30.1. EAP7 - Capability Service
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
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Startlevel | The startlevel for the capability. Can only be specified for OSGi bundles. | no | startlevel |
Note
Operations
Package Types
3.4.1.30.2. EAP7 - Bundle Service
Overview
Description: | Runtime bundle information. |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Id | The bundle ID. | no | id |
Startlevel | The bundle's start level. | no | startlevel |
Symbolic Name | The bundle symbolic name. | no | symbolic-name |
Version | The bundle version. | no | version |
Note
Operations
Name | Description |
---|---|
Start | Starts the bundle. |
Stop | Stops the bundle. |
Package Types
3.4.1.30.3. EAP7 - Property Service
Overview
Description: | A property |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The property value. | no | value |
Note
Operations
Package Types
3.4.1.31. EAP7 - Mail Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.31.1. EAP7 - Mail Session Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Debug | Enables javamail debugging. The default value is false. | no | debug |
From | From address that is used as default from, if not set when sending | no | from |
Jndi Name | JNDI name to where mail session should be bound | no | jndi-name |
Note
Operations
Package Types
3.4.1.31.1.1. EAP7 - SMTP Mail Server Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Outbound Socket Binding Ref | Outbound Socket binding to SMTP server | yes | outbound-socket-binding-ref |
Password | Password to authenticate on server | no | password |
Ssl | Does server requires SSL?. The default value is false. | no | ssl |
Username | Username to authenticate on server | no | username |
Note
3.4.1.31.1.2. EAP7 - IMAP Mail Server Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Outbound Socket Binding Ref | Outbound Socket binding to IMAP server | yes | outbound-socket-binding-ref |
Password | Password to authenticate on server | no | password |
Ssl | Does server requires SSL?. The default value is false. | no | ssl |
Username | Username to authenticate on server | no | username |
Note
3.4.1.31.1.3. EAP7 - POP3 Mail Server Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Outbound Socket Binding Ref | Outbound Socket binding to POP3 server | yes | outbound-socket-binding-ref |
Password | Password to authenticate on server | no | password |
Ssl | Does server requires SSL?. The default value is false. | no | ssl |
Username | Username to authenticate on server | no | username |
Note
3.4.1.32. EAP7 - ActiveMQ Messaging Service
Overview
Description: | The messaging subsystems |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.1.32.1. EAP7 - ActiveMQ Artemis Service
Overview
Description: | The ActiveMQ Artemis based messaging subsystem |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Active | trait | Whether the server is active (and accepting connections) or passive (in backup mode, waiting for failover). | active |
Started | trait | Whether this server is started. | started |
Version | trait | The server's version. | version |
Note
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Async Connection Execution Enabled | Whether 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 Password | The password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!. | no | cluster-password |
Cluster User | The 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:expr | If 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 Dir | Whether the server should create the bindings directory on start up. The default value is true. | no | create-bindings-dir |
Create Journal Dir | Whether the server should create the journal directory on start up. The default value is true. | no | create-journal-dir |
Id Cache Size:expr | The size of the cache for pre-creating message IDs. The default value is 20000. | no | id-cache-size:expr |
Incoming Interceptors | The list of incoming interceptor classes used by this server. | no | incoming-interceptors |
Jmx Domain | The JMX domain used to register internal ActiveMQ MBeans in the MBeanServer. The default value is org.apache.activemq.artemis. | no | jmx-domain |
Jmx Management Enabled | Whether 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:expr | The size of the internal buffer on the journal. | no | journal-buffer-size:expr |
Journal Buffer Timeout:expr | The timeout (in nanoseconds) used to flush internal buffers on the journal. | no | journal-buffer-timeout:expr |
Journal Compact Min Files:expr | The 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:expr | The percentage of live data on which we consider compacting the journal. The default value is 30. | no | journal-compact-percentage:expr |
Journal File Size:expr | The size (in bytes) of each journal file. The default value is 10485760. | no | journal-file-size:expr |
Journal Max Io:expr | The maximum number of write requests that can be in the AIO queue at any one time. | no | journal-max-io:expr |
Journal Min Files:expr | How many journal files to pre-create. The default value is 2. | no | journal-min-files:expr |
Journal Pool Files:expr | The 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 Transactional | Whether 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 Transactional | Whether 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 Type | The type of journal to use. The default value is ASYNCIO. | no | journal-type |
Log Journal Write Rate | Whether to periodically log the journal's write rate and flush rate. The default value is false. | no | log-journal-write-rate |
Management Address | Address to send management messages to. The default value is jms.queue.activemq.management. | no | management-address |
Management Notification Address | The 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:expr | Frequency 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:expr | Percentage 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:expr | How many days to keep message counter history. The default value is 10. | no | message-counter-max-day-history:expr |
Message Counter Sample Period:expr | The sample period (in ms) to use for message counters. The default value is 10000. | no | message-counter-sample-period:expr |
Message Expiry Scan Period:expr | How often (in ms) to scan for expired messages. The default value is 30000. | no | message-expiry-scan-period:expr |
Message Expiry Thread Priority:expr | The priority of the thread expiring messages. The default value is 3. | no | message-expiry-thread-priority:expr |
Outgoing Interceptors | The list of outgoing interceptor classes used by this server. | no | outgoing-interceptors |
Override In Vm Security | Whether 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:expr | The maximum number of concurrent reads allowed on paging. The default value is 5. | no | page-max-concurrent-io:expr |
Perf Blast Pages:expr | TODO. The default value is -1. | no | perf-blast-pages:expr |
Persist Delivery Count Before Delivery | Whether 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 Cache | Whether IDs are persisted to the journal. The default value is true. | no | persist-id-cache |
Persistence Enabled | Whether the server will use the file based journal for persistence. The default value is true. | no | persistence-enabled |
Run Sync Speed Test | Whether 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:expr | The number of threads that the main scheduled thread pool has. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Security Domain | The security domain to use to verify user and role information. The default value is other. | no | security-domain |
Security Enabled | Whether security is enabled. The default value is true. | no | security-enabled |
Security Invalidation Interval:expr | How long (in ms) to wait before invalidating the security cache. The default value is 10000. | no | security-invalidation-interval:expr |
Server Dump Interval:expr | How 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 Enabled | Whether gathering of statistics such as message counters are enabled. The default value is false. | no | statistics-enabled |
Thread Pool Max Size:expr | The 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:expr | How 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:expr | How often (in ms) to scan for timeout transactions. The default value is 1000. | no | transaction-timeout-scan-period:expr |
Wild Card Routing Enabled | Whether the server supports wild card routing. The default value is true. | no | wild-card-routing-enabled |
Note
Operations
Name | Description |
---|---|
Close Connections for Address | Closes all the connections of clients connected to this server whose remote address contains the specified IP address. |
Close Connections for User | Closes all the connections of clients connected to this server under the specified user name. |
Close Consumer Connections for Address | Closes all the connections of consumers that are consuming from queues bound to the specified address. |
Commit Prepared Transaction | Heuristically commits a prepared transaction. |
Export Journal | Export the journal to a XML file |
Force Failover | Force the messaging server to stop and notify clients to failover. |
Get address settings as JSON | Returns the address settings as a JSON string for an address match. |
Get connectors as JSON | Returns the connectors configured for this server in a JSON string containing the connectors information. |
Get last sent message ID | Returns the ID of the last message sent from the given session to the given address. |
Get roles | Get the security roles for a specific address match. |
Get roles as JSON | Gets the roles (as a JSON string) for a specific address match. |
Get session creation time | Gets the session's creation time. |
Import Journal | Import an XML file to the journal |
List add | Add entry to list attribute |
List all consumers as JSON | Lists all the consumers. |
List clear | Clear all entries from list attribute |
List connection IDs | Lists the IDs of all the connections connected to this server. |
List connections as JSON | Lists all JMS connections. |
List consumers as JSON | Lists all the consumers which belongs to the JMS Connection specified by the connection id. |
List get | Get entry from list attribute |
List heuristic committed transactions | Lists transactions which have been heuristically committed. |
List heuristic rolled back transactions | Lists transactions which have been heuristically rolled back. |
List prepared transaction details as HTML | Lists all the prepared transaction, sorted by date, oldest first, with details, in HTML format. |
List prepared transaction details as JSON | Lists all the prepared transaction, sorted by date, oldest first, with details, in JSON format. |
List prepared transaction JMS details as HTML | Lists all the prepared transactions, sorted by date, oldest first, in a HTML format. |
List prepared transaction JMS details as JSON | Lists all the prepared transactions, sorted by date, oldest first, in a JSON format. |
List prepared transactions | Lists all the prepared transaction, sorted by date, oldest first. |
List producers info as JSON | For all sessions, lists information about message producers using JSON serialization. |
List remote addresses | Lists 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 remove | Remove entry from list attribute |
List sessions | Lists all the sessions IDs for the specified connection ID. |
List sessions as JSON | Lists all the sessions IDs for the specified connection id. |
List target destinations | Lists all addresses to which the designated session has sent messages. |
Map clear | Clear all entries from map attribute |
Map get | Get entry from map attribute |
Map put | Add entry to map attribute |
Map remove | Remove entry from map attribute |
Query | Query a resource |
Reset all message counter histories | Resets all message counters history. |
Reset All Message Counters | Resets all message counters. |
Resolve address setting | Resolve the address settings using ActiveMQ hierarchy of address settings. |
Rollback prepared transaction | Heuristically rolls back a prepared transaction. |
Package Types
3.4.1.32.1.1. EAP7 - JMS Queue Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Consumer Count | measurement | The number of consumers consuming messages from this queue. | consumer-count |
Dead Letter Address | trait | The address to send dead messages to. | dead-letter-address |
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Expiry Address | trait | The address to send expired messages to. | expiry-address |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Paused | trait | Whether the queue is paused. | paused |
Scheduled Count | measurement | The number of scheduled messages in this queue. | scheduled-count |
Temporary | trait | Whether the queue is temporary. | temporary |
Queue Address | trait | The queue address defines what address is used for routing messages. | queue-address |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Durable | Whether the queue is durable or not. The default value is true. | no | durable |
Entries | The jndi names the queue will be bound to. | yes | entries |
Selector | The queue selector. | no | selector |
Note
Name | Description |
---|---|
Change Message Priority | Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Change Messages Priority | Change the priority of the messages corresponding to the given filter. Returns the number of removed messages. |
Count Messages | Returns the number of the messages in the queue matching the given filter. |
Expire Message | Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Expire Messages | Expire the messages matching the given filter. |
List Add | Add entry to list attribute |
List Clear | Clear all entries from list attribute |
List Consumers as JSON | A string in JSON format. |
List Delivering Messages | List the messages are currently being delivered. |
List Delivering Messages As Json | List the messages are currently being delivered as a string in JSON format |
List Get | Get entry from list attribute |
List Message Counter as HTML | List the message counter as a string in HTML format. |
List Message Counter as JSON | List the message counter as a string in JSON format. |
List Message Counter History as HTML | List the message counter history. |
List Message Counter History as JSON | List the message counter history as a string in JSON format. |
List Messages | List all messages in the queue that match the filter |
List Messages as JSON | List all messages in the queue that match the filter and return them as a string in JSON format. |
Map Clear | Clear all entries from map attribute |
Map Get | Get entry from map attribute |
Map Put | Add entry to map attribute |
Map Remove | Remove entry from map attribute |
Move Message | Move the message corresponding to the given message-id to another queue |
Move Messages | Move the messages corresponding to the given filter to another queue. |
Pause | Pause the queue. |
Remove Message | Remove the message corresponding to the given message-id. |
Remove Messages | Remove messages matching the given filter from the destination. |
Reset Message Counter | Reset the message counters. |
Resume | Resume the queue. |
Send Message to Dead Letter Address | Send the message corresponding to the given message-id to this queue's Dead Letter Address. |
Send Messages to Dead Letter Address | Send the messages corresponding to the given filter to this queue's Dead Letter Address. |
3.4.1.32.1.2. EAP7 - JMS Topic Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Durable Message Count | measurement | The number of messages for all durable subscribers for this topic. | durable-message-count |
Durable Subscription Count | measurement | The number of durable subscribers for this topic. | durable-subscription-count |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Non Durable Message Count | measurement | The number of messages for all non-durable subscribers for this topic. | non-durable-message-count |
Non Durable Subscription Count | measurement | The number of non-durable subscribers for this topic. | non-durable-subscription-count |
Subscription Count | measurement | The number of (durable and non-durable) subscribers for this topic. | subscription-count |
Temporary | trait | Whether the topic is temporary. | temporary |
Topic Address | trait | The address the topic points to. | topic-address |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
JNDI Names | The jndi names the queue will be bound to. | yes | entries |
Note
Name | Description |
---|---|
Count Messages for Subscription | Count the number of messages matching the filter for the given subscription. |
Drop All Subscriptions | Drop all subscriptions from this topic. |
Drop Durable Subscription | Drop a durable subscription |
List All Subscriptions | List all subscriptions. |
List All Subscriptions as JSON | List all subscriptions as a string in JSON format. |
List Durable Subscriptions | List only the durable subscriptions. |
List Durable Subscriptions as JSON | List only the durable subscriptions, as a string in JSON format. |
List Messages for Subscription | List all the messages for the given subscription. |
List Messages for Subscription as JSON | List all the messages for the given subscription as a string in JSON format. |
List Non-Durable Subscriptions | List only the non-durable subscriptions. |
List Non-Durable Subscriptions as JSON | List only the non-durable subscriptions, as a string in JSON format. |
Remove Messages | Remove messages matching the given filter from the destination. |
3.4.1.32.1.3. EAP7 - Connection Factory Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Auto Group | Whether or not message grouping is automatically used. The default value is false. | no | auto-group |
Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
Call Failover Timeout:expr | The timeout to use when fail over is in process (in ms). The default value is -1. | no | call-failover-timeout:expr |
Call Timeout:expr | The call time out. The default value is 30000. | no | call-timeout:expr |
Client Failure Check Period:expr | The client failure check period. The default value is 30000. | no | client-failure-check-period:expr |
Client Id | The client id. | no | client-id |
Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
Confirmation Window Size:expr | The confirmation window size. The default value is -1. | no | confirmation-window-size:expr |
Connection Load Balancing Policy Class Name | Name 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:expr | The connection ttl. The default value is 60000. | no | connection-ttl:expr |
Connectors | Defines 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:expr | The consumer max rate. The default value is -1. | no | consumer-max-rate:expr |
Consumer Window Size:expr | The consumer window size. The default value is 1048576. | no | consumer-window-size:expr |
Discovery Group | The discovery group name. | no | discovery-group |
Dups Ok Batch Size:expr | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size:expr |
Entries | The jndi names the connection factory should be bound to. | yes | entries |
Factory Type | The type of connection factory. The default value is GENERIC. | no | factory-type |
Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
Group Id | The group id. | no | group-id |
Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
Max Retry Interval:expr | The max retry interval. The default value is 2000. | no | max-retry-interval:expr |
Min Large Message Size:expr | The min large message size. The default value is 102400. | no | min-large-message-size:expr |
Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
Producer Max Rate:expr | The producer max rate. The default value is -1. | no | producer-max-rate:expr |
Producer Window Size:expr | The producer window size. The default value is 65536. | no | producer-window-size:expr |
Reconnect Attempts:expr | The reconnect attempts. The default value is 0. | no | reconnect-attempts:expr |
Retry Interval:expr | The retry interval. The default value is 2000. | no | retry-interval:expr |
Retry Interval Multiplier:expr | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier:expr |
Scheduled Thread Pool Max Size:expr | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Thread Pool Max Size:expr | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
Transaction Batch Size:expr | The transaction batch size. The default value is 1048576. | no | transaction-batch-size:expr |
Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Note
3.4.1.32.1.4. EAP7 - Pooled Connection Factory Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Auto Group | Whether or not message grouping is automatically used. The default value is false. | no | auto-group |
Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
Call Failover Timeout:expr | The timeout to use when fail over is in process (in ms). The default value is -1. | no | call-failover-timeout:expr |
Call Timeout:expr | The call time out. The default value is 30000. | no | call-timeout:expr |
Client Failure Check Period:expr | The client failure check period. The default value is 30000. | no | client-failure-check-period:expr |
Client Id | The client id. | no | client-id |
Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
Confirmation Window Size:expr | The confirmation window size. The default value is -1. | no | confirmation-window-size:expr |
Connection Load Balancing Policy Class Name | Name 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:expr | The connection ttl. The default value is 60000. | no | connection-ttl:expr |
Connectors | Defines 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:expr | The consumer max rate. The default value is -1. | no | consumer-max-rate:expr |
Consumer Window Size:expr | The consumer window size. The default value is 1048576. | no | consumer-window-size:expr |
Discovery Group | The discovery group name. | no | discovery-group |
Dups Ok Batch Size:expr | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size:expr |
Entries | The jndi names the connection factory should be bound to. | yes | entries |
Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
Group Id | The group id. | no | group-id |
Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
Max Retry Interval:expr | The max retry interval. The default value is 2000. | no | max-retry-interval:expr |
Min Large Message Size:expr | The min large message size. The default value is 102400. | no | min-large-message-size:expr |
Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
Producer Max Rate:expr | The producer max rate. The default value is -1. | no | producer-max-rate:expr |
Producer Window Size:expr | The producer window size. The default value is 65536. | no | producer-window-size:expr |
Protocol Manager Factory | The protocol manager factory used by this connection factory. | no | protocol-manager-factory |
Reconnect Attempts:expr | The reconnect attempts. The default value is 0. | no | reconnect-attempts:expr |
Retry Interval:expr | The retry interval. The default value is 2000. | no | retry-interval:expr |
Retry Interval Multiplier:expr | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier:expr |
Scheduled Thread Pool Max Size:expr | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Thread Pool Max Size:expr | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
Transaction Batch Size:expr | The transaction batch size. The default value is 1048576. | no | transaction-batch-size:expr |
Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Note
3.4.1.32.1.5. EAP7 - Security Setting Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.1.32.1.5.1. EAP7 - Role Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Consume | his permission allows the user to consume a message from a queue bound to matching addresses. The default value is false. | yes | consume |
Create Durable Queue | This permission allows the user to create a durable queue. The default value is false. | yes | create-durable-queue |
Create Non Durable Queue | This permission allows the user to create a temporary queue. The default value is false. | yes | create-non-durable-queue |
Delete Durable Queue | This permission allows the user to delete a durable queue. The default value is false. | yes | delete-durable-queue |
Delete Non Durable Queue | This permission allows the user to delete a temporary queue. The default value is false. | yes | delete-non-durable-queue |
Manage | This permission allows the user to invoke management operations by sending management messages to the management address. The default value is false. | yes | manage |
Send | This permission allows the user to send a message to matching addresses. The default value is false. | yes | send |
Note
3.4.1.32.1.6. EAP7 - Address Setting Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Address Full Policy | Determines 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 Address | The dead letter address | no | dead-letter-address |
Expiry Address | Defines where to send a message that has expired. | no | expiry-address |
Last Value Queue | Defines whether a queue only uses last values or not. The default value is false. | no | last-value-queue |
Max Delivery Attempts | Defines 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 Bytes | The max bytes size. The default value is -1. | no | max-size-bytes |
Message Counter History Day Limit | Day limit for the message counter history. The default value is 0. | no | message-counter-history-day-limit |
Page Max Cache Size | The 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 Bytes | The paging size. The default value is 10485760. | no | page-size-bytes |
Redelivery Delay | Defines how long to wait before attempting redelivery of a cancelled message. The default value is 0. | no | redelivery-delay |
Redistribution Delay | Defines 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 Route | If 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 Queues | Determines 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 Queues | Determines Whether ActiveMQ should automatically delete auto-created JMS queues when they have no consumers and no messages. | no | auto-delete-jms-queues |
Expiry Delay | Defines the expiration time that will be used for messages using the default expiration time. | no | expiry-delay |
Max Redelivery Delay | Maximum value for the redelivery-delay (in ms). | no | max-redelivery-delay |
Redelivery Multiplier | Multiplier to apply to the redelivery-delay parameter. | no | redelivery-multiplier |
Note
3.4.1.32.1.7. EAP7 - Grouping Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Grouping Handler Address | A reference to a cluster connection and the address it uses. | yes | grouping-handler-address |
Timeout | How 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 |
Type | Whether 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
3.4.1.32.1.8. EAP7 - Acceptor Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Started | trait | Whether this acceptor is started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Factory Class | The factory class. | yes | factory-class |
Socket Binding | The socket binding reference. | no | socket-binding |
Note
Name | Description |
---|---|
Start | Starts the acceptor. |
Stop | Stops the acceptor. |
3.4.1.32.1.8.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.1.32.1.9. EAP7 - Connector (ActiveMQ) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Factory Class | The factory class. | yes | factory-class |
Socket Binding | The socket binding reference. | no | socket-binding |
Note
3.4.1.32.1.9.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.1.32.1.10. EAP7 - In VM Acceptor Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Started | trait | Whether it's stopped or started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Server Id | The server id. | yes | server-id |
Note
Name | Description |
---|---|
Start | Starts the acceptor. |
Stop | Stops the acceptor. |
3.4.1.32.1.10.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.1.32.1.11. EAP7 - In VM Connector Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Server Id | The server id. | yes | server-id |
Note
3.4.1.32.1.11.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.1.32.1.12. EAP7 - Remote Acceptor Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Started | trait | Whether this acceptor is started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Socket Binding | The socket binding reference. | no | socket-binding |
Note
Name | Description |
---|---|
Start | Starts the acceptor. |
Stop | Stops the acceptor. |
3.4.1.32.1.12.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.1.32.1.13. EAP7 - Remote Connector Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Socket Binding | The socket binding reference. | no | socket-binding |
Note
3.4.1.32.1.13.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.1.32.1.14. EAP7 - Divert Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Divert Address | Address to divert from | yes | divert-address |
Exclusive | Whether 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 |
Filter | An 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 Address | Address to divert to | yes | forwarding-address |
Routing Name | Routing name of the divert | no | routing-name |
Transformer Class Name | The name of a class used to transform the message's body or properties before it is diverted. | no | transformer-class-name |
Note
3.4.1.32.1.15. EAP7 - Queue Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Id | trait | The id of the queue. | id |
Paused | trait | Whether the queue is paused. | paused |
Temporary | trait | Whether the queue is temporary. | temporary |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Durable | Defines whether the queue is durable. The default value is true. | no | durable |
Filter | A queue message filter definition. An undefined or empty filter will match all messages. | no | filter |
Queue Address | The queue address defines what address is used for routing messages. | yes | queue-address |
Note
Name | Description |
---|---|
Change Message Priority | Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Change Messages Priority | Change the priority of the messages corresponding to the given filter. |
Count Messages | Returns the number of the messages in the queue matching the given filter. |
Expire Message | Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Expire Messages | Expire the messages matching the given filter. |
List Consumers as JSON | A string in JSON format. |
List Message Counter as HTML | List the message counter as a string in HTML format. |
List Message Counter as JSON | List the message counter as a string in JSON format. |
List Message Counter History as HTML | List the message counter history. |
List Message Counter History as JSON | List the message counter history as a string in JSON format. |
List Messages | List all messages in the queue that match the filter |
List Messages as JSON | List all messages in the queue that match the filter and return them as a string in JSON format. |
List Scheduled Messages | List the messages scheduled for delivery. |
List Scheduled Messages as JSON | List the messages scheduled for delivery as a string in JSON format. |
Move Message | Move the message corresponding to the given message-id to another queue |
Move Messages | Move the messages corresponding to the given filter to another queue. |
Pause | Pause the queue. |
Remove Message | Remove the message corresponding to the given message-id. |
Remove Messages | Remove messages matching the given filter from the destination. |
Reset Message Counter | Reset the message counters. |
Resume | Resume the queue. |
Send Message to Dead Letter Address | Send the message corresponding to the given message-id to this queue's Dead Letter Address. |
Send Messages to Dead Letter Address | Send the messages corresponding to the given filter to this queue's Dead Letter Address. |
3.4.1.32.1.16. EAP7 - Core Address Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Binding Names | The names of all bindings (both queues and diverts) bound to this address. | yes | binding-names |
Number Of Bytes Per Page | The number of bytes used by each page for this address. | yes | number-of-bytes-per-page |
Number Of Pages | The number of pages used by this address. | yes | number-of-pages |
Queue Names | The names of the queues associated with the address. | yes | queue-names |
Roles | A list of the security roles (name and permissions) associated with the address. | yes | roles |
Note
3.4.1.32.1.17. EAP7 - Cluster Connection Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Node Id | trait | The node ID used by this cluster connection. | node-id |
Started | trait | Whether the cluster connection is started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Call Timeout | The timeout (in ms) for remote calls made by the cluster connection. The default value is 30000. | no | call-timeout |
Check Period | The period (in milliseconds) between client failure check. The default value is 30000. | no | check-period |
Cluster Connection Address | Each cluster connection only applies to messages sent to an address that starts with this value. | yes | cluster-connection-address |
Confirmation Window Size | The 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 Ttl | The 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 Ref | The confirmation-window-size to use for the connection used to forward messages to a target node. | yes | connector-ref |
Discovery Group Name | The 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 Consumers | Whether 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 Hops | The 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 Interval | The maximum interval of time used to retry connections. The default value is 2000. | no | max-retry-interval |
Min Large Message Size | The 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 Attempts | The 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 Interval | The 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 Multiplier | A 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 Connectors | The 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 Detection | Whether 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
Name | Description |
---|---|
Get Nodes | Returns 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. |
Start | Starts the cluster connection. |
Stop | Stops the cluster connection. |
3.4.1.32.1.18. EAP7 - Broadcast Group Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Started | trait | Whether the broadcast group is started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Broadcast Period | The period in milliseconds between consecutive broadcasts. The default value is 2000. | no | broadcast-period |
Connectors | Specifies the names of connectors that will be broadcast. | no | connectors |
Socket Binding | The broadcast group socket binding. | yes | socket-binding |
Note
Name | Description |
---|---|
Get Connector Pairs as JSON | Returns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization. |
Start | Starts the broadcast group. |
Stop | Stops the broadcast group. |
3.4.1.32.1.19. EAP7 - Path Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Path | The 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 To | The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:
| no | relative-to |
Path Type | Path Type | yes | __name |
Note
3.4.1.32.1.20. EAP7 - Bridge Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Started | trait | Whether the bridge is started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Check Period | The period (in milliseconds) between client failure check. The default value is 30000. | no | check-period |
Confirmation Window Size | The 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 Ttl | The 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 Name | The 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 Shutdown | Whether 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 |
Filter | An 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 Address | The 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 |
Ha | Whether 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 Interval | The maximum interval of time used to retry connections. The default value is 2000. | no | max-retry-interval |
Min Large Message Size | The 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 |
Password | The 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 Name | The unique name of the local queue that the bridge consumes from. | yes | queue-name |
Reconnect Attempts | The 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 Interval | The 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 Multiplier | A 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 Connectors | A 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 Name | The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface. | no | transformer-class-name |
Use Duplicate Detection | Whether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. | no | use-duplicate-detection |
User | The 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
Name | Description |
---|---|
Start | Starts the bridge. |
Stop | Stops the bridge. |
3.4.1.32.1.21. EAP7 - Discovery Group Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Initial Wait Timeout | Period, 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 Timeout | Period 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 Binding | The discovery group socket binding. | yes | socket-binding |
Note
3.4.1.32.1.22. EAP7 - Connector Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Factory Class | Class name of the factory class that can instantiate the connector service. | yes | factory-class |
Note
3.4.1.32.1.22.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.1.32.1.23. EAP7 - Runtime Queue Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Consumer Count | measurement | The number of consumers consuming messages from this queue. | consumer-count |
Dead Letter Address | trait | The address to send the queue's dead messages to. | dead-letter-address |
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Durable | trait | Defines whether the queue is durable. | durable |
Expiry Address | trait | The address to send the queue's expired messages to. | expiry-address |
Filter | trait | A queue message filter definition. An undefined or empty filter will match all messages. | filter |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Paused | trait | Whether the queue is paused. | paused |
Queue Address | trait | The queue address defines what address is used for routing messages. | queue-address |
Scheduled Count | measurement | The number of scheduled messages in this queue. | scheduled-count |
Temporary | trait | Whether the queue is temporary. | temporary |
Note
Name | Description |
---|---|
List Scheduled Messages as JSON | List the messages scheduled for delivery as a string in JSON format. |
List Messages as JSON | List all messages in the queue that match the filter and return them as a string in JSON format. |
Count Messages | Returns the number of the messages in the queue matching the given filter. |
List Consumers as JSON | Lists consumers. |
Change Messages Priority | Change the priority of the messages corresponding to the given filter. |
Pause | Pause the queue. |
List Message Counter History as JSON | List the message counter history as a string in JSON format. |
Expire Messages | Expire the messages matching the given filter. |
List Messages | List all messages in the queue that match the filter |
Send message To Dead Letter Address | Send the message corresponding to the given message-id to this queue's Dead Letter Address. |
Reset Message Counters | Reset the message counters. |
Move Message | Move the message corresponding to the given message-id to another queue |
Expire Message | Expire the message corresponding to the given message-id. |
List Message Counter as JSON | List the message counter as a string in JSON format. |
List Message Counter as HTML | List the message counter as a string in HTML format. |
Remove Messages | Remove messages matching the given filter from the destination. |
Move Messages | Move the messages corresponding to the given filter to another queue. |
List Message Counter as HTML | List the message counter history. |
List Scheduled Messages | List the messages scheduled for delivery. |
Resume | Resume the queue. |
Send Messages to Dead Letter Address | Send the messages corresponding to the given filter to this queue's Dead Letter Address. |
Remove Message | Remove the message corresponding to the given message-id. |
Change Message Priority | Change the priority of the message corresponding to the given message-id. |
3.4.2. EAP7 - Host Controller Server
Overview
Description: | Domain controller (delegate) for this host |
Singleton: | no |
Plugin: | EAP7 |
Note
Child Resource Types
Autodiscovery Process Scans
Name | Query |
---|---|
HostController | process|basename|match=^java.*,arg|org.jboss.as.host-controller|match=.* |
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Start Script Path | The 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 Prefix | A 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 Variables | The 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 Arguments | The 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 Authentication | Specifies 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 Strategy | Defines the trust strategy to use when reading the server certificate:
| yes | trustStrategy |
Hostname Verification | Defines the hostname verification logic:
| yes | hostnameVerification |
Truststore | Path to a truststore file. If undefined, the JVM default truststore is used. | no | truststore |
Truststore Type | Truststore file format (required when the Truststore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats. | no | truststoreType |
Truststore Password | Password protecting the truststore file. | no | truststorePassword |
Client Certificate Authentication | yes | clientcertAuthentication | |
Keystore | Path to a keystore file. Required when Client Certificate Authentication is on. | no | keystore |
Keystore Type | Keystore file format (required when the Keystore property is set). All certified JVMs support jks (Java KeyStore) or pkcs12 formats. | no | keystoreType |
Keystore Password | Password protecting the keystore file. | no | keystorePassword |
Key Password | Password protecting the secret key in the keystore file. | no | keyPassword |
Hostname | Host name of the domain API | yes | hostname |
Port | Port of the domain API | yes | port |
Secure | Encrypted transport indicator | yes | secure |
User | Management user for a secured Host controller | no | user |
Password | Password for the management user | no | password |
Management Connection Timeout | Maximum 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 Directory | Root directory of the server installation | no | homeDir |
Base Directory | Base directory for server content | no | baseDir |
Configuration Directory | Base configuration directory | no | configDir |
Log Directory | the directory where log files will be written for this host controller | no | logDir |
Domain Host | Host name within the AS7 domain (Deprecated, use 'name' trait) | no | domainHost |
Product Type | Server product type (e.g. AS or EAP) | no | productType |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Number of management requests | measurement | Number of requests sent to the controller | _internal:mgmtRequests |
Number of management requests per Minute | measurement | Number of requests sent to the controller | _internal:mgmtRequests |
Time used for management requests | measurement | Total time for requests | _internal:requestTime |
Time used for management requests per Minute | measurement | Total time for requests | _internal:requestTime |
Maximum request time | measurement | Max time for a request since last metric get | _internal:maxTime |
Server Code Name | trait | Server Code Name | _skm:release-codename |
Server Version | trait | Server Version | _skm:release-version |
Product Name | trait | Product Name | _skm:product-name |
Product Version | trait | Product Version | _skm:product-version |
Start time of the server | trait | Start time of the server | startTime |
Domain Config File | trait | The name of the domain configuration file this host controller is using | domain-config-file |
Host Config File | trait | The name of the host configuration file this host controller is using | host-config-file |
Domain Host Name | trait | The name of the host in domain this host controller is using | domain-host-name |
Domain Name | trait | The name of the managed domain this Host Controller belongs to. | domain-name |
Temporary Directory | trait | The temporary directory (usually 'domain/tmp'). May serve as deployment directory for handover bundles' | domain-temp-dir |
Active Patches | trait | The 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
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | no | *2 | |
Path | 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 | *3 |
Installed extensions | no | * | |
Domain Name | Name 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
Operations
Name | Description |
---|---|
Start this host controller | Start this Host/Domain Controller with all its enabled managed servers |
Shut down this host controller | Stop this Host/Domain Controller with all its managed servers |
Restart this host controller | Restart this Host/Domain Controller with all its running managed servers |
Install a management user | Installs a user in the server for management |
Execute CLI commands | Executes command via jboss-cli |
Execute CLI script | Executes script via jboss-cli |
Setup CLI | Setup 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
3.4.2.1. EAP7 - ServerGroup Service
Overview
Description: | A server group on this domain |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | no | *2 | |
Profile | The profile name | yes | profile |
Socket Binding Group | yes | socket-binding-group | |
Socket Binding Port Offset | The default offset to be added to the port values given by the socket binding group. | no | socket-binding-port-offset |
Note
Operations
Name | Description |
---|---|
Start Servers | Starts all configured servers belonging to the server group in the domain that are not currently running. |
Restart Servers | Restarts all servers belonging to the server group currently running in the domain. |
Stop Servers | Stops all servers belonging to the server group currently running in the domain. |
Package Types
3.4.2.1.1. EAP7 - JVM Definition Service
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
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Base Definition | The definition from host level to use/override | yes | baseDefinition |
Agent Lib | The JVM agent lib. | no | agent-lib |
Agent Path | The JVM agent path. | no | agent-path |
Env Classpath Ignored | Ignore the environment classpath. | no | env-classpath-ignored |
Environment Variables | The JVM environment variables. | no | environment-variables |
Heap Size | The initial heap size allocated by the JVM. | no | heap-size |
Java Agent | The java agent. | no | java-agent |
Java Home | The java home | no | java-home |
Jvm Options | The JVM options. Those can not be changed after initial creation of the definition. | no | jvm-options |
Max Heap Size | The maximum heap size that can be allocated by the JVM. | no | max-heap-size |
Max Permgen Size | The maximum size of the permanent generation. | no | max-permgen-size |
Permgen Size | The initial permanent generation size. | no | permgen-size |
Stack Size | The JVM stack size settings. | no | stack-size |
Type | The JVM type can be either SUN or IBM | no | type |
Note
Operations
Package Types
3.4.2.2. EAP7 - Host Service
Overview
Description: | A host involved in this domain |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Host state | trait | Detailed host state | host-state |
Start time of the server | trait | Start time of the server | startTime |
Note
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | no | *2 | |
Path | 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 | *3 |
Note
Operations
Package Types
3.4.2.2.1. EAP7 - Network Interface Service
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
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Any Address | Attribute 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 Address | Attribute 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 |
Loopback | Attribute 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 Address | Attribute 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 |
Multicast | Attribute 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 |
Nic | Attribute 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 Match | Attribute 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 Point | Attribute 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 Address | Attribute 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 Address | Attribute 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 Match | Attribute 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 |
Up | Attribute 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 |
Virtual | Attribute 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 Address | Attribute 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
Operations
Package Types
3.4.2.2.2. EAP7 - JVM Service
Overview
Description: | Information about the underlying JVM |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.2.2.1. EAP7 - Operating System Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Available Processors | measurement | The number of processors available to the Java virtual machine. | available-processors |
System Load Average | measurement | The 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
3.4.2.2.2.2. EAP7 - Memory Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Object Pending Finalization Count | measurement | The approximate number of objects for which finalization is pending. | object-pending-finalization-count |
Initial heap usage | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | heap-memory-usage:init |
Used heap | measurement | The amount of used memory in bytes. | heap-memory-usage:used |
Committed heap | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | heap-memory-usage:committed |
Maximum heap usage | measurement | The maximum amount of memory in bytes that can be used for memory management. | heap-memory-usage:max |
Initial non-heap usage | measurement | The 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 memory | measurement | The amount of used memory in bytes. | non-heap-memory-usage:used |
Committed non-heap memory | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | non-heap-memory-usage:committed |
Maximum non-heap usage | measurement | The maximum amount of memory in bytes that can be used for memory management. | non-heap-memory-usage:max |
Note
Name | Description |
---|---|
Trigger GC | Runs the garbage collector. |
3.4.2.2.2.3. EAP7 - Runtime Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Uptime | measurement | The uptime of the Java virtual machine in milliseconds. | uptime |
Note
3.4.2.2.2.4. EAP7 - Threading Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Thread Count | measurement | The current number of live threads including both daemon and non-daemon threads. | thread-count |
Peak Thread Count | measurement | The peak live thread count since the Java virtual machine started or peak was reset. | peak-thread-count |
Total Started Thread Count | measurement | The total number of threads created and also started since the Java virtual machine started. | total-started-thread-count |
Daemon Thread Count | measurement | The current number of live daemon threads. | daemon-thread-count |
Current Thread Cpu Time | measurement | The 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 Time | measurement | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Thread Contention Monitoring Enabled | Whether thread contention monitoring is enabled. | no | thread-contention-monitoring-enabled |
Thread Cpu Time Enabled | Whether thread CPU time measurement is enabled. | no | thread-cpu-time-enabled |
Thread Contention Monitoring Supported | Whether the Java virtual machine supports thread contention monitoring. | no | thread-contention-monitoring-supported |
Thread Cpu Time Supported | Whether the Java virtual machine implementation supports CPU time measurement for any thread. | no | thread-cpu-time-supported |
Current Thread Cpu Time Supported | Whether the Java virtual machine supports CPU time measurement for the current thread. | no | current-thread-cpu-time-supported |
Object Monitor Usage Supported | Whether the Java virtual machine supports monitoring of object monitor usage. | no | object-monitor-usage-supported |
Synchronizer Usage Supported | Whether the Java virtual machine supports monitoring of ownable synchronizer usage. | no | synchronizer-usage-supported |
Note
Name | Description |
---|---|
Dump All Threads | Returns the thread info for all live threads with stack trace and synchronization information. |
Find Deadlocked Threads | Finds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers. |
Find Monitor Deadlocked Threads | Finds cycles of threads that are in deadlock waiting to acquire object monitors. |
Get Thread Cpu Time | Returns the total CPU time for a thread of the specified ID in nanoseconds. |
Get Thread Info | Returns 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 Infos | Returns the thread info for each thread whose ID is in the input list. |
Get Thread User Time | Returns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds. |
Reset Peak Thread Count | Resets the peak thread count to the current number of live threads. |
Get All thread ids | Get all live thread IDs. If a security manager is installed and the caller does not have ManagementPermission('monitor'), the result will be undefined. |
3.4.2.2.2.5. EAP7 - Garbage Collector Service
Description: | Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.2.2.5.1. EAP7 - Garbage Collector Resource Service
Description: | The management interface for one of the garbage collectors in the Java virtual machine. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Collection Count | measurement | The total number of collections that have occurred. | collection-count |
Collection Count per Minute | measurement | The total number of collections that have occurred. | collection-count |
Collection Time | measurement | The approximate accumulated collection elapsed time in milliseconds. | collection-time |
Collection Time per Minute | measurement | The approximate accumulated collection elapsed time in milliseconds. | collection-time |
Name | trait | The name representing this garbage collector | name |
Valid | trait | Whether this this memory manager is valid in the Java virtual machine. | valid |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Memory Pool Names | The name of memory pools that this garbage collector manages. | yes | memory-pool-names |
Note
3.4.2.2.2.6. EAP7 - Memory Pool Service
Description: | Parent resource for the resources providing the management interface for the Java virtual machine's memory pools. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.2.2.6.1. EAP7 - Memory Pool Resource Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Collection Usage - Init | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | collection-usage:init |
Collection Usage - Used | measurement | The amount of used memory in bytes. | collection-usage:used |
Collection Usage - Committed | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | collection-usage:committed |
Collection Usage - Max | measurement | The maximum amount of memory in bytes that can be used for memory management. | collection-usage:max |
Collection Usage Threshold Count | measurement | The 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 Exceeded | trait | Whether 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 Supported | trait | Whether this memory pool supports a collection usage threshold. | collection-usage-threshold-supported |
Name | trait | The name representing this memory pool. | name |
Peak Usage - Init | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | peak-usage:init |
Peak Usage - Used | measurement | The amount of used memory in bytes. | peak-usage:used |
Peak Usage - Committed | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | peak-usage:committed |
Peak Usage - Max | measurement | The maximum amount of memory in bytes that can be used for memory management. | peak-usage:max |
Type | trait | The type of this memory pool. | type |
Usage - Init | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | usage:init |
Usage - Used | measurement | The amount of used memory in bytes. | usage:used |
Usage - Committed | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | usage:committed |
Usage - Max | measurement | The maximum amount of memory in bytes that can be used for memory management. | usage:max |
Usage Threshold Count | measurement | The 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 Exceeded | trait | Whether 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 Supported | trait | Whether this memory pool supports usage threshold. | usage-threshold-supported |
Valid | trait | Whether 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
Name | Description | Required | Internal Name |
---|---|---|---|
Collection Usage Threshold | The 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 Names | The names of the memory managers that manage this memory pool. | yes | memory-manager-names |
Usage Threshold | The 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
Name | Description |
---|---|
Reset Peak Usage | Resets the peak memory usage statistic of this memory pool to the current memory usage. |
3.4.2.2.3. EAP7 - JVM Definition (Host) Service
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
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Agent Lib | The JVM agent lib. | no | agent-lib |
Agent Path | The JVM agent path. | no | agent-path |
Env Classpath Ignored | Ignore the environment classpath. | no | env-classpath-ignored |
Environment Variables | The JVM environment variables. | no | environment-variables |
Heap Size | The initial heap size allocated by the JVM. | no | heap-size |
Java Agent | The java agent. | no | java-agent |
Java Home | The java home | no | java-home |
Jvm Options | The JVM options. Those can not be changed after initial creation of the definition. | no | jvm-options |
Max Heap Size | The maximum heap size that can be allocated by the JVM. | no | max-heap-size |
Max Permgen Size | The maximum size of the permanent generation. | no | max-permgen-size |
Permgen Size | The initial permanent generation size. | no | permgen-size |
Stack Size | The JVM stack size settings. | no | stack-size |
Type | The JVM type can be either SUN or IBM | no | type |
Note
Operations
Package Types
3.4.2.3. EAP7 - DomainDeployment Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Name | yes | name | |
Runtime Name | yes | runtime-name | |
Content | yes | content | |
Assigned to | yes | *1 |
Note
Operations
Name | Description |
---|---|
Assign to Server-Group | Deprecated: Use server-group property found in resource configuration instead |
Restart in Server-Group | Restarts this deployment in one or all assigned server group(s) |
Package Types
Name | Category | Description |
---|---|---|
File | Deployable | Deployments on this domain |
3.4.2.4. EAP7 - Managed Server
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Autodiscovery Process Scans
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Log Event Sources | yes | logEventSources | |
Path | yes | path |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Server Code Name | trait | Server Code Name | _skm:release-codename |
Server Version | trait | Server Version | _skm:release-version |
Product Name | trait | Product Name | _skm:product-name |
Product Version | trait | Product Version | _skm:product-version |
Server state | trait | Detailed server state | status |
Start time of the server | trait | Start time of the server | startTime |
JGroups Multicast Address | trait | the host and port used by JGroups for multicast | multicastAddress |
Note
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | no | *2 | |
Name of the host to put the server on | yes | hostname | |
Server Group | Server Group this instance belongs to. | yes | group |
Socket binding group | Socket bindings to use | yes | socket-binding-group |
Port Offset | Offset to the base ports | yes | socket-binding-port-offset |
Autostart | Whether or not this server should be started when the Host Controller starts. | yes | auto-start |
Note
Operations
Name | Description |
---|---|
Start | Start this server instance. |
Stop | Stop this server instance. |
Restart | Restart this server instance. |
Package Types
3.4.2.4.1. EAP7 - ManagedServerDeployment Service
Overview
Description: | Deployed package on a managed server. Go to corresponding DomainDeployment to manipulate it |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Status | trait | The 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
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Name | yes | name | |
Runtime Name | yes | runtime-name | |
Content | yes | content |
Note
Operations
Package Types
3.4.2.4.1.1. EAP7 - EJB3 Runtime Service
Description: | Runtime resources exposed by EJBs components included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.1.1. EAP7 - Message Driven Bean Runtime Service
Description: | Bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.2.4.1.1.2. EAP7 - Singleton Bean Runtime Service
Description: | Singleton bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.2.4.1.1.3. EAP7 - Stateless Session Bean Runtime Service
Description: | Stateless session bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.2.4.1.1.4. EAP7 - Entity Bean Runtime Service
Description: | Entity bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Note
3.4.2.4.1.1.5. EAP7 - Stateful Session Bean Runtime Service
Description: | Stateful session bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Note
3.4.2.4.1.2. EAP7 - Subdeployment Service
Description: | Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.2.1. EAP7 - EJB3 Runtime Service
Description: | Runtime resources exposed by EJBs components included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.2.1.1. EAP7 - Message Driven Bean Runtime Service
Description: | Bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.2.4.1.2.1.2. EAP7 - Singleton Bean Runtime Service
Description: | Singleton bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.2.4.1.2.1.3. EAP7 - Stateless Session Bean Runtime Service
Description: | Stateless session bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Timers | EJB timers associated with the component. | yes | timers |
Note
3.4.2.4.1.2.1.4. EAP7 - Entity Bean Runtime Service
Description: | Entity bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Pool Available Count | measurement | The number of available (i.e. not in use) instances in the pool. | pool-available-count |
Pool Create Count | measurement | The number of instances created for the pool. | pool-create-count |
Pool Current Size | measurement | The current size of the instance pool. | pool-current-size |
Pool Max Size | measurement | The maximum size of the instance pool. | pool-max-size |
Pool Remove Count | measurement | The number of instances removed from the pool. | pool-remove-count |
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Note
3.4.2.4.1.2.1.5. EAP7 - Stateful Session Bean Runtime Service
Description: | Stateful session bean component included in the deployment. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Peak concurrent invocations | measurement | The maximum number of concurrent invocations at any given time. | peak-concurrent-invocations |
Invocations | measurement | The total number of invocations made on this EJB. | invocations |
Invocations per Minute | measurement | Number of invocations processed. | invocations |
Wait Time | measurement | Total sum of wait-time for all methods in milliseconds. | wait-time |
Execution Time | measurement | Total execution-time (sum of all execution-time from all of the methods) in milliseconds | execution-time |
Execution Time per Minute | measurement | Time spent within a bean method | execution-time |
Method Execution Time | calltime | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Component Class Name | The component's class name. | no | component-class-name |
Declared Roles | The roles declared (via @DeclareRoles) on this EJB component. | yes | declared-roles |
Run As Role | The run-as role (if any) for this EJB component. | no | run-as-role |
Security Domain | The security domain for this EJB component. | no | security-domain |
Note
3.4.2.4.1.2.2. EAP7 - Resource Adapters Runtime Service
Description: | Configuration of the resource adapters subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.2.2.1. EAP7 - Connection Definition Runtime Service
Description: | Specifies the connection definitions. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Note
3.4.2.4.1.2.3. EAP7 - Web Runtime Service
Description: | Runtime resources exposed by web components in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Response Time Log File | the full path to the log file containing response-time stats for this webapp | no | responseTimeLogFile |
Response Time Url Excludes | a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection | no | responseTimeUrlExcludes |
Response Time Url Transforms | a 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
Name | Type | Description | Internal Name |
---|---|---|---|
Virtual Host | trait | the virtual host this webapp is deployed to | virtual-host |
Context Root | trait | the context root of this webapp | context-root |
Server | trait | The name of server this application belongs to | server |
Response Time | calltime | the minimum, maximum, and average response times for requests serviced by this webapp | responseTime |
Currently Active Sessions | measurement | The number of sessions that are currently active | active-sessions |
Expired Sessions | measurement | The number of expired sessions | expired-sessions |
Expired Sessions per Minute | measurement | The number of expired sessions | expired-sessions |
Maximum Active Sessions | measurement | The maximum number of sessions that have been active | max-active-sessions |
Rejected Sessions | measurement | The number of sessions rejected | rejected-sessions |
Rejected Sessions per Minute | measurement | The number of sessions rejected | rejected-sessions |
Average Session Alive Time | measurement | The average alive time of sessions | session-avg-alive-time |
Max Session Alive Time | measurement | The maximum alive time of sessions | session-max-alive-time |
Created Sessions | measurement | The number of sessions created | sessions-created |
Created Sessions per Minute | measurement | The number of sessions created | sessions-created |
Note
3.4.2.4.1.2.4. EAP7 - JPA Runtime Service
Description: | The configuration of the JPA subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.2.4.1. EAP7 - Hibernate Persistence Unit Service
Description: | Runtime information about JPA use in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Close Statement Count | measurement | Number of released prepared statements. | close-statement-count |
Close Statement Count per Minute | measurement | Number of released prepared statements. | close-statement-count |
Collection Fetch Count | measurement | Number of collections fetched. | collection-fetch-count |
Collection Fetch Count per Minute | measurement | Number of collections fetched. | collection-fetch-count |
Collection Load Count | measurement | Number of collections loaded. | collection-load-count |
Collection Load Count per Minute | measurement | Number of collections loaded. | collection-load-count |
Collection Recreated Count | measurement | Number of collections recreated. | collection-recreated-count |
Collection Recreated Count per Minute | measurement | Number of collections recreated. | collection-recreated-count |
Collection Remove Count | measurement | Number of collections removed. | collection-remove-count |
Collection Remove Count per Minute | measurement | Number of collections removed. | collection-remove-count |
Collection Update Count | measurement | Number of collections updated. | collection-update-count |
Collection Update Count per Minute | measurement | Number of collections updated. | collection-update-count |
Completed Transaction Count | measurement | Number of completed transactions. | completed-transaction-count |
Completed Transaction Count per Minute | measurement | Number of completed transactions. | completed-transaction-count |
Connect Count | measurement | Get the number of connections asked for by the sessions. | connect-count |
Connect Count per Minute | measurement | Get the number of connections asked for by the sessions. | connect-count |
Entity Delete Count | measurement | Get number of entity deletes. | entity-delete-count |
Entity Delete Count per Minute | measurement | Get number of entity deletes. | entity-delete-count |
Entity Fetch Count | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Fetch Count per Minute | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Insert Count | measurement | Get number of entity inserts. | entity-insert-count |
Entity Insert Count per Minute | measurement | Get number of entity inserts. | entity-insert-count |
Entity Load Count | measurement | Get number of entity loads. | entity-load-count |
Entity Load Count per Minute | measurement | Get number of entity loads. | entity-load-count |
Entity Update Count | measurement | Get number of entity updates. | entity-update-count |
Entity Update Count per Minute | measurement | Get number of entity updates. | entity-update-count |
Flush Count | measurement | Get the number of flushes executed by sessions (either implicit or explicit). | flush-count |
Flush Count per Minute | measurement | Get the number of flushes executed by sessions (either implicit or explicit). | flush-count |
Optimistic Failure Count | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Optimistic Failure Count per Minute | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Prepared Statement Count | measurement | Number of acquired prepared statements. | prepared-statement-count |
Prepared Statement Count per Minute | measurement | Number of acquired prepared statements. | prepared-statement-count |
Query Cache Hit Count | measurement | Get the number of cached queries successfully retrieved from cache. | query-cache-hit-count |
Query Cache Hit Count per Minute | measurement | Get the number of cached queries successfully retrieved from cache. | query-cache-hit-count |
Query Cache Miss Count | measurement | Get the number of cached queries not found in cache. | query-cache-miss-count |
Query Cache Miss Count per Minute | measurement | Get the number of cached queries not found in cache. | query-cache-miss-count |
Query Cache Put Count | measurement | Get the number of cacheable queries put in cache. | query-cache-put-count |
Query Cache Put Count per Minute | measurement | Get the number of cacheable queries put in cache. | query-cache-put-count |
Query Execution Count | measurement | Get number of executed queries. | query-execution-count |
Query Execution Count per Minute | measurement | Get number of executed queries. | query-execution-count |
Query Execution Max Time | measurement | Get the time in milliseconds of the slowest query. | query-execution-max-time |
Query Execution Max Time Query String | trait | Get the query string for the slowest query. | query-execution-max-time-query-string |
Second Level Cache Hit Count | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | second-level-cache-hit-count |
Second Level Cache Hit Count per Minute | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | second-level-cache-hit-count |
Second Level Cache Miss Count | measurement | Number of cacheable entities/collections not found in the cache and loaded. | second-level-cache-miss-count |
Second Level Cache Miss Count per Minute | measurement | Number of cacheable entities/collections not found in the cache and loaded. | second-level-cache-miss-count |
Second Level Cache Put Count | measurement | Number of cacheable entities/collections put in the cache. | second-level-cache-put-count |
Second Level Cache Put Count per Minute | measurement | Number of cacheable entities/collections put in the cache. | second-level-cache-put-count |
Session Close Count | measurement | Number of sessions closed. | session-close-count |
Session Close Count per Minute | measurement | Number of sessions closed. | session-close-count |
Session Open Count | measurement | Number of sessions opened. | session-open-count |
Session Open Count per Minute | measurement | Number of sessions opened. | session-open-count |
Successful Transaction Count | measurement | Number of successful transactions. | successful-transaction-count |
Successful Transaction Count per Minute | measurement | Number of successful transactions. | successful-transaction-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Enabled | Determine if statistics are enabled. | no | enabled |
Note
Name | Description |
---|---|
Subsystem:clear | Clear statistics. |
Subsystem:evict All | Evict all entities from second level cache. |
Subsystem:summary | Log the statistics. |
View Queries | View statistical information about queries executed by Hibernate |
3.4.2.4.1.2.4.1.1. EAP7 - Entity Cache Service
Description: | Statistics for a Hibernate Second Level Cache region. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Element Count In Memory | measurement | Number of cacheable entities/collections currently stored in memory. | element-count-in-memory |
Hit Count | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | hit-count |
Miss Count | measurement | Number of cacheable entities/collections not found in the cache and loaded. | miss-count |
Put Count | measurement | Number of cacheable entities/collections put in the cache. | put-count |
Note
3.4.2.4.1.2.4.1.2. EAP7 - Entity Service
Description: | Statistics for individual entities. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Entity Delete Count | measurement | Get number of entity deletes. | entity-delete-count |
Entity Delete Count per Minute | measurement | Get number of entity deletes. | entity-delete-count |
Entity Fetch Count | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Fetch Count per Minute | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Insert Count | measurement | Get number of entity inserts. | entity-insert-count |
Entity Insert Count per Minute | measurement | Get number of entity inserts. | entity-insert-count |
Entity Load Count | measurement | Get number of entity loads. | entity-load-count |
Entity Load Count per Minute | measurement | Get number of entity loads. | entity-load-count |
Entity Update Count | measurement | Get number of entity updates. | entity-update-count |
Entity Update Count per Minute | measurement | Get number of entity updates. | entity-update-count |
Optimistic Failure Count | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Optimistic Failure Count per Minute | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Note
3.4.2.4.1.2.4.1.3. EAP7 - Collection Service
Description: | Statistics for individual collections. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Collection Fetch Count | measurement | Number of times collection was fetched. | collection-fetch-count |
Collection Fetch Count per Minute | measurement | Number of times collection was fetched. | collection-fetch-count |
Collection Load Count | measurement | Number of times collection was loaded. | collection-load-count |
Collection Load Count per Minute | measurement | Number of times collection was loaded. | collection-load-count |
Collection Recreated Count | measurement | Number of times collection was recreated. | collection-recreated-count |
Collection Recreated Count per Minute | measurement | Number of times collection was recreated. | collection-recreated-count |
Collection Remove Count | measurement | Number of times collection was removed. | collection-remove-count |
Collection Remove Count per Minute | measurement | Number of times collection was removed. | collection-remove-count |
Collection Update Count | measurement | Number of times collection was updated. | collection-update-count |
Collection Update Count per Minute | measurement | Number of times collection was updated. | collection-update-count |
Note
3.4.2.4.1.2.5. EAP7 - Messaging Runtime Service
Description: | Runtime resources exposed by messaging resources included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.2.5.1. EAP7 - ActiveMQ Artemis Server Runtime Service
Description: | A ActiveMQ Artemis server instance. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.2.5.1.1. EAP7 - JMS Queue Runtime Service
Description: | Defines a JMS queue. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Consumer Count | measurement | The number of consumers consuming messages from this queue. | consumer-count |
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Dead Letter Address | trait | The address to send dead messages to. | dead-letter-address |
Durable | trait | Whether the queue is durable or not. The default value is true. | durable |
Expiry Address | trait | The address to send expired messages to. | expiry-address |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Paused | trait | Whether the queue is paused. | paused |
Queue Address | trait | The queue address defines what address is used for routing messages. | queue-address |
Scheduled Count | measurement | The number of scheduled messages in this queue. | scheduled-count |
Selector | trait | The queue selector. | selector |
Temporary | trait | Whether the queue is temporary. | temporary |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Entries | The jndi names the queue will be bound to. | no | entries |
Note
Name | Description |
---|---|
Change Message Priority | Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Change Messages Priority | Change the priority of the messages corresponding to the given filter. Returns the number of removed messages. |
Count Messages | Returns the number of the messages in the queue matching the given filter. |
Expire Message | Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Expire Messages | Expire the messages matching the given filter. |
List Consumers as JSON | A string in JSON format. |
Subsystem:list Delivering Messages | List the messages are currently being delivered. |
Subsystem:list Delivering Messages As Json | List the messages are currently being delivered as a string in JSON format |
List Message Counter as HTML | List the message counter as a string in HTML format. |
List Message Counter as JSON | List the message counter as a string in JSON format. |
List Message Counter History as HTML | List the message counter history. |
List Message Counter History as JSON | List the message counter history as a string in JSON format. |
List Messages | List all messages in the queue that match the filter |
List Messages as JSON | List all messages in the queue that match the filter and return them as a string in JSON format. |
Move Message | Move the message corresponding to the given message-id to another queue |
Move Messages | Move the messages corresponding to the given filter to another queue. |
Pause | Pause the queue. |
Remove Message | Remove the message corresponding to the given message-id. |
Remove Messages | Remove messages matching the given filter from the destination. |
Reset Message Counter | Reset the message counters. |
Resume | Resume the queue. |
Send Message to Dead Letter Address | Send the message corresponding to the given message-id to this queue's Dead Letter Address. |
Send Messages to Dead Letter Address | Send the messages corresponding to the given filter to this queue's Dead Letter Address. |
3.4.2.4.1.2.5.1.2. EAP7 - JMS Topic Runtime Service
Description: | Defines a JMS queue. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Durable Message Count | measurement | The number of messages for all durable subscribers for this topic. | durable-message-count |
Durable Subscription Count | measurement | The number of durable subscribers for this topic. | durable-subscription-count |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Non Durable Message Count | measurement | The number of messages for all non-durable subscribers for this topic. | non-durable-message-count |
Non Durable Subscription Count | measurement | The number of non-durable subscribers for this topic. | non-durable-subscription-count |
Subscription Count | measurement | The number of (durable and non-durable) subscribers for this topic. | subscription-count |
Temporary | trait | Whether the topic is temporary. | temporary |
Topic Address | trait | The address the topic points to. | topic-address |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
JNDI Names | The jndi names the queue will be bound to. | no | entries |
Note
Name | Description |
---|---|
Count Messages for Subscription | Count the number of messages matching the filter for the given subscription. |
Drop All Subscriptions | Drop all subscriptions from this topic. |
Drop Durable Subscription | Drop a durable subscription |
List All Subscriptions | List all subscriptions. |
List All Subscriptions as JSON | List all subscriptions as a string in JSON format. |
List Durable Subscriptions | List only the durable subscriptions. |
List Durable Subscriptions as JSON | List only the durable subscriptions, as a string in JSON format. |
List Messages for Subscription | List all the messages for the given subscription. |
List Messages for Subscription as JSON | List all the messages for the given subscription as a string in JSON format. |
List Non-Durable Subscriptions | List only the non-durable subscriptions. |
List Non-Durable Subscriptions as JSON | List only the non-durable subscriptions, as a string in JSON format. |
Remove Messages | Remove messages matching the given filter from the destination. |
3.4.2.4.1.2.5.1.3. EAP7 - Pooled Connection Factory Runtime Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Auto Group | The autogroup. The default value is false. | no | auto-group |
Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
Call Failover Timeout:expr | The timeout to use when fail over is in process (in ms). The default value is -1. | no | call-failover-timeout:expr |
Call Timeout:expr | The call time out. The default value is 30000. | no | call-timeout:expr |
Client Failure Check Period:expr | The client failure check period. The default value is 30000. | no | client-failure-check-period:expr |
Client Id | The client id. | no | client-id |
Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
Confirmation Window Size:expr | The confirmation window size. The default value is -1. | no | confirmation-window-size:expr |
Connection Load Balancing Policy Class Name | Name 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:expr | The connection ttl. The default value is 60000. | no | connection-ttl:expr |
Connectors | Defines 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:expr | The consumer max rate. The default value is -1. | no | consumer-max-rate:expr |
Consumer Window Size:expr | The consumer window size. The default value is 1048576. | no | consumer-window-size:expr |
Discovery Group | The discovery group name. | no | discovery-group |
Dups Ok Batch Size:expr | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size:expr |
Enlistment Trace | Enables 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 |
Entries | The jndi names the connection factory should be bound to. | yes | entries |
Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
Group Id | The group id. | no | group-id |
Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
Initial Connect Attempts:expr | The number of attempts to connect initially with this factory. The default value is 1. | no | initial-connect-attempts:expr |
Initial Message Packet Size:expr | The initial size of messages created through this factory. The default value is 1500. | no | initial-message-packet-size:expr |
Jndi Params | The JNDI params to use for locating the destination for incoming connections. | no | jndi-params |
Managed Connection Pool | The class name of the managed connection pool used by this pooled-connection-factory. | no | managed-connection-pool |
Max Pool Size:expr | The maximum size for the pool. The default value is -1. | no | max-pool-size:expr |
Max Retry Interval:expr | The max retry interval. The default value is 2000. | no | max-retry-interval:expr |
Min Large Message Size:expr | The min large message size. The default value is 102400. | no | min-large-message-size:expr |
Min Pool Size:expr | The minimum size for the pool. The default value is -1. | no | min-pool-size:expr |
Password | The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host. | no | password |
Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
Producer Max Rate:expr | The producer max rate. The default value is -1. | no | producer-max-rate:expr |
Producer Window Size:expr | The producer window size. The default value is 65536. | no | producer-window-size:expr |
Protocol Manager Factory | The protocol manager factory used by this pooled connection factory. | no | protocol-manager-factory |
Reconnect Attempts:expr | The 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:expr | The retry interval. The default value is 2000. | no | retry-interval:expr |
Retry Interval Multiplier:expr | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier:expr |
Scheduled Thread Pool Max Size:expr | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Setup Attempts:expr | The number of times to set up an MDB endpoint | no | setup-attempts:expr |
Setup Interval:expr | The interval between attempts at setting up an MDB endpoint. | no | setup-interval:expr |
Thread Pool Max Size:expr | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
Transaction | TODO. The default value is transaction. | no | transaction |
Transaction Batch Size:expr | The transaction batch size. The default value is 1048576. | no | transaction-batch-size:expr |
Use Auto Recovery | True to use auto recovery. The default value is true. | no | use-auto-recovery |
Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Use Jndi | Use JNDI to locate the destination for incoming connections | no | use-jndi |
Use Local Tx | Use a local transaction for incoming sessions | no | use-local-tx |
User | The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host. | no | user |
Note
3.4.2.4.1.2.6. EAP7 - Datasources Runtime Service
Description: | Runtime resources exposed by data sources included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.2.6.1. EAP7 - XA Datasource Runtime Service
Description: | A JDBC XA data-source configuration |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | no | *2 | |
Xa Datasource Class | The fully qualified name of the javax.sql.XADataSource implementation | yes | xa-datasource-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver Name | Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit | yes | driver-name |
User Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether to attempt to prefill the connection pool. Changing this value require a server restart. | no | pool-prefill |
Pool Use Strict Min | Define if the min-pool-size should be considered a strictly. | no | pool-use-strict-min |
Interleaving | An element to enable interleaving for XA connection factories | no | interleaving |
No Tx Separate Pool | Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different context | no | no-tx-separate-pool |
Pad Xid | Should the Xid be padded | no | pad-xid |
Same Rm Override | The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false | no | same-rm-override |
Wrap Xa Datasource | Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance | no | wrap-xa-datasource |
Security Domain | Indicates 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 Name | recovery plugin implementation provided for specific purpose (i.e vendor) | no | recovery-plugin-class-name |
Reauth Plugin Class Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | he 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 Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 Timeout | Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds | no | xa-resource-timeout |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Recovery Username | username used to try connection recovery | no | recovery-username |
Recovery Password | password used to try connection recovery | no | recovery-password |
Recovery Security Domain | security-domain used to try connection recovery | no | recovery-security-domain |
No Recovery | if true no recovery are tried for this connection pool | no | no-recovery |
Note
Name | Description |
---|---|
Subsystem:flush All Connection In Pool | Flushes all connections in the pool |
Subsystem:flush Idle Connection In Pool | Flushes all idle connections in the pool |
Subsystem:test Connection In Pool | Test if a connection can be obtained |
3.4.2.4.1.2.6.2. EAP7 - Datasource Runtime Service
Description: | A JDBC data-source configuration |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Connection Property | no | *1 | |
Connection Url | The JDBC driver connection URL | yes | connection-url |
Driver Name | Name of the (existing) JDBC driver to use | yes | driver-name |
Driver Class | The fully qualified name of the JDBC driver class | no | driver-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver | Defines 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 Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether to attempt to prefill the connection pool. Changing this value require a server restart. | no | pool-prefill |
Pool Use Strict Min | Define if the min-pool-size should be considered a strictly. | no | pool-use-strict-min |
Security Domain | Indicates 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 Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | Indicates the time in milliseconds to wait between retrying to allocate a connection. | no | allocation-retry-wait-millis |
Blocking Timeout Wait Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Note
Name | Description |
---|---|
Subsystem:flush All Connection In Pool | Flushes all connections in the pool |
Subsystem:flush Idle Connection In Pool | Flushes all idle connections in the pool |
Subsystem:test Connection In Pool | Test if a connection can be obtained |
3.4.2.4.1.2.7. EAP7 - Webservices Runtime Service
Description: | Runtime resources exposed by web service components in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.2.7.1. EAP7 - Endpoint Runtime Service
Description: | Webservice endpoint. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Average Processing Time | measurement | Average endpoint processing time. | average-processing-time |
Fault Count | measurement | Count of faults the endpoint generated. | fault-count |
Max Processing Time | measurement | Maximal endpoint processing time. | max-processing-time |
Min Processing Time | measurement | Minimal endpoint processing time. | min-processing-time |
Request Count | measurement | Count of requests the endpoint processed. | request-count |
Response Count | measurement | Count of responses the endpoint generated. | response-count |
Total Processing Time | measurement | Total endpoint processing time. | total-processing-time |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | Webservice endpoint class. | no | class |
Context | Webservice endpoint context. | no | context |
Name | Webservice endpoint name. | no | name |
Type | Webservice endpoint type. | no | type |
Wsdl Url | Webservice endpoint WSDL URL. | no | wsdl-url |
Note
3.4.2.4.1.3. EAP7 - Resource Adapters Runtime Service
Description: | Configuration of the resource adapters subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.3.1. EAP7 - Connection Definition Runtime Service
Description: | Specifies the connection definitions. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Note
3.4.2.4.1.4. EAP7 - Web Runtime Service
Description: | Runtime resources exposed by web components in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Response Time Log File | the full path to the log file containing response-time stats for this webapp | no | responseTimeLogFile |
Response Time Url Excludes | a space-delimited list of regular expressions specifying URLs that should be excluded from response-time stats collection | no | responseTimeUrlExcludes |
Response Time Url Transforms | a 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
Name | Type | Description | Internal Name |
---|---|---|---|
Virtual Host | trait | the virtual host this webapp is deployed to | virtual-host |
Context Root | trait | the context root of this webapp | context-root |
Server | trait | The name of server this application belongs to | server |
Response Time | calltime | the minimum, maximum, and average response times for requests serviced by this webapp | responseTime |
Currently Active Sessions | measurement | The number of sessions that are currently active | active-sessions |
Expired Sessions | measurement | The number of expired sessions | expired-sessions |
Expired Sessions per Minute | measurement | The number of expired sessions | expired-sessions |
Maximum Active Sessions | measurement | The maximum number of sessions that have been active | max-active-sessions |
Rejected Sessions | measurement | The number of sessions rejected | rejected-sessions |
Rejected Sessions per Minute | measurement | The number of sessions rejected | rejected-sessions |
Average Session Alive Time | measurement | The average alive time of sessions | session-avg-alive-time |
Max Session Alive Time | measurement | The maximum alive time of sessions | session-max-alive-time |
Created Sessions | measurement | The number of sessions created | sessions-created |
Created Sessions per Minute | measurement | The number of sessions created | sessions-created |
Note
3.4.2.4.1.5. EAP7 - JPA Runtime Service
Description: | The configuration of the JPA subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.5.1. EAP7 - Hibernate Persistence Unit Service
Description: | Runtime information about JPA use in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Close Statement Count | measurement | Number of released prepared statements. | close-statement-count |
Close Statement Count per Minute | measurement | Number of released prepared statements. | close-statement-count |
Collection Fetch Count | measurement | Number of collections fetched. | collection-fetch-count |
Collection Fetch Count per Minute | measurement | Number of collections fetched. | collection-fetch-count |
Collection Load Count | measurement | Number of collections loaded. | collection-load-count |
Collection Load Count per Minute | measurement | Number of collections loaded. | collection-load-count |
Collection Recreated Count | measurement | Number of collections recreated. | collection-recreated-count |
Collection Recreated Count per Minute | measurement | Number of collections recreated. | collection-recreated-count |
Collection Remove Count | measurement | Number of collections removed. | collection-remove-count |
Collection Remove Count per Minute | measurement | Number of collections removed. | collection-remove-count |
Collection Update Count | measurement | Number of collections updated. | collection-update-count |
Collection Update Count per Minute | measurement | Number of collections updated. | collection-update-count |
Completed Transaction Count | measurement | Number of completed transactions. | completed-transaction-count |
Completed Transaction Count per Minute | measurement | Number of completed transactions. | completed-transaction-count |
Connect Count | measurement | Get the number of connections asked for by the sessions. | connect-count |
Connect Count per Minute | measurement | Get the number of connections asked for by the sessions. | connect-count |
Entity Delete Count | measurement | Get number of entity deletes. | entity-delete-count |
Entity Delete Count per Minute | measurement | Get number of entity deletes. | entity-delete-count |
Entity Fetch Count | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Fetch Count per Minute | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Insert Count | measurement | Get number of entity inserts. | entity-insert-count |
Entity Insert Count per Minute | measurement | Get number of entity inserts. | entity-insert-count |
Entity Load Count | measurement | Get number of entity loads. | entity-load-count |
Entity Load Count per Minute | measurement | Get number of entity loads. | entity-load-count |
Entity Update Count | measurement | Get number of entity updates. | entity-update-count |
Entity Update Count per Minute | measurement | Get number of entity updates. | entity-update-count |
Flush Count | measurement | Get the number of flushes executed by sessions (either implicit or explicit). | flush-count |
Flush Count per Minute | measurement | Get the number of flushes executed by sessions (either implicit or explicit). | flush-count |
Optimistic Failure Count | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Optimistic Failure Count per Minute | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Prepared Statement Count | measurement | Number of acquired prepared statements. | prepared-statement-count |
Prepared Statement Count per Minute | measurement | Number of acquired prepared statements. | prepared-statement-count |
Query Cache Hit Count | measurement | Get the number of cached queries successfully retrieved from cache. | query-cache-hit-count |
Query Cache Hit Count per Minute | measurement | Get the number of cached queries successfully retrieved from cache. | query-cache-hit-count |
Query Cache Miss Count | measurement | Get the number of cached queries not found in cache. | query-cache-miss-count |
Query Cache Miss Count per Minute | measurement | Get the number of cached queries not found in cache. | query-cache-miss-count |
Query Cache Put Count | measurement | Get the number of cacheable queries put in cache. | query-cache-put-count |
Query Cache Put Count per Minute | measurement | Get the number of cacheable queries put in cache. | query-cache-put-count |
Query Execution Count | measurement | Get number of executed queries. | query-execution-count |
Query Execution Count per Minute | measurement | Get number of executed queries. | query-execution-count |
Query Execution Max Time | measurement | Get the time in milliseconds of the slowest query. | query-execution-max-time |
Query Execution Max Time Query String | trait | Get the query string for the slowest query. | query-execution-max-time-query-string |
Second Level Cache Hit Count | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | second-level-cache-hit-count |
Second Level Cache Hit Count per Minute | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | second-level-cache-hit-count |
Second Level Cache Miss Count | measurement | Number of cacheable entities/collections not found in the cache and loaded. | second-level-cache-miss-count |
Second Level Cache Miss Count per Minute | measurement | Number of cacheable entities/collections not found in the cache and loaded. | second-level-cache-miss-count |
Second Level Cache Put Count | measurement | Number of cacheable entities/collections put in the cache. | second-level-cache-put-count |
Second Level Cache Put Count per Minute | measurement | Number of cacheable entities/collections put in the cache. | second-level-cache-put-count |
Session Close Count | measurement | Number of sessions closed. | session-close-count |
Session Close Count per Minute | measurement | Number of sessions closed. | session-close-count |
Session Open Count | measurement | Number of sessions opened. | session-open-count |
Session Open Count per Minute | measurement | Number of sessions opened. | session-open-count |
Successful Transaction Count | measurement | Number of successful transactions. | successful-transaction-count |
Successful Transaction Count per Minute | measurement | Number of successful transactions. | successful-transaction-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Enabled | Determine if statistics are enabled. | no | enabled |
Note
Name | Description |
---|---|
Subsystem:clear | Clear statistics. |
Subsystem:evict All | Evict all entities from second level cache. |
Subsystem:summary | Log the statistics. |
View Queries | View statistical information about queries executed by Hibernate |
3.4.2.4.1.5.1.1. EAP7 - Entity Cache Service
Description: | Statistics for a Hibernate Second Level Cache region. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Element Count In Memory | measurement | Number of cacheable entities/collections currently stored in memory. | element-count-in-memory |
Hit Count | measurement | Number of cacheable entities/collections successfully retrieved from the cache. | hit-count |
Miss Count | measurement | Number of cacheable entities/collections not found in the cache and loaded. | miss-count |
Put Count | measurement | Number of cacheable entities/collections put in the cache. | put-count |
Note
3.4.2.4.1.5.1.2. EAP7 - Entity Service
Description: | Statistics for individual entities. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Entity Delete Count | measurement | Get number of entity deletes. | entity-delete-count |
Entity Delete Count per Minute | measurement | Get number of entity deletes. | entity-delete-count |
Entity Fetch Count | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Fetch Count per Minute | measurement | Get number of entity fetches. | entity-fetch-count |
Entity Insert Count | measurement | Get number of entity inserts. | entity-insert-count |
Entity Insert Count per Minute | measurement | Get number of entity inserts. | entity-insert-count |
Entity Load Count | measurement | Get number of entity loads. | entity-load-count |
Entity Load Count per Minute | measurement | Get number of entity loads. | entity-load-count |
Entity Update Count | measurement | Get number of entity updates. | entity-update-count |
Entity Update Count per Minute | measurement | Get number of entity updates. | entity-update-count |
Optimistic Failure Count | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Optimistic Failure Count per Minute | measurement | Number of optimistic lock exceptions. | optimistic-failure-count |
Note
3.4.2.4.1.5.1.3. EAP7 - Collection Service
Description: | Statistics for individual collections. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Collection Fetch Count | measurement | Number of times collection was fetched. | collection-fetch-count |
Collection Fetch Count per Minute | measurement | Number of times collection was fetched. | collection-fetch-count |
Collection Load Count | measurement | Number of times collection was loaded. | collection-load-count |
Collection Load Count per Minute | measurement | Number of times collection was loaded. | collection-load-count |
Collection Recreated Count | measurement | Number of times collection was recreated. | collection-recreated-count |
Collection Recreated Count per Minute | measurement | Number of times collection was recreated. | collection-recreated-count |
Collection Remove Count | measurement | Number of times collection was removed. | collection-remove-count |
Collection Remove Count per Minute | measurement | Number of times collection was removed. | collection-remove-count |
Collection Update Count | measurement | Number of times collection was updated. | collection-update-count |
Collection Update Count per Minute | measurement | Number of times collection was updated. | collection-update-count |
Note
3.4.2.4.1.6. EAP7 - Messaging Runtime Service
Description: | Runtime resources exposed by messaging resources included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.6.1. EAP7 - ActiveMQ Artemis Server Runtime Service
Description: | A ActiveMQ Artemis server instance. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.6.1.1. EAP7 - JMS Queue Runtime Service
Description: | Defines a JMS queue. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Consumer Count | measurement | The number of consumers consuming messages from this queue. | consumer-count |
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Dead Letter Address | trait | The address to send dead messages to. | dead-letter-address |
Durable | trait | Whether the queue is durable or not. The default value is true. | durable |
Expiry Address | trait | The address to send expired messages to. | expiry-address |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Paused | trait | Whether the queue is paused. | paused |
Queue Address | trait | The queue address defines what address is used for routing messages. | queue-address |
Scheduled Count | measurement | The number of scheduled messages in this queue. | scheduled-count |
Selector | trait | The queue selector. | selector |
Temporary | trait | Whether the queue is temporary. | temporary |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Entries | The jndi names the queue will be bound to. | no | entries |
Note
Name | Description |
---|---|
Change Message Priority | Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Change Messages Priority | Change the priority of the messages corresponding to the given filter. Returns the number of removed messages. |
Count Messages | Returns the number of the messages in the queue matching the given filter. |
Expire Message | Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Expire Messages | Expire the messages matching the given filter. |
List Consumers as JSON | A string in JSON format. |
Subsystem:list Delivering Messages | List the messages are currently being delivered. |
Subsystem:list Delivering Messages As Json | List the messages are currently being delivered as a string in JSON format |
List Message Counter as HTML | List the message counter as a string in HTML format. |
List Message Counter as JSON | List the message counter as a string in JSON format. |
List Message Counter History as HTML | List the message counter history. |
List Message Counter History as JSON | List the message counter history as a string in JSON format. |
List Messages | List all messages in the queue that match the filter |
List Messages as JSON | List all messages in the queue that match the filter and return them as a string in JSON format. |
Move Message | Move the message corresponding to the given message-id to another queue |
Move Messages | Move the messages corresponding to the given filter to another queue. |
Pause | Pause the queue. |
Remove Message | Remove the message corresponding to the given message-id. |
Remove Messages | Remove messages matching the given filter from the destination. |
Reset Message Counter | Reset the message counters. |
Resume | Resume the queue. |
Send Message to Dead Letter Address | Send the message corresponding to the given message-id to this queue's Dead Letter Address. |
Send Messages to Dead Letter Address | Send the messages corresponding to the given filter to this queue's Dead Letter Address. |
3.4.2.4.1.6.1.2. EAP7 - JMS Topic Runtime Service
Description: | Defines a JMS queue. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Durable Message Count | measurement | The number of messages for all durable subscribers for this topic. | durable-message-count |
Durable Subscription Count | measurement | The number of durable subscribers for this topic. | durable-subscription-count |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Non Durable Message Count | measurement | The number of messages for all non-durable subscribers for this topic. | non-durable-message-count |
Non Durable Subscription Count | measurement | The number of non-durable subscribers for this topic. | non-durable-subscription-count |
Subscription Count | measurement | The number of (durable and non-durable) subscribers for this topic. | subscription-count |
Temporary | trait | Whether the topic is temporary. | temporary |
Topic Address | trait | The address the topic points to. | topic-address |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
JNDI Names | The jndi names the queue will be bound to. | no | entries |
Note
Name | Description |
---|---|
Count Messages for Subscription | Count the number of messages matching the filter for the given subscription. |
Drop All Subscriptions | Drop all subscriptions from this topic. |
Drop Durable Subscription | Drop a durable subscription |
List All Subscriptions | List all subscriptions. |
List All Subscriptions as JSON | List all subscriptions as a string in JSON format. |
List Durable Subscriptions | List only the durable subscriptions. |
List Durable Subscriptions as JSON | List only the durable subscriptions, as a string in JSON format. |
List Messages for Subscription | List all the messages for the given subscription. |
List Messages for Subscription as JSON | List all the messages for the given subscription as a string in JSON format. |
List Non-Durable Subscriptions | List only the non-durable subscriptions. |
List Non-Durable Subscriptions as JSON | List only the non-durable subscriptions, as a string in JSON format. |
Remove Messages | Remove messages matching the given filter from the destination. |
3.4.2.4.1.6.1.3. EAP7 - Pooled Connection Factory Runtime Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Auto Group | The autogroup. The default value is false. | no | auto-group |
Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
Call Failover Timeout:expr | The timeout to use when fail over is in process (in ms). The default value is -1. | no | call-failover-timeout:expr |
Call Timeout:expr | The call time out. The default value is 30000. | no | call-timeout:expr |
Client Failure Check Period:expr | The client failure check period. The default value is 30000. | no | client-failure-check-period:expr |
Client Id | The client id. | no | client-id |
Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
Confirmation Window Size:expr | The confirmation window size. The default value is -1. | no | confirmation-window-size:expr |
Connection Load Balancing Policy Class Name | Name 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:expr | The connection ttl. The default value is 60000. | no | connection-ttl:expr |
Connectors | Defines 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:expr | The consumer max rate. The default value is -1. | no | consumer-max-rate:expr |
Consumer Window Size:expr | The consumer window size. The default value is 1048576. | no | consumer-window-size:expr |
Discovery Group | The discovery group name. | no | discovery-group |
Dups Ok Batch Size:expr | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size:expr |
Enlistment Trace | Enables 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 |
Entries | The jndi names the connection factory should be bound to. | yes | entries |
Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
Group Id | The group id. | no | group-id |
Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
Initial Connect Attempts:expr | The number of attempts to connect initially with this factory. The default value is 1. | no | initial-connect-attempts:expr |
Initial Message Packet Size:expr | The initial size of messages created through this factory. The default value is 1500. | no | initial-message-packet-size:expr |
Jndi Params | The JNDI params to use for locating the destination for incoming connections. | no | jndi-params |
Managed Connection Pool | The class name of the managed connection pool used by this pooled-connection-factory. | no | managed-connection-pool |
Max Pool Size:expr | The maximum size for the pool. The default value is -1. | no | max-pool-size:expr |
Max Retry Interval:expr | The max retry interval. The default value is 2000. | no | max-retry-interval:expr |
Min Large Message Size:expr | The min large message size. The default value is 102400. | no | min-large-message-size:expr |
Min Pool Size:expr | The minimum size for the pool. The default value is -1. | no | min-pool-size:expr |
Password | The default password to use with this connection factory. This is only needed when pointing the connection factory to a remote host. | no | password |
Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
Producer Max Rate:expr | The producer max rate. The default value is -1. | no | producer-max-rate:expr |
Producer Window Size:expr | The producer window size. The default value is 65536. | no | producer-window-size:expr |
Protocol Manager Factory | The protocol manager factory used by this pooled connection factory. | no | protocol-manager-factory |
Reconnect Attempts:expr | The 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:expr | The retry interval. The default value is 2000. | no | retry-interval:expr |
Retry Interval Multiplier:expr | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier:expr |
Scheduled Thread Pool Max Size:expr | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Setup Attempts:expr | The number of times to set up an MDB endpoint | no | setup-attempts:expr |
Setup Interval:expr | The interval between attempts at setting up an MDB endpoint. | no | setup-interval:expr |
Thread Pool Max Size:expr | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
Transaction | TODO. The default value is transaction. | no | transaction |
Transaction Batch Size:expr | The transaction batch size. The default value is 1048576. | no | transaction-batch-size:expr |
Use Auto Recovery | True to use auto recovery. The default value is true. | no | use-auto-recovery |
Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Use Jndi | Use JNDI to locate the destination for incoming connections | no | use-jndi |
Use Local Tx | Use a local transaction for incoming sessions | no | use-local-tx |
User | The default username to use with this connection factory. This is only needed when pointing the connection factory to a remote host. | no | user |
Note
3.4.2.4.1.7. EAP7 - Datasources Runtime Service
Description: | Runtime resources exposed by data sources included in this deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.7.1. EAP7 - XA Datasource Runtime Service
Description: | A JDBC XA data-source configuration |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | no | *2 | |
Xa Datasource Class | The fully qualified name of the javax.sql.XADataSource implementation | yes | xa-datasource-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver Name | Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit | yes | driver-name |
User Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether to attempt to prefill the connection pool. Changing this value require a server restart. | no | pool-prefill |
Pool Use Strict Min | Define if the min-pool-size should be considered a strictly. | no | pool-use-strict-min |
Interleaving | An element to enable interleaving for XA connection factories | no | interleaving |
No Tx Separate Pool | Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different context | no | no-tx-separate-pool |
Pad Xid | Should the Xid be padded | no | pad-xid |
Same Rm Override | The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false | no | same-rm-override |
Wrap Xa Datasource | Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance | no | wrap-xa-datasource |
Security Domain | Indicates 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 Name | recovery plugin implementation provided for specific purpose (i.e vendor) | no | recovery-plugin-class-name |
Reauth Plugin Class Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | he 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 Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 Timeout | Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds | no | xa-resource-timeout |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Recovery Username | username used to try connection recovery | no | recovery-username |
Recovery Password | password used to try connection recovery | no | recovery-password |
Recovery Security Domain | security-domain used to try connection recovery | no | recovery-security-domain |
No Recovery | if true no recovery are tried for this connection pool | no | no-recovery |
Note
Name | Description |
---|---|
Subsystem:flush All Connection In Pool | Flushes all connections in the pool |
Subsystem:flush Idle Connection In Pool | Flushes all idle connections in the pool |
Subsystem:test Connection In Pool | Test if a connection can be obtained |
3.4.2.4.1.7.2. EAP7 - Datasource Runtime Service
Description: | A JDBC data-source configuration |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Connection Property | no | *1 | |
Connection Url | The JDBC driver connection URL | yes | connection-url |
Driver Name | Name of the (existing) JDBC driver to use | yes | driver-name |
Driver Class | The fully qualified name of the JDBC driver class | no | driver-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver | Defines 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 Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether to attempt to prefill the connection pool. Changing this value require a server restart. | no | pool-prefill |
Pool Use Strict Min | Define if the min-pool-size should be considered a strictly. | no | pool-use-strict-min |
Security Domain | Indicates 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 Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | Indicates the time in milliseconds to wait between retrying to allocate a connection. | no | allocation-retry-wait-millis |
Blocking Timeout Wait Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Note
Name | Description |
---|---|
Subsystem:flush All Connection In Pool | Flushes all connections in the pool |
Subsystem:flush Idle Connection In Pool | Flushes all idle connections in the pool |
Subsystem:test Connection In Pool | Test if a connection can be obtained |
3.4.2.4.1.8. EAP7 - Webservices Runtime Service
Description: | Runtime resources exposed by web service components in the deployment. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.1.8.1. EAP7 - Endpoint Runtime Service
Description: | Webservice endpoint. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Average Processing Time | measurement | Average endpoint processing time. | average-processing-time |
Fault Count | measurement | Count of faults the endpoint generated. | fault-count |
Max Processing Time | measurement | Maximal endpoint processing time. | max-processing-time |
Min Processing Time | measurement | Minimal endpoint processing time. | min-processing-time |
Request Count | measurement | Count of requests the endpoint processed. | request-count |
Response Count | measurement | Count of responses the endpoint generated. | response-count |
Total Processing Time | measurement | Total endpoint processing time. | total-processing-time |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | Webservice endpoint class. | no | class |
Context | Webservice endpoint context. | no | context |
Name | Webservice endpoint name. | no | name |
Type | Webservice endpoint type. | no | type |
Wsdl Url | Webservice endpoint WSDL URL. | no | wsdl-url |
Note
3.4.2.4.2. EAP7 - Naming (Managed Server) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Operations
Name | Description |
---|---|
JNDIView | Peek at the JNDI tree |
Package Types
3.4.2.4.2.1. EAP7 - Binding (Managed Server) Service
Description: | JNDI bindings for primitive types |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Binding Type | The type of binding to create, may be simple, lookup or object-factory | yes | binding-type |
Class | The object factory class name for object factory bindings | no | class |
Lookup | The entry to lookup in JNDI for lookup bindings | no | lookup |
Module | The module to load the object factory from for object factory bindings | no | module |
Type | The type of the value to bind for simple bindings, this must be a primitive type | no | type |
Value | The value to bind for simple bindings | no | value |
Note
3.4.2.4.3. EAP7 - Webservices (Managed Server) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Modify Wsdl Address | Whether the soap address can be modified. | no | modify-wsdl-address |
Wsdl Host | The 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 Port | The 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 Port | The 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
Operations
Package Types
3.4.2.4.3.1. EAP7 - Endpoint (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.3.1.1. EAP7 - Post Handler Chain (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
3.4.2.4.3.1.1.1. EAP7 - Post Handler (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | Handler class | yes | class |
Note
3.4.2.4.3.1.2. EAP7 - Pre Handler Chain (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
3.4.2.4.3.1.2.1. EAP7 - Pre Handler (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | Handler class | yes | class |
Note
3.4.2.4.3.1.3. EAP7 - Property (Read Only) Service
Description: | A property |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The property value. | no | value |
Note
3.4.2.4.4. EAP7 - IIOP-OpenJDK (Managed Server) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Managed Runtime | yes | managedRuntime | |
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Add Component Via Interceptor | Indicates 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 Method | The authentication method. Valid values are 'none' and 'username_password'. The default value is username_password. | no | auth-method |
Caller Propagation | Indicates 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 Requires | Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | client-requires |
Client Supports | Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | client-supports |
Confidentiality | Indicates whether the transport must require confidentiality protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. | no | confidentiality |
Detect Misordering | Indicates 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 Replay | Indicates 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 Corbaloc | Indicates 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 Version | The GIOP version to be used. The default value is 1.2. | no | giop-version |
High Water Mark:expr | TCP 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 |
Integrity | Indicates 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:expr | TCP 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 Id | Persistent 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 |
Properties | A list of generic key/value properties. | no | properties |
Realm | The authentication service (AS) realm name. | no | realm |
Required | Indicates if authentication is required (true) or not (false). The default value is false. | no | required |
Root Context | The naming service root context. The default value is JBoss/Naming/root. | no | root-context |
Security | Indicates whether the security interceptors are to be installed (on) or not (off). The default value is none. | no | security |
Security Domain | The name of the security domain that holds the key and trust stores that will be used to establish SSL connections. | no | security-domain |
Server Requires | Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | server-requires |
Server Supports | Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | server-supports |
Socket Binding | The name of the socket binding configuration that specifies the ORB port. The default value is iiop. | no | socket-binding |
Ssl Socket Binding | The name of the socket binding configuration that specifies the ORB SSL port. The default value is iiop-ssl. | no | ssl-socket-binding |
Support Ssl | Indicates whether SSL is to be supported (on) or not (off). The default value is false. | no | support-ssl |
Transactions | Indicates 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 Client | Indicates 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 Target | Indicates 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
Operations
Package Types
3.4.2.4.5. EAP7 - JacORB (Managed Server) Service
Overview
Description: | JacORB subsystem configuration |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Add Component Via Interceptor | Indicates 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 Names | Indicates whether POA names should be cached (on) or not (off). The default value is off. | no | cache-poa-names |
Cache Typecodes | Indicates whether typecodes should be cached (on) or not (off). The default value is off. | no | cache-typecodes |
Chunk Custom Rmi Valuetypes | Indicates whether custom RMI valuetypes should be encoded as chunks (on) or not (off). The default value is on. | no | chunk-custom-rmi-valuetypes |
Client Requires | Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | client-requires |
Client Supports | Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | client-supports |
Client Timeout | The 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 |
Comet | Indicates whether interoperability with Comet's ORB is enabled (on) or not (off). The default value is off. | no | comet |
Export Corbaloc | Indicates 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 Version | The GIOP minor version to be used. The default value is 2. | no | giop-minor-version |
Indirection Encoding Disable | Indicates whether indirection encoding for repeated typecodes should be disabled (on) or not (off). The default value is off. | no | indirection-encoding-disable |
Iona | Indicates whether interoperability with IONA's ASP is enabled (on) or not (off). The default value is off. | no | iona |
Lax Boolean Encoding | Indicates 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 Size | The log2 of maximum size managed by the internal buffer manager. The default value is 24. | no | max-managed-buf-size |
Max Server Connections | The maximum number of connections accepted by the server. The default value is 2147483647. | no | max-server-connections |
Max Threads | The 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 |
Monitoring | Indicates whether the monitoring GUI should be displayed (on) or not (off). The default value is off. | no | monitoring |
Name | The name of the running ORB. The default value is JBoss. | no | name |
Outbuf Cache Timeout | The buffer cache timeout in milliseconds. The default value is -1. | no | outbuf-cache-timeout |
Outbuf Size | The size of the network buffers for outgoing messages. The default value is 2048. | no | outbuf-size |
Pool Size | The 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 Version | Indicates whether the version number should be printed during ORB startup (on) or not (off). The default value is off. | no | print-version |
Properties | A list of generic key/value properties. | no | properties |
Queue Max | The maximum number of requests that can be queued. The default value is 100. | no | queue-max |
Queue Min | The 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 Wait | Indicates 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 |
Retries | The number of retries if connections cannot be promptly established. The default value is 5. | no | retries |
Retry Interval | The interval in milliseconds between retries. The default value is 500. | no | retry-interval |
Root Context | The naming service root context. The default value is JBoss/Naming/root. | no | root-context |
Security | Indicates whether the security interceptors are to be installed (on) or not (off). The default value is off. | no | security |
Security Domain | The name of the security domain that holds the key and trust stores that will be used to establish SSL connections. | no | security-domain |
Server Requires | Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | server-requires |
Server Supports | Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | server-supports |
Server Timeout | The 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 Creation | Indicates 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 |
Sun | Indicates whether interoperability with Sun's ORB is enabled (on) or not (off). The default value is on. | no | sun |
Support Ssl | Indicates whether SSL is to be supported (on) or not (off). The default value is off. | no | support-ssl |
Transactions | Indicates 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 Bom | Indicates whether GIOP 1.2 byte order markers should be used (on) or not (off). The default value is off. | no | use-bom |
Use Imr | Indicates whether the implementation repository should be used (on) or not (off). The default value is off. | no | use-imr |
Note
Operations
Package Types
3.4.2.4.6. EAP7 - JAXR (Managed Server) Service
Overview
Description: | The configuration of the JAXR subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Class | The JAXR ConnectionFactory implementation class | no | class |
Jndi Name | The JNDI name under which the JAXR ConnectionFactory is bound | no | jndi-name |
Note
Operations
Package Types
3.4.2.4.6.1. EAP7 - Property (JAXR - Managed Server) Service
Description: | A JAXR property. The identity of the resource defines the property name. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The JAXR property value. | yes | value |
Note
3.4.2.4.7. EAP7 - JPA (Managed Server) Service
Overview
Description: | The configuration of the JPA subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Datasource | The name of the default global datasource. | no | default-datasource |
Note
Operations
Package Types
3.4.2.4.8. EAP7 - EE (Managed Server) Service
Overview
Description: | The configuration of the EE subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Ear Subdeployments Isolated | Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear. The default value is false. | no | ear-subdeployments-isolated |
Global Modules | A list of modules that should be made available to all deployments. | no | global-modules |
Note
Operations
Package Types
3.4.2.4.9. EAP7 - Infinispan (Managed Server) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.4.9.1. EAP7 - Cache Container (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Cache Manager Status | trait | The status of the cache manager component. May return null if the cache manager is not started. | cache-manager-status |
Cluster Name | trait | The name of the cluster this node belongs to. May return null if the cache manager is not started. | cluster-name |
Coordinator Address | trait | The logical address of the cluster's coordinator. May return null if the cache manager is not started. | coordinator-address |
Is Coordinator | trait | True if this node is the cluster's coordinator. May return null if the cache manager is not started. | is-coordinator |
Local Address | trait | The local address of the node. May return null if the cache manager is not started. | local-address |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Aliases | The list of aliases for this cache container | no | aliases |
Default Cache | The default infinispan cache | no | default-cache |
Jndi Name | The jndi name to which to bind this cache container | no | jndi-name |
Module | The 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 Enabled | If enabled, statistics will be collected for this cache container. | no | statistics-enabled |
Note
3.4.2.4.9.1.1. EAP7 - Cache (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Activations | measurement | The 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 Minute | measurement | The 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 Time | measurement | Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started. | average-read-time |
Average Write Time | measurement | Average time (in ms) for cache writes. May return null if the cache is not started. | average-write-time |
Cache Status | trait | The status of the cache component. May return null if the cache is not started. | cache-status |
Elapsed Time | measurement | Time (in secs) since cache started. May return null if the cache is not started. | elapsed-time |
Hit Ratio | measurement | The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started. | hit-ratio |
Hits | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Hits per Minute | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Invalidations | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Invalidations per Minute | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Misses | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Misses per Minute | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Number Of Entries | measurement | The current number of entries in the cache. May return null if the cache is not started. | number-of-entries |
Passivations | measurement | The 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 Minute | measurement | The 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 Ratio | measurement | The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started. | read-write-ratio |
Remove Hits | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Hits per Minute | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Misses | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Remove Misses per Minute | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Stores | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Stores per Minute | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Time Since Reset | measurement | Time (in secs) since cache statistics were reset. May return null if the cache is not started. | time-since-reset |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Jndi Name | The jndi-name to which to bind this cache instance. | no | jndi-name |
Mode | Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. | no | mode |
Module | The module whose class loader should be used when building this cache's configuration. | no | module |
Queue Flush Interval | In 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 Size | In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. | no | queue-size |
Remote Timeout | In 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 cache | Type of cache | no | __type |
Note
3.4.2.4.9.1.2. EAP7 - Distributed Cache (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Activations | measurement | The 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 Minute | measurement | The 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 Time | measurement | Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started. | average-read-time |
Average Write Time | measurement | Average time (in ms) for cache writes. May return null if the cache is not started. | average-write-time |
Cache Status | trait | The status of the cache component. May return null if the cache is not started. | cache-status |
Elapsed Time | measurement | Time (in secs) since cache started. May return null if the cache is not started. | elapsed-time |
Hit Ratio | measurement | The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started. | hit-ratio |
Hits | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Hits per Minute | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Invalidations | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Invalidations per Minute | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Misses | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Misses per Minute | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Number Of Entries | measurement | The current number of entries in the cache. May return null if the cache is not started. | number-of-entries |
Passivations | measurement | The 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 Minute | measurement | The 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 Ratio | measurement | The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started. | read-write-ratio |
Remove Hits | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Hits per Minute | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Misses | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Remove Misses per Minute | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Stores | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Stores per Minute | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Time Since Reset | measurement | Time (in secs) since cache statistics were reset. May return null if the cache is not started. | time-since-reset |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Jndi Name | The jndi-name to which to bind this cache instance. | no | jndi-name |
L 1 Lifespan | Maximum 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 |
Mode | Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. | no | mode |
Module | The module whose class loader should be used when building this cache's configuration. | no | module |
Owners | Number of cluster-wide replicas for each cache entry. The default value is 2. | no | owners |
Queue Flush Interval | In 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 Size | In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. | no | queue-size |
Remote Timeout | In 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
3.4.2.4.9.1.3. EAP7 - Local Cache (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Activations | measurement | The 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 Minute | measurement | The 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 Time | measurement | Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started. | average-read-time |
Average Write Time | measurement | Average time (in ms) for cache writes. May return null if the cache is not started. | average-write-time |
Cache Status | trait | The status of the cache component. May return null if the cache is not started. | cache-status |
Elapsed Time | measurement | Time (in secs) since cache started. May return null if the cache is not started. | elapsed-time |
Hit Ratio | measurement | The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started. | hit-ratio |
Hits | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Hits per Minute | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Invalidations | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Invalidations per Minute | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Misses | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Misses per Minute | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Number Of Entries | measurement | The current number of entries in the cache. May return null if the cache is not started. | number-of-entries |
Passivations | measurement | The 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 Minute | measurement | The 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 Ratio | measurement | The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started. | read-write-ratio |
Remove Hits | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Hits per Minute | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Misses | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Remove Misses per Minute | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Stores | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Stores per Minute | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Time Since Reset | measurement | Time (in secs) since cache statistics were reset. May return null if the cache is not started. | time-since-reset |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Jndi Name | The jndi-name to which to bind this cache instance. | no | jndi-name |
Module | The module whose class loader should be used when building this cache's configuration. | no | module |
Note
3.4.2.4.9.1.4. EAP7 - Transport (Managed Server) Service
Description: | The description of the transport used by this cache container |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Channel | The channel of this cache container's transport. | no | channel |
Lock Timeout | The timeout for locks for the transport. | no | lock-timeout |
Note
3.4.2.4.10. EAP7 - JGroups (Managed Server) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Stack | Default stack to use | yes | default-stack |
Note
Operations
Package Types
3.4.2.4.11. EAP7 - Remoting (Managed Server) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Worker Read Threads | The number of read threads to create for the remoting worker. The default value is 1. | no | worker-read-threads |
Worker Task Core Threads | The number of core threads for the remoting worker task thread pool. The default value is 4. | no | worker-task-core-threads |
Worker Task Keepalive | The number of milliseconds to keep non-core remoting worker task threads alive. The default value is 60. | no | worker-task-keepalive |
Worker Task Limit | The maximum number of remoting worker tasks to allow before rejecting. The default value is 16384. | no | worker-task-limit |
Worker Task Max Threads | The maximum number of threads for the remoting worker task thread pool. The default value is 16. | no | worker-task-max-threads |
Worker Write Threads | The number of write threads to create for the remoting worker. The default value is 1. | no | worker-write-threads |
Note
Operations
Package Types
3.4.2.4.12. EAP7 - Mail (Managed Server) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.4.12.1. EAP7 - Mail Session (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Debug | Enables javamail debugging. The default value is false. | no | debug |
From | From address that is used as default from, if not set when sending | no | from |
Jndi Name | JNDI name to where mail session should be bound | no | jndi-name |
Note
3.4.2.4.12.1.1. EAP7 - SMTP Mail Server (Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Outbound Socket Binding Ref | Outbound Socket binding to SMTP server | no | outbound-socket-binding-ref |
Password | Password to authenticate on server | no | password |
Ssl | Does server requires SSL?. The default value is false. | no | ssl |
Username | Username to authenticate on server | no | username |
Note
3.4.2.4.12.1.2. EAP7 - IMAP Mail Server (Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Outbound Socket Binding Ref | Outbound Socket binding to IMAP server | no | outbound-socket-binding-ref |
Password | Password to authenticate on server | no | password |
Ssl | Does server requires SSL?. The default value is false. | no | ssl |
Username | Username to authenticate on server | no | username |
Note
3.4.2.4.12.1.3. EAP7 - POP3 Mail Server (Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Outbound Socket Binding Ref | Outbound Socket binding to POP3 server | no | outbound-socket-binding-ref |
Password | Password to authenticate on server | no | password |
Ssl | Does server requires SSL?. The default value is false. | no | ssl |
Username | Username to authenticate on server | no | username |
Note
3.4.2.4.13. EAP7 - Undertow (Managed Server) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Security Domain | The default security domain used by web deployments. The default value is other. | no | default-security-domain |
Default Server | The default server to use for deployments. The default value is default-server. | no | default-server |
Default Servlet Container | The default servlet container to use for deployments. The default value is default. | no | default-servlet-container |
Default Virtual Host | The default virtual host to use for deployments. The default value is default-host. | no | default-virtual-host |
Instance Id | The cluster instance id. The default value is {EXPRESSION_VALUE=${jboss.node.name}}. | no | instance-id |
Statistics Enabled | Configures if are statistics enabled. The default value is false. | no | statistics-enabled |
Note
Operations
Package Types
3.4.2.4.13.1. EAP7 - Filter configurations (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.13.1.1. EAP7 - Error page (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code:expr | Error page code | yes | code:expr |
Path | Error page path | no | path |
Note
3.4.2.4.13.1.2. EAP7 - Expression filter (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Expression | The expression that defines the filter | yes | expression |
Module | Module to use to load the filter definitions | no | module |
Note
3.4.2.4.13.1.3. EAP7 - GZIP (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.13.1.4. EAP7 - Mod cluster (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Advertise Frequency:expr | The frequency (in milliseconds) that mod-cluster advertises itself on the network. The default value is 10000. | no | advertise-frequency:expr |
Advertise Path | The path that mod-cluster is registered under, defaults to /. The default value is /. | no | advertise-path |
Advertise Protocol | The protocol that is in use, defaults to HTTP. The default value is http. | no | advertise-protocol |
Advertise Socket Binding | The multicast group that is used to advertise | yes | advertise-socket-binding |
Broken Node Timeout:expr | The 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:expr | The number of connections that will be kept alive indefinitely. The default value is 40. | no | cached-connections-per-thread:expr |
Connection Idle Timeout:expr | The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread). The default value is 60. | no | connection-idle-timeout:expr |
Connections Per Thread:expr | The 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 2 | If the load balancer should attempt to upgrade back end connections to HTTP2. If HTTP2 is not supported HTTP or HTTPS will be used as normal. The default value is false. | no | enable-http2 |
Health Check Interval:expr | The frequency of health check pings to backend nodes. The default value is 10000. | no | health-check-interval:expr |
Management Access Predicate | A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands. Provides additional security on top of what is provided by limiting management to requests that originate from the management-socket-binding | no | management-access-predicate |
Management Socket Binding | The 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 Size | The maximum size for AJP packets. Increasing this will allow AJP to work for requests/responses that have a large amount of headers. This is an advanced option, and must be the same between load balancers and backend servers. | no | max-ajp-packet-size |
Max Request Time:expr | The 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:expr | The 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 Key | The security key that is used for the mod-cluster group. All members must use the same security key. | no | security-key |
Security Realm | The security realm that provides the SSL configuration | no | security-realm |
Use Alias | If an alias check is performed. The default value is false. | no | use-alias |
Worker | The XNIO worker that is used to send the advertise notifications. The default value is default. | no | worker |
Note
3.4.2.4.13.1.5. EAP7 - Rewrite (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Redirect | If this is true then a redirect will be done instead of a rewrite. The default value is false. | no | redirect |
Target | The expression that defines the target. If you are redirecting to a constant target put single quotes around the value | yes | target |
Note
3.4.2.4.13.1.6. EAP7 - Response header (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Header Name | Header name | yes | header-name |
Header Value | Value for header | yes | header-value |
Note
3.4.2.4.13.1.7. EAP7 - Request limit (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Max Concurrent Requests:expr | Maximum number of concurrent requests | no | max-concurrent-requests:expr |
Queue Size:expr | Number of requests to queue before they start being rejected | no | queue-size:expr |
Note
3.4.2.4.13.1.8. EAP7 - Custom filter (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class Name | Class name of HttpHandler | yes | class-name |
Module | Module name where class can be loaded from | yes | module |
Parameters | Filter parameters | no | parameters |
Note
3.4.2.4.13.2. EAP7 - Handler configuration (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.13.2.1. EAP7 - File Handler - Undertow (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cache Buffer Size:expr | Size of the buffers. The default value is 1024. | no | cache-buffer-size:expr |
Cache Buffers:expr | Number of buffers. The default value is 1024. | no | cache-buffers:expr |
Case Sensitive | Use case sensitive file handling. The default value is true. | no | case-sensitive |
Directory Listing | Enable directory listing?. The default value is false. | no | directory-listing |
Follow Symlink | Enable following symbolic links. The default value is false. | no | follow-symlink |
Path | Path on filesystem from where file handler will serve resources | no | path |
Safe Symlink Paths | Paths that are safe to be targets of symbolic links | no | safe-symlink-paths |
Note
3.4.2.4.13.2.2. EAP7 - Reverse proxy (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cached Connections Per Thread:expr | The number of connections that will be kept alive indefinitely. The default value is 5. | no | cached-connections-per-thread:expr |
Connection Idle Timeout:expr | The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread). The default value is 60. | no | connection-idle-timeout:expr |
Connections Per Thread:expr | The 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:expr | The 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:expr | Time 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:expr | The 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 Names | Comma separated list of session cookie names. Generally this will just be JSESSIONID. The default value is JSESSIONID. | no | session-cookie-names |
Note
3.4.2.4.13.2.2.1. EAP7 - Reverse proxy host (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Instance Id | The instance id (aka JVM route) that will be used to enable sticky sessions | no | instance-id |
Outbound Socket Binding | Outbound socket binding for this host | no | outbound-socket-binding |
Path | Optional path if host is using non root resource. The default value is /. | no | path |
Scheme | What kind of scheme is used. The default value is http. | no | scheme |
Security Realm | The security realm that provides the SSL configuration for the connection to the host | no | security-realm |
Note
3.4.2.4.13.3. EAP7 - Buffer Cache (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Buffer Size:expr | The size of an individual buffer. The default value is 1024. | no | buffer-size:expr |
Buffers Per Region:expr | The numbers of buffers in a region. The default value is 1024. | no | buffers-per-region:expr |
Max Regions:expr | The maximum number of regions. The default value is 10. | no | max-regions:expr |
Note
3.4.2.4.13.4. EAP7 - Server (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Default Host | The servers default virtual host. The default value is default-host. | no | default-host |
Servlet Container | The servers default servlet container. The default value is default. | no | servlet-container |
Note
3.4.2.4.13.4.1. EAP7 - Ajp Listener (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Bytes Received | measurement | The number of bytes that have been received by this listener | bytes-received |
Bytes Sent | measurement | The number of bytes that have been sent out on this listener | bytes-sent |
Error Count | measurement | The number of 500 responses that have been sent by this listener | error-count |
Max Processing Time | measurement | The maximum processing time taken by a request on this listener | max-processing-time |
Processing Time | measurement | The total processing time of all requests handed by this listener | processing-time |
Request Count | measurement | The number of requests this listener has served | request-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Encoded Slash | If 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 Value | If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped. The default value is false. | no | allow-equals-in-cookie-value |
Always Set Keep Alive | If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. | no | always-set-keep-alive |
Buffer Pipelined Data | If we should buffer pipelined requests. The default value is true. | no | buffer-pipelined-data |
Buffer Pool | The AJP listeners buffer pool. The default value is default. | no | buffer-pool |
Decode Url | If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired. The default value is true. | no | decode-url |
Disallowed Methods | A comma separated list of HTTP methods that are not allowed | no | disallowed-methods |
Enabled | If the listener is enabled. The default value is true. | no | enabled |
Max Buffered Request Size:expr | Maximum 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:expr | The maximum number of concurrent connections. | no | max-connections:expr |
Max Cookies:expr | The 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:expr | The maximum size in bytes of a http request header. The default value is 1048576. | no | max-header-size:expr |
Max Headers:expr | The 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:expr | The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters). The default value is 1000. | no | max-parameters:expr |
Max Post Size:expr | The maximum size of a post that will be accepted. The default value is 10485760. | no | max-post-size:expr |
No Request Timeout:expr | The 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:expr | Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}. | no | read-timeout:expr |
Receive Buffer:expr | The receive buffer size. | no | receive-buffer:expr |
Record Request Start Time | If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact. The default value is false. | no | record-request-start-time |
Redirect Socket | If this listener is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here. | no | redirect-socket |
Request Parse Timeout:expr | The maximum amount of time (in milliseconds) that can be spent parsing the request | no | request-parse-timeout:expr |
Resolve Peer Address | Enables host dns lookup. The default value is false. | no | resolve-peer-address |
Scheme | The listener scheme, can be HTTP or HTTPS. By default the scheme will be taken from the incoming AJP request. | no | scheme |
Send Buffer:expr | The send buffer size. | no | send-buffer:expr |
Socket Binding | The AJP listener socket binder | yes | socket-binding |
Tcp Backlog:expr | Configure a server with the specified backlog. | no | tcp-backlog:expr |
Tcp Keep Alive | Configure a channel to send TCP keep-alive messages in an implementation-dependent manner. | no | tcp-keep-alive |
Url Charset | URL charset. The default value is UTF-8. | no | url-charset |
Worker | The AJP listeners XNIO worker. The default value is default. | no | worker |
Write Timeout:expr | Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}. | no | write-timeout:expr |
Note
3.4.2.4.13.4.2. EAP7 - Undertow Host (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Alias | Aliases for the host | no | alias |
Default Response Code:expr | If 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 Module | Default web module. The default value is ROOT.war. | no | default-web-module |
Disable Console Redirect | if set to true, /console redirect wont be enabled for this host, default is false. The default value is false. | no | disable-console-redirect |
Note
3.4.2.4.13.4.2.1. EAP7 - Host Filter Ref (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Predicate | Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition. | no | predicate |
Priority:expr | Defines filter order, it should be set to 1 or more, higher number instructs server to be included earlier in handler chain than others under same context. The default value is 1. | no | priority:expr |
Note
3.4.2.4.13.4.2.2. EAP7 - Undertow-Location (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Handler | Default handler for this location | yes | handler |
Note
3.4.2.4.13.4.2.2.1. EAP7 - Location Filter Ref (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Predicate | Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition. | no | predicate |
Priority:expr | Defines filter order, it should be set to 1 or more, higher number instructs server to be included earlier in handler chain than others under same context. The default value is 1. | no | priority:expr |
Note
3.4.2.4.13.4.3. EAP7 - Http Listener (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Bytes Received | measurement | The number of bytes that have been received by this listener | bytes-received |
Bytes Sent | measurement | The number of bytes that have been sent out on this listener | bytes-sent |
Error Count | measurement | The number of 500 responses that have been sent by this listener | error-count |
Max Processing Time | measurement | The maximum processing time taken by a request on this listener | max-processing-time |
Processing Time | measurement | The total processing time of all requests handed by this listener | processing-time |
Request Count | measurement | The number of requests this listener has served | request-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Encoded Slash | If 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 Value | If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped. The default value is false. | no | allow-equals-in-cookie-value |
Always Set Keep Alive | If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. | no | always-set-keep-alive |
Buffer Pipelined Data | If we should buffer pipelined requests. The default value is true. | no | buffer-pipelined-data |
Buffer Pool | The AJP listeners buffer pool. The default value is default. | no | buffer-pool |
Certificate Forwarding | If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers. The default value is false. | no | certificate-forwarding |
Decode Url | If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired. The default value is true. | no | decode-url |
Disallowed Methods | A comma separated list of HTTP methods that are not allowed | no | disallowed-methods |
Enable Http 2 | Enables HTTP2 support for this listener. The default value is false. | no | enable-http2 |
Enabled | If the listener is enabled. The default value is true. | no | enabled |
Max Buffered Request Size:expr | Maximum 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:expr | The maximum number of concurrent connections. | no | max-connections:expr |
Max Cookies:expr | The 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:expr | The maximum size in bytes of a http request header. The default value is 1048576. | no | max-header-size:expr |
Max Headers:expr | The 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:expr | The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters). The default value is 1000. | no | max-parameters:expr |
Max Post Size:expr | The maximum size of a post that will be accepted. The default value is 10485760. | no | max-post-size:expr |
No Request Timeout:expr | The 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 Forwarding | enables 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:expr | Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}. | no | read-timeout:expr |
Receive Buffer:expr | The receive buffer size. | no | receive-buffer:expr |
Record Request Start Time | If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact. The default value is false. | no | record-request-start-time |
Redirect Socket | If this listener is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here. | no | redirect-socket |
Request Parse Timeout:expr | The maximum amount of time (in milliseconds) that can be spent parsing the request | no | request-parse-timeout:expr |
Resolve Peer Address | Enables host dns lookup. The default value is false. | no | resolve-peer-address |
Send Buffer:expr | The send buffer size. | no | send-buffer:expr |
Socket Binding | The AJP listener socket binder | yes | socket-binding |
Tcp Backlog:expr | Configure a server with the specified backlog. | no | tcp-backlog:expr |
Tcp Keep Alive | Configure a channel to send TCP keep-alive messages in an implementation-dependent manner. | no | tcp-keep-alive |
Url Charset | URL charset. The default value is UTF-8. | no | url-charset |
Worker | The AJP listeners XNIO worker. The default value is default. | no | worker |
Write Timeout:expr | Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}. | no | write-timeout:expr |
Note
3.4.2.4.13.4.4. EAP7 - Https Listener (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Bytes Received | measurement | The number of bytes that have been received by this listener | bytes-received |
Bytes Sent | measurement | The number of bytes that have been sent out on this listener | bytes-sent |
Error Count | measurement | The number of 500 responses that have been sent by this listener | error-count |
Max Processing Time | measurement | The maximum processing time taken by a request on this listener | max-processing-time |
Processing Time | measurement | The total processing time of all requests handed by this listener | processing-time |
Request Count | measurement | The number of requests this listener has served | request-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Encoded Slash | If 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 Value | If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped. The default value is false. | no | allow-equals-in-cookie-value |
Always Set Keep Alive | If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. | no | always-set-keep-alive |
Buffer Pipelined Data | If we should buffer pipelined requests. The default value is true. | no | buffer-pipelined-data |
Buffer Pool | The AJP listeners buffer pool. The default value is default. | no | buffer-pool |
Decode Url | If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired. The default value is true. | no | decode-url |
Disallowed Methods | A comma separated list of HTTP methods that are not allowed | no | disallowed-methods |
Enable Http 2 | Enables HTTP2 support for this listener. The default value is false. | no | enable-http2 |
Enable Spdy | Enables SPDY support for this listener. The default value is false. | no | enable-spdy |
Enabled | If the listener is enabled. The default value is true. | no | enabled |
Enabled Cipher Suites | Configures Enabled SSL cyphers | no | enabled-cipher-suites |
Enabled Protocols | Configures SSL protocols | no | enabled-protocols |
Max Buffered Request Size:expr | Maximum 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:expr | The maximum number of concurrent connections. | no | max-connections:expr |
Max Cookies:expr | The 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:expr | The maximum size in bytes of a http request header. The default value is 1048576. | no | max-header-size:expr |
Max Headers:expr | The 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:expr | The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters). The default value is 1000. | no | max-parameters:expr |
Max Post Size:expr | The maximum size of a post that will be accepted. The default value is 10485760. | no | max-post-size:expr |
No Request Timeout:expr | The 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:expr | Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}. | no | read-timeout:expr |
Receive Buffer:expr | The receive buffer size. | no | receive-buffer:expr |
Record Request Start Time | If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact. The default value is false. | no | record-request-start-time |
Request Parse Timeout:expr | The maximum amount of time (in milliseconds) that can be spent parsing the request | no | request-parse-timeout:expr |
Resolve Peer Address | Enables host dns lookup. The default value is false. | no | resolve-peer-address |
Security Realm | The listeners security realm | yes | security-realm |
Send Buffer:expr | The send buffer size. | no | send-buffer:expr |
Socket Binding | The AJP listener socket binder | yes | socket-binding |
Ssl Session Cache Size:expr | The maximum number of active SSL sessions | no | ssl-session-cache-size:expr |
Ssl Session Timeout:expr | The timeout for SSL sessions, in seconds | no | ssl-session-timeout:expr |
Tcp Backlog:expr | Configure a server with the specified backlog. | no | tcp-backlog:expr |
Tcp Keep Alive | Configure a channel to send TCP keep-alive messages in an implementation-dependent manner. | no | tcp-keep-alive |
Url Charset | URL charset. The default value is UTF-8. | no | url-charset |
Verify Client | The desired SSL client authentication mode for SSL channels. The default value is NOT_REQUESTED. | no | verify-client |
Worker | The AJP listeners XNIO worker. The default value is default. | no | worker |
Write Timeout:expr | Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}. | no | write-timeout:expr |
Note
3.4.2.4.13.5. EAP7 - Servlet Container (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Check Interval:expr | Check interval for JSP updates using a background thread. The default value is 0. | no | check-interval:expr |
Development | Enable Development mode which enables reloading JSP on-the-fly. The default value is false. | no | development |
Disabled | Enable the JSP container. The default value is false. | no | disabled |
Display Source Fragment | When a runtime error occurs, attempts to display corresponding JSP source fragment. The default value is true. | no | display-source-fragment |
Dump Smap | Write SMAP data to a file. The default value is false. | no | dump-smap |
Error On Use Bean Invalid Class Attribute | Enable 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 Arrays | Generate String constants as char arrays. The default value is false. | no | generate-strings-as-char-arrays |
Java Encoding | Specify the encoding used for Java sources. The default value is UTF8. | no | java-encoding |
Keep Generated | Keep the generated Servlets. The default value is true. | no | keep-generated |
Mapped File | Map to the JSP source. The default value is true. | no | mapped-file |
Modification Test Interval:expr | Minimum amount of time between two tests for updates, in seconds. The default value is 4. | no | modification-test-interval:expr |
Optimize Scriptlets | If JSP scriptlets should be optimised to remove string concatenation. The default value is false. | no | optimize-scriptlets |
Recompile On Fail | Retry failed JSP compilations on each request. The default value is false. | no | recompile-on-fail |
Scratch Dir | Specify a different work directory. | no | scratch-dir |
Smap | Enable SMAP. The default value is true. | no | smap |
Source Vm | Source VM level for compilation. The default value is 1.8. | no | source-vm |
Tag Pooling | Enable tag pooling. The default value is true. | no | tag-pooling |
Target Vm | Target VM level for compilation. The default value is 1.8. | no | target-vm |
Trim Spaces | Trim some spaces from the generated Servlet. The default value is false. | no | trim-spaces |
X Powered By | Enable advertising the JSP engine in x-powered-by. The default value is true. | no | x-powered-by |
Buffer Pool | The buffer pool to use for websocket deployments. The default value is default. | no | buffer-pool |
Dispatch To Worker | If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations. The default value is true. | no | dispatch-to-worker |
Worker | The worker to use for websocket deployments. The default value is default. | no | worker |
Allow Non Standard Wrappers | If 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 Cache | The buffer cache to use for caching static resources. The default value is default. | no | default-buffer-cache |
Default Encoding | Default encoding to use for all deployed applications | no | default-encoding |
Default Session Timeout:expr | The default session timeout (in minutes) for all applications deployed in the container. The default value is 30. | no | default-session-timeout:expr |
Directory Listing | If directory listing should be enabled for default servlets. | no | directory-listing |
Disable Caching For Secured Pages | If Undertow should set headers to disable caching for secured paged. Disabling this can cause security problems, as sensitive pages may be cached by an intermediary. The default value is true. | no | disable-caching-for-secured-pages |
Eager Filter Initialization | If true undertow calls filter init() on deployment start rather than when first requested. The default value is false. | no | eager-filter-initialization |
Ignore Flush | Ignore 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:expr | The maximum number of sessions that can be active at one time | no | max-sessions:expr |
Proactive Authentication | If 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:expr | The 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 Error | If 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 Encoding | Use encoding defined on listener. The default value is false. | no | use-listener-encoding |
Note
3.4.2.4.13.5.1. EAP7 - Mime Mapping (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The mime type for this mapping | yes | value |
Note
3.4.2.4.13.5.2. EAP7 - Welcome File (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.14. EAP7 - JCA (Managed Server) Service
Overview
Description: | The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Enabled | Specify whether bean validation is enabled. The default value is true. | no | enabled:1 |
Enabled | Specify whether archive validation is enabled. The default value is true. | no | enabled:2 |
Fail On Error | Should an archive validation error report fail the deployment. The default value is true. | no | fail-on-error |
Fail On Warn | Should an archive validation warning report fail the deployment. The default value is false. | no | fail-on-warn |
Debug | Enable/disable debug information logging. The default value is false. | no | debug |
Error | Enable/disable error information logging. The default value is false. | no | error |
Install | Enable/disable the cached connection manager valve and interceptor. The default value is false. | no | install |
Note
Operations
Package Types
3.4.2.4.14.1. EAP7 - BootstrapContext (Managed Server) Service
Description: | Bootstrap context for resource adapters. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Name | The name of the BootstrapContext | no | name |
Workmanager | The WorkManager instance for the BootstrapContext | no | workmanager |
Note
3.4.2.4.14.2. EAP7 - Workmanager (Managed Server) Service
Description: | WorkManager for resource adapters. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Name | The name of the WorkManager | no | name |
Note
3.4.2.4.14.2.1. EAP7 - Long Running Thread Pool (Managed Server) Service
Description: | Long running thread pool executor with a bounded queue where threads submitting tasks may block. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
Largest Thread Count | measurement | The largest number of threads that have ever simultaneously been in the pool. | largest-thread-count |
Rejected Count | measurement | The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded. | rejected-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Core Timeout | Whether core threads may time out. The default value is false. | no | allow-core-timeout |
Core Threads | The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size. | no | core-threads:expr |
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | yes | max-threads:expr |
Name | The name of the thread pool. | no | name |
Queue Length | The queue length. | yes | queue-length:expr |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Note
3.4.2.4.14.2.2. EAP7 - Short Running Thread Pool (Managed Server) Service
Description: | Short running thread pool executor with a bounded queue where threads submitting tasks may block. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
Largest Thread Count | measurement | The largest number of threads that have ever simultaneously been in the pool. | largest-thread-count |
Rejected Count | measurement | The number of tasks that have been passed to the handoff-executor (if one is specified) or discarded. | rejected-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Core Timeout | Whether core threads may time out. The default value is false. | no | allow-core-timeout |
Core Threads | The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size. | no | core-threads:expr |
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | yes | max-threads:expr |
Name | The name of the thread pool. | no | name |
Queue Length | The queue length. | yes | queue-length:expr |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Note
3.4.2.4.15. EAP7 - Osgi (Managed Server) Service
Overview
Description: | The OSGi subsystem configuration. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Activation | Activation flag for the OSGi subsystem. Possible values: lazy, eager. The default value is LAZY. | no | activation |
Startlevel | The current Start Level of the OSGi Framework. Changing this value will change the Start Level of the Framework accordingly. | no | startlevel |
Note
Operations
Name | Description |
---|---|
Activate | Activate the OSGi subsystem. |
Package Types
3.4.2.4.15.1. EAP7 - Capability (Managed Server) Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Startlevel | The startlevel for the capability. Can only be specified for OSGi bundles. | no | startlevel |
Note
3.4.2.4.15.2. EAP7 - Bundle (Managed Server) Service
Description: | Runtime bundle information. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Id | The bundle ID. | no | id |
Startlevel | The bundle's start level. | no | startlevel |
Symbolic Name | The bundle symbolic name. | no | symbolic-name |
Version | The bundle version. | no | version |
Note
Name | Description |
---|---|
Start | Starts the bundle. |
Stop | Stops the bundle. |
3.4.2.4.15.3. EAP7 - Property (Read Only) Service
Description: | A property |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The property value. | no | value |
Note
3.4.2.4.16. EAP7 - JMX (Managed Server) Service
Overview
Description: | The configuration of the JMX subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Show Model | Set to 'true' to include MBeans for the model controller resources | no | show-model |
Note
Operations
Package Types
3.4.2.4.16.1. EAP7 - Remoting Connector (Managed Server) Service
Description: | The configuration of a resource adapter. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Use Management Endpoint | If 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
3.4.2.4.17. EAP7 - Resource Adapters (Managed Server) Service
Overview
Description: | Configuration of the resource adapters subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.4.17.1. EAP7 - Resource Adapter (Managed Server) Service
Description: | The configuration of a resource adapter. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Archive | Specifies the resource adapter archive | yes | archive |
Beanvalidationgroups | Specifies the bean validation groups that should be used | no | beanvalidationgroups |
Bootstrapcontext | Specifies the unique name of the bootstrap context that should be used | no | bootstrapcontext |
Transaction Support | Specifies the transaction support level of the resource adapter | yes | transaction-support |
Note
3.4.2.4.17.1.1. EAP7 - Admin Objects (Managed Server) Service
Description: | Specifies the administration objects. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class Name | Specifies the fully qualified class name of a managed connection factory or admin object | yes | class-name |
Enabled | Specifies if the resource adapter should be enabled. The default value is true. | no | enabled |
Jndi Name | Specifies the JNDI name for the connection factory or admin object | no | jndi-name |
Use Java Context | Setting this to false will bind the object into global JNDI. The default value is true. | no | use-java-context |
Note
3.4.2.4.17.1.2. EAP7 - Connection Definitions (Managed Server) Service
Description: | Specifies the connection definitions. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allocation Retry | The 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 Millis | The 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 Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart. The default value is false. | no | background-validation |
Background Validation Millis | The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart | no | background-validation-millis:expr |
Blocking Timeout Wait Millis | The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time | no | blocking-timeout-wait-millis:expr |
Class Name | Specifies the fully qualified class name of a managed connection factory or admin object | yes | class-name |
Enabled | Specifies if the resource adapter should be enabled. The default value is true. | no | enabled |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Idle Timeout Minutes | The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value requires a server restart. | no | idle-timeout-minutes:expr |
Interleaving | An element to enable interleaving for XA connections. The default value is false. | no | interleaving |
Jndi Name | Specifies the JNDI name for the connection factory or admin object | no | jndi-name |
Max Pool Size | The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20. | no | max-pool-size |
Min Pool Size | The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0. | no | min-pool-size |
No Recovery | Specifies if the connection pool should be excluded from recovery | no | no-recovery |
No Tx Separate Pool | Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts. The default value is false. | no | no-tx-separate-pool |
Pad Xid | Should the Xid be padded. The default value is false. | no | pad-xid |
Pool Prefill | Should the pool be prefilled. Changing this value requires a server restart. The default value is false. | no | pool-prefill |
Pool Use Strict Min | Specifies if the min-pool-size should be considered strictly. The default value is false. | no | pool-use-strict-min |
Recovery Password | The password used for recovery | no | recovery-password |
Recovery Plugin Class Name | The fully qualified class name of the recovery plugin implementation | no | recovery-plugin-class-name |
Recovery Plugin Properties | The properties for the recovery plugin | no | recovery-plugin-properties |
Recovery Security Domain | The security domain used for recovery | no | recovery-security-domain |
Recovery Username | The user name used for recovery | no | recovery-username |
Same Rm Override | The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false | no | same-rm-override |
Security Application | Indicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool | no | security-application |
Security Domain | Specifies 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 Application | Indicates 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 Ccm | Enable the use of a cached connection manager. The default value is true. | no | use-ccm |
Use Fast Fail | Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false. | no | use-fast-fail |
Use Java Context | Setting this to false will bind the object into global JNDI. The default value is true. | no | use-java-context |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock:expr |
Wrap Xa Resource | Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true. | no | wrap-xa-resource |
XA Resource Timeout | The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero | no | xa-resource-timeout:expr |
Note
Name | Description |
---|---|
Flush All Connections in Pool | Flushes all connections in the pool |
Flush Idle Connections in Pool | Flushes all idle connections in the pool |
Test Connection in Pool | Test if a connection can be obtained |
3.4.2.4.17.1.2.1. EAP7 - Config Properties (Read Only) Service
Description: | Custom defined config properties. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | Custom defined config property value | no | value |
Note
3.4.2.4.17.1.3. EAP7 - Config Properties (Read Only) Service
Description: | Custom defined config properties. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | Custom defined config property value | no | value |
Note
3.4.2.4.18. EAP7 - CMP (Managed Server) Service
Overview
Description: | The configuration of the cmp subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.4.18.1. EAP7 - HiloKeygenerator (Managed Server) Service
Description: | HiLo based key generators. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Block Size | The block size | no | block-size |
Create Table | Boolean to determine whether to create create the tables | no | create-table |
Create Table Ddl | The DDL used to create the table | no | create-table-ddl |
Data Source | The datasource used for sequence generation | yes | data-source |
Drop Table | Boolean to determine whether to create drop the tables | no | drop-table |
Id Column | The ID column name | yes | id-column |
Select Hi Ddl | The DDL used to select the hi value | no | select-hi-ddl |
Sequence Column | The sequence column name | yes | sequence-column |
Sequence Name | The name of the sequence | yes | sequence-name |
Table Name | The table name | yes | table-name |
Note
3.4.2.4.19. EAP7 - EJB3 (Managed Server) Service
Overview
Description: | The configuration of the ejb3 subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Clustered Sfsb Cache | Name of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level | no | default-clustered-sfsb-cache |
Default Entity Bean Instance Pool | Name of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level | no | default-entity-bean-instance-pool |
Default Entity Bean Optimistic Locking | If set to true entity beans will use optimistic locking by default | no | default-entity-bean-optimistic-locking |
Default Mdb Instance Pool | Name of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level | no | default-mdb-instance-pool |
Default Resource Adapter Name | Name of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level. The default value is activemq-ra. | no | default-resource-adapter-name |
Default Sfsb Cache | Name of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level | no | default-sfsb-cache |
Default Singleton Bean Access Timeout | The default access timeout for singleton beans. The default value is 5000. | no | default-singleton-bean-access-timeout:expr |
Default Slsb Instance Pool | Name of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level | no | default-slsb-instance-pool |
Default Stateful Bean Access Timeout | The 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 Value | If set to false, the parameters to invocations on remote interface of an EJB, will be passed by reference. Else, the parameters will be passed by value. The default value is true. | no | in-vm-remote-interface-invocation-pass-by-value |
Enable Statistics | If set to true, enable the collection of invocation statistics. | no | enable-statistics |
Note
Operations
Package Types
3.4.2.4.19.1. EAP7 - EJB3 Thread Pool (Managed Server) Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Active Count | measurement | The approximate number of threads that are actively executing tasks. | active-count |
Completed Task Count | measurement | The approximate total number of tasks that have completed execution. | completed-task-count |
Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
Largest Thread Count | measurement | The largest number of threads that have ever simultaneously been in the pool. | largest-thread-count |
Rejected Count | measurement | The number of tasks that have been rejected. | rejected-count |
Task Count | measurement | The approximate total number of tasks that have ever been scheduled for execution. | task-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | no | max-threads:expr |
Name | The name of the thread pool. | no | name |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Note
3.4.2.4.19.2. EAP7 - File Passivation Store (Managed Server) Service
Description: | A file system based passivation store. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Groups Path | no | groups-path | |
Idle Timeout | The 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 Unit | The unit of idle-timeout. The default value is SECONDS. | no | idle-timeout-unit |
Max Size | The 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
3.4.2.4.19.3. EAP7 - MDB Delivery Group (Managed Server) Service
Description: | Delivery group to manage delivery for mdbs |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Active | Indicates if delivery for all MDBs belonging to this group is active. The default value is true. | no | active |
Note
3.4.2.4.19.4. EAP7 - Strict Max Bean Instance Pool (Managed Server) Service
Description: | A bean instance pool with a strict upper limit |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Derive Size | Specifies 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 Size | The maximum number of bean instances that the pool can hold at a given point in time. | no | max-pool-size |
Timeout | The maximum amount of time to wait for a bean instance to be available from the pool. The default value is 5. | no | timeout |
Timeout Unit | The instance acquisition timeout unit. The default value is MINUTES. | no | timeout-unit |
Note
3.4.2.4.19.5. EAP7 - SFSB Cache (Managed Server) Service
Description: | A SFSB cache. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Aliases | The aliases by which this cache may also be referenced | yes | aliases |
Passivation Store | The passivation store used by this cache | no | passivation-store |
Note
3.4.2.4.19.6. EAP7 - Cluster Passivation Store (Managed Server) Service
Description: | A clustered passivation store. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Bean Cache | The name of the cache used to store bean instances. | no | bean-cache |
Cache Container | The name of the cache container used for the bean and client-mappings caches. The default value is ejb. | no | cache-container |
Client Mappings Cache | The 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 Timeout | The 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 Unit | The unit of idle-timeout. The default value is SECONDS. | no | idle-timeout-unit |
Max Size | The 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 Replicate | Indicates whether replication should trigger passivation events on the bean. The default value is true. | no | passivate-events-on-replicate |
Note
3.4.2.4.19.7. EAP7 - Async Service (Managed Server) Service
Description: | The EJB3 Asynchronous Invocation Service |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Thread Pool Name | The name of the thread pool which handles asynchronous invocations | no | thread-pool-name |
Note
3.4.2.4.19.8. EAP7 - IIOP Service (Managed Server) Service
Description: | The IIOP service |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Enable By Default | If this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor | no | enable-by-default |
Use Qualified Name | If true EJB names will be bound into the naming service with the application and module name prepended to the name (e.g. myapp/mymodule/MyEjb) | no | use-qualified-name |
Note
3.4.2.4.19.9. EAP7 - Remote Service (Managed Server) Service
Description: | The EJB3 remote service |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Connector Ref | The name of the connector on which the EJB3 remoting channel is registered | no | connector-ref |
Thread Pool Name | The name of the thread pool that handles remote invocations | no | thread-pool-name |
Note
3.4.2.4.19.9.1. EAP7 - Channel Creation Options (Managed Server) Service
Description: | The options that will be used during the EJB remote channel creation |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Type | The type of the channel creation option | no | type |
Value | The value for the EJB remote channel creation option | no | value |
Note
3.4.2.4.19.10. EAP7 - Timer Service (Managed Server) Service
Description: | The EJB timer service |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Path | The directory to store persistent timer information in | no | path |
Relative To | The relative path that is used to resolve the timer data store location | no | relative-to |
Thread Pool Name | The name of the thread pool used to run timer service invocations | no | thread-pool-name |
Note
3.4.2.4.20. EAP7 - Threads (Managed Server) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.4.20.1. EAP7 - ThreadFactory (Managed Server) Service
Description: | A thread factory (implementing java.util.concurrent.ThreadFactory). |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Group Name | Specifies the name of a thread group to create for this thread factory. | no | group-name |
Name | The name of the created thread factory. | no | name |
Priority | May be used to specify the thread priority of created threads. The default value is -1. | no | priority:expr |
Thread Name Pattern | The 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
3.4.2.4.20.2. EAP7 - ThreadPool (Managed Server) Service
Description: | A thread pool executor |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Active Count | measurement | The approximate number of threads that are actively executing tasks. | active-count |
Completed Task Count | measurement | The approximate total number of tasks that have completed execution. | completed-task-count |
Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
Largest Thread Count | measurement | The largest number of threads that have ever simultaneously been in the pool. | largest-thread-count |
Rejected Count | measurement | The number of tasks that have been rejected. | rejected-count |
Task Count | measurement | The approximate total number of tasks that have ever been scheduled for execution. | task-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | yes | max-threads:expr |
Name | The name of the thread pool. | no | name |
Queue Length | The queue length. Required only for Bounded and Blocking Bounded Thread Pools. | no | queue-length:expr |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Allow Core Timeout | Whether core threads may time out. The default value is false. | no | allow-core-timeout |
Core Threads | The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size. | no | core-threads:expr |
Handoff Executor | An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded. | no | handoff-executor |
Thread Pool Type | Thread pool type | yes | __type |
Note
3.4.2.4.21. EAP7 - Security (Managed Server) Service
Overview
Description: | The configuration of the security subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Deep Copy Subject Mode | Sets the copy mode of subjects done by the security managers to be deep copies that makes copies of the subject principals and credentials if they are cloneable. It should be set to true if subject include mutable content that can be corrupted when multiple threads have the same identity and cache flushes/logout clearing the subject in one thread results in subject references affecting other threads. The default value is false. | no | deep-copy-subject-mode |
Note
Operations
Package Types
3.4.2.4.21.1. EAP7 - Security Domain (Managed Server) Service
Description: | Configures a security domain. Authentication, authorization, ACL, mapping, auditing and identity trust are configured here. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cache Type | Adds a cache to speed up authentication checks. Allowed values are 'default' to use simple map as the cache and 'infinispan' to use an Infinispan cache. | no | cache-type |
Note
Name | Description |
---|---|
Flush Cache | Remove 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 Principals | Lists the principals stored in the authentication cache for this security domain. |
3.4.2.4.21.1.1. EAP7 - ACL (Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.4.21.1.1.1. EAP7 - Acl Modules (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.4.21.1.1.1.1. EAP7 - Module Options (Acl - Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.4.21.1.2. EAP7 - Audit (Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Note
3.4.2.4.21.1.2.1. EAP7 - Provider Modules (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Note
3.4.2.4.21.1.2.1.1. EAP7 - Module Options (Provider Modules - Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.4.21.1.3. EAP7 - Authentication (Classic - Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.21.1.3.1. EAP7 - Login Modules (Classic - Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.4.21.1.3.1.1. EAP7 - Module Options (Classic - Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.4.21.1.4. EAP7 - Authentication (Jaspi - Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.4.21.1.4.1. EAP7 - Login Module Stack (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.4.21.1.4.1.1. EAP7 - Module Options (Login Module Stack (Managed Server)) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.4.21.1.5. EAP7 - Authorization (Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.4.21.1.5.1. EAP7 - Authorization Modules (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.4.21.1.5.1.1. EAP7 - Module Options (Authorization - Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.4.21.1.6. EAP7 - Identity Trust (Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.4.21.1.6.1. EAP7 - Identity Trust Modules (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.4.21.1.6.1.1. EAP7 - Module Options (Identity Trust - Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.4.21.1.7. EAP7 - JSSE (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cipher Suites | Comma separated list of cipher suites to enable on SSLSockets. | no | cipher-suites |
Client Alias | Preferred alias to use when the KeyManager chooses the client alias. | no | client-alias |
Client Auth | Boolean attribute to indicate if client's certificates should also be authenticated on the server side. | no | client-auth |
Key Manager | JSEE Key Manager factory | no | key-manager |
Keystore | Configures a JSSE key store | no | keystore |
Protocols | Comma separated list of protocols to enable on SSLSockets. | no | protocols |
Server Alias | Preferred alias to use when the KeyManager chooses the server alias. | no | server-alias |
Service Auth Token | Token to retrieve PrivateKeys from the KeyStore. | no | service-auth-token |
Trust Manager | JSEE Trust Manager factory | no | trust-manager |
Truststore | Configures a JSSE trust store | no | truststore |
Note
3.4.2.4.21.1.8. EAP7 - Mapping (Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Type | Type of mapping this module performs. Allowed values are principal, role, attribute or credential.. | yes | type |
Note
3.4.2.4.21.1.8.1. EAP7 - Mapping Modules (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Type | Type of mapping this module performs. Allowed values are principal, role, attribute or credential.. | yes | type |
Note
3.4.2.4.21.1.8.1.1. EAP7 - Module Options (Mapping - Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.4.21.2. EAP7 - Vault (Managed Server) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Fully Qualified Name of the Security Vault Implementation. | no | code |
Note
3.4.2.4.22. EAP7 - ActiveMQ Messaging (Managed Server) Service
Overview
Description: | The messaging subsystems |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.4.22.1. EAP7 - ActiveMQ Artemis (Managed Server) Service
Description: | The ActiveMQ Artemis based messaging subsystem |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Active | trait | Whether the server is active (and accepting connections) or passive (in backup mode, waiting for failover). | active |
Started | trait | Whether this server is started. | started |
Version | trait | The server's version. | version |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Async Connection Execution Enabled | Whether 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 Password | The password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!. | no | cluster-password |
Cluster User | The 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:expr | If 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 Dir | Whether the server should create the bindings directory on start up. The default value is true. | no | create-bindings-dir |
Create Journal Dir | Whether the server should create the journal directory on start up. The default value is true. | no | create-journal-dir |
Id Cache Size:expr | The size of the cache for pre-creating message IDs. The default value is 20000. | no | id-cache-size:expr |
Incoming Interceptors | The list of incoming interceptor classes used by this server. | no | incoming-interceptors |
Jmx Domain | The JMX domain used to register internal ActiveMQ MBeans in the MBeanServer. The default value is org.apache.activemq.artemis. | no | jmx-domain |
Jmx Management Enabled | Whether 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:expr | The size of the internal buffer on the journal. | no | journal-buffer-size:expr |
Journal Buffer Timeout:expr | The timeout (in nanoseconds) used to flush internal buffers on the journal. | no | journal-buffer-timeout:expr |
Journal Compact Min Files:expr | The 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:expr | The percentage of live data on which we consider compacting the journal. The default value is 30. | no | journal-compact-percentage:expr |
Journal File Size:expr | The size (in bytes) of each journal file. The default value is 10485760. | no | journal-file-size:expr |
Journal Max Io:expr | The maximum number of write requests that can be in the AIO queue at any one time. | no | journal-max-io:expr |
Journal Min Files:expr | How many journal files to pre-create. The default value is 2. | no | journal-min-files:expr |
Journal Pool Files:expr | The 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 Transactional | Whether 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 Transactional | Whether 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 Type | The type of journal to use. The default value is ASYNCIO. | no | journal-type |
Log Journal Write Rate | Whether to periodically log the journal's write rate and flush rate. The default value is false. | no | log-journal-write-rate |
Management Address | Address to send management messages to. The default value is jms.queue.activemq.management. | no | management-address |
Management Notification Address | The 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:expr | Frequency 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:expr | Percentage 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:expr | How many days to keep message counter history. The default value is 10. | no | message-counter-max-day-history:expr |
Message Counter Sample Period:expr | The sample period (in ms) to use for message counters. The default value is 10000. | no | message-counter-sample-period:expr |
Message Expiry Scan Period:expr | How often (in ms) to scan for expired messages. The default value is 30000. | no | message-expiry-scan-period:expr |
Message Expiry Thread Priority:expr | The priority of the thread expiring messages. The default value is 3. | no | message-expiry-thread-priority:expr |
Outgoing Interceptors | The list of outgoing interceptor classes used by this server. | no | outgoing-interceptors |
Override In Vm Security | Whether 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:expr | The maximum number of concurrent reads allowed on paging. The default value is 5. | no | page-max-concurrent-io:expr |
Perf Blast Pages:expr | TODO. The default value is -1. | no | perf-blast-pages:expr |
Persist Delivery Count Before Delivery | Whether 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 Cache | Whether IDs are persisted to the journal. The default value is true. | no | persist-id-cache |
Persistence Enabled | Whether the server will use the file based journal for persistence. The default value is true. | no | persistence-enabled |
Run Sync Speed Test | Whether 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:expr | The number of threads that the main scheduled thread pool has. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Security Domain | The security domain to use to verify user and role information. The default value is other. | no | security-domain |
Security Enabled | Whether security is enabled. The default value is true. | no | security-enabled |
Security Invalidation Interval:expr | How long (in ms) to wait before invalidating the security cache. The default value is 10000. | no | security-invalidation-interval:expr |
Server Dump Interval:expr | How 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 Enabled | Whether gathering of statistics such as message counters are enabled. The default value is false. | no | statistics-enabled |
Thread Pool Max Size:expr | The 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:expr | How 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:expr | How often (in ms) to scan for timeout transactions. The default value is 1000. | no | transaction-timeout-scan-period:expr |
Wild Card Routing Enabled | Whether the server supports wild card routing. The default value is true. | no | wild-card-routing-enabled |
Note
Name | Description |
---|---|
Close Connections for Address | Closes all the connections of clients connected to this server whose remote address contains the specified IP address. |
Close Connections for User | Closes all the connections of clients connected to this server under the specified user name. |
Close Consumer Connections for Address | Closes all the connections of consumers that are consuming from queues bound to the specified address. |
Commit Prepared Transaction | Heuristically commits a prepared transaction. |
Export Journal | Export the journal to a XML file |
Force Failover | Force the messaging server to stop and notify clients to failover. |
Get address settings as JSON | Returns the address settings as a JSON string for an address match. |
Get connectors as JSON | Returns the connectors configured for this server in a JSON string containing the connectors information. |
Get last sent message ID | Returns the ID of the last message sent from the given session to the given address. |
Get roles | Get the security roles for a specific address match. |
Get roles as JSON | Gets the roles (as a JSON string) for a specific address match. |
Get session creation time | Gets the session's creation time. |
Import Journal | Import an XML file to the journal |
List add | Add entry to list attribute |
List all consumers as JSON | Lists all the consumers. |
List clear | Clear all entries from list attribute |
List connection IDs | Lists the IDs of all the connections connected to this server. |
List connections as JSON | Lists all JMS connections. |
List consumers as JSON | Lists all the consumers which belongs to the JMS Connection specified by the connection id. |
List get | Get entry from list attribute |
List heuristic committed transactions | Lists transactions which have been heuristically committed. |
List heuristic rolled back transactions | Lists transactions which have been heuristically rolled back. |
List prepared transaction details as HTML | Lists all the prepared transaction, sorted by date, oldest first, with details, in HTML format. |
List prepared transaction details as JSON | Lists all the prepared transaction, sorted by date, oldest first, with details, in JSON format. |
List prepared transaction JMS details as HTML | Lists all the prepared transactions, sorted by date, oldest first, in a HTML format. |
List prepared transaction JMS details as JSON | Lists all the prepared transactions, sorted by date, oldest first, in a JSON format. |
List prepared transactions | Lists all the prepared transaction, sorted by date, oldest first. |
List producers info as JSON | For all sessions, lists information about message producers using JSON serialization. |
List remote addresses | Lists 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 remove | Remove entry from list attribute |
List sessions | Lists all the sessions IDs for the specified connection ID. |
List sessions as JSON | Lists all the sessions IDs for the specified connection id. |
List target destinations | Lists all addresses to which the designated session has sent messages. |
Map clear | Clear all entries from map attribute |
Map get | Get entry from map attribute |
Map put | Add entry to map attribute |
Map remove | Remove entry from map attribute |
Query | Query a resource |
Reset all message counter histories | Resets all message counters history. |
Reset All Message Counters | Resets all message counters. |
Resolve address setting | Resolve the address settings using ActiveMQ hierarchy of address settings. |
Rollback prepared transaction | Heuristically rolls back a prepared transaction. |
3.4.2.4.22.1.1. EAP7 - JMS Queue (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Consumer Count | measurement | The number of consumers consuming messages from this queue. | consumer-count |
Dead Letter Address | trait | The address to send dead messages to. | dead-letter-address |
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Expiry Address | trait | The address to send expired messages to. | expiry-address |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Paused | trait | Whether the queue is paused. | paused |
Scheduled Count | measurement | The number of scheduled messages in this queue. | scheduled-count |
Temporary | trait | Whether the queue is temporary. | temporary |
Queue Address | trait | The queue address defines what address is used for routing messages. | queue-address |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Durable | Whether the queue is durable or not. The default value is true. | no | durable |
Entries | The jndi names the queue will be bound to. | yes | entries |
Selector | The queue selector. | no | selector |
Note
Name | Description |
---|---|
Change Message Priority | Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Change Messages Priority | Change the priority of the messages corresponding to the given filter. Returns the number of removed messages. |
Count Messages | Returns the number of the messages in the queue matching the given filter. |
Expire Message | Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Expire Messages | Expire the messages matching the given filter. |
List Consumers as JSON | A string in JSON format. |
List Message Counter as HTML | List the message counter as a string in HTML format. |
List Message Counter as JSON | List the message counter as a string in JSON format. |
List Message Counter History as HTML | List the message counter history. |
List Message Counter History as JSON | List the message counter history as a string in JSON format. |
List Messages | List all messages in the queue that match the filter |
List Messages as JSON | List all messages in the queue that match the filter and return them as a string in JSON format. |
Move Message | Move the message corresponding to the given message-id to another queue |
Move Messages | Move the messages corresponding to the given filter to another queue. |
Pause | Pause the queue. |
Remove Message | Remove the message corresponding to the given message-id. |
Remove Messages | Remove messages matching the given filter from the destination. |
Reset Message Counter | Reset the message counters. |
Resume | Resume the queue. |
Send Message to Dead Letter Address | Send the message corresponding to the given message-id to this queue's Dead Letter Address. |
Send Messages to Dead Letter Address | Send the messages corresponding to the given filter to this queue's Dead Letter Address. |
3.4.2.4.22.1.2. EAP7 - JMS Topic (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Durable Message Count | measurement | The number of messages for all durable subscribers for this topic. | durable-message-count |
Durable Subscription Count | measurement | The number of durable subscribers for this topic. | durable-subscription-count |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Non Durable Message Count | measurement | The number of messages for all non-durable subscribers for this topic. | non-durable-message-count |
Non Durable Subscription Count | measurement | The number of non-durable subscribers for this topic. | non-durable-subscription-count |
Subscription Count | measurement | The number of (durable and non-durable) subscribers for this topic. | subscription-count |
Temporary | trait | Whether the topic is temporary. | temporary |
Topic Address | trait | The address the topic points to. | topic-address |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
JNDI Names | The jndi names the queue will be bound to. | yes | entries |
Note
Name | Description |
---|---|
Count Messages for Subscription | Count the number of messages matching the filter for the given subscription. |
Drop All Subscriptions | Drop all subscriptions from this topic. |
Drop Durable Subscription | Drop a durable subscription |
List All Subscriptions | List all subscriptions. |
List All Subscriptions as JSON | List all subscriptions as a string in JSON format. |
List Durable Subscriptions | List only the durable subscriptions. |
List Durable Subscriptions as JSON | List only the durable subscriptions, as a string in JSON format. |
List Messages for Subscription | List all the messages for the given subscription. |
List Messages for Subscription as JSON | List all the messages for the given subscription as a string in JSON format. |
List Non-Durable Subscriptions | List only the non-durable subscriptions. |
List Non-Durable Subscriptions as JSON | List only the non-durable subscriptions, as a string in JSON format. |
Remove Messages | Remove messages matching the given filter from the destination. |
3.4.2.4.22.1.3. EAP7 - Connection Factory (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Auto Group | Whether or not message grouping is automatically used. The default value is false. | no | auto-group |
Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
Call Failover Timeout:expr | The timeout to use when fail over is in process (in ms). The default value is -1. | no | call-failover-timeout:expr |
Call Timeout:expr | The call time out. The default value is 30000. | no | call-timeout:expr |
Client Failure Check Period:expr | The client failure check period. The default value is 30000. | no | client-failure-check-period:expr |
Client Id | The client id. | no | client-id |
Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
Confirmation Window Size:expr | The confirmation window size. The default value is -1. | no | confirmation-window-size:expr |
Connection Load Balancing Policy Class Name | Name 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:expr | The connection ttl. The default value is 60000. | no | connection-ttl:expr |
Connectors | Defines 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:expr | The consumer max rate. The default value is -1. | no | consumer-max-rate:expr |
Consumer Window Size:expr | The consumer window size. The default value is 1048576. | no | consumer-window-size:expr |
Discovery Group | The discovery group name. | no | discovery-group |
Dups Ok Batch Size:expr | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size:expr |
Entries | The jndi names the connection factory should be bound to. | yes | entries |
Factory Type | The type of connection factory. The default value is GENERIC. | no | factory-type |
Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
Group Id | The group id. | no | group-id |
Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
Max Retry Interval:expr | The max retry interval. The default value is 2000. | no | max-retry-interval:expr |
Min Large Message Size:expr | The min large message size. The default value is 102400. | no | min-large-message-size:expr |
Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
Producer Max Rate:expr | The producer max rate. The default value is -1. | no | producer-max-rate:expr |
Producer Window Size:expr | The producer window size. The default value is 65536. | no | producer-window-size:expr |
Reconnect Attempts:expr | The reconnect attempts. The default value is 0. | no | reconnect-attempts:expr |
Retry Interval:expr | The retry interval. The default value is 2000. | no | retry-interval:expr |
Retry Interval Multiplier:expr | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier:expr |
Scheduled Thread Pool Max Size:expr | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Thread Pool Max Size:expr | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
Transaction Batch Size:expr | The transaction batch size. The default value is 1048576. | no | transaction-batch-size:expr |
Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Note
3.4.2.4.22.1.4. EAP7 - Pooled Connection Factory (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Auto Group | Whether or not message grouping is automatically used. The default value is false. | no | auto-group |
Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
Call Failover Timeout:expr | The timeout to use when fail over is in process (in ms). The default value is -1. | no | call-failover-timeout:expr |
Call Timeout:expr | The call time out. The default value is 30000. | no | call-timeout:expr |
Client Failure Check Period:expr | The client failure check period. The default value is 30000. | no | client-failure-check-period:expr |
Client Id | The client id. | no | client-id |
Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
Confirmation Window Size:expr | The confirmation window size. The default value is -1. | no | confirmation-window-size:expr |
Connection Load Balancing Policy Class Name | Name 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:expr | The connection ttl. The default value is 60000. | no | connection-ttl:expr |
Connectors | Defines 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:expr | The consumer max rate. The default value is -1. | no | consumer-max-rate:expr |
Consumer Window Size:expr | The consumer window size. The default value is 1048576. | no | consumer-window-size:expr |
Discovery Group | The discovery group name. | no | discovery-group |
Dups Ok Batch Size:expr | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size:expr |
Entries | The jndi names the connection factory should be bound to. | yes | entries |
Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
Group Id | The group id. | no | group-id |
Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
Max Retry Interval:expr | The max retry interval. The default value is 2000. | no | max-retry-interval:expr |
Min Large Message Size:expr | The min large message size. The default value is 102400. | no | min-large-message-size:expr |
Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
Producer Max Rate:expr | The producer max rate. The default value is -1. | no | producer-max-rate:expr |
Producer Window Size:expr | The producer window size. The default value is 65536. | no | producer-window-size:expr |
Protocol Manager Factory | The protocol manager factory used by this connection factory. | no | protocol-manager-factory |
Reconnect Attempts:expr | The reconnect attempts. The default value is 0. | no | reconnect-attempts:expr |
Retry Interval:expr | The retry interval. The default value is 2000. | no | retry-interval:expr |
Retry Interval Multiplier:expr | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier:expr |
Scheduled Thread Pool Max Size:expr | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Thread Pool Max Size:expr | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
Transaction Batch Size:expr | The transaction batch size. The default value is 1048576. | no | transaction-batch-size:expr |
Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Note
3.4.2.4.22.1.5. EAP7 - Security Setting (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.22.1.5.1. EAP7 - Role (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Consume | his permission allows the user to consume a message from a queue bound to matching addresses. The default value is false. | yes | consume |
Create Durable Queue | This permission allows the user to create a durable queue. The default value is false. | yes | create-durable-queue |
Create Non Durable Queue | This permission allows the user to create a temporary queue. The default value is false. | yes | create-non-durable-queue |
Delete Durable Queue | This permission allows the user to delete a durable queue. The default value is false. | yes | delete-durable-queue |
Delete Non Durable Queue | This permission allows the user to delete a temporary queue. The default value is false. | yes | delete-non-durable-queue |
Manage | This permission allows the user to invoke management operations by sending management messages to the management address. The default value is false. | yes | manage |
Send | This permission allows the user to send a message to matching addresses. The default value is false. | yes | send |
Note
3.4.2.4.22.1.6. EAP7 - Address Setting (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Address Full Policy | Determines 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 Address | The dead letter address | no | dead-letter-address |
Expiry Address | Defines where to send a message that has expired. | no | expiry-address |
Last Value Queue | Defines whether a queue only uses last values or not. The default value is false. | no | last-value-queue |
Max Delivery Attempts | Defines 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 Bytes | The max bytes size. The default value is -1. | no | max-size-bytes |
Message Counter History Day Limit | Day limit for the message counter history. The default value is 0. | no | message-counter-history-day-limit |
Page Max Cache Size | The 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 Bytes | The paging size. The default value is 10485760. | no | page-size-bytes |
Redelivery Delay | Defines how long to wait before attempting redelivery of a cancelled message. The default value is 0. | no | redelivery-delay |
Redistribution Delay | Defines 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 Route | If 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 Queues | Determines 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 Queues | Determines Whether ActiveMQ should automatically delete auto-created JMS queues when they have no consumers and no messages. | no | auto-delete-jms-queues |
Expiry Delay | Defines the expiration time that will be used for messages using the default expiration time. | no | expiry-delay |
Max Redelivery Delay | Maximum value for the redelivery-delay (in ms). | no | max-redelivery-delay |
Redelivery Multiplier | Multiplier to apply to the redelivery-delay parameter. | no | redelivery-multiplier |
Note
3.4.2.4.22.1.7. EAP7 - Grouping Handler (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Grouping Handler Address | A reference to a cluster connection and the address it uses. | yes | grouping-handler-address |
Timeout | How 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 |
Type | Whether 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
3.4.2.4.22.1.8. EAP7 - Acceptor (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Started | trait | Whether this acceptor is started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Factory Class | The factory class. | yes | factory-class |
Socket Binding | The socket binding reference. | no | socket-binding |
Note
Name | Description |
---|---|
Start | Starts the acceptor. |
Stop | Stops the acceptor. |
3.4.2.4.22.1.8.1. EAP7 - Param (Read Only) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.4.22.1.9. EAP7 - Connector (ActiveMQ - Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Factory Class | The factory class. | yes | factory-class |
Socket Binding | The socket binding reference. | no | socket-binding |
Note
3.4.2.4.22.1.9.1. EAP7 - Param (Read Only) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.4.22.1.10. EAP7 - In VM Acceptor (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Started | trait | Whether it's stopped or started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Server Id | The server id. | yes | server-id |
Note
Name | Description |
---|---|
Start | Starts the acceptor. |
Stop | Stops the acceptor. |
3.4.2.4.22.1.10.1. EAP7 - Param (Read Only) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.4.22.1.11. EAP7 - In VM Connector (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Server Id | The server id. | yes | server-id |
Note
3.4.2.4.22.1.11.1. EAP7 - Param (Read Only) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.4.22.1.12. EAP7 - Remote Acceptor (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Started | trait | Whether this acceptor is started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Socket Binding | The socket binding reference. | no | socket-binding |
Note
Name | Description |
---|---|
Start | Starts the acceptor. |
Stop | Stops the acceptor. |
3.4.2.4.22.1.12.1. EAP7 - Param (Read Only) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.4.22.1.13. EAP7 - Remote Connector (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Socket Binding | The socket binding reference. | no | socket-binding |
Note
3.4.2.4.22.1.13.1. EAP7 - Param (Read Only) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.4.22.1.14. EAP7 - Divert (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Divert Address | Address to divert from | yes | divert-address |
Exclusive | Whether 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 |
Filter | An 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 Address | Address to divert to | yes | forwarding-address |
Routing Name | Routing name of the divert | no | routing-name |
Transformer Class Name | The name of a class used to transform the message's body or properties before it is diverted. | no | transformer-class-name |
Note
3.4.2.4.22.1.15. EAP7 - Queue (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Id | trait | The id of the queue. | id |
Paused | trait | Whether the queue is paused. | paused |
Temporary | trait | Whether the queue is temporary. | temporary |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Durable | Defines whether the queue is durable. The default value is true. | no | durable |
Filter | A queue message filter definition. An undefined or empty filter will match all messages. | no | filter |
Queue Address | The queue address defines what address is used for routing messages. | yes | queue-address |
Note
Name | Description |
---|---|
Change Message Priority | Change the priority of the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Change Messages Priority | Change the priority of the messages corresponding to the given filter. |
Count Messages | Returns the number of the messages in the queue matching the given filter. |
Expire Message | Expire the message corresponding to the given message-id. Returns true if the message was expired, false otherwise. |
Expire Messages | Expire the messages matching the given filter. |
List Consumers as JSON | A string in JSON format. |
List Message Counter as HTML | List the message counter as a string in HTML format. |
List Message Counter as JSON | List the message counter as a string in JSON format. |
List Message Counter History as HTML | List the message counter history. |
List Message Counter History as JSON | List the message counter history as a string in JSON format. |
List Messages | List all messages in the queue that match the filter |
List Messages as JSON | List all messages in the queue that match the filter and return them as a string in JSON format. |
List Scheduled Messages | List the messages scheduled for delivery. |
List Scheduled Messages as JSON | List the messages scheduled for delivery as a string in JSON format. |
Move Message | Move the message corresponding to the given message-id to another queue |
Move Messages | Move the messages corresponding to the given filter to another queue. |
Pause | Pause the queue. |
Remove Message | Remove the message corresponding to the given message-id. |
Remove Messages | Remove messages matching the given filter from the destination. |
Reset Message Counter | Reset the message counters. |
Resume | Resume the queue. |
Send Message to Dead Letter Address | Send the message corresponding to the given message-id to this queue's Dead Letter Address. |
Send Messages to Dead Letter Address | Send the messages corresponding to the given filter to this queue's Dead Letter Address. |
3.4.2.4.22.1.16. EAP7 - Core Address (Managed Server) Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Binding Names | The names of all bindings (both queues and diverts) bound to this address. | yes | binding-names |
Number Of Bytes Per Page | The number of bytes used by each page for this address. | yes | number-of-bytes-per-page |
Number Of Pages | The number of pages used by this address. | yes | number-of-pages |
Queue Names | The names of the queues associated with the address. | yes | queue-names |
Roles | A list of the security roles (name and permissions) associated with the address. | yes | roles |
Note
3.4.2.4.22.1.17. EAP7 - Cluster Connection (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Node Id | trait | The node ID used by this cluster connection. | node-id |
Started | trait | Whether the cluster connection is started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Call Timeout | The timeout (in ms) for remote calls made by the cluster connection. The default value is 30000. | no | call-timeout |
Check Period | The period (in milliseconds) between client failure check. The default value is 30000. | no | check-period |
Cluster Connection Address | Each cluster connection only applies to messages sent to an address that starts with this value. | yes | cluster-connection-address |
Confirmation Window Size | The 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 Ttl | The 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 Ref | The confirmation-window-size to use for the connection used to forward messages to a target node. | yes | connector-ref |
Discovery Group Name | The 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 Consumers | Whether 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 Hops | The 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 Interval | The maximum interval of time used to retry connections. The default value is 2000. | no | max-retry-interval |
Min Large Message Size | The 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 Attempts | The 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 Interval | The 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 Multiplier | A 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 Connectors | The 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 Detection | Whether 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
Name | Description |
---|---|
Get Nodes | Returns 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. |
Start | Starts the cluster connection. |
Stop | Stops the cluster connection. |
3.4.2.4.22.1.18. EAP7 - Broadcast Group (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Started | trait | Whether the broadcast group is started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Broadcast Period | The period in milliseconds between consecutive broadcasts. The default value is 2000. | no | broadcast-period |
Connectors | Specifies the names of connectors that will be broadcast. | no | connectors |
Socket Binding | The broadcast group socket binding. | yes | socket-binding |
Note
Name | Description |
---|---|
Get Connector Pairs as JSON | Returns the pairs of live-backup connectors that are broadcasted by this broadcast group using JSON serialization. |
Start | Starts the broadcast group. |
Stop | Stops the broadcast group. |
3.4.2.4.22.1.19. EAP7 - Path (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Path | The 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 To | The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:
| no | relative-to |
Path Type | Path Type | yes | __name |
Note
3.4.2.4.22.1.20. EAP7 - Bridge (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Started | trait | Whether the bridge is started. | started |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Check Period | The period (in milliseconds) between client failure check. The default value is 30000. | no | check-period |
Confirmation Window Size | The 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 Ttl | The 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 Name | The 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 Shutdown | Whether 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 |
Filter | An 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 Address | The 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 |
Ha | Whether 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 Interval | The maximum interval of time used to retry connections. The default value is 2000. | no | max-retry-interval |
Min Large Message Size | The 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 |
Password | The 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 Name | The unique name of the local queue that the bridge consumes from. | yes | queue-name |
Reconnect Attempts | The 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 Interval | The 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 Multiplier | A 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 Connectors | A 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 Name | The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface. | no | transformer-class-name |
Use Duplicate Detection | Whether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. | no | use-duplicate-detection |
User | The 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
Name | Description |
---|---|
Start | Starts the bridge. |
Stop | Stops the bridge. |
3.4.2.4.22.1.21. EAP7 - Discovery Group (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Initial Wait Timeout | Period, 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 Timeout | Period 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 Binding | The discovery group socket binding. | no | socket-binding |
Note
3.4.2.4.22.1.22. EAP7 - Connector Service (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Factory Class | Class name of the factory class that can instantiate the connector service. | yes | factory-class |
Note
3.4.2.4.22.1.22.1. EAP7 - Param (Read Only) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.4.22.1.23. EAP7 - Runtime Queue (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Consumer Count | measurement | The number of consumers consuming messages from this queue. | consumer-count |
Dead Letter Address | trait | The address to send the queue's dead messages to. | dead-letter-address |
Delivering Count | measurement | The number of messages that this queue is currently delivering to its consumers. | delivering-count |
Durable | trait | Defines whether the queue is durable. | durable |
Expiry Address | trait | The address to send the queue's expired messages to. | expiry-address |
Filter | trait | A queue message filter definition. An undefined or empty filter will match all messages. | filter |
Message Count | measurement | The number of messages currently in this queue. | message-count |
Messages Added | measurement | The number of messages added to this queue since it was created. | messages-added |
Paused | trait | Whether the queue is paused. | paused |
Queue Address | trait | The queue address defines what address is used for routing messages. | queue-address |
Scheduled Count | measurement | The number of scheduled messages in this queue. | scheduled-count |
Temporary | trait | Whether the queue is temporary. | temporary |
Note
Name | Description |
---|---|
List Scheduled Messages as JSON | List the messages scheduled for delivery as a string in JSON format. |
List Messages as JSON | List all messages in the queue that match the filter and return them as a string in JSON format. |
Count Messages | Returns the number of the messages in the queue matching the given filter. |
List Consumers as JSON | Lists consumers. |
Change Messages Priority | Change the priority of the messages corresponding to the given filter. |
Pause | Pause the queue. |
List Message Counter History as JSON | List the message counter history as a string in JSON format. |
Expire Messages | Expire the messages matching the given filter. |
List Messages | List all messages in the queue that match the filter |
Send message To Dead Letter Address | Send the message corresponding to the given message-id to this queue's Dead Letter Address. |
Reset Message Counters | Reset the message counters. |
Move Message | Move the message corresponding to the given message-id to another queue |
Expire Message | Expire the message corresponding to the given message-id. |
List Message Counter as JSON | List the message counter as a string in JSON format. |
List Message Counter as HTML | List the message counter as a string in HTML format. |
Remove Messages | Remove messages matching the given filter from the destination. |
Move Messages | Move the messages corresponding to the given filter to another queue. |
List Message Counter as HTML | List the message counter history. |
List Scheduled Messages | List the messages scheduled for delivery. |
Resume | Resume the queue. |
Send Messages to Dead Letter Address | Send the messages corresponding to the given filter to this queue's Dead Letter Address. |
Remove Message | Remove the message corresponding to the given message-id. |
Change Message Priority | Change the priority of the message corresponding to the given message-id. |
3.4.2.4.23. EAP7 - Logging (Managed Server) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Handlers | The Handlers associated with this Logger. | yes | handlers |
Note
Operations
Package Types
3.4.2.4.23.1. EAP7 - Async Handler (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Overflow Action | Specify what action to take when the overflowing. The valid options are 'block' and 'discard'. The default value is BLOCK. | yes | overflow-action |
Queue Length | The queue length to use before flushing writing | yes | queue-length |
Subhandlers | The Handlers associated with this async handler. | no | subhandlers |
Note
3.4.2.4.23.2. EAP7 - Console Handler (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Target | Defines 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
3.4.2.4.23.3. EAP7 - Custom Handler (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | The logging handler class to be used. | yes | class |
Encoding | The character encoding used by this Handler. | no | encoding |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Module | The module that the logging handler depends on. | yes | module |
Properties | yes | properties |
Note
3.4.2.4.23.4. EAP7 - File Handler (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Append | Specify whether to append to the target file. The default value is true. | no | append |
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
File | The file description consisting of the path and optional relative to path. | no | file |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Note
3.4.2.4.23.5. EAP7 - Logger (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Handlers | The Handlers associated with this Logger. | no | handlers |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Use Parent Handlers | Specifies whether or not this logger should send its output to it's parent Logger. The default value is true. | no | use-parent-handlers |
Note
3.4.2.4.23.6. EAP7 - Periodic Rotating File Handler (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Append | Specify whether to append to the target file. The default value is true. | no | append |
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
File | The file description consisting of the path and optional relative to path. | no | file |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Suffix | Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix. | yes | suffix |
Note
3.4.2.4.23.7. EAP7 - Size Rotating File Handler (Managed Server) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Append | Specify whether to append to the target file. The default value is true. | no | append |
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
File | The file description consisting of the path and optional relative to path. | no | file |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Max Backup Index | The maximum number of backups to keep. The default value is 1. | yes | max-backup-index |
Rotate Size | The size at which to rotate the log file. The default value is 2m. | yes | rotate-size |
Note
3.4.2.4.24. EAP7 - JVM Service
Overview
Description: | Information about the underlying JVM |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.4.24.1. EAP7 - Operating System Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Available Processors | measurement | The number of processors available to the Java virtual machine. | available-processors |
System Load Average | measurement | The 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
3.4.2.4.24.2. EAP7 - Memory Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Object Pending Finalization Count | measurement | The approximate number of objects for which finalization is pending. | object-pending-finalization-count |
Initial heap usage | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | heap-memory-usage:init |
Used heap | measurement | The amount of used memory in bytes. | heap-memory-usage:used |
Committed heap | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | heap-memory-usage:committed |
Maximum heap usage | measurement | The maximum amount of memory in bytes that can be used for memory management. | heap-memory-usage:max |
Initial non-heap usage | measurement | The 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 memory | measurement | The amount of used memory in bytes. | non-heap-memory-usage:used |
Committed non-heap memory | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | non-heap-memory-usage:committed |
Maximum non-heap usage | measurement | The maximum amount of memory in bytes that can be used for memory management. | non-heap-memory-usage:max |
Note
Name | Description |
---|---|
Trigger GC | Runs the garbage collector. |
3.4.2.4.24.3. EAP7 - Runtime Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Uptime | measurement | The uptime of the Java virtual machine in milliseconds. | uptime |
Note
3.4.2.4.24.4. EAP7 - Threading Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Thread Count | measurement | The current number of live threads including both daemon and non-daemon threads. | thread-count |
Peak Thread Count | measurement | The peak live thread count since the Java virtual machine started or peak was reset. | peak-thread-count |
Total Started Thread Count | measurement | The total number of threads created and also started since the Java virtual machine started. | total-started-thread-count |
Daemon Thread Count | measurement | The current number of live daemon threads. | daemon-thread-count |
Current Thread Cpu Time | measurement | The 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 Time | measurement | The 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
Name | Description | Required | Internal Name |
---|---|---|---|
Thread Contention Monitoring Enabled | Whether thread contention monitoring is enabled. | no | thread-contention-monitoring-enabled |
Thread Cpu Time Enabled | Whether thread CPU time measurement is enabled. | no | thread-cpu-time-enabled |
Thread Contention Monitoring Supported | Whether the Java virtual machine supports thread contention monitoring. | no | thread-contention-monitoring-supported |
Thread Cpu Time Supported | Whether the Java virtual machine implementation supports CPU time measurement for any thread. | no | thread-cpu-time-supported |
Current Thread Cpu Time Supported | Whether the Java virtual machine supports CPU time measurement for the current thread. | no | current-thread-cpu-time-supported |
Object Monitor Usage Supported | Whether the Java virtual machine supports monitoring of object monitor usage. | no | object-monitor-usage-supported |
Synchronizer Usage Supported | Whether the Java virtual machine supports monitoring of ownable synchronizer usage. | no | synchronizer-usage-supported |
Note
Name | Description |
---|---|
Dump All Threads | Returns the thread info for all live threads with stack trace and synchronization information. |
Find Deadlocked Threads | Finds cycles of threads that are in deadlock waiting to acquire object monitors or ownable synchronizers. |
Find Monitor Deadlocked Threads | Finds cycles of threads that are in deadlock waiting to acquire object monitors. |
Get Thread Cpu Time | Returns the total CPU time for a thread of the specified ID in nanoseconds. |
Get Thread Info | Returns 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 Infos | Returns the thread info for each thread whose ID is in the input list. |
Get Thread User Time | Returns the CPU time that a thread of the specified ID has executed in user mode in nanoseconds. |
Reset Peak Thread Count | Resets the peak thread count to the current number of live threads. |
Get All thread ids | Get all live thread IDs. If a security manager is installed and the caller does not have ManagementPermission('monitor'), the result will be undefined. |
3.4.2.4.24.5. EAP7 - Garbage Collector Service
Description: | Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.24.5.1. EAP7 - Garbage Collector Resource Service
Description: | The management interface for one of the garbage collectors in the Java virtual machine. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Collection Count | measurement | The total number of collections that have occurred. | collection-count |
Collection Count per Minute | measurement | The total number of collections that have occurred. | collection-count |
Collection Time | measurement | The approximate accumulated collection elapsed time in milliseconds. | collection-time |
Collection Time per Minute | measurement | The approximate accumulated collection elapsed time in milliseconds. | collection-time |
Name | trait | The name representing this garbage collector | name |
Valid | trait | Whether this this memory manager is valid in the Java virtual machine. | valid |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Memory Pool Names | The name of memory pools that this garbage collector manages. | yes | memory-pool-names |
Note
3.4.2.4.24.6. EAP7 - Memory Pool Service
Description: | Parent resource for the resources providing the management interface for the Java virtual machine's memory pools. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.4.24.6.1. EAP7 - Memory Pool Resource Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Collection Usage - Init | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | collection-usage:init |
Collection Usage - Used | measurement | The amount of used memory in bytes. | collection-usage:used |
Collection Usage - Committed | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | collection-usage:committed |
Collection Usage - Max | measurement | The maximum amount of memory in bytes that can be used for memory management. | collection-usage:max |
Collection Usage Threshold Count | measurement | The 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 Exceeded | trait | Whether 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 Supported | trait | Whether this memory pool supports a collection usage threshold. | collection-usage-threshold-supported |
Name | trait | The name representing this memory pool. | name |
Peak Usage - Init | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | peak-usage:init |
Peak Usage - Used | measurement | The amount of used memory in bytes. | peak-usage:used |
Peak Usage - Committed | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | peak-usage:committed |
Peak Usage - Max | measurement | The maximum amount of memory in bytes that can be used for memory management. | peak-usage:max |
Type | trait | The type of this memory pool. | type |
Usage - Init | measurement | The amount of memory in bytes that the Java virtual machine initially requests from the operating system for memory management. | usage:init |
Usage - Used | measurement | The amount of used memory in bytes. | usage:used |
Usage - Committed | measurement | The amount of memory in bytes that is committed for the Java virtual machine to use. | usage:committed |
Usage - Max | measurement | The maximum amount of memory in bytes that can be used for memory management. | usage:max |
Usage Threshold Count | measurement | The 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 Exceeded | trait | Whether 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 Supported | trait | Whether this memory pool supports usage threshold. | usage-threshold-supported |
Valid | trait | Whether 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
Name | Description | Required | Internal Name |
---|---|---|---|
Collection Usage Threshold | The 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 Names | The names of the memory managers that manage this memory pool. | yes | memory-manager-names |
Usage Threshold | The 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
Name | Description |
---|---|
Reset Peak Usage | Resets the peak memory usage statistic of this memory pool to the current memory usage. |
3.4.2.4.25. EAP7 - Datasources (Managed) Service
Overview
Description: | Datasources subsystem for Managed servers. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Available drivers | yes | *4 |
Note
Operations
Package Types
3.4.2.4.25.1. EAP7 - DataSource (Managed) Service
Description: | A non-XA data source |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Connection Property | no | *1 | |
Connection Url | The JDBC driver connection URL | yes | connection-url |
Driver Name | Name of the (existing) JDBC driver to use | yes | driver-name |
Driver Class | The fully qualified name of the JDBC driver class | no | driver-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver | Defines 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 Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether to attempt to prefill the connection pool. Changing this value require a server restart. | no | pool-prefill |
Pool Use Strict Min | Define if the min-pool-size should be considered a strictly. | no | pool-use-strict-min |
Security Domain | Indicates 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 Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | Indicates the time in milliseconds to wait between retrying to allocate a connection. | no | allocation-retry-wait-millis |
Blocking Timeout Wait Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Note
Name | Description |
---|---|
Flush All Connection In Pool | Flushes the pool for all connections |
Flush Idle Connection In Pool | Flushes the pool for idle connections |
Test Connection In Pool | Tests if a connection can be obtained |
3.4.2.4.25.2. EAP7 - XADataSource (Managed) Service
Description: | An XA data source |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Prepared Statement Cache Current Size | measurement | The number of prepared and callable statements currently cached in the statement cache | PreparedStatementCacheCurrentSize |
Prepared Statement Cache Miss Count | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Miss Count per Minute | measurement | The number of times that a statement request could not be satisfied with a statement from the cache | PreparedStatementCacheMissCount |
Prepared Statement Cache Add Count | measurement | The number of statements added to the statement cache | PreparedStatementCacheAddCount |
Prepared Statement Cache Access Count | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Access Count per Minute | measurement | The number of times that the statement cache was accessed | PreparedStatementCacheAccessCount |
Prepared Statement Cache Delete Count | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Delete Count per Minute | measurement | The number of statements discarded from the cache | PreparedStatementCacheDeleteCount |
Prepared Statement Cache Hit Count | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Prepared Statement Cache Hit Count per Minute | measurement | The number of times that statements from the cache were used | PreparedStatementCacheHitCount |
Active Count | measurement | The active count | ActiveCount |
Available Count | measurement | The available count | AvailableCount |
Average Blocking Time | measurement | The average time spent blocking for a connection | AverageBlockingTime |
Average Creation Time | measurement | The average time spent creating a physical connection | AverageCreationTime |
Created Count | measurement | The created count | CreatedCount |
Created Count per Minute | measurement | The created count | CreatedCount |
Destroyed Count | measurement | The destroyed count | DestroyedCount |
Destroyed Count per Minute | measurement | The destroyed count | DestroyedCount |
Max Creation Time | measurement | The maximum time for creating a physical connection | MaxCreationTime |
Max Used Count | measurement | The maximum number of connections used | MaxUsedCount |
Max Wait Time | measurement | The maximum wait time for a connection | MaxWaitTime |
Timed Out | measurement | The timed out count | TimedOut |
Timed Out per Minute | measurement | The timed out count | TimedOut |
Total Creation Time | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Creation Time per Minute | measurement | The total time spent creating physical connections | TotalCreationTime |
Total Blocking Time | measurement | The total blocking time | TotalBlockingTime |
Total Blocking Time per Minute | measurement | The total blocking time | TotalBlockingTime |
Connection Available? | trait | Connection Available? | connectionAvailable |
Min Pool Size setting | measurement | The min pool size setting | min-pool-size |
Max Pool Size setting | measurement | The max pool size setting | max-pool-size |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | no | *2 | |
Xa Datasource Class | The fully qualified name of the javax.sql.XADataSource implementation | yes | xa-datasource-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver Name | Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit | yes | driver-name |
User Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether to attempt to prefill the connection pool. Changing this value require a server restart. | no | pool-prefill |
Pool Use Strict Min | Define if the min-pool-size should be considered a strictly. | no | pool-use-strict-min |
Interleaving | An element to enable interleaving for XA connection factories | no | interleaving |
No Tx Separate Pool | Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different context | no | no-tx-separate-pool |
Pad Xid | Should the Xid be padded | no | pad-xid |
Same Rm Override | The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false | no | same-rm-override |
Wrap Xa Datasource | Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance | no | wrap-xa-datasource |
Security Domain | Indicates 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 Name | recovery plugin implementation provided for specific purpose (i.e vendor) | no | recovery-plugin-class-name |
Reauth Plugin Class Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | he 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 Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 Timeout | Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds | no | xa-resource-timeout |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Recovery Username | username used to try connection recovery | no | recovery-username |
Recovery Password | password used to try connection recovery | no | recovery-password |
Recovery Security Domain | security-domain used to try connection recovery | no | recovery-security-domain |
No Recovery | if true no recovery are tried for this connection pool | no | no-recovery |
Note
Name | Description |
---|---|
Flush All Connection In Pool | Flushes the pool for all connections |
Flush Idle Connection In Pool | Flushes the pool for idle connections |
Test Connection In Pool | Tests if a connection can be obtained |
3.4.2.4.26. EAP7 - JVM Definition Service
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
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Base Definition | The definition from host level to use/override | yes | baseDefinition |
Agent Lib | The JVM agent lib. | no | agent-lib |
Agent Path | The JVM agent path. | no | agent-path |
Env Classpath Ignored | Ignore the environment classpath. | no | env-classpath-ignored |
Environment Variables | The JVM environment variables. | no | environment-variables |
Heap Size | The initial heap size allocated by the JVM. | no | heap-size |
Java Agent | The java agent. | no | java-agent |
Java Home | The java home | no | java-home |
Jvm Options | The JVM options. Those can not be changed after initial creation of the definition. | no | jvm-options |
Max Heap Size | The maximum heap size that can be allocated by the JVM. | no | max-heap-size |
Max Permgen Size | The maximum size of the permanent generation. | no | max-permgen-size |
Permgen Size | The initial permanent generation size. | no | permgen-size |
Stack Size | The JVM stack size settings. | no | stack-size |
Type | The JVM type can be either SUN or IBM | no | type |
Note
Operations
Package Types
3.4.2.4.27. EAP7 - Transactions Subsystem (Managed) Service
Overview
Description: | The transactions subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Number Of Nested Transactions | measurement | The total number of nested (sub) transactions created. | number-of-nested-transactions |
Number Of Nested Transactions per Minute | measurement | The total number of nested (sub) transactions created. | number-of-nested-transactions |
Number Of Timed Out Transactions | measurement | The number of transactions that have rolled back due to timeout. | number-of-timed-out-transactions |
Number Of Timed Out Transactions per Minute | measurement | The number of transactions that have rolled back due to timeout. | number-of-timed-out-transactions |
Number Of Committed Transactions | measurement | The number of committed transactions. | number-of-committed-transactions |
Number Of Committed Transactions per Minute | measurement | The number of committed transactions. | number-of-committed-transactions |
Number Of Transactions | measurement | The total number of transactions (top-level and nested) created | number-of-transactions |
Number Of Transactions per Minute | measurement | The total number of transactions (top-level and nested) created | number-of-transactions |
Number Of Heuristics | measurement | The number of transactions which have terminated with heuristic outcomes. | number-of-heuristics |
Number Of Heuristics per Minute | measurement | The number of transactions which have terminated with heuristic outcomes. | number-of-heuristics |
Number Of Aborted Transactions | measurement | The number of aborted (i.e. rolledback) transactions. | number-of-aborted-transactions |
Number Of Aborted Transactions per Minute | measurement | The number of aborted (i.e. rolledback) transactions. | number-of-aborted-transactions |
Number Of Inflight Transactions | measurement | The number of transactions that have begun but not yet terminated. | number-of-inflight-transactions |
Number Of Inflight Transactions per Minute | measurement | The number of transactions that have begun but not yet terminated. | number-of-inflight-transactions |
Number Of Application Rollbacks | measurement | The 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 Minute | measurement | The 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 Rollbacks | measurement | The number of transactions that rolled back due to resource (participant) failure. | number-of-resource-rollbacks |
Number Of Resource Rollbacks per Minute | measurement | The number of transactions that rolled back due to resource (participant) failure. | number-of-resource-rollbacks |
Note
Configuration Properties
Operations
Package Types
3.4.2.4.27.1. EAP7 - Log Store (Managed) Service
Description: | Representation of the transaction logging storage mechanism. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Type | Specifies the implementation type of the logging store. | no | type |
Note
3.4.2.4.27.1.1. EAP7 - Transactions (Managed) Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Age In Seconds | The time since this transaction was prepared or when the recovery system last tried to recover it. | no | age-in-seconds |
Id | The id of this transaction. | no | id |
Jmx Name | The JMX name of this transaction. | no | jmx-name |
Type | The type name under which this record is stored. | no | type |
Note
3.4.2.4.27.1.1.1. EAP7 - Participants (Managed) Service
Description: | The resources that did work in a transaction. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Eis Product Name | The JCA enterprise information system's product name. | no | eis-product-name |
Eis Product Version | The JCA enterprise information system's product version | no | eis-product-version |
Jmx Name | The JMX name of this participant. | no | jmx-name |
Jndi Name | JNDI name of this participant. | no | jndi-name |
Status | Reports the commitment status of this participant (can be one of Pending, Prepared, Failed, Heuristic or Readonly). | no | status |
Type | The type name under which this record is stored. | no | type |
Note
3.4.2.4.28. EAP7 - JDR Service
Overview
Description: | JBoss Diagnostic Reporter (JDR) Subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Operations
Name | Description |
---|---|
Generate JDR Report | Request the generation of a JDR report. |
Package Types
3.4.2.5. EAP7 - Profile Service
Overview
Description: | A profile in a domain. Profiles are assigned to server groups. |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.5.1. EAP7 - ModCluster Domain Service
Overview
Description: | Mod_cluster support |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.5.1.1. EAP7 - Domain Service Configuration Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Proxy List | List of proxies, Format (hostname:port) separated with commas. | no | proxy-list |
Proxy Url | Base URL for MCMP requests. | no | proxy-url |
Advertise Socket | Name of Socket binding to use for the Advertise socket. | no | advertise-socket |
Advertise | Use Advertise logic or not. | no | advertise |
Advertise Security Key | String containing the security key for the Advertise logic. | no | advertise-security-key |
Balancer | The balancer name. | no | balancer |
Connector | Name of the web connector used to communicate with the load balancer. | yes | connector |
Load Balancing Group | loadBalancingGroup name. | no | load-balancing-group |
Excluded Contexts | List of contexts mod_cluster should ignore, Format String separated with commas. | no | excluded-contexts |
Auto Enable Contexts | Enable contexts even if disabled in mod_cluster_manger (httpd). | no | auto-enable-contexts |
Sticky Session | Use sticky sessions for requests. | no | sticky-session |
Sticky Session Remove | Remove session information on failover. | no | sticky-session-remove |
Sticky Session Force | Don't failover a request with session information. | no | sticky-session-force |
Worker Timeout | Timeout to wait in httpd for an available worker to process the requests. | no | worker-timeout |
Max Attempts | Max attempts to process an idempotent request. | no | max-attempts |
Flush Packets | Enables/disables packet flushing in httpd. | no | flush-packets |
Flush Wait | Time to wait before flushing packets in httpd. | no | flush-wait |
Ping | Time (in seconds) in which to wait for a pong answer to a ping. | no | ping |
Smax | Soft maximum idle connection count in httpd | no | smax |
Ttl | Time to live (in seconds) for idle connections above smax | no | ttl |
Node Timeout | Timeout (in seconds) for proxy connections to a node. | no | node-timeout |
Stop Context Timeout | Max time to wait for context to process pending requests. | no | stop-context-timeout |
Socket Timeout | Timeout to wait for httpd to answer a MCMP message. | no | socket-timeout |
Note
Name | Description |
---|---|
Add Custom Metric | Add new custom metric to the load balancer provider. |
Add Metric | Add new metric to the load balancer provider. |
Remove Custom Metric | Remove a custom metric from the load balancer provider. |
Remove Metric | Add new metric to the load balancer provider. |
3.4.2.5.1.1.1. EAP7 - Domain Dynamic Load Provider Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Decay | Decay. The default value is 2. | no | decay |
History | History. The default value is 9. | no | history |
Note
3.4.2.5.1.1.1.1. EAP7 - Domain Custom Load Metric Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Capacity | Capacity of the metric. The default value is 1 | no | capacity |
Class | Class name of the custom metric. | yes | class |
Weight | Weight of the metric. The default value is 1. | no | weight |
Note
3.4.2.5.1.1.1.2. EAP7 - Domain Load Metric Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Capacity | Capacity of the metric. The default value is 1. | no | capacity |
Type | Type of the metric | yes | type |
Weight | Weight of the metric. The default value is 1. | no | weight |
Note
3.4.2.5.1.1.2. EAP7 - Domain Ssl Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Ca Certificate File | Certificate authority. | no | ca-certificate-file |
Ca Revocation Ur | Certificate authority revocation list. | no | ca-revocation-ur |
Certificate Key File | Key file for the certificate. | no | certificate-key-file |
Cipher Suite | The allowed cipher suite. | no | cipher-suite |
Key Alias | The key alias. | no | key-alias |
Password | Password. | no | password |
Protocol | The SSL protocols that are enabled. | no | protocol |
Note
3.4.2.5.2. EAP7 - Naming (Profile) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.5.2.1. EAP7 - Binding (Profile) Service
Description: | JNDI bindings for primitive types |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Binding Type | The type of binding to create, may be simple, lookup or object-factory | yes | binding-type |
Class | The object factory class name for object factory bindings | no | class |
Lookup | The entry to lookup in JNDI for lookup bindings | no | lookup |
Module | The module to load the object factory from for object factory bindings | no | module |
Type | The type of the value to bind for simple bindings, this must be a primitive type | no | type |
Value | The value to bind for simple bindings | no | value |
Note
3.4.2.5.3. EAP7 - Undertow (Profile) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Security Domain | The default security domain used by web deployments. The default value is other. | no | default-security-domain |
Default Server | The default server to use for deployments. The default value is default-server. | no | default-server |
Default Servlet Container | The default servlet container to use for deployments. The default value is default. | no | default-servlet-container |
Default Virtual Host | The default virtual host to use for deployments. The default value is default-host. | no | default-virtual-host |
Instance Id | The cluster instance id. The default value is {EXPRESSION_VALUE=${jboss.node.name}}. | no | instance-id |
Statistics Enabled | Configures if are statistics enabled. The default value is false. | no | statistics-enabled |
Note
Operations
Package Types
3.4.2.5.3.1. EAP7 - Filter configurations (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.5.3.1.1. EAP7 - Error page (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code:expr | Error page code | yes | code:expr |
Path | Error page path | no | path |
Note
3.4.2.5.3.1.2. EAP7 - Expression filter (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Expression | The expression that defines the filter | yes | expression |
Module | Module to use to load the filter definitions | no | module |
Note
3.4.2.5.3.1.3. EAP7 - GZIP (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.5.3.1.4. EAP7 - Mod cluster (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Advertise Frequency:expr | The frequency (in milliseconds) that mod-cluster advertises itself on the network. The default value is 10000. | no | advertise-frequency:expr |
Advertise Path | The path that mod-cluster is registered under, defaults to /. The default value is /. | no | advertise-path |
Advertise Protocol | The protocol that is in use, defaults to HTTP. The default value is http. | no | advertise-protocol |
Advertise Socket Binding | The multicast group that is used to advertise | yes | advertise-socket-binding |
Broken Node Timeout:expr | The 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:expr | The number of connections that will be kept alive indefinitely. The default value is 40. | no | cached-connections-per-thread:expr |
Connection Idle Timeout:expr | The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread). The default value is 60. | no | connection-idle-timeout:expr |
Connections Per Thread:expr | The 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 2 | If the load balancer should attempt to upgrade back end connections to HTTP2. If HTTP2 is not supported HTTP or HTTPS will be used as normal. The default value is false. | no | enable-http2 |
Health Check Interval:expr | The frequency of health check pings to backend nodes. The default value is 10000. | no | health-check-interval:expr |
Management Access Predicate | A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands. Provides additional security on top of what is provided by limiting management to requests that originate from the management-socket-binding | no | management-access-predicate |
Management Socket Binding | The 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 Size | The maximum size for AJP packets. Increasing this will allow AJP to work for requests/responses that have a large amount of headers. This is an advanced option, and must be the same between load balancers and backend servers. | no | max-ajp-packet-size |
Max Request Time:expr | The 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:expr | The 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 Key | The security key that is used for the mod-cluster group. All members must use the same security key. | no | security-key |
Security Realm | The security realm that provides the SSL configuration | no | security-realm |
Use Alias | If an alias check is performed. The default value is false. | no | use-alias |
Worker | The XNIO worker that is used to send the advertise notifications. The default value is default. | no | worker |
Note
3.4.2.5.3.1.5. EAP7 - Rewrite (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Redirect | If this is true then a redirect will be done instead of a rewrite. The default value is false. | no | redirect |
Target | The expression that defines the target. If you are redirecting to a constant target put single quotes around the value | yes | target |
Note
3.4.2.5.3.1.6. EAP7 - Response header (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Header Name | Header name | yes | header-name |
Header Value | Value for header | yes | header-value |
Note
3.4.2.5.3.1.7. EAP7 - Request limit (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Max Concurrent Requests:expr | Maximum number of concurrent requests | no | max-concurrent-requests:expr |
Queue Size:expr | Number of requests to queue before they start being rejected | no | queue-size:expr |
Note
3.4.2.5.3.1.8. EAP7 - Custom filter (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class Name | Class name of HttpHandler | yes | class-name |
Module | Module name where class can be loaded from | yes | module |
Parameters | Filter parameters | no | parameters |
Note
3.4.2.5.3.2. EAP7 - Handler configuration (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.5.3.2.1. EAP7 - File Handler - Undertow (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cache Buffer Size:expr | Size of the buffers. The default value is 1024. | no | cache-buffer-size:expr |
Cache Buffers:expr | Number of buffers. The default value is 1024. | no | cache-buffers:expr |
Case Sensitive | Use case sensitive file handling. The default value is true. | no | case-sensitive |
Directory Listing | Enable directory listing?. The default value is false. | no | directory-listing |
Follow Symlink | Enable following symbolic links. The default value is false. | no | follow-symlink |
Path | Path on filesystem from where file handler will serve resources | no | path |
Safe Symlink Paths | Paths that are safe to be targets of symbolic links | no | safe-symlink-paths |
Note
3.4.2.5.3.2.2. EAP7 - Reverse proxy (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cached Connections Per Thread:expr | The number of connections that will be kept alive indefinitely. The default value is 5. | no | cached-connections-per-thread:expr |
Connection Idle Timeout:expr | The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread). The default value is 60. | no | connection-idle-timeout:expr |
Connections Per Thread:expr | The 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:expr | The 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:expr | Time 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:expr | The 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 Names | Comma separated list of session cookie names. Generally this will just be JSESSIONID. The default value is JSESSIONID. | no | session-cookie-names |
Note
3.4.2.5.3.2.2.1. EAP7 - Reverse proxy host (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Instance Id | The instance id (aka JVM route) that will be used to enable sticky sessions | no | instance-id |
Outbound Socket Binding | Outbound socket binding for this host | no | outbound-socket-binding |
Path | Optional path if host is using non root resource. The default value is /. | no | path |
Scheme | What kind of scheme is used. The default value is http. | no | scheme |
Security Realm | The security realm that provides the SSL configuration for the connection to the host | no | security-realm |
Note
3.4.2.5.3.3. EAP7 - Buffer Cache (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Buffer Size:expr | The size of an individual buffer. The default value is 1024. | no | buffer-size:expr |
Buffers Per Region:expr | The numbers of buffers in a region. The default value is 1024. | no | buffers-per-region:expr |
Max Regions:expr | The maximum number of regions. The default value is 10. | no | max-regions:expr |
Note
3.4.2.5.3.4. EAP7 - Server (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Default Host | The servers default virtual host. The default value is default-host. | no | default-host |
Servlet Container | The servers default servlet container. The default value is default. | no | servlet-container |
Note
3.4.2.5.3.4.1. EAP7 - Ajp Listener (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Bytes Received | measurement | The number of bytes that have been received by this listener | bytes-received |
Bytes Sent | measurement | The number of bytes that have been sent out on this listener | bytes-sent |
Error Count | measurement | The number of 500 responses that have been sent by this listener | error-count |
Max Processing Time | measurement | The maximum processing time taken by a request on this listener | max-processing-time |
Processing Time | measurement | The total processing time of all requests handed by this listener | processing-time |
Request Count | measurement | The number of requests this listener has served | request-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Encoded Slash | If 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 Value | If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped. The default value is false. | no | allow-equals-in-cookie-value |
Always Set Keep Alive | If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. | no | always-set-keep-alive |
Buffer Pipelined Data | If we should buffer pipelined requests. The default value is true. | no | buffer-pipelined-data |
Buffer Pool | The AJP listeners buffer pool. The default value is default. | no | buffer-pool |
Decode Url | If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired. The default value is true. | no | decode-url |
Disallowed Methods | A comma separated list of HTTP methods that are not allowed | no | disallowed-methods |
Enabled | If the listener is enabled. The default value is true. | no | enabled |
Max Buffered Request Size:expr | Maximum 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:expr | The maximum number of concurrent connections. | no | max-connections:expr |
Max Cookies:expr | The 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:expr | The maximum size in bytes of a http request header. The default value is 1048576. | no | max-header-size:expr |
Max Headers:expr | The 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:expr | The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters). The default value is 1000. | no | max-parameters:expr |
Max Post Size:expr | The maximum size of a post that will be accepted. The default value is 10485760. | no | max-post-size:expr |
No Request Timeout:expr | The 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:expr | Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}. | no | read-timeout:expr |
Receive Buffer:expr | The receive buffer size. | no | receive-buffer:expr |
Record Request Start Time | If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact. The default value is false. | no | record-request-start-time |
Redirect Socket | If this listener is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here. | no | redirect-socket |
Request Parse Timeout:expr | The maximum amount of time (in milliseconds) that can be spent parsing the request | no | request-parse-timeout:expr |
Resolve Peer Address | Enables host dns lookup. The default value is false. | no | resolve-peer-address |
Scheme | The listener scheme, can be HTTP or HTTPS. By default the scheme will be taken from the incoming AJP request. | no | scheme |
Send Buffer:expr | The send buffer size. | no | send-buffer:expr |
Socket Binding | The AJP listener socket binder | yes | socket-binding |
Tcp Backlog:expr | Configure a server with the specified backlog. | no | tcp-backlog:expr |
Tcp Keep Alive | Configure a channel to send TCP keep-alive messages in an implementation-dependent manner. | no | tcp-keep-alive |
Url Charset | URL charset. The default value is UTF-8. | no | url-charset |
Worker | The AJP listeners XNIO worker. The default value is default. | no | worker |
Write Timeout:expr | Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}. | no | write-timeout:expr |
Note
3.4.2.5.3.4.2. EAP7 - Undertow Host (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Alias | Aliases for the host | no | alias |
Default Response Code:expr | If 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 Module | Default web module. The default value is ROOT.war. | no | default-web-module |
Disable Console Redirect | if set to true, /console redirect wont be enabled for this host, default is false. The default value is false. | no | disable-console-redirect |
Note
3.4.2.5.3.4.2.1. EAP7 - Host Filter Ref (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Predicate | Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition. | no | predicate |
Priority:expr | Defines filter order, it should be set to 1 or more, higher number instructs server to be included earlier in handler chain than others under same context. The default value is 1. | no | priority:expr |
Note
3.4.2.5.3.4.2.2. EAP7 - Undertow-Location (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Handler | Default handler for this location | yes | handler |
Note
3.4.2.5.3.4.2.2.1. EAP7 - Location Filter Ref (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Predicate | Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition. | no | predicate |
Priority:expr | Defines filter order, it should be set to 1 or more, higher number instructs server to be included earlier in handler chain than others under same context. The default value is 1. | no | priority:expr |
Note
3.4.2.5.3.4.3. EAP7 - Http Listener (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Bytes Received | measurement | The number of bytes that have been received by this listener | bytes-received |
Bytes Sent | measurement | The number of bytes that have been sent out on this listener | bytes-sent |
Error Count | measurement | The number of 500 responses that have been sent by this listener | error-count |
Max Processing Time | measurement | The maximum processing time taken by a request on this listener | max-processing-time |
Processing Time | measurement | The total processing time of all requests handed by this listener | processing-time |
Request Count | measurement | The number of requests this listener has served | request-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Encoded Slash | If 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 Value | If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped. The default value is false. | no | allow-equals-in-cookie-value |
Always Set Keep Alive | If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. | no | always-set-keep-alive |
Buffer Pipelined Data | If we should buffer pipelined requests. The default value is true. | no | buffer-pipelined-data |
Buffer Pool | The AJP listeners buffer pool. The default value is default. | no | buffer-pool |
Certificate Forwarding | If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers. The default value is false. | no | certificate-forwarding |
Decode Url | If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired. The default value is true. | no | decode-url |
Disallowed Methods | A comma separated list of HTTP methods that are not allowed | no | disallowed-methods |
Enable Http 2 | Enables HTTP2 support for this listener. The default value is false. | no | enable-http2 |
Enabled | If the listener is enabled. The default value is true. | no | enabled |
Max Buffered Request Size:expr | Maximum 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:expr | The maximum number of concurrent connections. | no | max-connections:expr |
Max Cookies:expr | The 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:expr | The maximum size in bytes of a http request header. The default value is 1048576. | no | max-header-size:expr |
Max Headers:expr | The 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:expr | The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters). The default value is 1000. | no | max-parameters:expr |
Max Post Size:expr | The maximum size of a post that will be accepted. The default value is 10485760. | no | max-post-size:expr |
No Request Timeout:expr | The 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 Forwarding | enables 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:expr | Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}. | no | read-timeout:expr |
Receive Buffer:expr | The receive buffer size. | no | receive-buffer:expr |
Record Request Start Time | If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact. The default value is false. | no | record-request-start-time |
Redirect Socket | If this listener is supporting non-SSL requests, and a request is received for which a matching <security-constraint> requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here. | no | redirect-socket |
Request Parse Timeout:expr | The maximum amount of time (in milliseconds) that can be spent parsing the request | no | request-parse-timeout:expr |
Resolve Peer Address | Enables host dns lookup. The default value is false. | no | resolve-peer-address |
Send Buffer:expr | The send buffer size. | no | send-buffer:expr |
Socket Binding | The AJP listener socket binder | yes | socket-binding |
Tcp Backlog:expr | Configure a server with the specified backlog. | no | tcp-backlog:expr |
Tcp Keep Alive | Configure a channel to send TCP keep-alive messages in an implementation-dependent manner. | no | tcp-keep-alive |
Url Charset | URL charset. The default value is UTF-8. | no | url-charset |
Worker | The AJP listeners XNIO worker. The default value is default. | no | worker |
Write Timeout:expr | Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}. | no | write-timeout:expr |
Note
3.4.2.5.3.4.4. EAP7 - Https Listener (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Bytes Received | measurement | The number of bytes that have been received by this listener | bytes-received |
Bytes Sent | measurement | The number of bytes that have been sent out on this listener | bytes-sent |
Error Count | measurement | The number of 500 responses that have been sent by this listener | error-count |
Max Processing Time | measurement | The maximum processing time taken by a request on this listener | max-processing-time |
Processing Time | measurement | The total processing time of all requests handed by this listener | processing-time |
Request Count | measurement | The number of requests this listener has served | request-count |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Encoded Slash | If 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 Value | If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped. The default value is false. | no | allow-equals-in-cookie-value |
Always Set Keep Alive | If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification. The default value is true. | no | always-set-keep-alive |
Buffer Pipelined Data | If we should buffer pipelined requests. The default value is true. | no | buffer-pipelined-data |
Buffer Pool | The AJP listeners buffer pool. The default value is default. | no | buffer-pool |
Decode Url | If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired. The default value is true. | no | decode-url |
Disallowed Methods | A comma separated list of HTTP methods that are not allowed | no | disallowed-methods |
Enable Http 2 | Enables HTTP2 support for this listener. The default value is false. | no | enable-http2 |
Enable Spdy | Enables SPDY support for this listener. The default value is false. | no | enable-spdy |
Enabled | If the listener is enabled. The default value is true. | no | enabled |
Enabled Cipher Suites | Configures Enabled SSL cyphers | no | enabled-cipher-suites |
Enabled Protocols | Configures SSL protocols | no | enabled-protocols |
Max Buffered Request Size:expr | Maximum 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:expr | The maximum number of concurrent connections. | no | max-connections:expr |
Max Cookies:expr | The 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:expr | The maximum size in bytes of a http request header. The default value is 1048576. | no | max-header-size:expr |
Max Headers:expr | The 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:expr | The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities.This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters). The default value is 1000. | no | max-parameters:expr |
Max Post Size:expr | The maximum size of a post that will be accepted. The default value is 10485760. | no | max-post-size:expr |
No Request Timeout:expr | The 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:expr | Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}. | no | read-timeout:expr |
Receive Buffer:expr | The receive buffer size. | no | receive-buffer:expr |
Record Request Start Time | If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact. The default value is false. | no | record-request-start-time |
Request Parse Timeout:expr | The maximum amount of time (in milliseconds) that can be spent parsing the request | no | request-parse-timeout:expr |
Resolve Peer Address | Enables host dns lookup. The default value is false. | no | resolve-peer-address |
Security Realm | The listeners security realm | yes | security-realm |
Send Buffer:expr | The send buffer size. | no | send-buffer:expr |
Socket Binding | The AJP listener socket binder | yes | socket-binding |
Ssl Session Cache Size:expr | The maximum number of active SSL sessions | no | ssl-session-cache-size:expr |
Ssl Session Timeout:expr | The timeout for SSL sessions, in seconds | no | ssl-session-timeout:expr |
Tcp Backlog:expr | Configure a server with the specified backlog. | no | tcp-backlog:expr |
Tcp Keep Alive | Configure a channel to send TCP keep-alive messages in an implementation-dependent manner. | no | tcp-keep-alive |
Url Charset | URL charset. The default value is UTF-8. | no | url-charset |
Verify Client | The desired SSL client authentication mode for SSL channels. The default value is NOT_REQUESTED. | no | verify-client |
Worker | The AJP listeners XNIO worker. The default value is default. | no | worker |
Write Timeout:expr | Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}. | no | write-timeout:expr |
Note
3.4.2.5.3.5. EAP7 - Servlet Container (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Check Interval:expr | Check interval for JSP updates using a background thread. The default value is 0. | no | check-interval:expr |
Development | Enable Development mode which enables reloading JSP on-the-fly. The default value is false. | no | development |
Disabled | Enable the JSP container. The default value is false. | no | disabled |
Display Source Fragment | When a runtime error occurs, attempts to display corresponding JSP source fragment. The default value is true. | no | display-source-fragment |
Dump Smap | Write SMAP data to a file. The default value is false. | no | dump-smap |
Error On Use Bean Invalid Class Attribute | Enable 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 Arrays | Generate String constants as char arrays. The default value is false. | no | generate-strings-as-char-arrays |
Java Encoding | Specify the encoding used for Java sources. The default value is UTF8. | no | java-encoding |
Keep Generated | Keep the generated Servlets. The default value is true. | no | keep-generated |
Mapped File | Map to the JSP source. The default value is true. | no | mapped-file |
Modification Test Interval:expr | Minimum amount of time between two tests for updates, in seconds. The default value is 4. | no | modification-test-interval:expr |
Optimize Scriptlets | If JSP scriptlets should be optimised to remove string concatenation. The default value is false. | no | optimize-scriptlets |
Recompile On Fail | Retry failed JSP compilations on each request. The default value is false. | no | recompile-on-fail |
Scratch Dir | Specify a different work directory. | no | scratch-dir |
Smap | Enable SMAP. The default value is true. | no | smap |
Source Vm | Source VM level for compilation. The default value is 1.8. | no | source-vm |
Tag Pooling | Enable tag pooling. The default value is true. | no | tag-pooling |
Target Vm | Target VM level for compilation. The default value is 1.8. | no | target-vm |
Trim Spaces | Trim some spaces from the generated Servlet. The default value is false. | no | trim-spaces |
X Powered By | Enable advertising the JSP engine in x-powered-by. The default value is true. | no | x-powered-by |
Buffer Pool | The buffer pool to use for websocket deployments. The default value is default. | no | buffer-pool |
Dispatch To Worker | If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations. The default value is true. | no | dispatch-to-worker |
Worker | The worker to use for websocket deployments. The default value is default. | no | worker |
Allow Non Standard Wrappers | If 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 Cache | The buffer cache to use for caching static resources. The default value is default. | no | default-buffer-cache |
Default Encoding | Default encoding to use for all deployed applications | no | default-encoding |
Default Session Timeout:expr | The default session timeout (in minutes) for all applications deployed in the container. The default value is 30. | no | default-session-timeout:expr |
Directory Listing | If directory listing should be enabled for default servlets. | no | directory-listing |
Disable Caching For Secured Pages | If Undertow should set headers to disable caching for secured paged. Disabling this can cause security problems, as sensitive pages may be cached by an intermediary. The default value is true. | no | disable-caching-for-secured-pages |
Eager Filter Initialization | If true undertow calls filter init() on deployment start rather than when first requested. The default value is false. | no | eager-filter-initialization |
Ignore Flush | Ignore 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:expr | The maximum number of sessions that can be active at one time | no | max-sessions:expr |
Proactive Authentication | If 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:expr | The 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 Error | If 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 Encoding | Use encoding defined on listener. The default value is false. | no | use-listener-encoding |
Note
3.4.2.5.3.5.1. EAP7 - Mime Mapping (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The mime type for this mapping | yes | value |
Note
3.4.2.5.3.5.2. EAP7 - Welcome File (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.5.4. EAP7 - JCA (Profile) Service
Overview
Description: | The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Enabled | Specify whether bean validation is enabled. The default value is true. | no | enabled:1 |
Enabled | Specify whether archive validation is enabled. The default value is true. | no | enabled:2 |
Fail On Error | Should an archive validation error report fail the deployment. The default value is true. | no | fail-on-error |
Fail On Warn | Should an archive validation warning report fail the deployment. The default value is false. | no | fail-on-warn |
Debug | Enable/disable debug information logging. The default value is false. | no | debug |
Error | Enable/disable error information logging. The default value is false. | no | error |
Install | Enable/disable the cached connection manager valve and interceptor. The default value is false. | no | install |
Note
Operations
Package Types
3.4.2.5.4.1. EAP7 - BootstrapContext (Profile) Service
Description: | Bootstrap context for resource adapters. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Name | The name of the BootstrapContext | no | name |
Workmanager | The WorkManager instance for the BootstrapContext | no | workmanager |
Note
3.4.2.5.4.2. EAP7 - Workmanager (Profile) Service
Description: | WorkManager for resource adapters. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Name | The name of the WorkManager | no | name |
Note
3.4.2.5.4.2.1. EAP7 - Long Running Thread Pool (Profile) Service
Description: | Long running thread pool executor with a bounded queue where threads submitting tasks may block. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Core Timeout | Whether core threads may time out. The default value is false. | no | allow-core-timeout |
Core Threads | The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size. | no | core-threads:expr |
Handoff Executor | An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded. | no | handoff-executor |
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | yes | max-threads:expr |
Name | The name of the thread pool. | no | name |
Queue Length | The queue length. | yes | queue-length:expr |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Note
3.4.2.5.4.2.2. EAP7 - Short Running Thread Pool (Profile) Service
Description: | Short running thread pool executor with a bounded queue where threads submitting tasks may block. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allow Core Timeout | Whether core threads may time out. The default value is false. | no | allow-core-timeout |
Core Threads | The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size. | no | core-threads:expr |
Handoff Executor | An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded. | no | handoff-executor |
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | yes | max-threads:expr |
Name | The name of the thread pool. | no | name |
Queue Length | The queue length. | yes | queue-length:expr |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Note
3.4.2.5.5. EAP7 - Osgi (Profile) Service
Overview
Description: | The OSGi subsystem configuration. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Activation | Activation flag for the OSGi subsystem. Possible values: lazy, eager. The default value is LAZY. | no | activation |
Startlevel | The current Start Level of the OSGi Framework. Changing this value will change the Start Level of the Framework accordingly. | no | startlevel |
Note
Operations
Package Types
3.4.2.5.5.1. EAP7 - Capability (Profile) Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Startlevel | The startlevel for the capability. Can only be specified for OSGi bundles. | no | startlevel |
Note
3.4.2.5.5.2. EAP7 - Property Service
Description: | A property |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The property value. | no | value |
Note
3.4.2.5.6. EAP7 - Resource Adapters (Profile) Service
Overview
Description: | Configuration of the resource adapters subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.5.6.1. EAP7 - Resource Adapter (Profile) Service
Description: | The configuration of a resource adapter. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Archive | Specifies the resource adapter archive | yes | archive |
Beanvalidationgroups | Specifies the bean validation groups that should be used | no | beanvalidationgroups |
Bootstrapcontext | Specifies the unique name of the bootstrap context that should be used | no | bootstrapcontext |
Transaction Support | Specifies the transaction support level of the resource adapter | yes | transaction-support |
Note
3.4.2.5.6.1.1. EAP7 - Admin Objects (Profile) Service
Description: | Specifies the administration objects. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class Name | Specifies the fully qualified class name of a managed connection factory or admin object | yes | class-name |
Enabled | Specifies if the resource adapter should be enabled. The default value is true. | no | enabled |
Jndi Name | Specifies the JNDI name for the connection factory or admin object | no | jndi-name |
Use Java Context | Setting this to false will bind the object into global JNDI. The default value is true. | no | use-java-context |
Note
3.4.2.5.6.1.2. EAP7 - Connection Definitions (Profile) Service
Description: | Specifies the connection definitions. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Allocation Retry | The 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 Millis | The 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 Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value requires a server restart. The default value is false. | no | background-validation |
Background Validation Millis | The background-validation-millis element specifies the amount of time, in milliseconds, that background validation will run. Changing this value requires a server restart | no | background-validation-millis:expr |
Blocking Timeout Wait Millis | The blocking-timeout-millis element specifies the maximum time, in milliseconds, to block while waiting for a connection before throwing an exception. Note that this blocks only while waiting for locking a connection, and will never throw an exception if creating a new connection takes an inordinately long time | no | blocking-timeout-wait-millis:expr |
Class Name | Specifies the fully qualified class name of a managed connection factory or admin object | yes | class-name |
Enabled | Specifies if the resource adapter should be enabled. The default value is true. | no | enabled |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Idle Timeout Minutes | The idle-timeout-minutes elements specifies the maximum time, in minutes, a connection may be idle before being closed. The actual maximum time depends also on the IdleRemover scan time, which is half of the smallest idle-timeout-minutes value of any pool. Changing this value requires a server restart. | no | idle-timeout-minutes:expr |
Interleaving | An element to enable interleaving for XA connections. The default value is false. | no | interleaving |
Jndi Name | Specifies the JNDI name for the connection factory or admin object | no | jndi-name |
Max Pool Size | The max-pool-size element specifies the maximum number of connections for a pool. No more connections will be created in each sub-pool. The default value is 20. | no | max-pool-size:expr |
Min Pool Size | The min-pool-size element specifies the minimum number of connections for a pool. The default value is 0. | no | min-pool-size:expr |
No Recovery | Specifies if the connection pool should be excluded from recovery | no | no-recovery |
No Tx Separate Pool | Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different contexts. The default value is false. | no | no-tx-separate-pool |
Pad Xid | Should the Xid be padded. The default value is false. | no | pad-xid |
Pool Prefill | Should the pool be prefilled. Changing this value requires a server restart. The default value is false. | no | pool-prefill |
Pool Use Strict Min | Specifies if the min-pool-size should be considered strictly. The default value is false. | no | pool-use-strict-min |
Recovery Password | The password used for recovery | no | recovery-password |
Recovery Plugin Class Name | The fully qualified class name of the recovery plugin implementation | no | recovery-plugin-class-name |
Recovery Plugin Properties | The properties for the recovery plugin | no | recovery-plugin-properties |
Recovery Security Domain | The security domain used for recovery | no | recovery-security-domain |
Recovery Username | The user name used for recovery | no | recovery-username |
Same Rm Override | The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false | no | same-rm-override |
Security Application | Indicates that app supplied parameters (such as from getConnection(user, pw)) are used to distinguish connections in the pool | no | security-application |
Security Domain | Specifies 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 Application | Indicates 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 Ccm | Enable the use of a cached connection manager. The default value is true. | no | use-ccm |
Use Fast Fail | Whether to fail a connection allocation on the first try if it is invalid (true) or keep trying until the pool is exhausted of all potential connections (false). The default value is false. | no | use-fast-fail |
Use Java Context | Setting this to false will bind the object into global JNDI. The default value is true. | no | use-java-context |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock:expr |
Wrap Xa Resource | Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance. The default value is true. | no | wrap-xa-resource |
XA Resource Timeout | The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero | no | xa-resource-timeout:expr |
Note
3.4.2.5.6.1.2.1. EAP7 - Config Properties Service
Description: | Custom defined config properties. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | Custom defined config property value | no | value |
Note
3.4.2.5.6.1.3. EAP7 - Config Properties Service
Description: | Custom defined config properties. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | Custom defined config property value | no | value |
Note
3.4.2.5.7. EAP7 - EJB3 (Profile) Service
Overview
Description: | The configuration of the ejb3 subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Clustered Sfsb Cache | Name of the default stateful bean cache, which will be applicable to all clustered stateful EJBs, unless overridden at the deployment or bean level | no | default-clustered-sfsb-cache |
Default Entity Bean Instance Pool | Name of the default entity bean instance pool, which will be applicable to all entity beans, unless overridden at the deployment or bean level | no | default-entity-bean-instance-pool |
Default Entity Bean Optimistic Locking | If set to true entity beans will use optimistic locking by default | no | default-entity-bean-optimistic-locking |
Default Mdb Instance Pool | Name of the default MDB instance pool, which will be applicable to all MDBs, unless overridden at the deployment or bean level | no | default-mdb-instance-pool |
Default Resource Adapter Name | Name of the default resource adapter name that will be used by MDBs, unless overridden at the deployment or bean level. The default value is activemq-ra. | no | default-resource-adapter-name |
Default Sfsb Cache | Name of the default stateful bean cache, which will be applicable to all stateful EJBs, unless overridden at the deployment or bean level | no | default-sfsb-cache |
Default Singleton Bean Access Timeout | The default access timeout for singleton beans. The default value is 5000. | no | default-singleton-bean-access-timeout:expr |
Default Slsb Instance Pool | Name of the default stateless bean instance pool, which will be applicable to all stateless EJBs, unless overridden at the deployment or bean level | no | default-slsb-instance-pool |
Default Stateful Bean Access Timeout | The 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 Value | If set to false, the parameters to invocations on remote interface of an EJB, will be passed by reference. Else, the parameters will be passed by value. The default value is true. | no | in-vm-remote-interface-invocation-pass-by-value |
Enable Statistics | If set to true, enable the collection of invocation statistics. | no | enable-statistics |
Note
Operations
Package Types
3.4.2.5.7.1. EAP7 - EJB3 Thread Pool (Profile) Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | no | max-threads:expr |
Name | The name of the thread pool. | no | name |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Note
3.4.2.5.7.2. EAP7 - File Passivation Store (Profile) Service
Description: | A file system based passivation store. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Groups Path | no | groups-path | |
Idle Timeout | The 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 Unit | The unit of idle-timeout. The default value is SECONDS. | no | idle-timeout-unit |
Max Size | The 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
3.4.2.5.7.3. EAP7 - MDB Delivery Group (Profile) Service
Description: | Delivery group to manage delivery for mdbs |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Active | Indicates if delivery for all MDBs belonging to this group is active. The default value is true. | no | active |
Note
3.4.2.5.7.4. EAP7 - Strict Max Bean Instance Pool (Profile) Service
Description: | A bean instance pool with a strict upper limit |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Derive Size | Specifies 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 Size | The maximum number of bean instances that the pool can hold at a given point in time. | no | max-pool-size |
Timeout | The maximum amount of time to wait for a bean instance to be available from the pool. The default value is 5. | no | timeout |
Timeout Unit | The instance acquisition timeout unit. The default value is MINUTES. | no | timeout-unit |
Note
3.4.2.5.7.5. EAP7 - SFSB Cache (Profile) Service
Description: | A SFSB cache. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Aliases | The aliases by which this cache may also be referenced | yes | aliases |
Passivation Store | The passivation store used by this cache | no | passivation-store |
Note
3.4.2.5.7.6. EAP7 - Cluster Passivation Store (Profile) Service
Description: | A clustered passivation store. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Bean Cache | The name of the cache used to store bean instances. | no | bean-cache |
Cache Container | The name of the cache container used for the bean and client-mappings caches. The default value is ejb. | no | cache-container |
Client Mappings Cache | The 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 Timeout | The 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 Unit | The unit of idle-timeout. The default value is SECONDS. | no | idle-timeout-unit |
Max Size | The 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 Replicate | Indicates whether replication should trigger passivation events on the bean. The default value is true. | no | passivate-events-on-replicate |
Note
3.4.2.5.7.7. EAP7 - Async Service (Profile) Service
Description: | The EJB3 Asynchronous Invocation Service |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Thread Pool Name | The name of the thread pool which handles asynchronous invocations | no | thread-pool-name |
Note
3.4.2.5.7.8. EAP7 - IIOP Service (Profile) Service
Description: | The IIOP service |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Enable By Default | If this is true EJB's will be exposed over IIOP by default, otherwise it needs to be explicitly enabled in the deployment descriptor | no | enable-by-default |
Use Qualified Name | If true EJB names will be bound into the naming service with the application and module name prepended to the name (e.g. myapp/mymodule/MyEjb) | no | use-qualified-name |
Note
3.4.2.5.7.9. EAP7 - Remote Service (Profile) Service
Description: | The EJB3 remote service |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Connector Ref | The name of the connector on which the EJB3 remoting channel is registered | no | connector-ref |
Thread Pool Name | The name of the thread pool that handles remote invocations | no | thread-pool-name |
Note
3.4.2.5.7.9.1. EAP7 - Channel Creation Options (Profile) Service
Description: | The options that will be used during the EJB remote channel creation |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Type | The type of the channel creation option | no | type |
Value | The value for the EJB remote channel creation option | no | value |
Note
3.4.2.5.7.10. EAP7 - Timer Service (Profile) Service
Description: | The EJB timer service |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Path | The directory to store persistent timer information in | no | path |
Relative To | The relative path that is used to resolve the timer data store location | no | relative-to |
Thread Pool Name | The name of the thread pool used to run timer service invocations | no | thread-pool-name |
Note
3.4.2.5.8. EAP7 - Threads (Profile) Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.5.8.1. EAP7 - ThreadFactory (Profile) Service
Description: | A thread factory (implementing java.util.concurrent.ThreadFactory). |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Group Name | Specifies the name of a thread group to create for this thread factory. | no | group-name |
Name | The name of the created thread factory. | no | name |
Priority | May be used to specify the thread priority of created threads. The default value is -1. | no | priority:expr |
Thread Name Pattern | The 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
3.4.2.5.8.2. EAP7 - ThreadPool (Profile) Service
Description: | A thread pool executor |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Keepalive Time | Used to specify the amount of time that pool threads should be kept running when idle; if not specified, threads will run until the executor is shut down. | no | keepalive-time |
Max Threads | The maximum thread pool size. | yes | max-threads:expr |
Name | The name of the thread pool. | no | name |
Queue Length | The queue length. Required only for Bounded and Blocking Bounded Thread Pools. | no | queue-length:expr |
Thread Factory | Specifies the name of a specific thread factory to use to create worker threads. If not defined an appropriate default thread factory will be used. | no | thread-factory |
Allow Core Timeout | Whether core threads may time out. The default value is false. | no | allow-core-timeout |
Core Threads | The core thread pool size which is smaller than the maximum pool size. If undefined, the core thread pool size is the same as the maximum thread pool size. | no | core-threads:expr |
Handoff Executor | An executor to delegate tasks to in the event that a task cannot be accepted. If not specified, tasks that cannot be accepted will be silently discarded. | no | handoff-executor |
Thread Pool Type | Thread pool type | yes | __type |
Note
3.4.2.5.9. EAP7 - Security (Profile) Service
Overview
Description: | The configuration of the security subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Deep Copy Subject Mode | Sets the copy mode of subjects done by the security managers to be deep copies that makes copies of the subject principals and credentials if they are cloneable. It should be set to true if subject include mutable content that can be corrupted when multiple threads have the same identity and cache flushes/logout clearing the subject in one thread results in subject references affecting other threads. The default value is false. | no | deep-copy-subject-mode |
Note
Operations
Package Types
3.4.2.5.9.1. EAP7 - Security Domain (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cache Type | Adds a cache to speed up authentication checks. Allowed values are 'default' to use simple map as the cache and 'infinispan' to use an Infinispan cache. | no | cache-type |
Note
3.4.2.5.9.1.1. EAP7 - ACL (Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.5.9.1.1.1. EAP7 - Acl Modules (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.5.9.1.1.1.1. EAP7 - Module Options (Acl - Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.5.9.1.2. EAP7 - Audit (Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Note
3.4.2.5.9.1.2.1. EAP7 - Provider Modules (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Note
3.4.2.5.9.1.2.1.1. EAP7 - Module Options (Provider Modules - Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.5.9.1.3. EAP7 - Authentication (Classic - Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.5.9.1.3.1. EAP7 - Login Modules (Classic - Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.5.9.1.3.1.1. EAP7 - Module Options (Classic - Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.5.9.1.4. EAP7 - Authentication (Jaspi - Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.5.9.1.4.1. EAP7 - Login Module Stack (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.5.9.1.4.1.1. EAP7 - Module Options (Login Module Stack (Profile)) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.5.9.1.5. EAP7 - Authorization (Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.5.9.1.5.1. EAP7 - Authorization Modules (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.5.9.1.5.1.1. EAP7 - Module Options (Authorization - Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.5.9.1.6. EAP7 - Identity Trust (Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.5.9.1.6.1. EAP7 - Identity Trust Modules (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Flag | The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional. | yes | flag |
Note
3.4.2.5.9.1.6.1.1. EAP7 - Module Options (Identity Trust - Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.5.9.1.7. EAP7 - JSSE (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Cipher Suites | Comma separated list of cipher suites to enable on SSLSockets. | no | cipher-suites |
Client Alias | Preferred alias to use when the KeyManager chooses the client alias. | no | client-alias |
Client Auth | Boolean attribute to indicate if client's certificates should also be authenticated on the server side. | no | client-auth |
Key Manager | JSEE Key Manager factory | no | key-manager |
Keystore | Configures a JSSE key store | no | keystore |
Protocols | Comma separated list of protocols to enable on SSLSockets. | no | protocols |
Server Alias | Preferred alias to use when the KeyManager chooses the server alias. | no | server-alias |
Service Auth Token | Token to retrieve PrivateKeys from the KeyStore. | no | service-auth-token |
Trust Manager | JSEE Trust Manager factory | no | trust-manager |
Truststore | Configures a JSSE trust store | no | truststore |
Note
3.4.2.5.9.1.8. EAP7 - Mapping (Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Type | Type of mapping this module performs. Allowed values are principal, role, attribute or credential.. | yes | type |
Note
3.4.2.5.9.1.8.1. EAP7 - Mapping Modules (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Class name of the module to be instantiated. | yes | code |
Type | Type of mapping this module performs. Allowed values are principal, role, attribute or credential.. | yes | type |
Note
3.4.2.5.9.1.8.1.1. EAP7 - Module Options (Mapping - Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Module Options | no | Module Options |
Note
3.4.2.5.9.2. EAP7 - Vault (Profile) Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Code | Fully Qualified Name of the Security Vault Implementation. | no | code |
Note
3.4.2.5.10. EAP7 - ActiveMQMessaging (Profile) Service
Overview
Description: | The messaging subsystems |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.5.10.1. EAP7 - ActiveMQ Artemis (Profile) Service
Description: | The ActiveMQ Artemis based messaging subsystem |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Async Connection Execution Enabled | Whether 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 Password | The password used by cluster connections to communicate between the clustered nodes. The default value is CHANGE ME!!. | no | cluster-password |
Cluster User | The 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:expr | If 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 Dir | Whether the server should create the bindings directory on start up. The default value is true. | no | create-bindings-dir |
Create Journal Dir | Whether the server should create the journal directory on start up. The default value is true. | no | create-journal-dir |
Id Cache Size:expr | The size of the cache for pre-creating message IDs. The default value is 20000. | no | id-cache-size:expr |
Incoming Interceptors | The list of incoming interceptor classes used by this server. | no | incoming-interceptors |
Jmx Domain | The JMX domain used to register internal ActiveMQ MBeans in the MBeanServer. The default value is org.apache.activemq.artemis. | no | jmx-domain |
Jmx Management Enabled | Whether 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:expr | The size of the internal buffer on the journal. | no | journal-buffer-size:expr |
Journal Buffer Timeout:expr | The timeout (in nanoseconds) used to flush internal buffers on the journal. | no | journal-buffer-timeout:expr |
Journal Compact Min Files:expr | The 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:expr | The percentage of live data on which we consider compacting the journal. The default value is 30. | no | journal-compact-percentage:expr |
Journal File Size:expr | The size (in bytes) of each journal file. The default value is 10485760. | no | journal-file-size:expr |
Journal Max Io:expr | The maximum number of write requests that can be in the AIO queue at any one time. | no | journal-max-io:expr |
Journal Min Files:expr | How many journal files to pre-create. The default value is 2. | no | journal-min-files:expr |
Journal Pool Files:expr | The 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 Transactional | Whether 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 Transactional | Whether 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 Type | The type of journal to use. The default value is ASYNCIO. | no | journal-type |
Log Journal Write Rate | Whether to periodically log the journal's write rate and flush rate. The default value is false. | no | log-journal-write-rate |
Management Address | Address to send management messages to. The default value is jms.queue.activemq.management. | no | management-address |
Management Notification Address | The 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:expr | Frequency 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:expr | Percentage 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:expr | How many days to keep message counter history. The default value is 10. | no | message-counter-max-day-history:expr |
Message Counter Sample Period:expr | The sample period (in ms) to use for message counters. The default value is 10000. | no | message-counter-sample-period:expr |
Message Expiry Scan Period:expr | How often (in ms) to scan for expired messages. The default value is 30000. | no | message-expiry-scan-period:expr |
Message Expiry Thread Priority:expr | The priority of the thread expiring messages. The default value is 3. | no | message-expiry-thread-priority:expr |
Outgoing Interceptors | The list of outgoing interceptor classes used by this server. | no | outgoing-interceptors |
Override In Vm Security | Whether 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:expr | The maximum number of concurrent reads allowed on paging. The default value is 5. | no | page-max-concurrent-io:expr |
Perf Blast Pages:expr | TODO. The default value is -1. | no | perf-blast-pages:expr |
Persist Delivery Count Before Delivery | Whether 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 Cache | Whether IDs are persisted to the journal. The default value is true. | no | persist-id-cache |
Persistence Enabled | Whether the server will use the file based journal for persistence. The default value is true. | no | persistence-enabled |
Run Sync Speed Test | Whether 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:expr | The number of threads that the main scheduled thread pool has. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Security Domain | The security domain to use to verify user and role information. The default value is other. | no | security-domain |
Security Enabled | Whether security is enabled. The default value is true. | no | security-enabled |
Security Invalidation Interval:expr | How long (in ms) to wait before invalidating the security cache. The default value is 10000. | no | security-invalidation-interval:expr |
Server Dump Interval:expr | How 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 Enabled | Whether gathering of statistics such as message counters are enabled. The default value is false. | no | statistics-enabled |
Thread Pool Max Size:expr | The 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:expr | How 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:expr | How often (in ms) to scan for timeout transactions. The default value is 1000. | no | transaction-timeout-scan-period:expr |
Wild Card Routing Enabled | Whether the server supports wild card routing. The default value is true. | no | wild-card-routing-enabled |
Note
3.4.2.5.10.1.1. EAP7 - JMS Queue (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Durable | Whether the queue is durable or not. The default value is true. | no | durable |
Entries | The jndi names the queue will be bound to. | yes | entries |
Selector | The queue selector. | no | selector |
Note
3.4.2.5.10.1.2. EAP7 - JMS Topic (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
JNDI Names | The jndi names the queue will be bound to. | yes | entries |
Note
3.4.2.5.10.1.3. EAP7 - Connection Factory (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Auto Group | Whether or not message grouping is automatically used. The default value is false. | no | auto-group |
Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
Call Failover Timeout:expr | The timeout to use when fail over is in process (in ms). The default value is -1. | no | call-failover-timeout:expr |
Call Timeout:expr | The call time out. The default value is 30000. | no | call-timeout:expr |
Client Failure Check Period:expr | The client failure check period. The default value is 30000. | no | client-failure-check-period:expr |
Client Id | The client id. | no | client-id |
Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
Confirmation Window Size:expr | The confirmation window size. The default value is -1. | no | confirmation-window-size:expr |
Connection Load Balancing Policy Class Name | Name 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:expr | The connection ttl. The default value is 60000. | no | connection-ttl:expr |
Connectors | Defines 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:expr | The consumer max rate. The default value is -1. | no | consumer-max-rate:expr |
Consumer Window Size:expr | The consumer window size. The default value is 1048576. | no | consumer-window-size:expr |
Discovery Group | The discovery group name. | no | discovery-group |
Dups Ok Batch Size:expr | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size:expr |
Entries | The jndi names the connection factory should be bound to. | yes | entries |
Factory Type | The type of connection factory. The default value is GENERIC. | no | factory-type |
Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
Group Id | The group id. | no | group-id |
Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
Max Retry Interval:expr | The max retry interval. The default value is 2000. | no | max-retry-interval:expr |
Min Large Message Size:expr | The min large message size. The default value is 102400. | no | min-large-message-size:expr |
Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
Producer Max Rate:expr | The producer max rate. The default value is -1. | no | producer-max-rate:expr |
Producer Window Size:expr | The producer window size. The default value is 65536. | no | producer-window-size:expr |
Reconnect Attempts:expr | The reconnect attempts. The default value is 0. | no | reconnect-attempts:expr |
Retry Interval:expr | The retry interval. The default value is 2000. | no | retry-interval:expr |
Retry Interval Multiplier:expr | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier:expr |
Scheduled Thread Pool Max Size:expr | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Thread Pool Max Size:expr | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
Transaction Batch Size:expr | The transaction batch size. The default value is 1048576. | no | transaction-batch-size:expr |
Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Note
3.4.2.5.10.1.4. EAP7 - Pooled Connection Factory (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Auto Group | Whether or not message grouping is automatically used. The default value is false. | no | auto-group |
Block On Acknowledge | True to set block on acknowledge. The default value is false. | no | block-on-acknowledge |
Block On Durable Send | True to set block on durable send. The default value is true. | no | block-on-durable-send |
Block On Non Durable Send | True to set block on non durable send. The default value is false. | no | block-on-non-durable-send |
Cache Large Message Client | True to cache large messages. The default value is false. | no | cache-large-message-client |
Call Failover Timeout:expr | The timeout to use when fail over is in process (in ms). The default value is -1. | no | call-failover-timeout:expr |
Call Timeout:expr | The call time out. The default value is 30000. | no | call-timeout:expr |
Client Failure Check Period:expr | The client failure check period. The default value is 30000. | no | client-failure-check-period:expr |
Client Id | The client id. | no | client-id |
Compress Large Messages | Whether large messages should be compressed. The default value is false. | no | compress-large-messages |
Confirmation Window Size:expr | The confirmation window size. The default value is -1. | no | confirmation-window-size:expr |
Connection Load Balancing Policy Class Name | Name 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:expr | The connection ttl. The default value is 60000. | no | connection-ttl:expr |
Connectors | Defines 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:expr | The consumer max rate. The default value is -1. | no | consumer-max-rate:expr |
Consumer Window Size:expr | The consumer window size. The default value is 1048576. | no | consumer-window-size:expr |
Discovery Group | The discovery group name. | no | discovery-group |
Dups Ok Batch Size:expr | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size:expr |
Entries | The jndi names the connection factory should be bound to. | yes | entries |
Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
Group Id | The group id. | no | group-id |
Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
Max Retry Interval:expr | The max retry interval. The default value is 2000. | no | max-retry-interval:expr |
Min Large Message Size:expr | The min large message size. The default value is 102400. | no | min-large-message-size:expr |
Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
Producer Max Rate:expr | The producer max rate. The default value is -1. | no | producer-max-rate:expr |
Producer Window Size:expr | The producer window size. The default value is 65536. | no | producer-window-size:expr |
Protocol Manager Factory | The protocol manager factory used by this connection factory. | no | protocol-manager-factory |
Reconnect Attempts:expr | The reconnect attempts. The default value is 0. | no | reconnect-attempts:expr |
Retry Interval:expr | The retry interval. The default value is 2000. | no | retry-interval:expr |
Retry Interval Multiplier:expr | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier:expr |
Scheduled Thread Pool Max Size:expr | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
Thread Pool Max Size:expr | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
Transaction Batch Size:expr | The transaction batch size. The default value is 1048576. | no | transaction-batch-size:expr |
Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Note
3.4.2.5.10.1.5. EAP7 - Security Setting (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.5.10.1.5.1. EAP7 - Role (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Consume | his permission allows the user to consume a message from a queue bound to matching addresses. The default value is false. | yes | consume |
Create Durable Queue | This permission allows the user to create a durable queue. The default value is false. | yes | create-durable-queue |
Create Non Durable Queue | This permission allows the user to create a temporary queue. The default value is false. | yes | create-non-durable-queue |
Delete Durable Queue | This permission allows the user to delete a durable queue. The default value is false. | yes | delete-durable-queue |
Delete Non Durable Queue | This permission allows the user to delete a temporary queue. The default value is false. | yes | delete-non-durable-queue |
Manage | This permission allows the user to invoke management operations by sending management messages to the management address. The default value is false. | yes | manage |
Send | This permission allows the user to send a message to matching addresses. The default value is false. | yes | send |
Note
3.4.2.5.10.1.6. EAP7 - Address Setting (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Address Full Policy | Determines 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 Address | The dead letter address | no | dead-letter-address |
Expiry Address | Defines where to send a message that has expired. | no | expiry-address |
Last Value Queue | Defines whether a queue only uses last values or not. The default value is false. | no | last-value-queue |
Max Delivery Attempts | Defines 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 Bytes | The max bytes size. The default value is -1. | no | max-size-bytes |
Message Counter History Day Limit | Day limit for the message counter history. The default value is 0. | no | message-counter-history-day-limit |
Page Max Cache Size | The 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 Bytes | The paging size. The default value is 10485760. | no | page-size-bytes |
Redelivery Delay | Defines how long to wait before attempting redelivery of a cancelled message. The default value is 0. | no | redelivery-delay |
Redistribution Delay | Defines 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 Route | If 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 Queues | Determines 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 Queues | Determines Whether ActiveMQ should automatically delete auto-created JMS queues when they have no consumers and no messages. | no | auto-delete-jms-queues |
Expiry Delay | Defines the expiration time that will be used for messages using the default expiration time. | no | expiry-delay |
Max Redelivery Delay | Maximum value for the redelivery-delay (in ms). | no | max-redelivery-delay |
Redelivery Multiplier | Multiplier to apply to the redelivery-delay parameter. | no | redelivery-multiplier |
Note
3.4.2.5.10.1.7. EAP7 - Grouping Handler (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Grouping Handler Address | A reference to a cluster connection and the address it uses. | yes | grouping-handler-address |
Timeout | How 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 |
Type | Whether 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
3.4.2.5.10.1.8. EAP7 - Acceptor (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Factory Class | The factory class. | yes | factory-class |
Socket Binding | The socket binding reference. | no | socket-binding |
Note
3.4.2.5.10.1.8.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.5.10.1.9. EAP7 - Connector (ActiveMQ - Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Factory Class | The factory class. | yes | factory-class |
Socket Binding | The socket binding reference. | no | socket-binding |
Note
3.4.2.5.10.1.9.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.5.10.1.10. EAP7 - In VM Acceptor (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Server Id | The server id. | yes | server-id |
Note
3.4.2.5.10.1.10.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.5.10.1.11. EAP7 - In VM Connector (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Server Id | The server id. | yes | server-id |
Note
3.4.2.5.10.1.11.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.5.10.1.12. EAP7 - Remote Acceptor (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Socket Binding | The socket binding reference. | no | socket-binding |
Note
3.4.2.5.10.1.12.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.5.10.1.13. EAP7 - Remote Connector (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Socket Binding | The socket binding reference. | no | socket-binding |
Note
3.4.2.5.10.1.13.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.5.10.1.14. EAP7 - Divert (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Divert Address | Address to divert from | yes | divert-address |
Exclusive | Whether 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 |
Filter | An 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 Address | Address to divert to | yes | forwarding-address |
Routing Name | Routing name of the divert | no | routing-name |
Transformer Class Name | The name of a class used to transform the message's body or properties before it is diverted. | no | transformer-class-name |
Note
3.4.2.5.10.1.14.1. EAP7 - Module Option Service
Description: | The module options to be used. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Modules Options | List of module options. | no | Modules Options |
Note
3.4.2.5.10.1.15. EAP7 - Queue (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Durable | Defines whether the queue is durable. The default value is true. | no | durable |
Filter | A queue message filter definition. An undefined or empty filter will match all messages. | no | filter |
Queue Address | The queue address defines what address is used for routing messages. | yes | queue-address |
Note
3.4.2.5.10.1.16. EAP7 - Core Address (Profile) Service
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 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Include Runtime | yes | includeRuntime |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Binding Names | The names of all bindings (both queues and diverts) bound to this address. | yes | binding-names |
Number Of Bytes Per Page | The number of bytes used by each page for this address. | yes | number-of-bytes-per-page |
Number Of Pages | The number of pages used by this address. | yes | number-of-pages |
Queue Names | The names of the queues associated with the address. | yes | queue-names |
Roles | A list of the security roles (name and permissions) associated with the address. | yes | roles |
Note
3.4.2.5.10.1.17. EAP7 - Cluster Connection (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Call Timeout | The timeout (in ms) for remote calls made by the cluster connection. The default value is 30000. | no | call-timeout |
Check Period | The period (in milliseconds) between client failure check. The default value is 30000. | no | check-period |
Cluster Connection Address | Each cluster connection only applies to messages sent to an address that starts with this value. | yes | cluster-connection-address |
Confirmation Window Size | The 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 Ttl | The 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 Ref | The confirmation-window-size to use for the connection used to forward messages to a target node. | yes | connector-ref |
Discovery Group Name | The 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 Consumers | Whether 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 Hops | The 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 Interval | The maximum interval of time used to retry connections. The default value is 2000. | no | max-retry-interval |
Min Large Message Size | The 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 Attempts | The 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 Interval | The 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 Multiplier | A 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 Connectors | The 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 Detection | Whether 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
3.4.2.5.10.1.18. EAP7 - Broadcast Group (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Broadcast Period | The period in milliseconds between consecutive broadcasts. The default value is 2000. | no | broadcast-period |
Connectors | Specifies the names of connectors that will be broadcast. | no | connectors |
Socket Binding | The broadcast group socket binding. | yes | socket-binding |
Note
3.4.2.5.10.1.19. EAP7 - Path (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Path | The 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 To | The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute. The standard paths provided by the system include:
| no | relative-to |
Path Type | Path Type | yes | __name |
Note
3.4.2.5.10.1.20. EAP7 - Bridge (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Check Period | The period (in milliseconds) between client failure check. The default value is 30000. | no | check-period |
Confirmation Window Size | The 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 Ttl | The 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 Name | The 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 Shutdown | Whether 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 |
Filter | An 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 Address | The 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 |
Ha | Whether 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 Interval | The maximum interval of time used to retry connections. The default value is 2000. | no | max-retry-interval |
Min Large Message Size | The 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 |
Password | The 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 Name | The unique name of the local queue that the bridge consumes from. | yes | queue-name |
Reconnect Attempts | The 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 Interval | The 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 Multiplier | A 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 Connectors | A 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 Name | The name of a user-defined class which implements the org.apache.activemq.artemis.core.server.cluster.Transformer interface. | no | transformer-class-name |
Use Duplicate Detection | Whether the bridge will automatically insert a duplicate id property into each message that it forwards. The default value is true. | no | use-duplicate-detection |
User | The 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
3.4.2.5.10.1.21. EAP7 - Discovery Group (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Initial Wait Timeout | Period, 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 Timeout | Period 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 Binding | The discovery group socket binding. | yes | socket-binding |
Note
3.4.2.5.10.1.22. EAP7 - Connector Service (Profile) Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Factory Class | Class name of the factory class that can instantiate the connector service. | yes | factory-class |
Note
3.4.2.5.10.1.22.1. EAP7 - Param Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The parameter value | yes | value |
Note
3.4.2.5.11. EAP7 - IIOP-OpenJDK Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Add Component Via Interceptor | Indicates 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 Method | The authentication method. Valid values are 'none' and 'username_password'. The default value is username_password. | no | auth-method |
Caller Propagation | Indicates 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 Requires | Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | client-requires |
Client Supports | Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | client-supports |
Confidentiality | Indicates whether the transport must require confidentiality protection or not. Valid values are 'none', 'supported' and 'required'. The default value is none. | no | confidentiality |
Detect Misordering | Indicates 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 Replay | Indicates 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 Corbaloc | Indicates 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 Version | The GIOP version to be used. The default value is 1.2. | no | giop-version |
High Water Mark:expr | TCP 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 |
Integrity | Indicates 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:expr | TCP 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 Id | Persistent 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 |
Properties | A list of generic key/value properties. | no | properties |
Realm | The authentication service (AS) realm name. | no | realm |
Required | Indicates if authentication is required (true) or not (false). The default value is false. | no | required |
Root Context | The naming service root context. The default value is JBoss/Naming/root. | no | root-context |
Security | Indicates whether the security interceptors are to be installed (on) or not (off). The default value is none. | no | security |
Security Domain | The name of the security domain that holds the key and trust stores that will be used to establish SSL connections. | no | security-domain |
Server Requires | Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | server-requires |
Server Supports | Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | server-supports |
Socket Binding | The name of the socket binding configuration that specifies the ORB port. The default value is iiop. | no | socket-binding |
Ssl Socket Binding | The name of the socket binding configuration that specifies the ORB SSL port. The default value is iiop-ssl. | no | ssl-socket-binding |
Support Ssl | Indicates whether SSL is to be supported (on) or not (off). The default value is false. | no | support-ssl |
Transactions | Indicates 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 Client | Indicates 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 Target | Indicates 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
Operations
Package Types
3.4.2.5.12. EAP7 - Datasources (Profile) Service
Overview
Description: | Datasources subsystem for profile. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.5.12.1. EAP7 - DataSource (Profile) Service
Description: | A non-XA data source |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Connection Property | no | *1 | |
Connection Url | The JDBC driver connection URL | yes | connection-url |
Driver Name | Name of the (existing) JDBC driver to use | yes | driver-name |
Driver Class | The fully qualified name of the JDBC driver class | no | driver-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver | Defines 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 Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Jta | Enable JTA integration | no | jta |
Max Pool Size | The 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 Size | The 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 Prefill | Whether 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 Min | Define if the min-pool-size should be considered a strictly. Existing value cannot be unset. | no | pool-use-strict-min |
Security Domain | Indicates 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 Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Allow Multiple Users | Specifies if multiple users will access the datasource through the getConnection(user, password) method and hence if the internal pool type should account for that | no | allow-multiple-users |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | Indicates the time in milliseconds to wait between retrying to allocate a connection. | no | allocation-retry-wait-millis |
Blocking Timeout Wait Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Note
Name | Description |
---|---|
Enable | Enables the data-source. Note this operation will not be supported runtime in next versions. |
Disable | Disables the data-source. Note this operation will not be supported runtime in next versions. |
3.4.2.5.12.2. EAP7 - XADataSource (Profile) Service
Description: | An XA data source |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Properties | yes | *2 | |
Xa Datasource Class | The fully qualified name of the javax.sql.XADataSource implementation | yes | xa-datasource-class |
Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
Driver Name | Defines the JDBC driver the datasource should use. It is a symbolic name matching the the name of installed driver. In case the driver is deployed as jar, the name is the name of deployment unit | yes | driver-name |
User Name | Specify the username used when creating a new connection. | no | user-name |
Password | Specify the password used when creating a new connection. | no | password |
New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
Url Delimiter | Specifies the delimiter for URLs in connection-url for HA datasources | no | url-delimiter |
Url Selector Strategy Class Name | A class that implements org.jboss.jca.adapters.jdbc.URLSelectorStrategy | no | url-selector-strategy-class-name |
Use Java Context | Setting this to false will bind the DataSource into global JNDI; | no | use-java-context |
Enabled | Specifies if the datasource should be enabled. Note this attribute will not be supported runtime in next versions. | no | enabled |
Max Pool Size | The 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 Size | The 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 Prefill | Whether 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 Min | Define if the min-pool-size should be considered a strictly. Existing value cannot be unset. | no | pool-use-strict-min |
Interleaving | An element to enable interleaving for XA connection factories | no | interleaving |
No Tx Separate Pool | Oracle does not like XA connections getting used both inside and outside a JTA transaction. To workaround the problem you can create separate sub-pools for the different context | no | no-tx-separate-pool |
Pad Xid | Should the Xid be padded | no | pad-xid |
Same Rm Override | The is-same-rm-override element allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false | no | same-rm-override |
Wrap Xa Datasource | Should the XAResource instances be wrapped in a org.jboss.tm.XAResourceWrapper instance | no | wrap-xa-datasource |
Security Domain | Indicates 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 Name | recovery plugin implementation provided for specific purpose (i.e vendor) | no | recovery-plugin-class-name |
Reauth Plugin Class Name | re-authentication plugin implementation provided for specific purpose (i.e vendor) | no | reauth-plugin-class-name |
Flush Strategy | Specifies how the pool should be flush in case of an error. | no | flush-strategy |
Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
Share Prepared Statements | Whether 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 Statements | Whether 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 Retry | The 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 Millis | he 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 Millis | The 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 Minutes | The 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 Timeout | Any configured query timeout in seconds The default is no timeout | no | query-timeout |
Use Try Lock | Any configured timeout for internal locks on the resource adapter objects in seconds | no | use-try-lock |
Set Tx Query Timeout | Whether to set the query timeout based on the time remaining until transaction timeout, any configured query timeout will be used if there is no transaction. | no | set-tx-query-timeout |
Transaction Isolation | Set 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 Sql | Specify 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 Name | An 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 Name | An 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 Name | An 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 Millis | The 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 Validation | An 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 Fail | Whether 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 Match | The 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 Timeout | Passed to XAResource.setTransactionTimeout() Default is zero which does not invoke the setter. In seconds | no | xa-resource-timeout |
Spy | whatever spy or not the jdbc connection | no | spy |
Use Ccm | Enable the use of a cached connection manager | no | use-ccm |
Recovery Username | username used to try connection recovery | no | recovery-username |
Recovery Password | password used to try connection recovery | no | recovery-password |
Recovery Security Domain | security-domain used to try connection recovery | no | recovery-security-domain |
No Recovery | if true no recovery are tried for this connection pool | no | no-recovery |
Note
Name | Description |
---|---|
Enable | Enables the data-source. Note this operation will not be supported runtime in next versions. |
Disable | Disables the data-source. Note this operation will not be supported runtime in next versions. |
3.4.2.5.13. EAP7 - Logging Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Handlers | The Handlers associated with this Logger. | yes | handlers |
Note
Operations
Package Types
3.4.2.5.13.1. EAP7 - Async Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Overflow Action | Specify what action to take when the overflowing. The valid options are 'block' and 'discard'. The default value is BLOCK. | yes | overflow-action |
Queue Length | The queue length to use before flushing writing | yes | queue-length |
Subhandlers | The Handlers associated with this async handler. | no | subhandlers |
Note
Name | Description |
---|---|
Assign Subhandler | Assign a subhandler to the ASYNC handler. |
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
Unassign Subhandler | Unassign a subhandler from the ASYNC handler. |
3.4.2.5.13.2. EAP7 - Console Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Target | Defines 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
Name | Description |
---|---|
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
3.4.2.5.13.3. EAP7 - Custom Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | The logging handler class to be used. | yes | class |
Encoding | The character encoding used by this Handler. | no | encoding |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Module | The module that the logging handler depends on. | yes | module |
Properties | yes | properties |
Note
Name | Description |
---|---|
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
3.4.2.5.13.4. EAP7 - File Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Append | Specify whether to append to the target file. The default value is true. | no | append |
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
File | The file description consisting of the path and optional relative to path. | no | file |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Note
Name | Description |
---|---|
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
3.4.2.5.13.5. EAP7 - Logger Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Handlers | The Handlers associated with this Logger. | no | handlers |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Use Parent Handlers | Specifies whether or not this logger should send its output to it's parent Logger. The default value is true. | no | use-parent-handlers |
Note
Name | Description |
---|---|
Change Log Level | Change the logging level for a logger category. |
3.4.2.5.13.6. EAP7 - Periodic Rotating File Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Append | Specify whether to append to the target file. The default value is true. | no | append |
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
File | The file description consisting of the path and optional relative to path. | no | file |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Suffix | Set the suffix string. The string is in a format which can be understood by java.text.SimpleDateFormat. The period of the rotation is automatically calculated based on the suffix. | yes | suffix |
Note
Name | Description |
---|---|
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
3.4.2.5.13.7. EAP7 - Size Rotating File Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Append | Specify whether to append to the target file. The default value is true. | no | append |
Autoflush | Automatically flush after each write. The default value is true. | no | autoflush |
Encoding | The character encoding used by this Handler. | no | encoding |
File | The file description consisting of the path and optional relative to path. | no | file |
Formatter | Defines a formatter. The default value is %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n. | no | formatter |
Level | The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded. | no | level |
Max Backup Index | The maximum number of backups to keep. The default value is 1. | yes | max-backup-index |
Rotate Size | The size at which to rotate the log file. The default value is 2m. | yes | rotate-size |
Note
Name | Description |
---|---|
Disable | Disable a logging handler. |
Enable | Enable a logging handler. |
3.4.2.5.14. EAP7 - Webservices Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path | |
Managed Runtime | yes | managedRuntime |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Modify Wsdl Address | Whether the soap address can be modified. | no | modify-wsdl-address |
Wsdl Host | The 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 Port | The 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 Port | The 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
Operations
Package Types
3.4.2.5.14.1. EAP7 - Endpoint Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
3.4.2.5.14.1.1. EAP7 - Post Handler Chain Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
3.4.2.5.14.1.1.1. EAP7 - Post Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | Handler class | yes | class |
Note
3.4.2.5.14.1.2. EAP7 - Pre Handler Chain Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
3.4.2.5.14.1.2.1. EAP7 - Pre Handler Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Class | Handler class | yes | class |
Note
3.4.2.5.14.1.3. EAP7 - Property Service
Description: | A property |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The property value. | no | value |
Note
3.4.2.5.15. EAP7 - Transactions Subsystem (Profile) Service
Overview
Description: | The transactions subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Process Id Uuid | Indicates whether the transaction manager should use a UUID based process id. | no | process-id-uuid |
Socket Binding | Used to reference the correct socket binding to use for the recovery environment. | yes | socket-binding |
Jts | If true this enables the Java Transaction Service. The default value is false. | no | jts |
Object Store Path | Denotes a relative or absolute filesystem path denoting where the transaction manager object store should store data. By default the value is treated as relative to the path denoted by the 'relative-to' attribute. The default value is tx-object-store. | no | object-store-path |
Process Id Socket Binding | The name of the socket binding configuration to use if the transaction manager should use a socket-based process id. Will be 'undefined' if 'process-id-uuid' is 'true'; otherwise must be set. | no | process-id-socket-binding |
Default Timeout | The default timeout. The default value is 300. | no | default-timeout |
Process Id Socket Max Ports | The maximum number of ports to search for an open port if the transaction manager should use a socket-based process id. If the port specified by the socket binding referenced in 'process-id-socket-binding' is occupied, the next higher port will be tried until an open port is found or the number of ports specified by this attribute have been tried. Will be 'undefined' if 'process-id-uuid' is 'true'. The default value is 10. | no | process-id-socket-max-ports |
Recovery Listener | Used to specify if the recovery system should listen on a network socket or not. The default value is false. | no | recovery-listener |
Status Socket Binding | Used to reference the correct socket binding to use for the transaction status manager. | no | status-socket-binding |
Node Identifier | Used to set the node identifier on the core environment. The default value is 1. | no | node-identifier |
Enable Tsm Status | Whether 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 To | References 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 Statistics | Whether statistics should be enabled. The default value is false. | no | enable-statistics |
Note
Operations
Package Types
3.4.2.5.15.1. EAP7 - Log Store (Profile) Service
Description: | Representation of the transaction logging storage mechanism. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Type | Specifies the implementation type of the logging store. | no | type |
Note
Name | Description |
---|---|
Probe | Scan for new transaction logs. This operation will creates a child for each pending transaction. |
3.4.2.5.16. EAP7 - JacORB Service
Overview
Description: | JacORB subsystem configuration |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Add Component Via Interceptor | Indicates 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 Names | Indicates whether POA names should be cached (on) or not (off). The default value is off. | no | cache-poa-names |
Cache Typecodes | Indicates whether typecodes should be cached (on) or not (off). The default value is off. | no | cache-typecodes |
Chunk Custom Rmi Valuetypes | Indicates whether custom RMI valuetypes should be encoded as chunks (on) or not (off). The default value is on. | no | chunk-custom-rmi-valuetypes |
Client Requires | Value that indicates the client SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | client-requires |
Client Supports | Value that indicates the client SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | client-supports |
Client Timeout | The 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 |
Comet | Indicates whether interoperability with Comet's ORB is enabled (on) or not (off). The default value is off. | no | comet |
Export Corbaloc | Indicates 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 Version | The GIOP minor version to be used. The default value is 2. | no | giop-minor-version |
Indirection Encoding Disable | Indicates whether indirection encoding for repeated typecodes should be disabled (on) or not (off). The default value is off. | no | indirection-encoding-disable |
Iona | Indicates whether interoperability with IONA's ASP is enabled (on) or not (off). The default value is off. | no | iona |
Lax Boolean Encoding | Indicates 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 Size | The log2 of maximum size managed by the internal buffer manager. The default value is 24. | no | max-managed-buf-size |
Max Server Connections | The maximum number of connections accepted by the server. The default value is 2147483647. | no | max-server-connections |
Max Threads | The 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 |
Monitoring | Indicates whether the monitoring GUI should be displayed (on) or not (off). The default value is off. | no | monitoring |
Name | The name of the running ORB. The default value is JBoss. | no | name |
Outbuf Cache Timeout | The buffer cache timeout in milliseconds. The default value is -1. | no | outbuf-cache-timeout |
Outbuf Size | The size of the network buffers for outgoing messages. The default value is 2048. | no | outbuf-size |
Pool Size | The 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 Version | Indicates whether the version number should be printed during ORB startup (on) or not (off). The default value is off. | no | print-version |
Properties | A list of generic key/value properties. | no | properties |
Queue Max | The maximum number of requests that can be queued. The default value is 100. | no | queue-max |
Queue Min | The 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 Wait | Indicates 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 |
Retries | The number of retries if connections cannot be promptly established. The default value is 5. | no | retries |
Retry Interval | The interval in milliseconds between retries. The default value is 500. | no | retry-interval |
Root Context | The naming service root context. The default value is JBoss/Naming/root. | no | root-context |
Security | Indicates whether the security interceptors are to be installed (on) or not (off). The default value is off. | no | security |
Security Domain | The name of the security domain that holds the key and trust stores that will be used to establish SSL connections. | no | security-domain |
Server Requires | Value that indicates the server SSL required parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is None. | no | server-requires |
Server Supports | Value that indicates the server SSL supported parameters (None, ServerAuth, ClientAuth, MutualAuth). The default value is MutualAuth. | no | server-supports |
Server Timeout | The 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 Creation | Indicates 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 |
Sun | Indicates whether interoperability with Sun's ORB is enabled (on) or not (off). The default value is on. | no | sun |
Support Ssl | Indicates whether SSL is to be supported (on) or not (off). The default value is off. | no | support-ssl |
Transactions | Indicates 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 Bom | Indicates whether GIOP 1.2 byte order markers should be used (on) or not (off). The default value is off. | no | use-bom |
Use Imr | Indicates whether the implementation repository should be used (on) or not (off). The default value is off. | no | use-imr |
Note
Operations
Package Types
3.4.2.5.17. EAP7 - JAXR Service
Overview
Description: | The configuration of the JAXR subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Class | The JAXR ConnectionFactory implementation class | no | class |
Jndi Name | The JNDI name under which the JAXR ConnectionFactory is bound | no | jndi-name |
Note
Operations
Package Types
3.4.2.5.17.1. EAP7 - Property (JAXR) Service
Description: | A JAXR property. The identity of the resource defines the property name. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Value | The JAXR property value. | yes | value |
Note
3.4.2.5.18. EAP7 - JPA Service
Overview
Description: | The configuration of the JPA subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Datasource | The name of the default global datasource. | no | default-datasource |
Note
Operations
Package Types
3.4.2.5.19. EAP7 - CMP Service
Overview
Description: | The configuration of the cmp subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.5.19.1. EAP7 - HiloKeygenerator Service
Description: | HiLo based key generators. |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Block Size | The block size | no | block-size |
Create Table | Boolean to determine whether to create create the tables | no | create-table |
Create Table Ddl | The DDL used to create the table | no | create-table-ddl |
Data Source | The datasource used for sequence generation | yes | data-source |
Drop Table | Boolean to determine whether to create drop the tables | no | drop-table |
Id Column | The ID column name | yes | id-column |
Select Hi Ddl | The DDL used to select the hi value | no | select-hi-ddl |
Sequence Column | The sequence column name | yes | sequence-column |
Sequence Name | The name of the sequence | yes | sequence-name |
Table Name | The table name | yes | table-name |
Note
3.4.2.5.20. EAP7 - EE Service
Overview
Description: | The configuration of the EE subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Ear Subdeployments Isolated | Flag indicating whether each of the subdeployments within a .ear can access classes belonging to another subdeployment within the same .ear. A value of false means the subdeployments can see classes belonging to other subdeployments within the .ear. The default value is false. | no | ear-subdeployments-isolated |
Global Modules | A list of modules that should be made available to all deployments. | no | global-modules |
Note
Operations
Package Types
3.4.2.5.21. EAP7 - JMX Service
Overview
Description: | The configuration of the JMX subsystem. |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Show Model | Set to 'true' to include MBeans for the model controller resources | no | show-model |
Note
Operations
Package Types
3.4.2.5.21.1. EAP7 - Remoting Connector Service
Description: | The configuration of a resource adapter. |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Use Management Endpoint | If 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
3.4.2.5.22. EAP7 - Infinispan Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.5.22.1. EAP7 - Cache Container Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Cache Manager Status | trait | The status of the cache manager component. May return null if the cache manager is not started. | cache-manager-status |
Cluster Name | trait | The name of the cluster this node belongs to. May return null if the cache manager is not started. | cluster-name |
Coordinator Address | trait | The logical address of the cluster's coordinator. May return null if the cache manager is not started. | coordinator-address |
Is Coordinator | trait | True if this node is the cluster's coordinator. May return null if the cache manager is not started. | is-coordinator |
Local Address | trait | The local address of the node. May return null if the cache manager is not started. | local-address |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Aliases | The list of aliases for this cache container | no | aliases |
Default Cache | The default infinispan cache | no | default-cache |
Jndi Name | The jndi name to which to bind this cache container | no | jndi-name |
Module | The 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 Enabled | If enabled, statistics will be collected for this cache container. | no | statistics-enabled |
Note
3.4.2.5.22.1.1. EAP7 - Cache Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Activations | measurement | The 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 Minute | measurement | The 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 Time | measurement | Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started. | average-read-time |
Average Write Time | measurement | Average time (in ms) for cache writes. May return null if the cache is not started. | average-write-time |
Cache Status | trait | The status of the cache component. May return null if the cache is not started. | cache-status |
Elapsed Time | measurement | Time (in secs) since cache started. May return null if the cache is not started. | elapsed-time |
Hit Ratio | measurement | The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started. | hit-ratio |
Hits | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Hits per Minute | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Invalidations | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Invalidations per Minute | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Misses | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Misses per Minute | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Number Of Entries | measurement | The current number of entries in the cache. May return null if the cache is not started. | number-of-entries |
Passivations | measurement | The 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 Minute | measurement | The 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 Ratio | measurement | The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started. | read-write-ratio |
Remove Hits | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Hits per Minute | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Misses | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Remove Misses per Minute | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Stores | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Stores per Minute | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Time Since Reset | measurement | Time (in secs) since cache statistics were reset. May return null if the cache is not started. | time-since-reset |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Jndi Name | The jndi-name to which to bind this cache instance. | no | jndi-name |
Mode | Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. | yes | mode |
Module | The module whose class loader should be used when building this cache's configuration. | no | module |
Queue Flush Interval | In 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 Size | In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. | no | queue-size |
Remote Timeout | In 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 cache | Type of cache | yes | __type |
Note
3.4.2.5.22.1.2. EAP7 - Distributed Cache Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Activations | measurement | The 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 Minute | measurement | The 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 Time | measurement | Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started. | average-read-time |
Average Write Time | measurement | Average time (in ms) for cache writes. May return null if the cache is not started. | average-write-time |
Cache Status | trait | The status of the cache component. May return null if the cache is not started. | cache-status |
Elapsed Time | measurement | Time (in secs) since cache started. May return null if the cache is not started. | elapsed-time |
Hit Ratio | measurement | The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started. | hit-ratio |
Hits | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Hits per Minute | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Invalidations | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Invalidations per Minute | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Misses | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Misses per Minute | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Number Of Entries | measurement | The current number of entries in the cache. May return null if the cache is not started. | number-of-entries |
Passivations | measurement | The 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 Minute | measurement | The 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 Ratio | measurement | The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started. | read-write-ratio |
Remove Hits | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Hits per Minute | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Misses | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Remove Misses per Minute | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Stores | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Stores per Minute | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Time Since Reset | measurement | Time (in secs) since cache statistics were reset. May return null if the cache is not started. | time-since-reset |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Jndi Name | The jndi-name to which to bind this cache instance. | no | jndi-name |
L 1 Lifespan | Maximum 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 |
Mode | Sets the clustered cache mode, ASYNC for asynchronous operation, or SYNC for synchronous operation. | yes | mode |
Module | The module whose class loader should be used when building this cache's configuration. | no | module |
Owners | Number of cluster-wide replicas for each cache entry. The default value is 2. | no | owners |
Queue Flush Interval | In 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 Size | In ASYNC mode, this attribute can be used to trigger flushing of the queue when it reaches a specific threshold. | no | queue-size |
Remote Timeout | In 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
3.4.2.5.22.1.3. EAP7 - Local Cache Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Type | Description | Internal Name |
---|---|---|---|
Activations | measurement | The 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 Minute | measurement | The 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 Time | measurement | Average time (in ms) for cache reads. Includes hits and misses. May return null if the cache is not started. | average-read-time |
Average Write Time | measurement | Average time (in ms) for cache writes. May return null if the cache is not started. | average-write-time |
Cache Status | trait | The status of the cache component. May return null if the cache is not started. | cache-status |
Elapsed Time | measurement | Time (in secs) since cache started. May return null if the cache is not started. | elapsed-time |
Hit Ratio | measurement | The hit/miss ratio for the cache (hits/hits+misses). May return null if the cache is not started. | hit-ratio |
Hits | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Hits per Minute | measurement | The number of cache attribute hits. May return null if the cache is not started. | hits |
Invalidations | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Invalidations per Minute | measurement | The number of cache invalidations. May return null if the cache is not started. | invalidations |
Misses | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Misses per Minute | measurement | The number of cache attribute misses. May return null if the cache is not started. | misses |
Number Of Entries | measurement | The current number of entries in the cache. May return null if the cache is not started. | number-of-entries |
Passivations | measurement | The 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 Minute | measurement | The 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 Ratio | measurement | The read/write ratio of the cache ((hits+misses)/stores). May return null if the cache is not started. | read-write-ratio |
Remove Hits | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Hits per Minute | measurement | The number of cache attribute remove hits. May return null if the cache is not started. | remove-hits |
Remove Misses | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Remove Misses per Minute | measurement | The number of cache attribute remove misses. May return null if the cache is not started. | remove-misses |
Stores | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Stores per Minute | measurement | The number of cache attribute put operations. May return null if the cache is not started. | stores |
Time Since Reset | measurement | Time (in secs) since cache statistics were reset. May return null if the cache is not started. | time-since-reset |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Jndi Name | The jndi-name to which to bind this cache instance. | no | jndi-name |
Module | The module whose class loader should be used when building this cache's configuration. | no | module |
Note
3.4.2.5.22.1.4. EAP7 - Transport Service
Description: | The description of the transport used by this cache container |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Channel | The channel of this cache container's transport. | no | channel |
Lock Timeout | The timeout for locks for the transport. The default value is 240000. | no | lock-timeout |
Note
3.4.2.5.23. EAP7 - JGroups Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Default Stack | Default stack to use | yes | default-stack |
Note
Operations
Package Types
3.4.2.5.24. EAP7 - Remoting Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Worker Read Threads | The number of read threads to create for the remoting worker. The default value is 1. | no | worker-read-threads |
Worker Task Core Threads | The number of core threads for the remoting worker task thread pool. The default value is 4. | no | worker-task-core-threads |
Worker Task Keepalive | The number of milliseconds to keep non-core remoting worker task threads alive. The default value is 60. | no | worker-task-keepalive |
Worker Task Limit | The maximum number of remoting worker tasks to allow before rejecting. The default value is 16384. | no | worker-task-limit |
Worker Task Max Threads | The maximum number of threads for the remoting worker task thread pool. The default value is 16. | no | worker-task-max-threads |
Worker Write Threads | The number of write threads to create for the remoting worker. The default value is 1. | no | worker-write-threads |
Note
Operations
Package Types
3.4.2.5.25. EAP7 - Mail Service
Overview
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Operations
Package Types
3.4.2.5.25.1. EAP7 - Mail Session Service
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Debug | Enables javamail debugging. The default value is false. | no | debug |
From | From address that is used as default from, if not set when sending | no | from |
Jndi Name | JNDI name to where mail session should be bound | no | jndi-name |
Note
3.4.2.5.25.1.1. EAP7 - SMTP Mail Server Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Outbound Socket Binding Ref | Outbound Socket binding to SMTP server | yes | outbound-socket-binding-ref |
Password | Password to authenticate on server | no | password |
Ssl | Does server requires SSL?. The default value is false. | no | ssl |
Username | Username to authenticate on server | no | username |
Note
3.4.2.5.25.1.2. EAP7 - IMAP Mail Server Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Outbound Socket Binding Ref | Outbound Socket binding to IMAP server | yes | outbound-socket-binding-ref |
Password | Password to authenticate on server | no | password |
Ssl | Does server requires SSL?. The default value is false. | no | ssl |
Username | Username to authenticate on server | no | username |
Note
3.4.2.5.25.1.3. EAP7 - POP3 Mail Server Service
Description: | |
Singleton: | yes |
Plugin: | EAP7 |
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Name | Description | Required | Internal Name |
---|---|---|---|
Outbound Socket Binding Ref | Outbound Socket binding to POP3 server | yes | outbound-socket-binding-ref |
Password | Password to authenticate on server | no | password |
Ssl | Does server requires SSL?. The default value is false. | no | ssl |
Username | Username to authenticate on server | no | username |
Note
3.4.2.6. EAP7 - Network Interface Service
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
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Any Address | Attribute 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 Address | Attribute 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 |
Loopback | Attribute 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 Address | Attribute 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 |
Multicast | Attribute 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 |
Nic | Attribute 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 Match | Attribute 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 Point | Attribute 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 Address | Attribute 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 Address | Attribute 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 Match | Attribute 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 |
Up | Attribute 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 |
Virtual | Attribute 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 Address | Attribute 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
Operations
Package Types
3.4.2.7. EAP7 - SocketBindingGroup Service
Overview
Description: | |
Singleton: | no |
Plugin: | EAP7 |
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Path | yes | path |
Note
Metrics
Configuration Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Bindings | yes | * | |
Bindings | yes | *1 | |
Bindings | yes | *2 | |
Default Interface | Default Interface for these bindings. See Network Interfaces for its definition | yes | default-interface |
Port Offset | Offset from standard ports for this group. This is only available in standalone mode | no | port-offset |
Note
Operations
Package Types
3.4.3. EAP7 - Wildfly 10/EAP 7 Patch Handler Service
Overview
Description: | Handles installation of patches of Wildfly or JBoss EAP application servers and their variants |
Singleton: | yes |
Plugin: | EAP7 |