-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat JBoss Operations Network
Complete Resource Reference for Metrics, Operations, and Configuration Properties
JBoss Operations Network 3.1.2
a complete reference for monitoring metrics, operations, and configuration options
Edition 3.1.2
JBoss Operations Network Engineering Team
Copyright © 2012 Red Hat, Inc.
January 23, 2013
Abstract
This is a reference for all monitoring checks available for the default resources handled in JBoss Operations Network 3.1.2, as well as available resource operations.
Preface
1. Document History
| Revision History | ||||
|---|---|---|---|---|
| Revision 3.1.2-1.400 | 2013-10-31 | Rüdiger Landmann | ||
| ||||
| Revision 3.1.2-1 | January 23, 2013 | Ella Deon Lackey | ||
| ||||
| Revision 3.1-1 | June 19, 2012 | Ella Deon Lackey | ||
| ||||
| Revision 3.1-0 | June 12, 2012 | Ella Deon Lackey | ||
| ||||
Chapter 1. Managed Platforms
JBoss Operations Network 3.1.2 supports several major types of platforms and operating systems, including Java, Linux, Unix distributions, and Windows. Platform support is implemented through a single agent resource plug-in that defines the individual configuration, metrics, and operations for all supported platform types.
1.1. Platforms - AIX Platform
Overview
Table 1.1. Overview
| Description: | IBM AIX Operating System |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
Connection Properties
none
Metrics
Table 1.2. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.3. Metrics
| Name | Description |
|---|---|
| Manual Autodiscovery | Run an immediate discovery to search for resources |
| View Process List | View running processes on this system |
Package Types
none
1.1.1. Platforms - Network Adapter Service
Overview
Table 1.4. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.5. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Inet4Address | trait | IP address of the network adapter | Trait.net4.address |
| Interface Flags | trait | Flag constants for network related operations | Trait.interfaceFlags |
| Bytes Received | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Bytes Received per Minute | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Packets Received | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Packets Received per Minute | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Bytes Transmitted | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Bytes Transmitted per Minute | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Packets Transmitted | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Packets Transmitted per Minute | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Receive Errors | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Errors per Minute | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Packets Dropped | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Packets Dropped per Minute | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Overrurns | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Overrurns per Minute | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Frame | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Receive Frame per Minute | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Transmit Errors | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Errors per Minute | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Packets Dropped | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Packets Dropped per Minute | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Overruns | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Overruns per Minute | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Collisions | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Collisions per Minute | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Carrier | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
| Transmit Carrier per Minute | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.1.2. Platforms - File System Service
Overview
Table 1.6. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.7. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Space | measurement | The total free bytes on filesystem | fileSystemUsage.free |
| Used Percentage | measurement | The percentage of disk used | fileSystemUsage.usePercent |
| Capacity | trait | The total size of the filesystem | fileSystemUsage.total |
| Volume Type | trait | The filesystem's generic type name | fileSystem.typeName |
| Drive Type | trait | The filesystem's operating system-specific type name | fileSystem.sysTypeName |
| name | trait | The name of this device | fileSystem.devName |
| Free Files | measurement | The number of free file nodes on the filesystem | fileSystemUsage.freeFiles |
| Flags | trait | The filesystem's flags | fileSystem.flags |
| Used | measurement | The total bytes used on the filesystem | fileSystemUsage.used |
| Disk Reads | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Reads per Minute | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Writes | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Writes per Minute | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Read Bytes | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Read Bytes per Minute | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Write Bytes | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Write Bytes per Minute | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Queue | measurement | The number of I/Os currently in progress | fileSystemUsage.diskQueue |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.1.3. Platforms - CPU Service
Overview
Table 1.8. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.9. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Idle | measurement | Idle percentage of this CPU | CpuPerc.idle |
| System Load | measurement | Percentage of this CPU running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of this CPU running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of this CPU waiting on I/O | CpuPerc.wait |
| User Time | measurement | The total system CPU user time | Cpu.user |
| User Time per Minute | measurement | The total system CPU user time | Cpu.user |
| Nice Time | measurement | The total system CPU nice time | Cpu.nice |
| Nice Time per Minute | measurement | The total system CPU nice time | Cpu.nice |
| System Time | measurement | The total system CPU kernel time | Cpu.sys |
| System Time per Minute | measurement | The total system CPU kernel time | Cpu.sys |
| Idle Time | measurement | The total system CPU idle time | Cpu.idle |
| Idle Time per Minute | measurement | The total system CPU idle time | Cpu.idle |
| Wait Time | measurement | The total system CPU I/O wait time | Cpu.wait |
| Wait Time per Minute | measurement | The total system CPU I/O wait time | Cpu.wait |
| Vendor | trait | Vendor of this CPU | CpuTrait.vendor |
| CPU Model | trait | Model of this CPU | CpuTrait.model |
| CPU Speed | trait | Speed of this CPU in Mhz | CpuTrait.mhz |
| Cache size | trait | Cache Size of this CPU | CpuTrait.cacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.1.4. Platforms - Process Service
Overview
Table 1.10. Overview
| Description: | A generic process monitoring service to track native process information based on a pid file or process query |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
Table 1.11.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |
| Piql | Process Information Query Language for process to monitor | no | piql |
| Full Process Tree | If true, the entire process tree will be monitored | yes | fullProcessTree |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.12. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all processes | Process.cpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all processes | Process.memory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all processes | Process.memory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all processes | Process.fileDescriptor.total |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.2. Platforms - FreeBSD Platform
Overview
Table 1.13. Overview
| Description: | FreeBSD Operating System |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
Connection Properties
none
Metrics
Table 1.14. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.15. Metrics
| Name | Description |
|---|---|
| Manual Autodiscovery | Run an immediate discovery to search for resources |
| View Process List | View running processes on this system |
Package Types
none
1.2.1. Platforms - Network Adapter Service
Overview
Table 1.16. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.17. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Inet4Address | trait | IP address of the network adapter | Trait.net4.address |
| Interface Flags | trait | Flag constants for network related operations | Trait.interfaceFlags |
| Bytes Received | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Bytes Received per Minute | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Packets Received | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Packets Received per Minute | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Bytes Transmitted | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Bytes Transmitted per Minute | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Packets Transmitted | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Packets Transmitted per Minute | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Receive Errors | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Errors per Minute | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Packets Dropped | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Packets Dropped per Minute | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Overrurns | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Overrurns per Minute | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Frame | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Receive Frame per Minute | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Transmit Errors | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Errors per Minute | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Packets Dropped | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Packets Dropped per Minute | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Overruns | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Overruns per Minute | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Collisions | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Collisions per Minute | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Carrier | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
| Transmit Carrier per Minute | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.2.2. Platforms - File System Service
Overview
Table 1.18. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.19. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Space | measurement | The total free bytes on filesystem | fileSystemUsage.free |
| Used Percentage | measurement | The percentage of disk used | fileSystemUsage.usePercent |
| Capacity | trait | The total size of the filesystem | fileSystemUsage.total |
| Volume Type | trait | The filesystem's generic type name | fileSystem.typeName |
| Drive Type | trait | The filesystem's operating system-specific type name | fileSystem.sysTypeName |
| name | trait | The name of this device | fileSystem.devName |
| Free Files | measurement | The number of free file nodes on the filesystem | fileSystemUsage.freeFiles |
| Flags | trait | The filesystem's flags | fileSystem.flags |
| Used | measurement | The total bytes used on the filesystem | fileSystemUsage.used |
| Disk Reads | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Reads per Minute | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Writes | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Writes per Minute | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Read Bytes | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Read Bytes per Minute | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Write Bytes | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Write Bytes per Minute | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Queue | measurement | The number of I/Os currently in progress | fileSystemUsage.diskQueue |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.2.3. Platforms - CPU Service
Overview
Table 1.20. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.21. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Idle | measurement | Idle percentage of this CPU | CpuPerc.idle |
| System Load | measurement | Percentage of this CPU running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of this CPU running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of this CPU waiting on I/O | CpuPerc.wait |
| User Time | measurement | The total system CPU user time | Cpu.user |
| User Time per Minute | measurement | The total system CPU user time | Cpu.user |
| Nice Time | measurement | The total system CPU nice time | Cpu.nice |
| Nice Time per Minute | measurement | The total system CPU nice time | Cpu.nice |
| System Time | measurement | The total system CPU kernel time | Cpu.sys |
| System Time per Minute | measurement | The total system CPU kernel time | Cpu.sys |
| Idle Time | measurement | The total system CPU idle time | Cpu.idle |
| Idle Time per Minute | measurement | The total system CPU idle time | Cpu.idle |
| Wait Time | measurement | The total system CPU I/O wait time | Cpu.wait |
| Wait Time per Minute | measurement | The total system CPU I/O wait time | Cpu.wait |
| Vendor | trait | Vendor of this CPU | CpuTrait.vendor |
| CPU Model | trait | Model of this CPU | CpuTrait.model |
| CPU Speed | trait | Speed of this CPU in Mhz | CpuTrait.mhz |
| Cache size | trait | Cache Size of this CPU | CpuTrait.cacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.2.4. Platforms - Process Service
Overview
Table 1.22. Overview
| Description: | A generic process monitoring service to track native process information based on a pid file or process query |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
Table 1.23.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |
| Piql | Process Information Query Language for process to monitor | no | piql |
| Full Process Tree | If true, the entire process tree will be monitored | yes | fullProcessTree |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.24. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all processes | Process.cpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all processes | Process.memory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all processes | Process.memory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all processes | Process.fileDescriptor.total |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.3. Platforms - HP-UX Platform
Overview
Table 1.25. Overview
| Description: | Hewlett-Packard HP-UX Operating System |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
Connection Properties
none
Metrics
Table 1.26. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.27. Metrics
| Name | Description |
|---|---|
| Manual Autodiscovery | Run an immediate discovery to search for resources |
| View Process List | View running processes on this system |
Package Types
none
1.3.1. Platforms - Network Adapter Service
Overview
Table 1.28. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.29. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Inet4Address | trait | IP address of the network adapter | Trait.net4.address |
| Interface Flags | trait | Flag constants for network related operations | Trait.interfaceFlags |
| Bytes Received | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Bytes Received per Minute | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Packets Received | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Packets Received per Minute | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Bytes Transmitted | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Bytes Transmitted per Minute | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Packets Transmitted | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Packets Transmitted per Minute | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Receive Errors | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Errors per Minute | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Packets Dropped | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Packets Dropped per Minute | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Overrurns | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Overrurns per Minute | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Frame | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Receive Frame per Minute | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Transmit Errors | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Errors per Minute | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Packets Dropped | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Packets Dropped per Minute | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Overruns | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Overruns per Minute | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Collisions | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Collisions per Minute | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Carrier | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
| Transmit Carrier per Minute | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.3.2. Platforms - File System Service
Overview
Table 1.30. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.31. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Space | measurement | The total free bytes on filesystem | fileSystemUsage.free |
| Used Percentage | measurement | The percentage of disk used | fileSystemUsage.usePercent |
| Capacity | trait | The total size of the filesystem | fileSystemUsage.total |
| Volume Type | trait | The filesystem's generic type name | fileSystem.typeName |
| Drive Type | trait | The filesystem's operating system-specific type name | fileSystem.sysTypeName |
| name | trait | The name of this device | fileSystem.devName |
| Free Files | measurement | The number of free file nodes on the filesystem | fileSystemUsage.freeFiles |
| Flags | trait | The filesystem's flags | fileSystem.flags |
| Used | measurement | The total bytes used on the filesystem | fileSystemUsage.used |
| Disk Reads | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Reads per Minute | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Writes | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Writes per Minute | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Read Bytes | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Read Bytes per Minute | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Write Bytes | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Write Bytes per Minute | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Queue | measurement | The number of I/Os currently in progress | fileSystemUsage.diskQueue |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.3.3. Platforms - CPU Service
Overview
Table 1.32. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.33. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Idle | measurement | Idle percentage of this CPU | CpuPerc.idle |
| System Load | measurement | Percentage of this CPU running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of this CPU running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of this CPU waiting on I/O | CpuPerc.wait |
| User Time | measurement | The total system CPU user time | Cpu.user |
| User Time per Minute | measurement | The total system CPU user time | Cpu.user |
| Nice Time | measurement | The total system CPU nice time | Cpu.nice |
| Nice Time per Minute | measurement | The total system CPU nice time | Cpu.nice |
| System Time | measurement | The total system CPU kernel time | Cpu.sys |
| System Time per Minute | measurement | The total system CPU kernel time | Cpu.sys |
| Idle Time | measurement | The total system CPU idle time | Cpu.idle |
| Idle Time per Minute | measurement | The total system CPU idle time | Cpu.idle |
| Wait Time | measurement | The total system CPU I/O wait time | Cpu.wait |
| Wait Time per Minute | measurement | The total system CPU I/O wait time | Cpu.wait |
| Vendor | trait | Vendor of this CPU | CpuTrait.vendor |
| CPU Model | trait | Model of this CPU | CpuTrait.model |
| CPU Speed | trait | Speed of this CPU in Mhz | CpuTrait.mhz |
| Cache size | trait | Cache Size of this CPU | CpuTrait.cacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.3.4. Platforms - Process Service
Overview
Table 1.34. Overview
| Description: | A generic process monitoring service to track native process information based on a pid file or process query |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
Table 1.35.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |
| Piql | Process Information Query Language for process to monitor | no | piql |
| Full Process Tree | If true, the entire process tree will be monitored | yes | fullProcessTree |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.36. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all processes | Process.cpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all processes | Process.memory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all processes | Process.memory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all processes | Process.fileDescriptor.total |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.4. Platforms - Java Platform
Overview
Table 1.37. Overview
| Description: | Platform with 100% Java capability but not natively supported |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.38. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.39. Metrics
| Name | Description |
|---|---|
| Manual Autodiscovery | Run an immediate discovery to search for resources |
| View Process List | View running processes on this system |
Package Types
none
1.5. Platforms - Linux Platform
Overview
Table 1.40. Overview
| Description: | Linux Operating System |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
Connection Properties
Table 1.41.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Enable Content Discovery | If true, attempts will be made to discover installed packages on this platform | yes | enableContentDiscovery |
| Enable Internal Yum Server | If true, an internal yum server will be started in order to process yum content requests made on the local machine. | yes | enableInternalYumServer |
| Yum server port | The port the plugin will listen on in order to process yum requests. This is ignored if the internal yum server is not enabled. | yes | yumPort |
| Metadata Cache Timeout | The time, in seconds, that the package metadata will always be considered valid. After the cache has lived this long or longer, the cache will be checked to see if it is stale, and if so, will be refreshed. | no | metadataCacheTimeout |
| Logs | yes | logs |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.42. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
| Distribution Name | trait | name of the Linux distribution | distro.name |
| Distribution Version | trait | version of the Linux distribution | distro.version |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.43. Metrics
| Name | Description |
|---|---|
| Manual Autodiscovery | Run an immediate discovery to search for resources |
| View Process List | View running processes on this system |
| Clean Yum Metadata Cache | Deletes all cached package metadata |
Package Types
Table 1.44. Package Types
| Name | Category | Description |
|---|---|---|
| RPM File | Deployable | Red Hat installable package |
1.5.1. Platforms - Network Adapter Service
Overview
Table 1.45. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.46. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Inet4Address | trait | IP address of the network adapter | Trait.net4.address |
| Interface Flags | trait | Flag constants for network related operations | Trait.interfaceFlags |
| Bytes Received | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Bytes Received per Minute | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Packets Received | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Packets Received per Minute | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Bytes Transmitted | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Bytes Transmitted per Minute | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Packets Transmitted | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Packets Transmitted per Minute | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Receive Errors | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Errors per Minute | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Packets Dropped | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Packets Dropped per Minute | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Overrurns | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Overrurns per Minute | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Frame | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Receive Frame per Minute | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Transmit Errors | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Errors per Minute | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Packets Dropped | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Packets Dropped per Minute | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Overruns | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Overruns per Minute | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Collisions | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Collisions per Minute | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Carrier | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
| Transmit Carrier per Minute | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.5.2. Platforms - File System Service
Overview
Table 1.47. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.48. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Space | measurement | The total free bytes on filesystem | fileSystemUsage.free |
| Used Percentage | measurement | The percentage of disk used | fileSystemUsage.usePercent |
| Capacity | trait | The total size of the filesystem | fileSystemUsage.total |
| Volume Type | trait | The filesystem's generic type name | fileSystem.typeName |
| Drive Type | trait | The filesystem's operating system-specific type name | fileSystem.sysTypeName |
| name | trait | The name of this device | fileSystem.devName |
| Free Files | measurement | The number of free file nodes on the filesystem | fileSystemUsage.freeFiles |
| Flags | trait | The filesystem's flags | fileSystem.flags |
| Used | measurement | The total bytes used on the filesystem | fileSystemUsage.used |
| Disk Reads | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Reads per Minute | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Writes | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Writes per Minute | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Read Bytes | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Read Bytes per Minute | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Write Bytes | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Write Bytes per Minute | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Queue | measurement | The number of I/Os currently in progress | fileSystemUsage.diskQueue |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.5.3. Platforms - CPU Service
Overview
Table 1.49. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.50. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Idle | measurement | Idle percentage of this CPU | CpuPerc.idle |
| System Load | measurement | Percentage of this CPU running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of this CPU running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of this CPU waiting on I/O | CpuPerc.wait |
| User Time | measurement | The total system CPU user time | Cpu.user |
| User Time per Minute | measurement | The total system CPU user time | Cpu.user |
| Nice Time | measurement | The total system CPU nice time | Cpu.nice |
| Nice Time per Minute | measurement | The total system CPU nice time | Cpu.nice |
| System Time | measurement | The total system CPU kernel time | Cpu.sys |
| System Time per Minute | measurement | The total system CPU kernel time | Cpu.sys |
| Idle Time | measurement | The total system CPU idle time | Cpu.idle |
| Idle Time per Minute | measurement | The total system CPU idle time | Cpu.idle |
| Wait Time | measurement | The total system CPU I/O wait time | Cpu.wait |
| Wait Time per Minute | measurement | The total system CPU I/O wait time | Cpu.wait |
| Vendor | trait | Vendor of this CPU | CpuTrait.vendor |
| CPU Model | trait | Model of this CPU | CpuTrait.model |
| CPU Speed | trait | Speed of this CPU in Mhz | CpuTrait.mhz |
| Cache size | trait | Cache Size of this CPU | CpuTrait.cacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.5.4. Platforms - Process Service
Overview
Table 1.51. Overview
| Description: | A generic process monitoring service to track native process information based on a pid file or process query |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
Table 1.52.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |
| Piql | Process Information Query Language for process to monitor | no | piql |
| Full Process Tree | If true, the entire process tree will be monitored | yes | fullProcessTree |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.53. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all processes | Process.cpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all processes | Process.memory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all processes | Process.memory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all processes | Process.fileDescriptor.total |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.6. Platforms - Mac OS X Platform
Overview
Table 1.54. Overview
| Description: | Mac OS X Operating System |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
Connection Properties
Table 1.55.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Logs | yes | logs |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.56. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.57. Metrics
| Name | Description |
|---|---|
| Manual Autodiscovery | Run an immediate discovery to search for resources |
| View Process List | View running processes on this system |
Package Types
none
1.6.1. Platforms - Network Adapter Service
Overview
Table 1.58. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.59. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Inet4Address | trait | IP address of the network adapter | Trait.net4.address |
| Interface Flags | trait | Flag constants for network related operations | Trait.interfaceFlags |
| Bytes Received | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Bytes Received per Minute | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Packets Received | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Packets Received per Minute | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Bytes Transmitted | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Bytes Transmitted per Minute | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Packets Transmitted | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Packets Transmitted per Minute | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Receive Errors | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Errors per Minute | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Packets Dropped | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Packets Dropped per Minute | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Overrurns | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Overrurns per Minute | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Frame | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Receive Frame per Minute | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Transmit Errors | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Errors per Minute | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Packets Dropped | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Packets Dropped per Minute | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Overruns | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Overruns per Minute | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Collisions | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Collisions per Minute | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Carrier | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
| Transmit Carrier per Minute | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.6.2. Platforms - File System Service
Overview
Table 1.60. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.61. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Space | measurement | The total free bytes on filesystem | fileSystemUsage.free |
| Used Percentage | measurement | The percentage of disk used | fileSystemUsage.usePercent |
| Capacity | trait | The total size of the filesystem | fileSystemUsage.total |
| Volume Type | trait | The filesystem's generic type name | fileSystem.typeName |
| Drive Type | trait | The filesystem's operating system-specific type name | fileSystem.sysTypeName |
| name | trait | The name of this device | fileSystem.devName |
| Free Files | measurement | The number of free file nodes on the filesystem | fileSystemUsage.freeFiles |
| Flags | trait | The filesystem's flags | fileSystem.flags |
| Used | measurement | The total bytes used on the filesystem | fileSystemUsage.used |
| Disk Reads | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Reads per Minute | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Writes | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Writes per Minute | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Read Bytes | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Read Bytes per Minute | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Write Bytes | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Write Bytes per Minute | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Queue | measurement | The number of I/Os currently in progress | fileSystemUsage.diskQueue |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.6.3. Platforms - CPU Service
Overview
Table 1.62. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.63. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Idle | measurement | Idle percentage of this CPU | CpuPerc.idle |
| System Load | measurement | Percentage of this CPU running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of this CPU running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of this CPU waiting on I/O | CpuPerc.wait |
| User Time | measurement | The total system CPU user time | Cpu.user |
| User Time per Minute | measurement | The total system CPU user time | Cpu.user |
| Nice Time | measurement | The total system CPU nice time | Cpu.nice |
| Nice Time per Minute | measurement | The total system CPU nice time | Cpu.nice |
| System Time | measurement | The total system CPU kernel time | Cpu.sys |
| System Time per Minute | measurement | The total system CPU kernel time | Cpu.sys |
| Idle Time | measurement | The total system CPU idle time | Cpu.idle |
| Idle Time per Minute | measurement | The total system CPU idle time | Cpu.idle |
| Wait Time | measurement | The total system CPU I/O wait time | Cpu.wait |
| Wait Time per Minute | measurement | The total system CPU I/O wait time | Cpu.wait |
| Vendor | trait | Vendor of this CPU | CpuTrait.vendor |
| CPU Model | trait | Model of this CPU | CpuTrait.model |
| CPU Speed | trait | Speed of this CPU in Mhz | CpuTrait.mhz |
| Cache size | trait | Cache Size of this CPU | CpuTrait.cacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.6.4. Platforms - Process Service
Overview
Table 1.64. Overview
| Description: | A generic process monitoring service to track native process information based on a pid file or process query |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
Table 1.65.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |
| Piql | Process Information Query Language for process to monitor | no | piql |
| Full Process Tree | If true, the entire process tree will be monitored | yes | fullProcessTree |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.66. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all processes | Process.cpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all processes | Process.memory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all processes | Process.memory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all processes | Process.fileDescriptor.total |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.7. Platforms - Solaris Platform
Overview
Table 1.67. Overview
| Description: | SUN Solaris Operating System |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
Connection Properties
Table 1.68.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Logs | yes | logs |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.69. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.70. Metrics
| Name | Description |
|---|---|
| Manual Autodiscovery | Run an immediate discovery to search for resources |
| View Process List | View running processes on this system |
Package Types
none
1.7.1. Platforms - Network Adapter Service
Overview
Table 1.71. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.72. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Inet4Address | trait | IP address of the network adapter | Trait.net4.address |
| Interface Flags | trait | Flag constants for network related operations | Trait.interfaceFlags |
| Bytes Received | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Bytes Received per Minute | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Packets Received | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Packets Received per Minute | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Bytes Transmitted | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Bytes Transmitted per Minute | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Packets Transmitted | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Packets Transmitted per Minute | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Receive Errors | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Errors per Minute | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Packets Dropped | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Packets Dropped per Minute | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Overrurns | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Overrurns per Minute | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Frame | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Receive Frame per Minute | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Transmit Errors | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Errors per Minute | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Packets Dropped | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Packets Dropped per Minute | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Overruns | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Overruns per Minute | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Collisions | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Collisions per Minute | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Carrier | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
| Transmit Carrier per Minute | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.7.2. Platforms - File System Service
Overview
Table 1.73. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.74. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Space | measurement | The total free bytes on filesystem | fileSystemUsage.free |
| Used Percentage | measurement | The percentage of disk used | fileSystemUsage.usePercent |
| Capacity | trait | The total size of the filesystem | fileSystemUsage.total |
| Volume Type | trait | The filesystem's generic type name | fileSystem.typeName |
| Drive Type | trait | The filesystem's operating system-specific type name | fileSystem.sysTypeName |
| name | trait | The name of this device | fileSystem.devName |
| Free Files | measurement | The number of free file nodes on the filesystem | fileSystemUsage.freeFiles |
| Flags | trait | The filesystem's flags | fileSystem.flags |
| Used | measurement | The total bytes used on the filesystem | fileSystemUsage.used |
| Disk Reads | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Reads per Minute | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Writes | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Writes per Minute | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Read Bytes | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Read Bytes per Minute | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Write Bytes | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Write Bytes per Minute | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Queue | measurement | The number of I/Os currently in progress | fileSystemUsage.diskQueue |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.7.3. Platforms - CPU Service
Overview
Table 1.75. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.76. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Idle | measurement | Idle percentage of this CPU | CpuPerc.idle |
| System Load | measurement | Percentage of this CPU running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of this CPU running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of this CPU waiting on I/O | CpuPerc.wait |
| User Time | measurement | The total system CPU user time | Cpu.user |
| User Time per Minute | measurement | The total system CPU user time | Cpu.user |
| Nice Time | measurement | The total system CPU nice time | Cpu.nice |
| Nice Time per Minute | measurement | The total system CPU nice time | Cpu.nice |
| System Time | measurement | The total system CPU kernel time | Cpu.sys |
| System Time per Minute | measurement | The total system CPU kernel time | Cpu.sys |
| Idle Time | measurement | The total system CPU idle time | Cpu.idle |
| Idle Time per Minute | measurement | The total system CPU idle time | Cpu.idle |
| Wait Time | measurement | The total system CPU I/O wait time | Cpu.wait |
| Wait Time per Minute | measurement | The total system CPU I/O wait time | Cpu.wait |
| Vendor | trait | Vendor of this CPU | CpuTrait.vendor |
| CPU Model | trait | Model of this CPU | CpuTrait.model |
| CPU Speed | trait | Speed of this CPU in Mhz | CpuTrait.mhz |
| Cache size | trait | Cache Size of this CPU | CpuTrait.cacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.7.4. Platforms - Process Service
Overview
Table 1.77. Overview
| Description: | A generic process monitoring service to track native process information based on a pid file or process query |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
Table 1.78.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |
| Piql | Process Information Query Language for process to monitor | no | piql |
| Full Process Tree | If true, the entire process tree will be monitored | yes | fullProcessTree |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.79. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all processes | Process.cpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all processes | Process.memory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all processes | Process.memory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all processes | Process.fileDescriptor.total |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.8. Platforms - Windows Platform
Overview
Table 1.80. Overview
| Description: | Microsoft Windows Operating System |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
Connection Properties
Table 1.81.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Enable Content Discovery | If true, attempts will be made to discover installed packages on this platform | yes | enableContentDiscovery |
| Event Tracking Enabled | Enables the collection of Windows events into the event subsystem | yes | eventTrackingEnabled |
| Regular Expression | A regular expression that if not-null must be matched by the event detail for the message to be accepted | no | regularExpression |
| Minimum Severity | The minimum severity event that will be collected | yes | minimumSeverity |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.82. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Memory | measurement | The total free system memory (does not include buffer or cache memory) | Native.MemoryInfo.free |
| Actual Free Memory | measurement | The actual total free system memory (includes unallocated memory as well as available buffer and cache memory) | Native.MemoryInfo.actualFree |
| Used Memory | measurement | The total used system memory (does not include buffer or cache memory) | Native.MemoryInfo.used |
| Actual Used Memory | measurement | The actual total used system memory (includes buffer and cache memory) | Native.MemoryInfo.actualUsed |
| Total Memory | measurement | The total system memory | Native.MemoryInfo.total |
| Free Swap Space | measurement | The total free system swap | Native.SwapInfo.free |
| Used Swap Space | measurement | The total used system swap | Native.SwapInfo.used |
| Total Swap Space | measurement | The total system swap | Native.SwapInfo.total |
| Idle | measurement | Idle percentage of all CPUs | CpuPerc.idle |
| System Load | measurement | Percentage of all CPUs running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of all CPUs running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of all CPUs waiting on I/O | CpuPerc.wait |
| Hostname | trait | Name that this platform is known as | Trait.hostname |
| OS Name | trait | Name that the operating system is known as | Trait.osname |
| OS Version | trait | Version of the operating system | Trait.osversion |
| Architecture | trait | Hardware architecture of the platform | Trait.sysarch |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 1.83. Metrics
| Name | Description |
|---|---|
| Manual Autodiscovery | Run an immediate discovery to search for resources |
| View Process List | View running processes on this system |
Package Types
Table 1.84. Package Types
| Name | Category | Description |
|---|---|---|
| Installed Software | Deployable | Installed Windows Software |
1.8.1. Platforms - Network Adapter Service
Overview
Table 1.85. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.86. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Inet4Address | trait | IP address of the network adapter | Trait.net4.address |
| Interface Flags | trait | Flag constants for network related operations | Trait.interfaceFlags |
| Bytes Received | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Bytes Received per Minute | measurement | The total number of bytes received across this network interface since it started | rxBytes |
| Packets Received | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Packets Received per Minute | measurement | The total number of packets received across this network interface since it started | rxPackets |
| Bytes Transmitted | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Bytes Transmitted per Minute | measurement | The total number of bytes transmitted across this network interface since it started | txBytes |
| Packets Transmitted | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Packets Transmitted per Minute | measurement | The total number of packets transmitted across this network interface since it started | txPackets |
| Receive Errors | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Errors per Minute | measurement | 'errors' statistic for received packets across this network interface since it started | rxErrors |
| Receive Packets Dropped | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Packets Dropped per Minute | measurement | 'dropped' statistic for received packets across this network interface since it started | rxDropped |
| Receive Overrurns | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Overrurns per Minute | measurement | 'overruns' statistic for received packets across this network interface since it started | rxOverruns |
| Receive Frame | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Receive Frame per Minute | measurement | 'frame' statistic for received packets across this network interface since it started | rxFrame |
| Transmit Errors | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Errors per Minute | measurement | 'errors' statistic for transmitted packets across this network interface since it started | txErrors |
| Transmit Packets Dropped | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Packets Dropped per Minute | measurement | 'dropped' statistic for transmitted packets across this network interface since it started | txDropped |
| Transmit Overruns | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Overruns per Minute | measurement | 'overruns' statistic for transmitted packets across this network interface since it started | txOverruns |
| Transmit Collisions | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Collisions per Minute | measurement | 'collisions' statistic for transmitted packets across this network interface since it started | txCollisions |
| Transmit Carrier | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
| Transmit Carrier per Minute | measurement | 'carrier' statistic for transmitted packets across this network interface since it started | txCarrier |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.8.2. Platforms - File System Service
Overview
Table 1.87. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.88. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Space | measurement | The total free bytes on filesystem | fileSystemUsage.free |
| Used Percentage | measurement | The percentage of disk used | fileSystemUsage.usePercent |
| Capacity | trait | The total size of the filesystem | fileSystemUsage.total |
| Volume Type | trait | The filesystem's generic type name | fileSystem.typeName |
| Drive Type | trait | The filesystem's operating system-specific type name | fileSystem.sysTypeName |
| name | trait | The name of this device | fileSystem.devName |
| Free Files | measurement | The number of free file nodes on the filesystem | fileSystemUsage.freeFiles |
| Flags | trait | The filesystem's flags | fileSystem.flags |
| Used | measurement | The total bytes used on the filesystem | fileSystemUsage.used |
| Disk Reads | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Reads per Minute | measurement | The number of physical disk reads | fileSystemUsage.diskReads |
| Disk Writes | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Writes per Minute | measurement | The number of physical disk writes | fileSystemUsage.diskWrites |
| Disk Read Bytes | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Read Bytes per Minute | measurement | The number of physical disk bytes read | fileSystemUsage.diskReadBytes |
| Disk Write Bytes | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Write Bytes per Minute | measurement | The number of physical disk bytes written | fileSystemUsage.diskWriteBytes |
| Disk Queue | measurement | The number of I/Os currently in progress | fileSystemUsage.diskQueue |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.8.3. Platforms - CPU Service
Overview
Table 1.89. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
none
Metrics
Table 1.90. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Idle | measurement | Idle percentage of this CPU | CpuPerc.idle |
| System Load | measurement | Percentage of this CPU running in system mode | CpuPerc.sys |
| User Load | measurement | Percentage of this CPU running in user mode | CpuPerc.user |
| Wait Load | measurement | Percentage of this CPU waiting on I/O | CpuPerc.wait |
| User Time | measurement | The total system CPU user time | Cpu.user |
| User Time per Minute | measurement | The total system CPU user time | Cpu.user |
| Nice Time | measurement | The total system CPU nice time | Cpu.nice |
| Nice Time per Minute | measurement | The total system CPU nice time | Cpu.nice |
| System Time | measurement | The total system CPU kernel time | Cpu.sys |
| System Time per Minute | measurement | The total system CPU kernel time | Cpu.sys |
| Idle Time | measurement | The total system CPU idle time | Cpu.idle |
| Idle Time per Minute | measurement | The total system CPU idle time | Cpu.idle |
| Wait Time | measurement | The total system CPU I/O wait time | Cpu.wait |
| Wait Time per Minute | measurement | The total system CPU I/O wait time | Cpu.wait |
| Vendor | trait | Vendor of this CPU | CpuTrait.vendor |
| CPU Model | trait | Model of this CPU | CpuTrait.model |
| CPU Speed | trait | Speed of this CPU in Mhz | CpuTrait.mhz |
| Cache size | trait | Cache Size of this CPU | CpuTrait.cacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
1.8.4. Platforms - Process Service
Overview
Table 1.91. Overview
| Description: | A generic process monitoring service to track native process information based on a pid file or process query |
| Singleton: | no |
| Plugin: | Platforms |
Child Resource Types
none
Connection Properties
Table 1.92.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Choice of using a pid file or a PIQL query to find the process to monitor | yes | type |
| Pid File | Fully qualified path to the pid file for the process to monitor | no | pidFile |
| Piql | Process Information Query Language for process to monitor | no | piql |
| Full Process Tree | If true, the entire process tree will be monitored | yes | fullProcessTree |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 1.93. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all processes | Process.cpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all processes | Process.cpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all processes | Process.cpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all processes | Process.memory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all processes | Process.memory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all processes | Process.fileDescriptor.total |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
Chapter 2. Core Managed Resources
There are certain server types that are supported by default in JBoss Operations Network, both for JBoss and non-JBoss resource types.
2.1. Apache - HTTP Server
Overview
Table 2.1. Overview
| Description: | an Apache HTTP Server instance |
| Singleton: | no |
| Plugin: | Apache |
Child Resource Types
Autodiscovery Process Scans
Table 2.2. Metrics
| Name | Query |
|---|---|
| HttpdOnUnix | process|basename|match=httpd.*,process|basename|nomatch|parent=httpd.* |
| HttpdOnWindows | process|basename|match=(?i)httpd.exe,process|basename|match|parent=(?i)httpd.exe |
| Apache2OnUnix | process|basename|match=apache2,process|basename|nomatch|parent=apache2 |
| ApacheOnWindows | process|basename|match=(?i)Apache.exe,process|basename|match|parent=(?i)Apache.exe |
Connection Properties
Table 2.3.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Enable augeas support | Enable augeas support | yes | augeasEnabled |
| Augeas Module Name | the name of the Augeas module/lens to use for loading and updating this resource's configuration | yes | augeasModuleName |
| Httpd config file | Location of the Apache main configuration file. | yes | configurationFilesInclusionPatterns |
| Virtual Hosts Configuration Placement | How should the new virtual host definitions be put in the configuration | yes | vhostCreationPolicy |
| Path To Contain Virtual Hosts Files | If the new virtual hosts should be created in standalone files, this mask determines where to create those files. The '*' in the path is replaced by the name of the virtual host. If the path is relative, it is considered relative to server root. | yes | vhostFilesMask |
| Error Log File Path | The absolute path to the error log file - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'logs/error_log' on UNIX or 'logs\error.log' on Windows. | no | errorLogFilePath |
| Error Log Events Enabled | A flag indicating whether or not generation of Events for new error log entries is enabled. | yes | errorLogEventsEnabled |
| Error Log Minimum Severity | The minimum severity of error log entry Events that should be collected. If not specified, there is no minimum severity (i.e. all events will be collected). | no | errorLogMinimumSeverity |
| Error Log Includes Pattern | A regular expression against which an error log entry's detail is matched to determine if an Event should be fired for that entry. If not specified, no filtering of log entries will be done based on their detail. | no | errorLogIncludesPattern |
| Custom Module Names | Apache can use 2 values to identify a module. Either its module name that is used in the LoadModule directive or its source file that can be used in the IfModule directive (as of Apache 2.1 the IfModule directive can but doesn't have to use the module name, too). The plugin contains the mappings of the module names to module files for all the standard apache modules mentioned on the http://httpd.apache.org/docs/current/mod/ plus the SNMP module and mod_jk. If you use any non-standard modules and use their source file in the IfModule directives, you have to add the module-name-to-module-file mapping to this list so that the plugin can determine the correct runtime configuration of the apache instance. | yes | customModuleNames |
| Server Root | the absolute path of the Apache server root directory | yes | serverRoot |
| Executable Path | the path to the Apache executable - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default value is 'bin/httpd' on UNIX or 'bin\Apache.exe' on Windows | no | executablePath |
| Control Script Path | the path to the Apache control script - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'bin/apachectl' on UNIX or the Apache executable on Windows | no | controlScriptPath |
| Config File | the path to the httpd.conf file - if the path is not absolute, it will be resolved relative to the server root directory; if unset, default will be 'conf/httpd.conf' on UNIX | yes | configFile |
| URL | The http or https URL that will be used to check availability for this Apache server; if not set, availability will be determined based on whether plugin can connect to the Apache server's SNMP agent. Note that SSL certificate validation is disabled during availability checks if this is an HTTPS URL. | no | url |
| SNMP Agent Host | the host name or IP address of the Apache SNMP agent (typically '127.0.0.1') | yes | snmpAgentHost |
| SNMP Agent Port | the UDP port of the Apache SNMP agent (typically '1610') | yes | snmpAgentPort |
| SNMP Agent Community | the SNMP community of the Apache SNMP agent (typically 'public') | yes | snmpAgentCommunity |
| SNMP Request Timeout | the timeout, in milliseconds, for requests to the Apache SNMP agent; defaults to 2000 | no | snmpRequestTimeout |
| SNMP Request Retries | the number of times a request that has timed out should be retried; defaults to 1 | no | snmpRequestRetries |
| Restart After Configuration Update | If set to true, each configuration update of the server or any underlying virtual host or directory is followed by the restart of the Apache instance so that the configuration changes are applied immediately. If set to false, you have to manually restart the server (for example using the restart operation in the operations tab) once all the configuration updates are finished. | yes | restartAfterConfigurationUpdate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 2.4. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number of Concurrent Connections | measurement | Number of Concurrent Connections | applInboundAssociations |
| Server Built | trait | the date and time this Apache server's binary was compiled | serverBuilt |
| Start Time | trait | the date and time this Apache server was last started | wwwServiceStartTime |
| Time to ping the server for availability | measurement | Time it took to ping the server for availability over http; this includes DNS lookup time. | rhq_avail_ping_time |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 2.5.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Listen | yes | Listen | |
| Name Virtual Host | A required directive if you want to configure name-based virtual hosts. Although the value can be hostname it is recommended that you always use an IP address. IPv6 addresses must be enclosed in square brackets. To receive requests on all interfaces, you can set the value to *. Note that the IP address of a name-based virtual host must exactly match the value of this property. The address may be optionally followed by the port specification to further limit the directive effect. | no | NameVirtualHost |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 2.6. Metrics
| Name | Description |
|---|---|
| Start | Starts this Apache server, or returns an error if it is already running. The control script used is specified in the Connection Properties. |
| Stop | Stops this Apache server, or returns an error if it is not running. The control script used is specified in the Connection Properties. |
| Restart | Restarts the Apache server by sending its process a SIGHUP. If the server is not running, it is started. This command automatically checks the server's configuration files via configtest before initiating the restart to make sure Apache doesn't die. The control script used is specified in the Connection Properties. Only supported on UNIX platforms. |
| Start with SSL Support | Starts this Apache server with support for SSL. The control script used is specified in the Connection Properties. Only supported on Apache 1.3. |
| Restart Gracefully | Gracefully restarts the Apache server by sending it a SIGUSR1. If the daemon is not running, it is started. This differs from a normal restart in that currently open connections are not aborted. A side effect is that old log files will not be closed immediately. This means that if used in a log rotation script, a substantial delay may be necessary to ensure that the old log files are closed before processing them. This command automatically checks the configuration files via configtest before initiating the restart to make sure Apache doesn't die. The control script used is specified in the Connection Properties. |
| Check Configuration File Syntax | Run a configuration file syntax test. It parses the configuration files and either reports Syntax Ok or detailed information about the particular syntax error. The control script used is specified in the Connection Properties. Only supported on UNIX platforms. |
| Install mod_jk configuration | Tries to install a mod_jk configuration in httpd.conf if none is detected. This includes a workers.properties file and urimap file |
Package Types
none
2.1.1. Apache - Virtual Host Service
Overview
Table 2.7. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Apache |
Child Resource Types
Connection Properties
Table 2.8.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Response Time Log File | the full path to the log file containing response-time stats for this virtual host | 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 |
| URL | The http or https URL that will be used to check availability for this virtual host. Note that SSL certificate validation is disabled during availability checks if this is an HTTPS URL. If the URL is not set, the availability is determined by pinging the configured SNMP location. | no | url |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 2.9. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Host | trait | the host name or IP address of this virtual host | wwwServiceName |
| Port | trait | the TCP port of this virtual host | wwwServiceProtocol |
| Administrator | trait | the administrator of this virtual host | wwwServiceContact |
| Total Number of Requests | measurement | The number of inbound requests on the service | wwwSummaryInRequests |
| Total Number of Requests per Minute | measurement | The number of inbound requests on the service | wwwSummaryInRequests |
| Total Number of Bytes Received | measurement | The number of bytes received by the service | wwwSummaryInLowBytes |
| Total Number of Bytes Received per Minute | measurement | The number of bytes received by the service | wwwSummaryInLowBytes |
| Total Number of Responses | measurement | The number of outbound requests on the service | wwwSummaryOutResponses |
| Total Number of Responses per Minute | measurement | The number of outbound requests on the service | wwwSummaryOutResponses |
| Total Number of Bytes Sent | measurement | The number of bytes sent by the service | wwwSummaryOutLowBytes |
| Total Number of Bytes Sent per Minute | measurement | The number of bytes sent by the service | wwwSummaryOutLowBytes |
| Number of GET Requests | measurement | The number of inbound GET requests on the service | wwwRequestInRequests.GET |
| Number of GET Requests per Minute | measurement | The number of inbound GET requests on the service | wwwRequestInRequests.GET |
| Number of HEAD Requests | measurement | The number of inbound HEAD requests on the service | wwwRequestInRequests.HEAD |
| Number of HEAD Requests per Minute | measurement | The number of inbound HEAD requests on the service | wwwRequestInRequests.HEAD |
| Number of POST Requests | measurement | The number of inbound POST requests on the service | wwwRequestInRequests.POST |
| Number of POST Requests per Minute | measurement | The number of inbound POST requests on the service | wwwRequestInRequests.POST |
| Number of PUT Requests | measurement | The number of inbound PUT requests on the service | wwwRequestInRequests.PUT |
| Number of PUT Requests per Minute | measurement | The number of inbound PUT requests on the service | wwwRequestInRequests.PUT |
| Bytes Received for GET Requests | measurement | The number of bytes received by GET requests on the service | wwwRequestInBytes.GET |
| Bytes Received for GET Requests per Minute | measurement | The number of bytes received by GET requests on the service | wwwRequestInBytes.GET |
| Bytes Received for HEAD Requests | measurement | The number of bytes received by HEAD requests on the service | wwwRequestInBytes.HEAD |
| Bytes Received for HEAD Requests per Minute | measurement | The number of bytes received by HEAD requests on the service | wwwRequestInBytes.HEAD |
| Bytes Received for POST Requests | measurement | The number of bytes received by POST requests on the service | wwwRequestInBytes.POST |
| Bytes Received for POST Requests per Minute | measurement | The number of bytes received by POST requests on the service | wwwRequestInBytes.POST |
| Bytes Received for PUT Requests | measurement | The number of bytes received by PUT requests on the service | wwwRequestInBytes.PUT |
| Bytes Received for PUT Requests per Minute | measurement | The number of bytes received by PUT requests on the service | wwwRequestInBytes.PUT |
| Number of 200 Responses | measurement | The number of 200 responses generated by this service | wwwResponseOutResponses.200 |
| Number of 200 Responses per Minute | measurement | The number of 200 responses generated by this service | wwwResponseOutResponses.200 |
| Number of 301 Responses | measurement | The number of 301 responses generated by this service | wwwResponseOutResponses.301 |
| Number of 301 Responses per Minute | measurement | The number of 301 responses generated by this service | wwwResponseOutResponses.301 |
| Number of 302 Responses | measurement | The number of 302 responses generated by this service | wwwResponseOutResponses.302 |
| Number of 302 Responses per Minute | measurement | The number of 302 responses generated by this service | wwwResponseOutResponses.302 |
| Number of 401 Responses | measurement | The number of 401 responses generated by this service | wwwResponseOutResponses.401 |
| Number of 401 Responses per Minute | measurement | The number of 401 responses generated by this service | wwwResponseOutResponses.401 |
| Number of 403 Responses | measurement | The number of 403 responses generated by this service | wwwResponseOutResponses.403 |
| Number of 403 Responses per Minute | measurement | The number of 403 responses generated by this service | wwwResponseOutResponses.403 |
| Number of 404 Responses | measurement | The number of 404 responses generated by this service | wwwResponseOutResponses.404 |
| Number of 404 Responses per Minute | measurement | The number of 404 responses generated by this service | wwwResponseOutResponses.404 |
| Number of 500 Responses | measurement | The number of 500 responses generated by this service | wwwResponseOutResponses.500 |
| Number of 500 Responses per Minute | measurement | The number of 500 responses generated by this service | wwwResponseOutResponses.500 |
| Bytes Sent for 200 Responses | measurement | The number of bytes sent for 200 responses generated by this service | wwwResponseOutBytes.200 |
| Bytes Sent for 200 Responses per Minute | measurement | The number of bytes sent for 200 responses generated by this service | wwwResponseOutBytes.200 |
| Bytes Sent for 301 Responses | measurement | The number of bytes sent for 301 responses generated by this service | wwwResponseOutBytes.301 |
| Bytes Sent for 301 Responses per Minute | measurement | The number of bytes sent for 301 responses generated by this service | wwwResponseOutBytes.301 |
| Bytes Sent for 302 Responses | measurement | The number of bytes sent for 302 responses generated by this service | wwwResponseOutBytes.302 |
| Bytes Sent for 302 Responses per Minute | measurement | The number of bytes sent for 302 responses generated by this service | wwwResponseOutBytes.302 |
| Bytes Sent for 401 Responses | measurement | The number of bytes sent for 401 responses generated by this service | wwwResponseOutBytes.401 |
| Bytes Sent for 401 Responses per Minute | measurement | The number of bytes sent for 401 responses generated by this service | wwwResponseOutBytes.401 |
| Bytes Sent for 403 Responses | measurement | The number of bytes sent for 403 responses generated by this service | wwwResponseOutBytes.403 |
| Bytes Sent for 403 Responses per Minute | measurement | The number of bytes sent for 403 responses generated by this service | wwwResponseOutBytes.403 |
| Bytes Sent for 404 Responses | measurement | The number of bytes sent for 404 responses generated by this service | wwwResponseOutBytes.404 |
| Bytes Sent for 404 Responses per Minute | measurement | The number of bytes sent for 404 responses generated by this service | wwwResponseOutBytes.404 |
| Bytes Sent for 500 Responses | measurement | The number of bytes sent for 500 responses generated by this service | wwwResponseOutBytes.500 |
| Bytes Sent for 500 Responses per Minute | measurement | The number of bytes sent for 500 responses generated by this service | wwwResponseOutBytes.500 |
| HTTP Response Time | calltime | The minimum, maximum, and average response times for HTTP requests serviced by this virtual host | ResponseTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 2.10.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Error Log | Sets the name of the file to which the server will log any errors it encounters. If the file-path is not absolute then it is assumed to be relative to the ServerRoot. If the file-path begins with a pipe (|) then it is assumed to be a command to spawn to handle the error log. Using syslog instead of a filename enables logging via syslogd(8) if the system supports it. The default is to use syslog facility local7, but you can override this by using the syslog:facility syntax where facility can be one of the names usually documented in syslog(1). | no | ErrorLog |
| Request logs | Configure the logging of requests to the server. | yes | CustomLog |
| Server Name | Sets the request scheme, hostname and port that the server uses to identify itself. This is used when creating redirection URLs. If no ServerName is specified, then the server attempts to deduce the hostname by performing a reverse lookup on the IP address. If no port is specified in the ServerName, then the server will use the port from the incoming request. For optimal reliability and predictability, you should specify an explicit hostname and port using the ServerName directive. If you are using name-based virtual hosts, the ServerName inside a <VirtualHost> section specifies what hostname must appear in the request's Host: header to match this virtual host. | no | ServerName |
| Server Alias | yes | ServerAlias | |
| Server Admin | The email address or URL to contact the server administrator in case of errors. This address is used in various Apache generated error messages. | no | ServerAdmin |
| Document Root | This directive sets the directory from which httpd will serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document. If the directory-path is not absolute then it is assumed to be relative to the ServerRoot. The DocumentRoot should be specified without a trailing slash. | yes | DocumentRoot |
| Add Default Charset | This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. | no | AddDefaultCharset |
| Alias | The Alias directive allows documents to be stored in the local filesystem other than under the DocumentRoot. With " Alias /image /ftp/pub/image", a request for http://myserver/image/foo.gif would cause the server to return the file /ftp/pub/image/foo.gif. Only complete path segments are matched, so the above alias would not match a request for http://myserver/imagefoo.gif. Note that you may need to specify additional <Directory> sections which cover the destination of aliases. In particular, if you are creating an Alias to a directory outside of your DocumentRoot, you may need to explicitly permit access to the target directory. | yes | Alias |
| Default Type | There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. | no | DefaultType |
| Directory Index | Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. | no | DirectoryIndex |
| Error Document | In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. | yes | ErrorDocument |
| Timeout | The TimeOut directive defines the length of time Apache will wait for I/O in various circumstances. | no | Timeout |
| Options | The Options directive controls which server features are available in a particular directory. | no | Options |
| Use Canonical Name | With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. | no | UseCanonicalName |
| Use Canonical Physical Port | In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. | no | UseCanonicalPhysicalPort |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
2.1.1.1. Apache - Directory Service
Overview
Table 2.11. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Apache |
Child Resource Types
Connection Properties
Table 2.12.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Regular Expression | Does the name of this directory denote a regular expression? | yes | regexp |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 2.13.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| IfModule Conditions | List of modules which must be loaded to use directive configuration. | yes | IfModules |
| Order | The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two. | no | Order |
| Allow | The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface. | no | Allow |
| Deny | The arguments for the Deny directive are identical to the arguments for the Allow directive. | no | Deny |
| Allow Override | no | AllowOverride | |
| Add Default Charset | This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. | no | AddDefaultCharset |
| Default Type | There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. | no | DefaultType |
| Directory Index | Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. | no | DirectoryIndex |
| Error Document | In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. | yes | ErrorDocument |
| Options | The Options directive controls which server features are available in a particular directory. | no | Options |
| Use Canonical Name | With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. | no | UseCanonicalName |
| Use Canonical Physical Port | In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. | no | UseCanonicalPhysicalPort |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
2.1.1.1.1. Apache - IfModule Parameters Service
Overview
Table 2.14. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Apache |
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties
Table 2.15.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| IfModule Conditions | List of modules which must be loaded to use directive configuration. | yes | IfModules |
| Order | The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two. | no | Order |
| Allow | The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface. | no | Allow |
| Deny | The arguments for the Deny directive are identical to the arguments for the Allow directive. | no | Deny |
| Allow Override | no | AllowOverride | |
| Add Default Charset | This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. | no | AddDefaultCharset |
| Default Type | There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. | no | DefaultType |
| Directory Index | Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. | no | DirectoryIndex |
| Error Document | In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. | yes | ErrorDocument |
| Options | The Options directive controls which server features are available in a particular directory. | no | Options |
| Use Canonical Name | With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. | no | UseCanonicalName |
| Use Canonical Physical Port | In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. | no | UseCanonicalPhysicalPort |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
2.1.1.2. Apache - IfModule Service
Overview
Table 2.16. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Apache |
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties
Table 2.17.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| IfModule Conditions | List of modules which must be loaded to use directive configuration. | yes | IfModules |
| Order | The Order directive, along with the Allow and Deny directives, controls a three-pass access control system. The first pass processes either all Allow or all Deny directives, as specified by the Order directive. The second pass parses the rest of the directives (Deny or Allow). The third pass applies to all requests which do not match either of the first two. | no | Order |
| Allow | The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP address, IP address range. The environment variables settings are not supported in the user interface. | no | Allow |
| Deny | The arguments for the Deny directive are identical to the arguments for the Allow directive. | no | Deny |
| Allow Override | no | AllowOverride | |
| Add Default Charset | This directive specifies a default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response's content-type is either text/plain or text/html. Value "Off" disables this functionality. "On" enables a default charset of iso-8859-1. Any other value is assumed to be the charset to be used, which should be one of the IANA registered charset values for use in MIME media types. | no | AddDefaultCharset |
| Default Type | There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings. The server SHOULD inform the client of the content-type of the document. If the server is unable to determine this by normal means, it will set it to the configured DefaultType. | no | DefaultType |
| Directory Index | Sets the list of resources to look for, when the client requests an index of the directory by specifying a / at the end of the directory name. Note that the documents do not need to be relative to the directory. | no | DirectoryIndex |
| Error Document | In the event of a problem or error, Apache can be configured to do one of four things, 1. output a simple hardcoded error message, 2. output a customized message, 3. redirect to a local URL-path to handle the problem/error, 4. redirect to an external URL to handle the problem/error. The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error. | yes | ErrorDocument |
| Options | The Options directive controls which server features are available in a particular directory. | no | Options |
| Use Canonical Name | With UseCanonicalName On Apache will use the hostname and port specified in the ServerName directive to construct the canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs. With UseCanonicalName Off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name, as defined above). UseCanonicalName DNS is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs. | no | UseCanonicalName |
| Use Canonical Physical Port | In many situations Apache must construct a self-referential URL -- that is, a URL that refers back to the same server. With UseCanonicalPhysicalPort On Apache will, when constructing the canonical port for the server to honor the UseCanonicalName directive, provide the actual physical port number being used by this request as a potential port. With UseCanonicalPhysicalPort Off Apache will not ever use the actual physical port number, instead relying on all configured information to construct a valid port number. | no | UseCanonicalPhysicalPort |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
2.1.2. Apache - Mod JK Service
Overview
Table 2.18. Overview
| Description: | Management of mod_jk |
| Singleton: | yes |
| Plugin: | Apache |
Child Resource Types
none
Connection Properties
Table 2.19.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path to workers.properties | The path to the file containing worker properties. If this is a relative path, it will be looked up in the server root of the parent Apache server | no | workerFile |
| Path to the uriworkers file | The path to the file containing uri to worker mappings. If this is a relative path, it will be looked up in the server root of the parent Apache server | no | uriWorkerFile |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
2.2. IIS - Server (Deprecated)
Important
This plug-in is deprecated in JBoss ON 3.1.2 and will be removed in a future release.
Overview
Table 2.20. Overview
| Description: | IIS Web Server |
| Singleton: | no |
| Plugin: | IIS |
Child Resource Types
Autodiscovery Process Scans
none
Connection Properties
none
Metrics
Table 2.21. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Bytes Sent | measurement | Shows the rate that data bytes are sent by the Web service. | Bytes Sent/sec |
| Bytes Sent per Minute | measurement | Shows the rate that data bytes are sent by the Web service. | Bytes Sent/sec |
| Bytes Received | measurement | Shows the rate that data bytes are received by the Web service. | Bytes Received/sec |
| Bytes Received per Minute | measurement | Shows the rate that data bytes are received by the Web service. | Bytes Received/sec |
| Total Files Sent | measurement | Shows the total number of files sent by the Web service (counted since service startup). | Total Files Sent |
| Total Files Sent per Minute | measurement | Shows the total number of files sent by the Web service (counted since service startup). | Total Files Sent |
| Total Files Received | measurement | Shows the total number of files received by the Web service (counted since service startup). | Total Files Received |
| Total Files Received per Minute | measurement | Shows the total number of files received by the Web service (counted since service startup). | Total Files Received |
| Total Files Transferred | measurement | Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup). | Total Files Transferred |
| Total Files Transferred per Minute | measurement | Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup). | Total Files Transferred |
| Current Anonymous Users | measurement | Shows the number of users who currently have an anonymous connection using the Web service. | Current Anonymous Users |
| Current NonAnonymous Users | measurement | Shows the number of users who currently have a non-anonymous connection using the Web service. | Current NonAnonymous Users |
| Total Anonymous Users | measurement | Shows the total number of users who established an anonymous connection with the Web service (counted since service startup). | Total Anonymous Users |
| Total Anonymous Users per Minute | measurement | Shows the total number of users who established an anonymous connection with the Web service (counted since service startup). | Total Anonymous Users |
| Total Non Anonymous Users | measurement | Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup). | Total NonAnonymous Users |
| Total Non Anonymous Users per Minute | measurement | Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup). | Total NonAnonymous Users |
| Maximum Anonymous Users | measurement | Shows the maximum number of users who established concurrent anonymous connections using the Web service (counted since service startup). | Maximum Anonymous Users |
| Maximum Non Anonymous Users | measurement | Shows the maximum number of users who established concurrent non-anonymous connections using the Web service (counted since service startup). | Maximum NonAnonymous Users |
| Current Connections | measurement | Shows the current number of connections established with the Web service. | Current Connections |
| Maximum Connections | measurement | Shows the maximum number of simultaneous connections established with the Web service. | Maximum Connections |
| Total Logon Attempts | measurement | Shows the number of logons that have been attempted using the Web service (counted since service startup). | Total Logon Attempts |
| Total Logon Attempts per Minute | measurement | Shows the number of logons that have been attempted using the Web service (counted since service startup). | Total Logon Attempts |
| Total GET Requests | measurement | Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms. | Total Get Requests |
| Total GET Requests per Minute | measurement | Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms. | Total Get Requests |
| Total POST Requests | measurement | Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests. | Total Post Requests |
| Total POST Requests per Minute | measurement | Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests. | Total Post Requests |
| Total HEAD Requests | measurement | Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed. | Total Head Requests |
| Total HEAD Requests per Minute | measurement | Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed. | Total Head Requests |
| Total PUT Requests | measurement | Shows the number of HTTP requests using the PUT method (counted since service startup). | Total Put Requests |
| Total PUT Requests per Minute | measurement | Shows the number of HTTP requests using the PUT method (counted since service startup). | Total Put Requests |
| Total DELETE Requests | measurement | Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals. | Total Delete Requests |
| Total DELETE Requests per Minute | measurement | Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals. | Total Delete Requests |
| Total TRACE Requests | measurement | Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes. | Total Trace Requests |
| Total TRACE Requests per Minute | measurement | Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes. | Total Trace Requests |
| Total Other Request Methods | measurement | Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications. | Total Other Request Methods |
| Total Other Request Methods per Minute | measurement | Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications. | Total Other Request Methods |
| Total Method Requests | measurement | Shows the number of all HTTP requests (counted since service startup). | Total Method Requests |
| Total Method Requests per Minute | measurement | Shows the number of all HTTP requests (counted since service startup). | Total Method Requests |
| Total CGI Requests | measurement | Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup. | Total CGI Requests |
| Total CGI Requests per Minute | measurement | Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup. | Total CGI Requests |
| Total ISAPI Extension Requests | measurement | Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup. | Total ISAPI Extension Requests |
| Total ISAPI Extension Requests per Minute | measurement | Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup. | Total ISAPI Extension Requests |
| Total Not Found Errors | measurement | Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup. | Total Not Found Errors |
| Total Not Found Errors per Minute | measurement | Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup. | Total Not Found Errors |
| Total Locked Errors | measurement | Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup. | Total Locked Errors |
| Total Locked Errors per Minute | measurement | Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup. | Total Locked Errors |
| Current CGI Requests | measurement | Shows the current number of CGI requests that are simultaneously being processed by the Web service. | Current CGI Requests |
| Current CGI Requests per Minute | measurement | Shows the current number of CGI requests that are simultaneously being processed by the Web service. | Current CGI Requests |
| Current ISAPI Extension Requests | measurement | Shows the current number of Extension requests that are simultaneously being processed by the Web service. | Current ISAPI Extension Requests |
| Maximum CGI Requests | measurement | Shows the maximum number of CGI requests simultaneously processed by the Web service. | Maximum CGI Requests |
| Maximum ISAPI Extension Requests | measurement | Shows the maximum number of Extension requests simultaneously processed by the Web service. | Maximum ISAPI Extension Requests |
| Total Blocked Async I/O Requests | measurement | Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup). | Total Blocked Async I/O Requests |
| Total Blocked Async I/O Requests per Minute | measurement | Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup). | Total Blocked Async I/O Requests |
| Total Allowed Async I/O Requests | measurement | Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted. | Total Allowed Async I/O Requests |
| Total Allowed Async I/O Requests per Minute | measurement | Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted. | Total Allowed Async I/O Requests |
| Total Rejected Async I/O Requests | measurement | Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup). | Total Rejected Async I/O Requests |
| Total Rejected Async I/O Requests per Minute | measurement | Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup). | Total Rejected Async I/O Requests |
| Current Blocked Async I/O Requests | measurement | Shows current requests that are temporarily blocked due to bandwidth throttling settings. | Current Blocked Async I/O Requests |
| Measured Async I/O Bandwidth Usage | measurement | Shows the measured bandwidth of asynchronous I/O averaged over a minute. | Measured Async I/O Bandwidth Usage |
| Total Connection Attempts (all Instances) | measurement | Shows the number of connections that have been attempted using the Web service (counted since service startup). This counter is for all instances listed. | Total Connection Attempts (all instances) |
| Total Connection Attempts (all Instances) per Minute | measurement | Shows the number of connections that have been attempted using the Web service (counted since service startup). This counter is for all instances listed. | Total Connection Attempts (all instances) |
| Service Uptime | measurement | The amount of time this service has been up for | Service Uptime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 2.22. Metrics
| Name | Description |
|---|---|
| Start | Starts IIS and, if necessary, dependent services |
| Stop | Shuts down IIS |
Package Types
none
2.2.1. IIS - VHost Service
Overview
Table 2.23. Overview
| Description: | IIS VHost |
| Singleton: | no |
| Plugin: | IIS |
Child Resource Types
none
Connection Properties
Table 2.24.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Site Name | yes | siteName | |
| Hostname | yes | hostname | |
| Port | yes | port | |
| Ip Address | yes | ipAddress | |
| Doc Root | yes | docRoot | |
| Ssl | yes | ssl | |
| Log Directory | yes | logDirectory | |
| Log Format | The format log entries are written in. This is a per-site, general option of the W3C Extended Log File Format. Format must contain the following tokens - 'date' ,'time' , 'c-ip', 'cs-uri-stem', 'sc-status', and 'time-taken' - but can include others. Tokens must *not* have quotes around them, and should be space-delimited. | yes | responseTimeLogFormat |
| 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 |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 2.25. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Bytes Sent | measurement | Shows the rate that data bytes are sent by the Web service. | Bytes Sent/sec |
| Bytes Sent per Minute | measurement | Shows the rate that data bytes are sent by the Web service. | Bytes Sent/sec |
| Bytes Received | measurement | Shows the rate that data bytes are received by the Web service. | Bytes Received/sec |
| Bytes Received per Minute | measurement | Shows the rate that data bytes are received by the Web service. | Bytes Received/sec |
| Total Files Sent | measurement | Shows the total number of files sent by the Web service (counted since service startup). | Total Files Sent |
| Total Files Sent per Minute | measurement | Shows the total number of files sent by the Web service (counted since service startup). | Total Files Sent |
| Total Files Received | measurement | Shows the total number of files received by the Web service (counted since service startup). | Total Files Received |
| Total Files Received per Minute | measurement | Shows the total number of files received by the Web service (counted since service startup). | Total Files Received |
| Total Files Transferred | measurement | Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup). | Total Files Transferred |
| Total Files Transferred per Minute | measurement | Shows the sum of Files Sent and Files Received. This is the total number of files transferred by the Web service (counted since service startup). | Total Files Transferred |
| Current Anonymous Users | measurement | Shows the number of users who currently have an anonymous connection using the Web service. | Current Anonymous Users |
| Current NonAnonymous Users | measurement | Shows the number of users who currently have a non-anonymous connection using the Web service. | Current NonAnonymous Users |
| Total Anonymous Users | measurement | Shows the total number of users who established an anonymous connection with the Web service (counted since service startup). | Total Anonymous Users |
| Total Anonymous Users per Minute | measurement | Shows the total number of users who established an anonymous connection with the Web service (counted since service startup). | Total Anonymous Users |
| Total Non Anonymous Users | measurement | Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup). | Total NonAnonymous Users |
| Total Non Anonymous Users per Minute | measurement | Shows the total number of users who established a non-anonymous connection with the Web service (counted since service startup). | Total NonAnonymous Users |
| Maximum Anonymous Users | measurement | Shows the maximum number of users who established concurrent anonymous connections using the Web service (counted since service startup). | Maximum Anonymous Users |
| Maximum Non Anonymous Users | measurement | Shows the maximum number of users who established concurrent non-anonymous connections using the Web service (counted since service startup). | Maximum NonAnonymous Users |
| Current Connections | measurement | Shows the current number of connections established with the Web service. | Current Connections |
| Maximum Connections | measurement | Shows the maximum number of simultaneous connections established with the Web service. | Maximum Connections |
| Total Logon Attempts | measurement | Shows the number of logons that have been attempted using the Web service (counted since service startup). | Total Logon Attempts |
| Total Logon Attempts per Minute | measurement | Shows the number of logons that have been attempted using the Web service (counted since service startup). | Total Logon Attempts |
| Total GET Requests | measurement | Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms. | Total Get Requests |
| Total GET Requests per Minute | measurement | Shows the number of HTTP requests using the GET method (counted since service startup). GET requests are generally used for basic file retrievals or image maps, though they can be used with forms. | Total Get Requests |
| Total POST Requests | measurement | Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests. | Total Post Requests |
| Total POST Requests per Minute | measurement | Shows the number of HTTP requests using the POST method (counted since service startup). POST requests are generally used for forms or gateway requests. | Total Post Requests |
| Total HEAD Requests | measurement | Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed. | Total Head Requests |
| Total HEAD Requests per Minute | measurement | Shows the number of HTTP requests using the HEAD method (counted since service startup). Head requests generally indicate a client is querying the state of a document they already have to see if it needs to be refreshed. | Total Head Requests |
| Total PUT Requests | measurement | Shows the number of HTTP requests using the PUT method (counted since service startup). | Total Put Requests |
| Total PUT Requests per Minute | measurement | Shows the number of HTTP requests using the PUT method (counted since service startup). | Total Put Requests |
| Total DELETE Requests | measurement | Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals. | Total Delete Requests |
| Total DELETE Requests per Minute | measurement | Shows the number of HTTP requests using the DELETE method (counted since service startup). Delete requests are generally used for file removals. | Total Delete Requests |
| Total TRACE Requests | measurement | Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes. | Total Trace Requests |
| Total TRACE Requests per Minute | measurement | Shows the number of HTTP requests using the TRACE method (counted since service startup). TRACE requests allow the client to see what is being received at the end of the request chain and use the information for diagnostic purposes. | Total Trace Requests |
| Total Other Request Methods | measurement | Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications. | Total Other Request Methods |
| Total Other Request Methods per Minute | measurement | Shows the number of HTTP requests that are not OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, MOVE, COPY, MKCOL, PROPFIND, PROPPATCH, MS-SEARCH, LOCK or UNLOCK methods (counted since service startup). These may include LINK or other methods supported by gateway applications. | Total Other Request Methods |
| Total Method Requests | measurement | Shows the number of all HTTP requests (counted since service startup). | Total Method Requests |
| Total Method Requests per Minute | measurement | Shows the number of all HTTP requests (counted since service startup). | Total Method Requests |
| Total CGI Requests | measurement | Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup. | Total CGI Requests |
| Total CGI Requests per Minute | measurement | Shows the total number of CGI requests. CGI requests are custom gateway executables (.exe) the administrator can install to add forms processing or other dynamic data sources. CGI requests initiate a process on the server which can be a large drain on server resources. The count is the total since service startup. | Total CGI Requests |
| Total ISAPI Extension Requests | measurement | Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup. | Total ISAPI Extension Requests |
| Total ISAPI Extension Requests per Minute | measurement | Shows the total number of ISAPI Extension Requests. ISAPI Extension Requests are custom gateway Dynamic Link Libraries (.dll) the administrator can install to add forms processing or other dynamic data sources. Unlike CGI requests, ISAPI requests are simple calls to a DLL library routine, thus they are better suited to high performance gateway applications. The count is the total since service startup. | Total ISAPI Extension Requests |
| Total Not Found Errors | measurement | Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup. | Total Not Found Errors |
| Total Not Found Errors per Minute | measurement | Shows the number of requests that could not be satisfied by the server because the requested document could not be found. These are generally reported as an HTTP 404 error code to the client. The count is the total since service startup. | Total Not Found Errors |
| Total Locked Errors | measurement | Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup. | Total Locked Errors |
| Total Locked Errors per Minute | measurement | Shows the number of requests that could not be satisfied by the server because the requested was locked. These are generally reported as an HTTP 423 error code to the client. The count is the total since service startup. | Total Locked Errors |
| Current CGI Requests | measurement | Shows the current number of CGI requests that are simultaneously being processed by the Web service. | Current CGI Requests |
| Current CGI Requests per Minute | measurement | Shows the current number of CGI requests that are simultaneously being processed by the Web service. | Current CGI Requests |
| Current ISAPI Extension Requests | measurement | Shows the current number of Extension requests that are simultaneously being processed by the Web service. | Current ISAPI Extension Requests |
| Maximum CGI Requests | measurement | Shows the maximum number of CGI requests simultaneously processed by the Web service. | Maximum CGI Requests |
| Maximum ISAPI Extension Requests | measurement | Shows the maximum number of Extension requests simultaneously processed by the Web service. | Maximum ISAPI Extension Requests |
| Total Blocked Async I/O Requests | measurement | Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup). | Total Blocked Async I/O Requests |
| Total Blocked Async I/O Requests per Minute | measurement | Shows the number of total requests temporarily blocked due to bandwidth throttling settings (counted since service startup). | Total Blocked Async I/O Requests |
| Total Allowed Async I/O Requests | measurement | Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted. | Total Allowed Async I/O Requests |
| Total Allowed Async I/O Requests per Minute | measurement | Shows the total number of requests allowed by bandwidth throttling settings (counted since service startup). When bandwidth throttling is defined, the number of allowed user requests is restricted. | Total Allowed Async I/O Requests |
| Total Rejected Async I/O Requests | measurement | Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup). | Total Rejected Async I/O Requests |
| Total Rejected Async I/O Requests per Minute | measurement | Shows the total number of requests rejected due to bandwidth throttling settings (counted since service startup). | Total Rejected Async I/O Requests |
| Current Blocked Async I/O Requests | measurement | Shows current requests that are temporarily blocked due to bandwidth throttling settings. | Current Blocked Async I/O Requests |
| Measured Async I/O Bandwidth Usage | measurement | Shows the measured bandwidth of asynchronous I/O averaged over a minute. | Measured Async I/O Bandwidth Usage |
| HTTP Response Time | calltime | the minimum, maximum, and average response times for HTTP requests serviced by this virtual host | ResponseTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
2.3. Postgres - Server (Deprecated)
Important
This plug-in is deprecated in JBoss ON 3.1.2 and will be removed in a future release.
Overview
Table 2.26. Overview
| Description: | PostgreSQL Server |
| Singleton: | no |
| Plugin: | Postgres |
Child Resource Types
Autodiscovery Process Scans
Table 2.27. Metrics
| Name | Query |
|---|---|
| unix | process|basename|match=^(postgres|postmaster)$,process|basename|nomatch|parent=^(postgres|postmaster)$ |
| windows | process|basename|match=^(?i)(postgres|postmaster)\.exe$,process|basename|nomatch|parent=^(?i)(postgres|postmaster)\.exe$ |
Connection Properties
Table 2.28.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| listen host | the hostname or IP address that the database is listening on | yes | host |
| listen port | the TCP port that the database is listening on | yes | port |
| database name | the name of the database to connect to | yes | db |
| JDBC driver class | the fully-qualified classname of the JDBC driver class | no | driverClass |
| role name | the database role to connect as | yes | principal |
| role password | the password for the database role being used to connect | yes | credentials |
| PGDATA directory | the absolute path to the directory containing the cluster configuration files postgresql.conf, pg_hba.conf, and pg_ident.conf | yes | pgdataDir |
| configuration file | the absolute path to the main cluster configuration file; default value is '{pgDataDir}/postgresql.conf', where [pgDataDir] is the value of the pgDataDir connection property | no | configFile |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 2.29. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| User Time | measurement | The aggregate amount of CPU user time spent by all postgres processes | Process.aggregateCpu.user |
| User Time per Minute | measurement | The aggregate amount of CPU user time spent by all postgres processes | Process.aggregateCpu.user |
| Kernel Time | measurement | The aggregate amount of CPU kernel time spent by all postgres processes | Process.aggregateCpu.sys |
| Kernel Time per Minute | measurement | The aggregate amount of CPU kernel time spent by all postgres processes | Process.aggregateCpu.sys |
| CPU Percentage | measurement | The percentage of CPU currently being used by all postgres processes | Process.aggregateCpu.percent |
| Physical Memory | measurement | The aggregate amount of resident memory used by all postgres processes | Process.aggregateMemory.resident |
| Virtual Memory | measurement | The aggregate amount of virtual memory used by all postgres processes | Process.aggregateMemory.size |
| Open File Descriptors | measurement | The aggregate number of file descriptors open by all postgres processes | Process.aggregateFileDescriptor.total |
| Active Backends | measurement | Number of currently active backends (user connections) | Database.backends |
| Start time | trait | Start time of the PostgreSQL database server | Database.startTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 2.30.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Port | Sets the TCP port the server listens on; default value is '5432'. | no | port |
| Max_connections | Sets the maximum number of concurrent connections; default value is '100'. | no | max_connections |
| Shared_buffers | Sets the number of the shared memory buffers used by the server; default value is typically '1000'. | no | shared_buffers |
| Max_fsm_pages | Maximum FSM Pages, must be a minimum of max_fsm_relations*16, 6 bytes each) | no | max_fsm_pages |
| Log_destination | Available options depend on operating system; default value is 'stderr' | no | log_destination |
| Redirect_stderr | Enable capturing of stderr into log files; enabled by default | no | redirect_stderr |
| Stats_start_collector | needed for block or row stats; enabled by default | no | stats_start_collector |
| Stats_block_level | Enables the collection of block-level statistics on database activity; if this option is enabled, the data that is produced can be accessed via the pg_stat and pg_statio family of system views; disabled by default | no | stats_block_level |
| Stats_row_level | Enables the collection of row-level statistics on database activity; if this option is enabled, the data that is produced can be accessed via the pg_stat and pg_statio family of system views; disabled by default | no | stats_row_level |
| Autovacuum | Enable autovacuum subprocess? (requires stats_start_collector and stats_row_level to also be on); enabled by default | no | autovacuum |
| Runtime Settings | properties available from show all | no | runtimeSettings |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 2.31. Metrics
| Name | Description |
|---|---|
| List Process Statistics | List statistics about the currently executing postgres backends |
Package Types
none
2.3.1. Postgres - Database Service
Overview
Table 2.32. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Postgres |
Child Resource Types
Connection Properties
Table 2.33.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Database Name | yes | databaseName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 2.34. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Backends | measurement | Number of active server processes for database | numbackends |
| Transactions Committed | measurement | Transactions committed in database | xact_commit |
| Transactions Committed per Minute | measurement | Transactions committed in database | xact_commit |
| Transactions Rolled Back | measurement | Transactions rolled back in database | xact_rollback |
| Transactions Rolled Back per Minute | measurement | Transactions rolled back in database | xact_rollback |
| Blocks Read | measurement | Number of disk block fetch requests for database | blks_read |
| Blocks Read per Minute | measurement | Number of disk block fetch requests for database | blks_read |
| Blocks Hit | measurement | Number of disk block fetch requests found in cache for database | blks_hit |
| Blocks Hit per Minute | measurement | Number of disk block fetch requests found in cache for database | blks_hit |
| Size | measurement | Disk space used by the database | size |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 2.35. Metrics
| Name | Description |
|---|---|
| Reset Statistics | Resets the statistics in this database |
| Invoke Sql | Execute arbitrary SQL |
Package Types
none
2.3.1.1. Postgres - Table Service
Overview
Table 2.36. Overview
| Description: | Database table |
| Singleton: | no |
| Plugin: | Postgres |
Child Resource Types
none
Connection Properties
Table 2.37.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Table Name | yes | tableName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 2.38. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Sequential Scans | measurement | Number of sequential scans done against this table (when an index scan was not possible) | seq_scan |
| Sequential Scans per Minute | measurement | Number of sequential scans done against this table (when an index scan was not possible) | seq_scan |
| Sequential Rows Read | measurement | Number of rows read by sequential scans | seq_tup_read |
| Sequential Rows Read per Minute | measurement | Number of rows read by sequential scans | seq_tup_read |
| Index Scans | measurement | Number of index scans done against this table | idx_scan |
| Index Scans per Minute | measurement | Number of index scans done against this table | idx_scan |
| Index Scan Rows Read | measurement | Number of index entries returned by index scans | idx_tup_fetch |
| Index Scan Rows Read per Minute | measurement | Number of index entries returned by index scans | idx_tup_fetch |
| Heap Blocks Read | measurement | The number of heap blocks read that were not a buffer cache hit | heap_blks_read |
| Heap Blocks Read per Minute | measurement | The number of heap blocks read that were not a buffer cache hit | heap_blks_read |
| Heap Blocks Hit | measurement | The number of heap block requests that were found in the buffer cache | heap_blks_hit |
| Heap Blocks Hit per Minute | measurement | The number of heap block requests that were found in the buffer cache | heap_blks_hit |
| Index Blocks Read | measurement | The number of index blocks fetched that were not a buffer cache hit | idx_blks_read |
| Index Blocks Read per Minute | measurement | The number of index blocks fetched that were not a buffer cache hit | idx_blks_read |
| Index Blocks Hit | measurement | The number of index block requests that were found in the buffer cache | idx_blks_hit |
| Index Blocks Hit per Minute | measurement | The number of index block requests that were found in the buffer cache | idx_blks_hit |
| Toast Blocks Reads | measurement | The number of toast blocks fetched that were not a buffer cache hit | toast_blks_read |
| Toast Blocks Reads per Minute | measurement | The number of toast blocks fetched that were not a buffer cache hit | toast_blks_read |
| Toast Blocks Hit | measurement | The number of toast block requests that were found in the buffer cache | toast_blks_hit |
| Toast Blocks Hit per Minute | measurement | The number of toast block requests that were found in the buffer cache | toast_blks_hit |
| Toast Index Blocks Read | measurement | The number of toast index blocks fetched that were not a buffer cache hit | tidx_blks_read |
| Toast Index Blocks Read per Minute | measurement | The number of toast index blocks fetched that were not a buffer cache hit | tidx_blks_read |
| Toast Index Blocks Hit | measurement | The number of toast index block requests that were found in the buffer cache | tidx_blks_hit |
| Toast Index Blocks Hit per Minute | measurement | The number of toast index block requests that were found in the buffer cache | tidx_blks_hit |
| Row Inserts | measurement | The number of rows ever inserted into this table | n_tup_ins |
| Row Inserts per Minute | measurement | The number of rows ever inserted into this table | n_tup_ins |
| Row Updates | measurement | The number of rows ever updated on this table | n_tup_upd |
| Row Updates per Minute | measurement | The number of rows ever updated on this table | n_tup_upd |
| Row Deletes | measurement | The number of rows ever deleted from this table | n_tup_del |
| Row Deletes per Minute | measurement | The number of rows ever deleted from this table | n_tup_del |
| Table Size | measurement | The size in bytes of the data in the table | table_size |
| Total Size | measurement | The size in bytes of the data and all associated indexes and toast tables | total_size |
| Rows | measurement | The count of rows in the table. Warning: This may be an expensive operation | rows |
| Approximate rows | measurement | The approximate count of rows in the table. This is basically the number of rows of the last ANALYZE of the table. This metric is not expensive. | rows_approx |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 2.39.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Table Name | yes | tableName | |
| Columns | yes | columns |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 2.40. Metrics
| Name | Description |
|---|---|
| Vacuum | Vacuum the table |
Package Types
none
2.3.1.2. Postgres - Query Service
Overview
Table 2.41. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Postgres |
Child Resource Types
none
Connection Properties
Table 2.42.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Table | The table to discover and to be queried on for metric data | yes | table |
| Name | Initial name of the resource when manually added. This is also part of the resource key - make this unique if you want two Query resources based on the same table. | no | name |
| Description | Initial description of resource when manually added | no | description |
| Metric Query | The query that will gather metric data. This must return two columns, a string column whose value is 'metricColumn' and then a numeric column whose value is the metric to be collected. | no | metricQuery |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 2.43. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Metric Value | measurement | The metric value for this Query. If Metric Query is not specified, this is not collected. | metricColumn |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
2.3.2. Postgres - User Service
Overview
Table 2.44. Overview
| Description: | A User in the Postgres System |
| Singleton: | no |
| Plugin: | Postgres |
Child Resource Types
none
Connection Properties
Table 2.45.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| User Name | yes | userName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 2.46. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Total User Connections | measurement | The total number of user connections in the system, whether actively querying or idle | total |
| Active User Connections | measurement | The number of user connections in the system actively querying | active |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 2.47.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Inherit Rights | Inherit rights from parent roles | yes | inheritRights |
| Super User | Is a super user | yes | superuser |
| Can Create Database Types | yes | canCreateDatabaseObjects | |
| Can Create Roles | yes | canCreateRoles | |
| Can Modify Catalog Directly | yes | canModifyCatalogDirectly | |
| User connection limit | yes | connectionLimit | |
| User | yes | user | |
| Can Login | yes | canLogin | |
| Password | yes | password |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
2.4. Abstract Database Plugin (Deprecated)
Important
This plug-in is deprecated in JBoss ON 3.1.2 and will be removed in a future release.
Table 2.48. Basic Details
| Internal Name: | Database |
| Description: | Abstract plugin supporting concrete database plugins |
| Version: | 4.4.0 |
Top-Level Resource Types
This plugin does not define any Resource types. It it probably an "abstract plugin", that is, one that provides Resource components and/or discovery components that can be used by other plugins.
2.5. Script - Server
Overview
Table 2.49. Overview
| Description: | A resource with a command line executable or script as its management interface |
| Singleton: | no |
| Plugin: | Script |
Child Resource Types
none
Autodiscovery Process Scans
none
Connection Properties
Table 2.50.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Executable | The full path to the command line executable or script | yes | executable |
| Working Directory | When the executable is invoked, this will be its working directory. | no | workingDirectory |
| Environment Variables | Environment variables that are set when executing the executable | no | environmentVariables |
| Availability Execute Check | If specified and true, the ability to successfully execute the executable can determine whether or not the managed resource is considered up and available. If you set this to true, you normally do not set the availability regex settings in order to allow availability to be determined based solely on the successful execution, regardless of the exit code or output. If this is false, setting one of the avail regex settings will override it as if it were true. | no | availabilityExecuteCheck |
| Availability Exit Code Regex | If specified, the executable must return an exit code that matches this regular expression if the managed resource is to be considered up and available | no | availabilityExitCodeRegex |
| Availability Output Regex | If specified, the executable must output text that matches this regular expression if the managed resource is to be considered up and available | no | availabilityOutputRegex |
| Availability Arguments | If the executable needs to be executed in order to determine availability, these are the arguments that will be passed to the executable. If you do not specify the regex settings and you set the execute check setting to false, the executable will not be executed and these arguments will not be used - in this case, availability will be determined by the mere existence of the executable file. | no | availabilityArguments |
| Version Arguments | The arguments to pass to the executable that will help determine the version of the managed resource | no | versionArguments |
| Version Regex | The regex that can pick out the version from the executable output. If the regex has a captured group, its matched content will be used as the version. If there is no captured group, the entire output will be used as the version. | no | versionRegex |
| Fixed Version | If specified, this will be the version of the managed resource - the executable will not be invoked to determine it. | no | fixedVersion |
| Description Arguments | The arguments to pass to the executable that will help determine the managed resource description. This can be arguments to enable verbose version output. | no | descriptionArguments |
| Description Regex | The regex that can pick out the description from the executable output. If the regex has a captured group, its matched content will be used as the description. If there is no captured group, the entire output will be used as the description. | no | descriptionRegex |
| Fixed Description | If specified, this will be the description of the managed resource - the executable will not be invoked to determine it. | no | fixedDescription |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 2.51. Metrics
| Name | Description |
|---|---|
| Execute | Executes the executable with a set of arguments and returns the output and exit code. |
Package Types
none
Chapter 3. Enterprise Application Platform Resources
There are certain server types that are supported by default in JBoss Operations Network, both for JBoss and non-JBoss resource types.
The JBoss resources here are included with JBoss ON by default through the EAP plug-in pack. Additional JBoss resources can be managed by JBoss ON by installing additional plug-in packs.
3.1. JBoss AS 4 and EAP 4 Server (Deprecated)
Important
This plug-in is deprecated in JBoss ON 3.1.2 and will be removed in a future release.
Overview
Table 3.1. Overview
| Description: | JBoss Application Server |
| Singleton: | no |
| Plugin: | JBossAS |
Binding to IP addresses
When starting JBossAS instances that need to be monitored using remote JMX (i.e. JNP), it is necessary for the
java.rmi.server.hostname System property to be set to the same value as the server's JNP address (which is set to the jboss.bind.address System property by default). Due to bugs in JBossAS (for more information please see http://jira.jboss.com/jira/browse/JBAS-4736 and http://jira.jboss.com/jira/browse/JBAS-4955, java.rmi.server.hostname will default to 127.0.0.1, unless JBossAS is started using -b, in which case java.rmi.server.hostname will default to the bind address specified as the argument to -b.
Therefore, you must start your JBossAS instances by using either
-b:
run -b 12.34.56.78 ...
or by explicitly specifying a value for
java.rmi.server.hostname via -D or -P, e.g.:
run -Djboss.bind.address=12.34.56.78 -Djava.rmi.server.hostname=12.34.56.78 ...
Otherwise, you will not be able to manage the instance via JON.
Using
-b is the recommended way to specify the bind address, since, in addition to setting jboss.bind.address and java.rmi.server.hostname, it will also set other JGroups-related System properties to the specified address.
Monitoring of EJB 2.x EJBs
The issue here is that JBossAS changed the way it creates the MBean names of the deployed EJBs from the JNDI names / EJB names. Basically the <jndi-name>, or <local-jndi-name> if <jndi-name> is not present, from jboss.xml is used.
So the workaround is to set the <jndi-name> to the ejb-name in your application. As this probably breaks client code, you will want to setup a naming reference that restores the original hierarchy. For example, if you have in jboss.xml:
<session> <ejb-name>Ability</ejb-name> <local-jndi-name>flower.AbilityLocal</local-jndi-name>
You might change this to:
<session> <ejb-name>Ability</ejb-name> <local-jndi-name>Ability</local-jndi-name>
And then add an MBean flowsys-naming-alias-service.xml:
<mbean code="org.jboss.naming.NamingAlias" name=":service=naming-alias"> <attribute name="ToName">flower.AbilityLocal</attribute> <attribute name="FromName">Ability</attribute> </mbean>
After you have done this, go into the inventory of the respective beans, edit the configuration and then click OK.
The naming alias ensures that clients of the Ability EJB can still find the bean in JNDI at the original location. Naming aliases appear in JNDIView (within JMX-Console) as LinkRef.
Child Resource Types
Autodiscovery Process Scans
Table 3.2. Metrics
| Name | Query |
|---|---|
| JBoss4 | process|basename|match=^java.*,arg|org.jboss.Main|match=.* |
Connection Properties
Table 3.3.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Naming Provider URL | The JNP URL with which to connect to the JBoss Application Server instance (e.g. jnp://127.0.0.1:1099). | yes | namingURL |
| Principal | The name of the principal (i.e. user) to authenticate. | no | principal |
| Credentials | The credentials (i.e. password) that should be used to authenticate the principal. | no | credentials |
| JBoss Home Directory | The absolute path to the directory where JBossAS is installed (e.g. /opt/jboss-4.2.2.GA). | yes | jbossHomeDir |
| Configuration Path | The path to the configuration directory under which this instance operates (e.g. /opt/jboss-4.2.2.GA/server/default); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}. | yes | configurationPath |
| Configuration Set | The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {configurationPath}. | no | configurationSet |
| Script Prefix | A prefix applied to script execution commands; this prefix is applied verbatim. The full path of the executable is required (e.g. /usr/bin/sudo). For applicable platforms, this is typically a sudo command, so a sudo user must be configured appropriately for the specified command. Ignored if not set. | no | scriptPrefix |
| Start Script | The path to the script used by the 'Start' operation to start this JBossAS server (e.g. /opt/jboss-4.2.2.GA/bin/run.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/run.sh' on UNIX or 'bin\run.bat' on Windows. | no | startScript |
| Shutdown Script | The path to the script used by the 'Shutdown' operation to shutdown this JBossAS server (e.g. /opt/jboss-4.2.2.GA/bin/shutdown.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/shutdown.sh' on UNIX or 'bin\shutdown.bat' on Windows. | no | shutdownScript |
| Shutdown Method | The method used to execute the Shutdown operation; defaults to 'JMX MBean'. | no | shutdownMethod |
| Binding Address | The host or IP address used by all JBoss services as the binding address (e.g. 10.11.14.233); specify 0.0.0.0 to tell JBossAS to bind to all available network interfaces; defaults to '127.0.0.1'. | no | bindingAddress |
| JAVA_HOME Path | The absolute path to a JRE or JDK installation directory containing the JVM that should be used to start and shutdown the JBossAS instance; defaults to the home directory of the RHQ agent JRE. | no | javaHomePath |
| Start Wait Max | The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to start up. The default is 5 minutes. | no | startWaitMax |
| Stop Wait Max | The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to stop. The default is 2.5 minutes. | no | stopWaitMax |
| Log Event Sources | yes | logEventSources | |
| Snapshot Config Enabled | If true, take a snapshot of the configuration | yes | snapshotConfigEnabled |
| Snapshot Config Directory | The directory containing the configuration files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path. | yes | snapshotConfigDirectory |
| Snapshot Config Regex | If defined, this regular expression must match a configuration file name if that file is to be captured in the snapshot. If not defined, all configuration files will be captured. | no | snapshotConfigRegex |
| Snapshot Config Recursive | If true, the snapshot will include files located in subdirectories under the config directory. | yes | snapshotConfigRecursive |
| Snapshot Log Enabled | If true, take a snapshot of the log files | yes | snapshotLogEnabled |
| Snapshot Log Directory | The directory containing the log files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path. | yes | snapshotLogDirectory |
| Snapshot Log Regex | If defined, this regular expression must match a log file name if that file is to be captured in the snapshot. If not defined, all log files will be captured. | no | snapshotLogRegex |
| Snapshot Log Recursive | If true, the snapshot will include files located in subdirectories under the log directory. | yes | snapshotLogRecursive |
| Snapshot Data Enabled | If true, take a snapshot of the data files | yes | snapshotDataEnabled |
| Snapshot Data Directory | The directory containing the data files that will be captured in the snapshot. This is usually relative to the configurationPath but can be a full absolute path. | yes | snapshotDataDirectory |
| Snapshot Data Regex | If defined, this regular expression must match a data file name if that file is to be captured in the snapshot. If not defined, all data files will be captured. | no | snapshotDataRegex |
| Snapshot Data Recursive | If true, the snapshot will include files located in subdirectories under the data directory. | yes | snapshotDataRecursive |
| Snapshot Additional Files List | Additional files to be included in the snapshot report | yes | snapshotAdditionalFilesList |
| Type | The type of the connection. | yes | type |
| Shutdown MBean Name | Name of the MBean to use when shutting down this server through JMX. | yes | shutdownMbeanName |
| Shutdown MBean Operation | Name of the operation to invoke when shutting down this server through JMX. Note that only operations with no parameter or with one int parameter are supported. If the operation requires an int parameter, '0' will be supplied. | yes | shutdownMbeanOperation |
| Availability Check Period | The amount of time, in seconds, that must elapse between availability checks to see if the server is up. If set, the availability checks will be performed asynchronously thus allowing slow-responding servers to avoid being falsely reported as down. | no | availabilityCheckPeriod |
| JBoss AS JVM Name | The name of the JBoss AS JVM resource. | no | childJmxServerName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.4. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Partition Name | trait | the name of the cluster partition this app server instance belongs to | partitionName |
| Version Name | trait | the code name for the this app server instance's major version (AS 3.2 = WonderLand, AS 4.0 = Zion, AS 4.2 = Trinity, EAP 4.x = EAP, SOA 4.x = SOA) | jboss.system:type=Server:VersionName |
| Build Date | trait | the date this app server was built | jboss.system:type=Server:BuildDate |
| Start Date | trait | the date and time this app server instance was started | jboss.system:type=Server:StartDate |
| Active Thread Count | measurement | The current number of active threads for this app server instance | jboss.system:type=ServerInfo:ActiveThreadCount |
| Active Thread Group Count | measurement | The current number of active thread groups for this app server instance | jboss.system:type=ServerInfo:ActiveThreadGroupCount |
| JVM Free Memory | measurement | An approximation of the total amount of memory currently available in the app server JVM for future allocated objects, measured in bytes | jboss.system:type=ServerInfo:FreeMemory |
| JVM Max Memory | measurement | The maximum amount of memory that the app server JVM will attempt to use, measured in bytes; if there is no inherent limit then the value Long.MAX_VALUE will be returned | jboss.system:type=ServerInfo:MaxMemory |
| JVM Total Memory | measurement | The total amount of memory currently available in the app server JVM for current and future objects, measured in bytes | jboss.system:type=ServerInfo:TotalMemory |
| Total Transactions | measurement | Total number of transactions since last restart | jboss:service=TransactionManager:TransactionCount |
| Total Transactions per Minute | measurement | Total number of transactions since last restart | jboss:service=TransactionManager:TransactionCount |
| Transactions Committed | measurement | Number of transactions commited since last restart | jboss:service=TransactionManager:CommitCount |
| Transactions Committed per Minute | measurement | Number of transactions commited since last restart | jboss:service=TransactionManager:CommitCount |
| Transactions Rolledback | measurement | Number of transactions commited since last restart | jboss:service=TransactionManager:RollbackCount |
| Transactions Rolledback per Minute | measurement | Number of transactions commited since last restart | jboss:service=TransactionManager:RollbackCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.5. Metrics
| Name | Description |
|---|---|
| Start | Start this application server. The script used is specified in the Operations group of connection properties. |
| Shutdown | Shutdown this application server via script or JMX depending on the settings in the Operations and Advanced groups of connection properties. |
| Restart | Shutdown and then start this application server. |
Package Types
Table 3.6. Package Types
| Name | Category | Description |
|---|---|---|
| Cumulative Patch | Deployable | Automatically installable application server patches |
| Jar Library | Deployable | Library Jar files deployed in JBoss AS |
3.1.1. JBossAS - Embedded Tomcat Server
Overview
Table 3.7. Overview
| Description: | Tomcat Web Application Container embedded in a JBossAS Server |
| Singleton: | yes |
| Plugin: | JBossAS |
Child Resource Types
Autodiscovery Process Scans
none
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.1.1.1. JBossAS - Connector Service
Overview
Table 3.8. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.9.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Port | Port this connector listens on. | yes | port |
| Address | Address this connector listens on. | yes | address |
| Scheme | The scheme of the protocol used by this connector (e.g. jk, ajp, http, https). | yes | schema |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.10. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Maximum Request Time | measurement | Maximum time it took to process a request | jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:maxTime |
| Request count | measurement | Total number of requests processed since last restart. | jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:requestCount |
| Request count per Minute | measurement | Total number of requests processed since last restart. | jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:requestCount |
| Error count | measurement | Number of errors while processing since last restart. | jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:errorCount |
| Error count per Minute | measurement | Number of errors while processing since last restart. | jboss.web:name=%schema%%dash%%address%-%port%,type=GlobalRequestProcessor:errorCount |
| Threads Active | measurement | Threads Active | jboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:currentThreadsBusy |
| Threads Allocated | measurement | Threads Allocated | jboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:currentThreadCount |
| Maximum Threads | trait | Maximum number of threads that can be allocated for the thread pool of this connector | jboss.web:name=%schema%%dash%%address%-%port%,type=ThreadPool:maxThreads |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.1.2. JBossAS - VHost Service
Overview
Table 3.11. Overview
| Description: | A virtual host in the web container |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.12.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.13. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Aliases | trait | The aliases for this virtual host | jboss.web:type=Host,host=%name%:aliases |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.2. JBossAS - Datasource Service
Overview
Table 3.14. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.15.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this datasource | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.16. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Total Connections | measurement | Total Number of Connections for the Connection Pool, both active and in-active. | ConnectionCount |
| Available Connections | measurement | Number of available connections in the connection pool in-active and waiting. | AvailableConnectionCount |
| Active Connections | measurement | Number of Connections currently supporting clients. | InUseConnectionCount |
| Connections Created | measurement | Number of Connections created since the Connection Pool was created. | ConnectionCreatedCount |
| Connections Created per Minute | measurement | Number of Connections created since the Connection Pool was created. | ConnectionCreatedCount |
| Connections Destroyed | measurement | Number of Connections destroyed since the Connection Pool was created. | ConnectionDestroyedCount |
| Connections Destroyed per Minute | measurement | Number of Connections destroyed since the Connection Pool was created. | ConnectionDestroyedCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.17.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | yes | type | |
| JNDI Name | The JNDI name under which the DataSource wrapper will be bound. | yes | jndi-name |
| Driver Class | The fully qualified name of the JDBC driver or datasource class. Not used for XA-Datasources | no | driver-class |
| Connection Url | The JDBC driver connection URL string. Needed for Tx and Non-Tx datasources | no | connection-url |
| User Name | no | user-name | |
| Password | no | password | |
| Min Pool Size | no | min-pool-size | |
| Max Pool Size | no | max-pool-size | |
| Transaction Isolation | The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. | no | transaction-isolation |
| Blocking Timeout Millis | 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. If nothing is specified the default of 30000 milliseconds is used. | no | blocking-timeout-millis |
| Idle Timeout Minutes | 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. If nothing is specified the default of 15 minutes is used. | no | idle-timeout-minutes |
| Prepared Statement Cache Size | The number of prepared statements per connection in an LRU cache. | no | prepared-statement-cache-size |
| Valid Connection Checker Class Name | An org.jboss.resource.adapter.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 |
| Use Java Context | Indicates if the JNDI name should be prefixed with java: which causes the DataSource to only be accessible from within the JBoss server vm. The default is Yes. | no | use-java-context |
| Security Domain | Indicates Subjects (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 handle authentication. This name correlates to the JAAS login-config.xml descriptor application-policy/name attribute. Must be specified if either Container Based or Container and Application Based authentication types are specified. | no | security-domain |
| New Connection Sql | Specify an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
| Exception Sorter Class Name | An org.jboss.resource.adapter.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 message. | no | exception-sorter-class-name |
| 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 |
| 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/returned to the prepared statement cache. The default is Yes, but no warnings. | no | track-statements |
| Xa Datasource Class | The datasource class for XA connections. | no | xa-datasource-class |
| Connection Property | no | connection-property | |
| No Tx Separate Pools | Whether to use separate pools for connections retrieved in a transaction and those retrieved outside a transaction. The default is Yes. | no | no-tx-separate-pools |
| Application Managed Security | no | application-managed-security | |
| Security Domain and Application | no | security-domain-and-application | |
| Track Connection By Tx | Whether the connection should be "locked" to the transaction, returning it to the pool at the end of the transaction. The default is No. | no | track-connection-by-tx |
| Is Same RM Override Value | Allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRM(XAResource) returns true or false. The default is not to override the return value. | no | isSameRM-override-value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.18. Metrics
| Name | Description |
|---|---|
| Flush | Resets the connection pool for this datasource. Performs the following steps: 1) all idle connections are immediately closed, 2) any in use connections are closed when the application finishes with them, and 3) new connections are created. |
Package Types
none
3.1.3. JBossAS - ConnectionFactory Service
Overview
Table 3.19. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.20.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this Connection Factory | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.21. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Available Connection Count | measurement | Number of available connections. | AvailableConnectionCount |
| Connection Count | measurement | Connection Count | ConnectionCount |
| Connection Created Count | measurement | Connection Created Count | ConnectionCreatedCount |
| Connection Destroyed Count | measurement | Connection Destroyed Count | ConnectionDestroyedCount |
| In Use Connection Count | measurement | Mumber of connections currently in use. | InUseConnectionCount |
| Max Connections In Use Count | measurement | Maximum number of maximum connections that have been in use. | MaxConnectionsInUseCount |
| Max Size | measurement | Max Size | MaxSize |
| Min Size | measurement | Min Size | MinSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.22.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connection Factory Type | Connection Factory Type (Tx or no Tx) | yes | type |
| JNDI Name | The JNDI Name under which the DataSource wrapper will be bound. | yes | jndi-name |
| User Name | This element specifies the default username used when creating a new connection. The actual username may be overridden by the application code getConnection parameters or the connection creation context JAAS Subject. | no | user-name |
| Password | This element specifies the default password used when creating a new connection. The actual password may be overridden by the application code getConnection parameters or the connection creation context JAAS Subject. | no | password |
| Minimum Pool Size | Indicates the minimum number of connections the pool should hold. | no | min-pool-size |
| Maximum Pool Size | Indicates the maximum number of connections the pool should hold. | no | max-pool-size |
| Application Managed Security | Specifying this element indicates that connections in the pool should be distinguished by application code supplied parameters, such as from getConnection(user, pw). This requires that you set a security domain which will populate a security-domain-and-application tag. If it is missing this resource will not be created or saved. | no | application-managed-security |
| Security Domain/Security Domain and Application | Indicates Subjects from security domain are used to distinguish connections in this pool. If Application Managed Security is set to true, then this will create a security-domain tag. If it is set to false or unset, then this property will populate a security-domain-and-application tag. | no | security-domain |
| Adapter Display Name | used to identify the RAR deployment matching the display-name in the ra.xml | no | adapter-display-name |
| Depends | The depends element specifies the JMX ObjectName string of a service that the connection manager services depend on. The connection manager service will not be started until the dependent services have been started. | no | depends |
| Rar Name | This is the name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar. | yes | rar-name |
| Connection Definition | This is the connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. | yes | connection-definition |
| Type Mappings | This element declares a default type mapping for this datasource. The type mapping should match a type-mapping/name element from standardjbosscmp-jdbc.xml. | no | type-mapping |
| Use Java Context | Indicates if the JNDI name should be prefixed with java:. | no | use-java-context |
| Transaction Type | Whether to use local or xa transactions. If nothing is specified, the default of local will be used. | no | transaction-type |
| No Tx Separate Pools | The presence of this element indicates that two connection pools are required to isolate connections used with JTA transaction from those used without a JTA transaction. The pools are lazily constructed on first use. Its use case is for Oracle (and possibly other vendors) XA implementations that don't like using an XA connection with and without a JTA transaction. | no | no-tx-separate-pools |
| Track Connection By Transaction | Whether the connection should be locked into the transaction. | no | track-connection-by-tx |
| isSameRM Override Value | Allows one to unconditionally set whether the javax.transaction.xa.XAResource.isSameRMXAResource returns true or false. The default is not to override the return value. | no | isSameRM-override-value |
| Use Strict Minimum | Whether on not to use strict minumum. | no | use-strict-min |
| Prefill | Prefill the Pool with Connection objects, or lazy load objects in the pool | no | prefill |
| Blocking Timeout in Milliseconds | 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. If nothing is specified the default of 30000 milliseconds is used. | no | blocking-timeout-millis |
| Idle Timeout | Maximum time in minutes a connection can be idle before it is closed. | no | idle-timeout-minutes |
| XA Resource Timeout | Maximum time in minutes an XA Resource can be idle before it is removed. | no | xa-resource-timeout |
| New Connection SQL | Specify an SQL statement to execute whenever a connection is added to the connection pool. | no | new-connection-sql |
| 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 |
| Config Property | Configuration Properties | no | config-property |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.1.4. JBossAS - JBossMQ Service
Overview
Table 3.23. Overview
| Description: | The JBossMQ subsystem |
| Singleton: | yes |
| Plugin: | JBossAS |
Child Resource Types
Connection Properties
Table 3.24.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.25. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| JMS Message Cache Hits | measurement | The number of cache hits to the JMS Message Cache | jboss.mq:service=MessageCache:CacheHits |
| JMS Message Cache Hits per Minute | measurement | The number of cache hits to the JMS Message Cache | jboss.mq:service=MessageCache:CacheHits |
| JMS Message Cache Misses | measurement | The number of cache misses to the JMS Message Cache | jboss.mq:service=MessageCache:CacheMisses |
| JMS Message Cache Misses per Minute | measurement | The number of cache misses to the JMS Message Cache | jboss.mq:service=MessageCache:CacheMisses |
| JMS Message Cache Current Memory Usage | measurement | The total memory currently in use by the JMS Message Cache | jboss.mq:service=MessageCache:CurrentMemoryUsage |
| JMS Message Cache High Memory Mark | measurement | The peak amount of memory the JMS Message Cache has actively used since server start | jboss.mq:service=MessageCache:HighMemoryMark |
| JMS Message Cache Max Memory Mark | measurement | The maximum amount of memory the JMS Message Cache is allowed to use | jboss.mq:service=MessageCache:MaxMemoryMark |
| JMS Message Cache Size | measurement | The number of messages currently in the JMS Message Cache | jboss.mq:service=MessageCache:TotalCacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.4.1. JBossAS - JMQ JMS Queue Service
Overview
Table 3.26. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.27.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this queue | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.28. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Messages in Queue | measurement | The number of undelivered messages in the queue. | QueueDepth |
| Receivers Count | measurement | The number of ClientConsumers waiting for a message. | ReceiversCount |
| Scheduled Message Count | measurement | The number of messages waiting to be scheduled | ScheduledMessageCount |
| In Process Message Count | measurement | The number of messages received by clients but not acknowledged (from AS 4.0.5) | InProcessMessageCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.29.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Destination Manager | The JMX object name of the destination manager configured for the server. | yes | DestinationManager |
| Security Manager | The JMX object name of the security manager that is being used to validate client requests. | no | SecurityManager |
| Expiry Destination | By default, JBossMQ silently removes expired JMS message from its destination. As of JBoss 4.0.4, expired messages can now be moved into a separate destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMQ destination. | no | ExpiryDestination |
| JNDI Name | The location in JNDI to which the queue object will be bound. If this is not set it will be bound under the queue context using the name of the queue. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples. | no | JNDIName |
| In Memory | Don't persist messages and avoid message softening when using the NullPersistenceManager | no | InMemory |
| Redelivery Limit | The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely) | no | RedeliveryLimit |
| Redelivery Delay | The length of time in milliseconds to wait before a message is redelivered after a nack | no | RedeliveryDelay |
| Message Counter History Day Limit | Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count. | no | MessageCounterHistoryDayLimit |
| Maximum Depth | The MaxDepth is an upper limit to the backlog of messages that can exist for a destination. If exceeded, attempts to add new messages will result in a org.jboss.mq.DestinationFullException. The MaxDepth can still be exceeded in a number of situations, e.g. when a message is placed back into the queue. Also transactions performing read committed processing, look at the current size of queue, ignoring any messages that may be added as a result of the current transaction or other transactions. This is because we don't want the transaction to fail during the commit phase when the message is physically added to the queue. | no | MaxDepth |
| Recovery Retries | Specifies the number of times uncommitted transactions are to be resolved before failing. Default 0 - zero (from JBoss-4.0.3). | no | RecoveryRetries |
| Security Configurations | This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. | yes | SecurityConf |
| Queue Name | Name of the queue to be used in the JMX object name. | yes | MBeanName |
| JNDI Binding | Binding path of this Queue in JNDI. | yes | JNDIBinding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.30. Metrics
| Name | Description |
|---|---|
| Remove All Messages | Clears all Messages in the Queue |
| Reset Message Counter | Clears the MessageCounter data for this Queue |
| Reset Message Counter History | Clears the MessageCounter history data for this Queue |
| List Messages by Selector | Lists the Messages in the Queue by Selector (if provided). Selector is not required. |
| List Scheduled Messages | Lists the Scheduled Messages by Selector (if provided). Selector is not required. |
| List In Process Messages | Lists the Messages in process by Selector (if provided). Selector is not required. |
Package Types
none
3.1.4.2. JBossAS - JMQ JMS Topic Service
Overview
Table 3.31. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.32.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this topic | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.33. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| All Message Counter | measurement | Returns the total message count for all subscriptions. | AllMessageCount |
| Durable Message Count | measurement | Total number of messages for all durable subscriptions. | DurableMessageCount |
| Non-durable Message Count | measurement | Total number of messages for all non-durable subscriptions. | NonDurableMessageCount |
| All Subscription Count | measurement | Number of subscriptions waiting for a message. | AllSubscriptionsCount |
| Durable Subscription Count | measurement | Number of durable subscriptions waiting for a message. | DurableSubscriptionsCount |
| Non-durable Subscription Count | measurement | Number of non-durable subscriptions waiting for a message. | NonDurableSubscriptionsCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.34.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Destination Manager | The JMX object name of the destination manager configured for the server. | yes | DestinationManager |
| Security Manager | The JMX object name of the security manager that is being used to validate client requests. | no | SecurityManager |
| Expiry Destination | By default, JBossMQ silently removes expired JMS message from its destination. As of JBoss 4.0.4, expired messages can now be moved into a separate destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMQ destination. | no | ExpiryDestination |
| JNDI Name | The location in JNDI to which the topic will be bound. If this is not set it will be bound under the topic context using the mbean name of the topic. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples. | no | JNDIName |
| In Memory | Don't persist messages and avoid message softening when using the NullPersistenceManager. | no | InMemory |
| Redelivery Limit | The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely). | no | RedeliveryLimit |
| Redelivery Delay | The length of time in milliseconds to wait before a message is redelivered after a nack. | no | RedeliveryDelay |
| Message Counter History Day Limit | Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count. | no | MessageCounterHistoryDayLimit |
| Maximum Depth | The MaxDepth is an upper limit to the backlog of messages that can exist for a destination. If exceeded, attempts to add new messages will result in a org.jboss.mq.DestinationFullException. The MaxDepth can still be exceeded in a number of situations, e.g. when a message is placed back into the queue. Also transactions performing read committed processing, look at the current size of queue, ignoring any messages that may be added as a result of the current transaction or other transactions. This is because we don't want the transaction to fail during the commit phase when the message is physically added to the queue. | no | MaxDepth |
| Recovery Retries | Specifies the number of times uncommitted transactions are to be resolved before failing. Default 0 - zero (from JBoss-4.0.3). | no | RecoveryRetries |
| Security Configurations | This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. | yes | SecurityConf |
| Topic Name | Name of the queue to be used as the JMX object name. | yes | MBeanName |
| JNDI Binding | Binding path of this Topic in JNDI. | yes | JNDIBinding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.35. Metrics
| Name | Description |
|---|---|
| Remove All Messages | Clears all Subscriptions |
| List All Subscriptions | Lists all the Subscriptions. |
| List Durable Subscriptions | Lists all the durable subscriptions. |
| List Non-durable Subscriptions | Lists all the non-durable subscriptions. |
| Reset Message Counter | Clears the message counter data for all topic subscriptions. |
| Reset Message Counter History | Clears the message counter history data for this topic. |
| List Messages by ID and Selector | List the messages for a subscription by ID and with an optional selector. |
| Get Non-durable Message Count | Gets the message count for non-durable messages by client ID and subscription ID. |
| List Non-durable Messages | Lists the non-durable messages by client ID, subscription ID, and an optional selector. |
| Get Durable Message Count | Gets the message count for durable messages by client ID and subscription ID. |
| List Durable Messages | Lists the durable messages by client ID, subscription ID, and an optional selector. |
| Get Non-durable Scheduled Message Count | Gets the message count for non-durable scheduled messages by client ID and subscription ID. |
| List Non-durable Scheduled Messages | Lists the non-durable scheduled messages by client ID, subscription ID, and an optional selector. |
| Get Durable Scheduled Message Count | Gets the message count for durable scheduled messages by client ID and subscription ID. |
| List Durable Scheduled Messages | Lists the durable scheduled messages by client ID, subscription ID, and an optional selector. |
| Get Non-durable In-process Message Count | Gets the message count for non-durable in-process messages by client Id and subscription Id |
| List Non-durable In-process Messages | Lists the non-durable in-process messages by client ID, subscription ID, and an optional selector. |
| Get Durable In-process Message Count | Gets the message count for durable in-process messages by client ID and subscription Id |
| List Durable In-process Messages | Lists the durable in-process messages by client ID, subscription ID, and an optional selector. |
Package Types
none
3.1.5. JBossAS - JBossMessaging Service
Overview
Table 3.36. Overview
| Description: | The JBoss Messaging subsystem |
| Singleton: | yes |
| Plugin: | JBossAS |
Child Resource Types
Connection Properties
Table 3.37.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.38. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Version of the Provider | trait | The version of JBoss Messaging in use | jboss.messaging:service=ServerPeer:ProviderVersion |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.5.1. JBossAS - JBM JMS Queue Service
Overview
Table 3.39. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.40.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this queue | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.41. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Messages in Queue | measurement | The number of messages in the queue. | MessageCount |
| Consumer Count | measurement | The number of ClientConsumers waiting for a message. | ConsumerCount |
| Scheduled Message Count | measurement | The number of scheduled messages in the Queue | ScheduledMessageCount |
| Created programmatically | trait | Was this Queue created dynamically | CreatedProgrammatically |
| Delivering Count | measurement | The number of messages currently being delivered | DeliveringCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.42.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Server Peer | The ObjectName of the server peer this destination was deployed on. | yes | ServerPeer |
| Dead Letter Queue | The DLQ for this queue, overrides the default DLQ on the server peer. | no | DLQ |
| Expiry Queue | By default, JBoss Messaging silently removes expired JMS message from its destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMessaging destination. | no | ExpiryQueue |
| JNDI Name | The location in JNDI to which the queue object will be bound. If this is not set it will be bound under the queue context using the name of the queue. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples. | no | JNDIName |
| Clustered | Is this a clustered destination? | no | Clustered |
| Max Delivery Attempts | The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely) | no | MaxDeliveryAttempts |
| Redelivery Delay | The length of time in milliseconds to wait before a message is redelivered after a nack | no | RedeliveryDelay |
| Message Counter History Day Limit | Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count. | no | MessageCounterHistoryDayLimit |
| Maximum Queue Size | The maximum number of messages this queue can hold before they are dropped (-1 = infinite) | no | MaxSize |
| Full Size | The in-memory message limit, can only be set when queue is stopped | no | FullSize |
| Page Size | The paging size, can only be set when queue is stopped | no | PageSize |
| Down Cache Size | The write-cache size, can only be set when queue is stopped | no | DownCacheSize |
| Security Configurations | This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. | yes | SecurityConfig |
| Queue Name | Name of the queue to be used in the JMX object name. | yes | MBeanName |
| JNDI Binding | Binding path of this Queue in JNDI. | yes | JNDIBinding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.43. Metrics
| Name | Description |
|---|---|
| Remove All Messages | Clears all Messages in the Queue |
| Reset Message Counter | Clears the MessageCounter data for this Queue |
| Reset Message Counter History | Clears the MessageCounter history data for this Queue |
| List Messages by Selector | Lists the Messages in the Queue by Selector (if provided). Selector is not required. |
| List All Messages | Lists All Messages by Selector (if provided). Selector is not required. |
| List Durable Messages | Lists Durable Messages by Selector (if provided). Selector is not required. |
| List Non-Durable Messages | Lists Non-Durable Messages by Selector (if provided). Selector is not required. |
Package Types
none
3.1.5.2. JBossAS - JBM JMS Topic Service
Overview
Table 3.44. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.45.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this topic | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.46. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| All Message Counter | measurement | Returns the total message count for all subscriptions. | AllMessageCount |
| Durable Message Count | measurement | Total number of messages for all durable subscriptions. | DurableMessageCount |
| Non-durable Message Count | measurement | Total number of messages for all non-durable subscriptions. | NonDurableMessageCount |
| All Subscription Count | measurement | Number of subscriptions waiting for a message. | AllSubscriptionsCount |
| Durable Subscription Count | measurement | Number of durable subscriptions waiting for a message. | DurableSubscriptionsCount |
| Non-durable Subscription Count | measurement | Number of non-durable subscriptions waiting for a message. | NonDurableSubscriptionsCount |
| Created programmatically | trait | Was this Topic created dynamically | CreatedProgrammatically |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.47.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Server Peer | The ObjectName of the server peer this destination was deployed on. | yes | ServerPeer |
| Dead Letter Queue | The DLQ for this queue, overrides the default DLQ on the server peer. | no | DLQ |
| Expiry Queue | By default, JBoss Messaging silently removes expired JMS message from its destination. ExpiryDestination indicates the javax.management.ObjectName of the expiry destination. This destination must be located on the same server and be a JBossMessaging destination. | no | ExpiryQueue |
| JNDI Name | The location in JNDI to which the topic will be bound. If this is not set it will be bound under the topic context using the mbean name of the topic. This property is optional, in most cases the mbean name is used for binding purpose. See {server-config}/deploy/jms/jbossmq-destinations-service.xml for examples. | no | JNDIName |
| Clustered | Is this a clustered destination? | no | Clustered |
| Max Delivery Attempts | The maximum times a message is nacked before a message is sent to the Dead Letter Queue (0 - don't redeliver, n - redeliver n times, -1 - continue redelivering indefinitely) | no | MaxDeliveryAttempts |
| Redelivery Delay | The length of time in milliseconds to wait before a message is redelivered after a NACK | no | RedeliveryDelay |
| Message Counter History Day Limit | Sets the destination message counter history day limit with a value less than 0 indicating unlimited history, a 0 value disabling history and a value greater than 0 giving the history days count. | no | MessageCounterHistoryDayLimit |
| Maximum Queue Size | The maximum number of messages this queue can hold before they are dropped (-1 = infinite) | no | MaxSize |
| Full Size | The in-memory message limit, can only be set when queue is stopped | no | FullSize |
| Page Size | The paging size, can only be set when queue is stopped | no | PageSize |
| Down Cache Size | The write-cache size, can only be set when queue is stopped | no | DownCacheSize |
| Security Configurations | This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. | yes | SecurityConfig |
| Topic Name | Name of the queue to be used in the JMX object name. | yes | MBeanName |
| JNDI Binding | Binding path of this Topic in JNDI. | yes | JNDIBinding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.48. Metrics
| Name | Description |
|---|---|
| Remove All Messages | Clears all Subscriptions |
| List All Subscriptions | Lists all the Subscriptions. |
| List Durable Subscriptions | Lists all the durable subscriptions. |
| List Non-durable Subscriptions | Lists all the non-durable subscriptions. |
| List Messages by ID and Selector | List the messages for a subscription by ID and with an optional selector. |
| List Non-durable Messages | Lists the non-durable messages by subscription ID and an optional selector. |
| List Durable Messages | Lists the durable messages by subscription ID and an optional selector. |
Package Types
none
3.1.6. JBossAS - EJB3 Session Bean Service
Overview
Table 3.49. Overview
| Description: | An EJB3 Stateless or Stateful Session Bean |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.50.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this bean | yes | name |
| Ear | yes | ear | |
| Jar | yes | jar |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.51. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Current Count | measurement | The total number of currently pooled instances of this EJB3 Session Bean | CurrentSize |
| Create Count | measurement | The number of instances of this EJB3 Session Bean that have been created since server start | CreateCount |
| Create Count per Minute | measurement | The number of instances of this EJB3 Session Bean that have been created since server start | CreateCount |
| Remove Count | measurement | The number of instances of this EJB3 Session Bean that have been removed since server start | RemoveCount |
| Remove Count per Minute | measurement | The number of instances of this EJB3 Session Bean that have been removed since server start | RemoveCount |
| Available Count | measurement | The number of pooled instances of this EJB3 Session Bean in the method-ready state | AvailableCount |
| Max Size | measurement | The maximum number of instances that are allowed to be pooled | MaxSize |
| Method Invocation Time | calltime | The minimum, maximum, and average invocation times for each of the methods exposed by this EJB; NOTE: this metric is only available if JBoss EJB3 RC9 Patch 1 or later is being used (a capable version of EJB3 is included with JBossAS 4.2.0.GA or later) | MethodInvocationTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.52. Metrics
| Name | Description |
|---|---|
| View Method Stats | View method execution statistics for the EJB; NOTE: this operation is only available if JBoss EJB3 RC9 Patch 1 or later is being used (a capable version of EJB3 is included with JBossAS 4.2.0.GA or later) |
Package Types
none
3.1.7. JBossAS - Stateless Session EJB Service
Overview
Table 3.53. Overview
| Description: | An EJB 1.x or 2.x Stateless Session Bean |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.54.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this ejb | yes | name |
| J 2ee Application | yes | j2eeApplication | |
| Ejb Jar | yes | ejbJar |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.55. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Create Calls | measurement | The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been created since server start | {stats.createCount.count} |
| Create Calls per Minute | measurement | The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been created since server start | {stats.createCount.count} |
| Remove Calls | measurement | The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been removed since server start | {stats.removeCount.count} |
| Remove Calls per Minute | measurement | The number of instances of this EJB 1.x or 2.x Stateless Session Bean that have been removed since server start | {stats.removeCount.count} |
| Method-Ready Beans | measurement | The number of pooled instances of this EJB 1.x or 2.x Stateless Session Bean in the method-ready state | {stats.methodReadyCount.current} |
| Pool Size | measurement | The total number of currently pooled instances of this EJB 1.x or 2.x Stateless Session Bean | {{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}CurrentSize} |
| Max Pool Size | measurement | The maximum number of instances that are allowed to be pooled | {{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}MaxSize} |
| Method Invocation Time | calltime | the minimum, maximum, and average invocation times for each of the methods exposed by this EJB | MethodInvocationTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.8. JBossAS - Stateful Session EJB Service
Overview
Table 3.56. Overview
| Description: | An EJB 1.x or 2.x Stateful Session Bean |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.57.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this EJB | yes | name |
| J 2ee Application | yes | j2eeApplication | |
| Ejb Jar | yes | ejbJar |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.58. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Create Calls | measurement | The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been created since server start | {stats.createCount.count} |
| Create Calls per Minute | measurement | The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been created since server start | {stats.createCount.count} |
| Remove Calls | measurement | The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been removed since server start | {stats.removeCount.count} |
| Remove Calls per Minute | measurement | The number of instances of this EJB 1.x or 2.x Stateful Session Bean that have been removed since server start | {stats.removeCount.count} |
| Method-Ready Beans | measurement | The number of pooled instances of this EJB 1.x or 2.x Stateful Session Bean in the method-ready state | {stats.methodReadyCount.current} |
| Passive Beans | measurement | The number of pooled instances of this EJB 1.x or 2.x Stateful Session Bean in the passivated state | {stats.passiveCount.current} |
| Method Invocation Time | calltime | the minimum, maximum, and average invocation times for each of the methods exposed by this EJB | MethodInvocationTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.9. JBossAS - Entity EJB Service
Overview
Table 3.59. Overview
| Description: | An EJB 1.x or 2.x Entity Bean |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.60.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this ejb | yes | name |
| J 2ee Application | yes | j2eeApplication | |
| Ejb Jar | yes | ejbJar |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.61. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Create Calls | measurement | The number of instances of this EJB 1.x or 2.x Entity Bean that have been created since server start | {stats.createCount.count} |
| Create Calls per Minute | measurement | The number of instances of this EJB 1.x or 2.x Entity Bean that have been created since server start | {stats.createCount.count} |
| Remove Calls | measurement | The number of instances of this EJB 1.x or 2.x Entity Bean that have been removed since server start | {stats.removeCount.count} |
| Remove Calls per Minute | measurement | The number of instances of this EJB 1.x or 2.x Entity Bean that have been removed since server start | {stats.removeCount.count} |
| Method-Ready Beans | measurement | The number of pooled instances of this EJB 1.x or 2.x Entity Bean in the method-ready state | {stats.methodReadyCount.current} |
| Pooled Beans | measurement | The total number of currently pooled instances of this EJB 1.x or 2.x Entity Bean | {stats.pooledCount.current} |
| Cache Size | measurement | The total number of currently cached instances of this EJB 1.x or 2.x Entity Bean | {{jboss.j2ee:jndiName=%name%,plugin=cache,service=EJB}CacheSize} |
| Passivated Count | measurement | The number of pooled instances of this EJB 1.x or 2.x Entity Bean in the passivated state | {{jboss.j2ee:jndiName=%name%,plugin=cache,service=EJB}PassivatedCount} |
| Passivated Count per Minute | measurement | The number of pooled instances of this EJB 1.x or 2.x Entity Bean in the passivated state | {{jboss.j2ee:jndiName=%name%,plugin=cache,service=EJB}PassivatedCount} |
| Current Size | measurement | The total number of currently pooled instances of this EJB 1.x or 2.x Entity Bean | {{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}PoolSize} |
| Max Size | measurement | The maximum number of instances that are allowed to be pooled | {{jboss.j2ee:jndiName=%name%,plugin=pool,service=EJB}MaxPoolSize} |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.10. JBossAS - Message Driven EJB Service
Overview
Table 3.62. Overview
| Description: | An EJB 1.x or 2.x Message Driven Bean |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.63.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The name of this ejb | yes | name |
| J 2ee Application | yes | j2eeApplication | |
| Ejb Jar | yes | ejbJar |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.64. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Create Calls | measurement | The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been created since server start | {stats.createCount.count} |
| Create Calls per Minute | measurement | The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been created since server start | {stats.createCount.count} |
| Remove Calls | measurement | The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been removed since server start | {stats.removeCount.count} |
| Remove Calls per Minute | measurement | The number of instances of this EJB 1.x or 2.x Message Driven Bean that have been removed since server start | {stats.removeCount.count} |
| Method-Ready Beans | measurement | The number of pooled instances of this EJB 1.x or 2.x Message Driven Bean in the method-ready state | {stats.messageCount.count} |
| Method-Ready Beans per Minute | measurement | The number of pooled instances of this EJB 1.x or 2.x Message Driven Bean in the method-ready state | {stats.messageCount.count} |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.11. JBossAS - Enterprise Application (EAR) Service
Overview
Table 3.65. Overview
| Description: | Enterprise Application |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
Connection Properties
Table 3.66.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of this EAR | yes | name |
| Filename | yes | filename | |
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.67. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Path | trait | The absolute path of this EAR file or directory | Application.path |
| Exploded? | trait | Whether this EAR is deployed exploded (i.e. as a directory) | Application.exploded |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.68. Metrics
| Name | Description |
|---|---|
| Revert | Tries to revert this enterprise application from a saved backup in the same directory and with a name ending in .bak |
Package Types
Table 3.69. Package Types
| Name | Category | Description |
|---|---|---|
| EAR File | Deployable |
3.1.11.1. JBossAS - Embedded Web Application (WAR) Service
Overview
Table 3.70. Overview
| Description: | Web Application embedded inside of an Enterprise Application |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.71.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of this WAR | yes | name |
| Filename | yes | filename | |
| Object Name | yes | objectName | |
| Context Root | this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR | no | contextRoot |
| Virtual Host | The (virtual) host that this application is running on. If no virtual host is set, this defaults to 'localhost' | no | vHost |
| Jboss Web Name | the objectName for the jboss.web WebModule that will be used to fire operations | no | jbossWebName |
| 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 |
| Name Template | yes | nameTemplate | |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.72. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Path | trait | the absolute path of this WAR file or directory | Application.path |
| Exploded? | trait | whether this WAR is deployed exploded (i.e. as a directory) | Application.exploded |
| Context Root | trait | this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR | ContextRoot |
| HTTP Response Time | calltime | the minimum, maximum, and average response times for HTTP requests serviced by this webapp | ResponseTime |
| Min. Servlet Resp. Time | measurement | Minimum response time of a servlet | Servlet.MinResponseTime |
| Avg. Servlet Resp. Time | measurement | Average response time of a servlet | Servlet.AvgResponseTime |
| Max. Servlet Resp. Time | measurement | Maximum response time of a servlet | Servlet.MaxResponseTime |
| Total processing time | measurement | Total processing time of the webapp | Servlet.TotalTime |
| Total processing time per Minute | measurement | Total processing time of the webapp | Servlet.TotalTime |
| Requests served | measurement | Number of requests served by servlets | Servlet.NumRequests |
| Requests served per Minute | measurement | Number of requests served by servlets | Servlet.NumRequests |
| Errors while processing | measurement | Number of errors while processing | Servlet.NumErrors |
| Errors while processing per Minute | measurement | Number of errors while processing | Servlet.NumErrors |
| Currently Active Sessions | measurement | Number active sessions for the webapp right now | Session.activeSessions |
| Maximum number of Active Sessions | measurement | Maximum number of active sessions for the webapp | Session.maxActive |
| Sessions created | measurement | Number of sessions created for the webapp | Session.sessionCounter |
| Sessions created per Minute | measurement | Number of sessions created for the webapp | Session.sessionCounter |
| Expired Sessions | measurement | Number of expired sessions for the webapp | Session.expiredSessions |
| Expired Sessions per Minute | measurement | Number of expired sessions for the webapp | Session.expiredSessions |
| Rejected Sessions | measurement | Number of sessions rejected for the webapp | Session.rejectedSessions |
| Rejected Sessions per Minute | measurement | Number of sessions rejected for the webapp | Session.rejectedSessions |
| Session Average alive time | measurement | Average alive time of a Sessions | Session.sessionAverageAliveTime |
| Max Session alive time | measurement | Maximum alive time of a Sessions | Session.sessionMaxAliveTime |
| Vhost | trait | Virtual hosts this app runs on | Vhost.name |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.73. Metrics
| Name | Description |
|---|---|
| Start | starts this webapp; NOTE: this operation is *not* supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006) |
| Stop | stops this webapp; NOTE: this operation is *not* supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006) |
| Reload | reloads this webapp; NOTE: if the webapp is not in the started state, this operation will fail |
Package Types
none
3.1.12. JBossAS - Web Application (WAR) Service
Overview
Table 3.74. Overview
| Description: | Web Application |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.75.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of this WAR | yes | name |
| Filename | yes | filename | |
| Object Name | yes | objectName | |
| Context Root | this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR | no | contextRoot |
| Virtual Host | The (virtual) host that this application is running on. If no virtual host is set, this defaults to 'localhost' | no | vHost |
| Jboss Web Name | the objectName for the jboss.web WebModule that will be used to fire operations | no | jbossWebName |
| Response Time Log File | the full path to the log file containing response-time stats for this webapp. The location is determined by the RtFilter and is usually something like ...server/.../log/rt/appname_rt.log | 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 |
| Name Template | yes | nameTemplate | |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.76. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Path | trait | the absolute path of this WAR file or directory | Application.path |
| Exploded? | trait | whether this WAR is deployed exploded (i.e. as a directory) | Application.exploded |
| Context Root | trait | this WAR's context root - used as a unique path prefix for URLs corresponding to this WAR | ContextRoot |
| HTTP Response Time | calltime | the minimum, maximum, and average response times for HTTP requests serviced by this webapp | ResponseTime |
| Min. Servlet Resp. Time | measurement | Minimum response time of a servlet | Servlet.MinResponseTime |
| Avg. Servlet Resp. Time | measurement | Average response time of a servlet | Servlet.AvgResponseTime |
| Max. Servlet Resp. Time | measurement | Maximum response time of a servlet | Servlet.MaxResponseTime |
| Total processing time | measurement | Total processing time of the webapp | Servlet.TotalTime |
| Total processing time per Minute | measurement | Total processing time of the webapp | Servlet.TotalTime |
| Requests served | measurement | Number of requests served by servlets | Servlet.NumRequests |
| Requests served per Minute | measurement | Number of requests served by servlets | Servlet.NumRequests |
| Errors while processing | measurement | Number of errors while processing | Servlet.NumErrors |
| Errors while processing per Minute | measurement | Number of errors while processing | Servlet.NumErrors |
| Currently Active Sessions | measurement | Number active sessions for the webapp right now | Session.activeSessions |
| Maximum number of Active Sessions | measurement | Maximum number of active sessions for the webapp | Session.maxActive |
| Sessions created | measurement | Number of sessions created for the webapp | Session.sessionCounter |
| Sessions created per Minute | measurement | Number of sessions created for the webapp | Session.sessionCounter |
| Expired Sessions | measurement | Number of expired sessions for the webapp | Session.expiredSessions |
| Expired Sessions per Minute | measurement | Number of expired sessions for the webapp | Session.expiredSessions |
| Rejected Sessions | measurement | Number of sessions rejected for the webapp | Session.rejectedSessions |
| Rejected Sessions per Minute | measurement | Number of sessions rejected for the webapp | Session.rejectedSessions |
| Session Average alive time | measurement | Average alive time of a Sessions | Session.sessionAverageAliveTime |
| Max Session alive time | measurement | Maximum alive time of a Sessions | Session.sessionMaxAliveTime |
| Vhost | trait | Virtual hosts this app runs on | Vhost.name |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.77. Metrics
| Name | Description |
|---|---|
| Start | starts this webapp; NOTE: this operation is *not* supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006) |
| Stop | stops this webapp; NOTE: this operation is *not* supported for JBossAS versions prior to 4.0.4.GA (see http://jira.jboss.org/jira/browse/JBAS-3006) |
| Reload | reloads this webapp; NOTE: if the webapp is not in the started state, this operation will fail |
| Revert | Tries to revert this web application from a saved backup in the same directory and with a name ending in .bak |
Package Types
Table 3.78. Package Types
| Name | Category | Description |
|---|---|---|
| WAR File | Deployable |
3.1.13. JBossAS - EJB3 Entity Tree Cache Service
Overview
Table 3.79. Overview
| Description: | The entity cache |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
Connection Properties
Table 3.80.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.81. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number Of Locks Held | measurement | The number of entities locked for update / replication across the (clustered) tree cache | NumberOfLocksHeld |
| Number Of Nodes | measurement | The total number of entities currently cached across the (clustered) tree cache | NumberOfNodes |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.13.1. JBossAS - EJB3 Entity Tree Cache Interceptor Service
Overview
Table 3.82. Overview
| Description: | The entity cache interceptor |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.83.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.84. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Hit Miss Ratio | measurement | Returns the hit/miss ratio for the cache. This ratio is defined as hits/(hits + misses). | HitMissRatio |
| Read Write Ratio | measurement | Returns the read/write ratio for the cache. This ratio is defined as (hits + misses)/stores. | ReadWriteRatio |
| Hits | measurement | Returns the number of requests made to this cache which it could answer without interrogating the underlying data store | Hits |
| Misses | measurement | Returns the number of requests made to this cache which required interrogating the underlying data store | Misses |
| Evictions | measurement | Returns the number of elements purged from this cache in accordance with its specific eviction policy | Evictions |
| Number Of Locks Held | measurement | The number of elements locked by this interceptor for update / replication across the (clustered) tree cache | NumberOfLocksHeld |
| Number Of Nodes | measurement | The total number of entities currently cached across the (clustered) tree cache | NumberOfNodes |
| Average Write Time | measurement | The average time it takes to insert or update elements for the cache | AverageWriteTime |
| Time Since Reset | measurement | The amount of time since this cache was reset / cleared | TimeSinceReset |
| Average Read Time | measurement | The average time it takes to read elements for the cache, includes | AverageReadTime |
| Stores | measurement | Number of store / writes into this cache made by this interceptor | Stores |
| Number Of Attributes | measurement | The total number of attributes (properties of an entity) currently cached across the (clustered) tree cache | NumberOfAttributes |
| Elapsed Time | measurement | The amount of time since this cache was created | ElapsedTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.1.14. JBossAS - Script Service
Overview
Table 3.85. Overview
| Description: | provides the ability to execute a script that performs some task related to its parent JBossAS server |
| Singleton: | no |
| Plugin: | JBossAS |
Child Resource Types
none
Connection Properties
Table 3.86.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | the absolute path to the script file | yes | path |
| Environment Variables | the environment variables that will be passed to the script; each variable must be on a new line and have the syntax name=value; the variable's value can contain properties with the syntax %propertyName%; the script plugin will interpolate these with the current values of the corresponding properties from the script's parent JBossAS server's connection properties | no | environmentVariables |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.87. Metrics
| Name | Description |
|---|---|
| Execute Script | execute the script; NOTE: environment variables to be passed to the script can be configured via this Script service's connection properties (under its Inventory>Connection tab) |
Package Types
none
3.2. JBoss AS 5 and EAP 5 Server
Overview
Table 3.88. Overview
| Description: | JBoss Application Server (AS) 5.x or 6.x instance and Enterprise Application Platform (EAP), Enterprise SOA Platform (SOA-P), or Enterprise Web Platform (EWP) 5.x instances. |
| Singleton: | no |
| Plugin: | JBossAS5 |
Note
The server can be started, restarted, or stopped via the Start, Restart, and Shutdown operations. The Start and Restart operations start the server by executing the server start script, typically run.sh on UNIX or run.bat on Windows. The following connection settings can be used to configure the start script execution:
- Start Script - the absolute path of the start script (e.g. "/opt/jboss-eap-5.0/bin/run.sh")
- Start Script Prefix - a prefix command line to be prepended to the start script command line (e.g. "nohup sudo -u jboss -g jboss")
- Start Script Arguments - arguments to be passed to the start script (e.g. "--configuration=production")
- Start Script Environment - environment variables to be set in the start script's environment (e.g. "JAVA_HOME=/usr/java/jdk1.6.0_30")
These settings are automatically initialized by the JBossAS5 plugin discovery code to match the currently running server process' command line and environment.
The settings are not used by the Stop operation, since it stops the server via the management interface, not via a script.
For more detailed descriptions of the settings, see the Connection Settings section below.
Child Resource Types
Autodiscovery Process Scans
Table 3.89. Metrics
| Name | Query |
|---|---|
| jbossas | process|basename|match=^java.*,arg|org.jboss.Main|match=.* |
Connection Properties
Table 3.90.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Naming Provider URL | The JBoss Naming Provider (JNP) URL with which to connect to the JBoss AS or EAP instance (e.g. jnp://127.0.0.1:1099). | yes | namingURL |
| Principal | The name of the principal (i.e. user) to authenticate. | no | principal |
| Credentials | The credentials (i.e. password) that should be used to authenticate the principal. | no | credentials |
| JBoss Home Directory | The absolute path to the directory where JBoss AS or EAP is installed (e.g. /opt/jboss-5.1.0.GA). | yes | homeDir |
| Server Home Dir | The path to the configuration directory under which this instance operates (e.g. /opt/jboss-5.2.0.GA/server/default); if the path is not absolute, then it will be resolved relative to {homeDir}. | yes | serverHomeDir |
| Server Name | The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {serverHomeDir}. If the 'startScriptArgs' property is not set, this property will be used by the Start and Restart operations as the value of the -c option that is passed to the start script. However, this property is deprecated for that purpose and 'startScriptArgs' should be used instead. | no | serverName |
| Client Url | The URL of the server's client JAR library directory; if not specified, it will default to {homeDir}/client. | no | clientUrl |
| Lib Url | The URL of the server's main JAR library directory; if not specified, it will default to {homeDir}/lib. | no | libUrl |
| Common Lib Url | The URL of the server's common JAR library directory; if not specified, it will default to {homeDir}/common/lib. | no | commonLibUrl |
| Script Prefix | A prefix applied to script execution commands; this prefix is applied verbatim. The full path of the executable is required (e.g. /usr/bin/sudo). For applicable platforms, this is typically a sudo command, so a sudo user must be configured appropriately for the specified command. Ignored if not set. | no | scriptPrefix |
| Start Script | The path to the script used by the 'Start' operation to start this JBossAS server (e.g. /opt/jboss-5.2.0.GA/bin/run.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/run.sh' on UNIX or 'bin\run.bat' on Windows. | no | startScript |
| 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 default. There is currently a 2000 character limit for this value. | no | startScriptArgs |
| Shutdown Script | The path to the script used by the Shut Down operation to shut down this JBossAS server (e.g. /opt/jboss-5.2.0.GA/bin/shutdown.sh); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}; defaults to 'bin/shutdown.sh' on UNIX or 'bin\shutdown.bat' on Windows. | no | shutdownScript |
| Shutdown Method | The method used to execute the Shut Down operation; defaults to 'JMX MBean'. 'JMX MBean' is the preferred shutdown method and should be used unless there is a specific use case for using a script. | no | shutdownMethod |
| Bind Address | The host or IP address that all application server services should listen on (e.g. 10.11.14.233 or foo.example.com); specify 0.0.0.0 to tell the application server to bind to all available network interfaces; defaults to '127.0.0.1'. If the 'startScriptArgs' property is not set, this property will be used by the Start and Restart operations as the value of the -b option that is passed to the start script. However, this property is deprecated for that purpose and 'startScriptArgs' should be used instead. | no | bindAddress |
| Java Home | The absolute path to a JRE or JDK installation directory containing the JVM that should be used by the operations that start and/or shut down this JBoss AS server; for the Shutdown operation to work when the shutdown method is set to 'shutdown script', the property must be set. For the Start operation, this property is deprecated and will be ignored if the 'startScriptEnv' property is set. | no | javaHome |
| Start Wait Max | The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to start up. The default is 5 minutes. | no | startWaitMax |
| Stop Wait Max | The time, in minutes,(e.g. 1 or 8) that must elapse before the server is considered to have failed to stop. The default is 2.5 minutes. | no | stopWaitMax |
| Shutdown MBean Name | Name of the MBean to use when shutting down this server through JMX. | yes | shutdownMBeanName |
| Shutdown MBean Operation | Name of the operation to invoke when shutting down this server through JMX. Note that only operations with no parameter or with one int parameter are supported. If the operation requires an int parameter, '0' will be supplied. | yes | shutdownMBeanOperation |
| Availability Check Period | The amount of time, in seconds, that must elapse between availability checks to see if the server is up. If set, the availability checks will be performed asynchronously thus allowing slow-responding servers to avoid being falsely reported as down. | no | availabilityCheckPeriod |
| Service Availability Refresh Interval | The amount of time, in minutes, that can elapse for service resource (e.g., EJBs, data sources) availability checks without having to refresh the managed object from the JBoss server. The information used to perform availability checks is cached. This property determines how frequently that data needs to be reloaded from the JBoss server. Any time the managed object is loaded from the server, like for collecting metrics, the availability information is updated and the interval is reset. | no | serviceAvailabilityRefreshInterval |
| JBoss AS JVM Name | The name of the JBoss AS JVM resource. | no | childJmxServerName |
| Log Event Sources | yes | logEventSources |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.91. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Cluster Partition Name | trait | the name of the cluster partition this server belongs to | MCBean|ServerConfig|*|partitionName |
| Server Name | trait | the name of the active profile (i.e. configuration set) this server is using | MCBean|ServerConfig|*|serverName |
| Server Home Dir | trait | the full path of the configuration set directory this server is using (e.g. /opt/jboss-5.1.0.CR1/server/default) | MCBean|ServerConfig|*|serverHomeDir |
| Version Name | trait | the code name for this app server's version (AS 5.0 = Morpheus, AS 5.1 = The Oracle, AS 6.x = Neo) | MCBean|MCServer|*|versionName |
| Build Date | trait | the date this app server was built | MCBean|MCServer|*|buildDate |
| Start Date | trait | the date and time this app server instance was started | MCBean|MCServer|*|startDate |
| Active Thread Count | measurement | The current number of active threads for this app server instance | MCBean|ServerInfo|*|activeThreadCount |
| Active Thread Group Count | measurement | The current number of active thread groups for this app server instance | MCBean|ServerInfo|*|activeThreadGroupCount |
| JVM Free Memory | measurement | An approximation of the total amount of memory currently available in the app server JVM for future allocated objects, measured in bytes | MCBean|ServerInfo|*|freeMemory |
| JVM Max Memory | measurement | The maximum amount of memory that the app server JVM will attempt to use, measured in bytes; if there is no inherent limit then the value Long.MAX_VALUE will be returned | MCBean|ServerInfo|*|maxMemory |
| JVM Total Memory | measurement | The total amount of memory currently available in the app server JVM for current and future objects, measured in bytes | MCBean|ServerInfo|*|totalMemory |
| Total Transactions | measurement | Total number of transactions since last restart | MCBean|JTA|*|transactionCount |
| Total Transactions per Minute | measurement | Total number of transactions since last restart | MCBean|JTA|*|transactionCount |
| Transactions Committed | measurement | Number of transactions committed since last restart | MCBean|JTA|*|commitCount |
| Transactions Committed per Minute | measurement | Number of transactions committed since last restart | MCBean|JTA|*|commitCount |
| Transactions Rolled Back | measurement | Number of transactions rolled back since last restart | MCBean|JTA|*|rollbackCount |
| Transactions Rolled Back per Minute | measurement | Number of transactions rolled back since last restart | MCBean|JTA|*|rollbackCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.92. Metrics
| Name | Description |
|---|---|
| Start | Start this application server. The script used is specified in the Operations group of connection properties. This operation will fail if the server is already started. |
| Shut Down | Shut down this application server via script or JMX, depending on the settings in the Operations and Advanced groups of connection properties. This operation will fail if the server is already shut down. |
| Restart | Shut down (if started) and then start this application server. |
Package Types
Table 3.93. Package Types
| Name | Category | Description |
|---|---|---|
| Cumulative Patch | Deployable | Automatically installable application server patches |
| JAR Library | Deployable | Library Jar files deployed in JBoss AS |
3.2.1. JBossAS5 - JBoss Web Service
Overview
Table 3.94. Overview
| Description: | JBoss Web Servlet Container |
| Singleton: | yes |
| Plugin: | JBossAS5 |
Child Resource Types
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.2.1.1. JBossAS5 - Connector Service
Overview
Table 3.95. Overview
| Description: | a JBoss Web Connector |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.96.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Protocol | this connector's protocol (e.g. jk, ajp, http) | yes | protocol |
| Address | the IP address this connector listens on | yes | address |
| Port | the port this connector listens on | yes | port |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.97. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Maximum Request Time | measurement | the maximum time it took to process a request since the last restart | maxTime |
| Request Count | measurement | the total number of requests processed since the last restart | requestCount |
| Request Count per Minute | measurement | the total number of requests processed since the last restart | requestCount |
| Error Count | measurement | the number of errors while processing requests since the last restart | errorCount |
| Error Count per Minute | measurement | the number of errors while processing requests since the last restart | errorCount |
| Current Active Threads | measurement | the number of threads for this connector that are currently active | ThreadPool|currentThreadsBusy |
| Current Thread Count | measurement | the number of threads for this connector that currently exist | ThreadPool|currentThreadCount |
| Maximum Threads | trait | Maximum number of threads that can be allocated for the thread pool of this connector | ThreadPool|maxThreads |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.1.2. JBossAS5 - Virtual Host Service
Overview
Table 3.98. Overview
| Description: | a JBoss Web virtual host |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.99.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Name | the virtual host's name (e.g. localhost) | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.100. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Aliases | trait | the aliases for this virtual host, if any | aliases |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.2. JBossAS5 - No Tx Datasource Service
Overview
Table 3.101. Overview
| Description: | No Transaction Datasources deployed in the instance of JBoss AS |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.102.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.103. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Run State | trait | Run State | runState |
| Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric. | custom.connectionAvailable |
| Pool JNDI Name | trait | the JNDI name of the connection pool for this datasource | poolJndiName |
| Available Connection Count | measurement | the maximum number of connections that are available | availableConnectionCount |
| Connection Count | measurement | the number of connections that are currently in the pool | connectionCount |
| Connection Created Count | measurement | the number of connections that have been created since the datasource was last started | connectionCreatedCount |
| Connection Destroyed Count | measurement | the number of connections that have been destroyed since the datasource was last started | connectionDestroyedCount |
| In Use Connection Count | measurement | the number of connections that are currently in use | inUseConnectionCount |
| Local Transaction | trait | Local Transaction | local-transaction |
| Max Connections In Use Count | measurement | the most connections that have been simultaneously in use since this datasource was started | maxConnectionsInUseCount |
| Max Size | measurement | Max Size | maxSize |
| Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.104.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Name | The global JNDI Name under which to bind the datasource | yes | jndi-name |
| Username | The default username when creating a new connection. | no | user-name |
| Password | The default password when creating a new connection. | no | password |
| Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
| Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
| JDBC Driver Class | The fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver"). | yes | driver-class |
| Connection URL | The JDBC URL for the database (e.g. "jdbc:oracle:thin:@host.example.com:1521:db"). To define a high availablity (HA) datasource, specify a list of URLs separated by URL delimiters (e.g. "jdbc:oracle:thin:@host1.example.com:1521:db1|jdbc:oracle:thin:@host2.example.com:1521:db2"). | yes | connection-url |
| Connection Properties | Arbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method. | no | connection-properties |
| Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
| Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
| Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
| Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
| Blocking Timeout in Milliseconds | 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. The default is 30000 (30 seconds). | no | blocking-timeout-millis |
| Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
| Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
| Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
| Metadata | Metadata properties. | no | metadata |
| No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
| Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |
| Security Settings | Security settings for connections in the pool. | no | security-domain |
| Statistics Formatter | The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". | no | statistics-formatter |
| Type Mapping | The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. | no | type-mapping |
| Use Java Context | Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. | no | use-java-context |
| Use Strict Min | Whether idle connections below the min-pool-size should be closed. The default is No. | no | use-strict-min |
| 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. The default is Yes. | no | validate-on-match |
| Check Valid Connection SQL | The SQL statement to use to check the validity of a pool connection. | no | check-valid-connection-sql |
| Connection Definition | The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". | no | connection-definition |
| Exception Sorter Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast. | no | exception-sorter-class-name |
| New Connection SQL | An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc. | no | new-connection-sql |
| Prepared Statement Cache Size | The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0. | no | prepared-statement-cache-size |
| Query Timeout | Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0. | no | query-timeout |
| Rar Name | The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars. | no | rar-name |
| 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. The default is No. | no | set-tx-query-timeout |
| Share Prepared Statements | Should prepared statements be shared? The default is No. | no | share-prepared-statements |
| Stale Connection Checker Class Name | Fully qualified name of the Java class used to check if a connection has become stale. | no | stale-connection-checker-class-name |
| Track Statements | Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". | no | track-statements |
| Transaction Isolation | The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. | no | transaction-isolation |
| Url Delimiter | Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "|". | no | url-delimiter |
| Url Selector Strategy Class Name | The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface. | no | url-selector-strategy-class-name |
| Use Try Lock | Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0. | no | use-try-lock |
| Valid Connection Checker Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool. | no | valid-connection-checker-class-name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.105. Metrics
| Name | Description |
|---|---|
| Flush | Flush the connections in the pool |
| List Formatted Sub Pool Statistics | Obtain a formatted sub pool statistics report |
| List Statistics | Obtain a statistics report |
| Test Connection | Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained |
Package Types
none
3.2.3. JBossAS5 - Local Tx Datasource Service
Overview
Table 3.106. Overview
| Description: | Local Transaction Datasources deployed in the instance of JBoss AS |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.107.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.108. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Run State | trait | Run State | runState |
| Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric. | custom.connectionAvailable |
| Pool JNDI Name | trait | the JNDI name of the connection pool for this datasource | poolJndiName |
| Available Connection Count | measurement | the maximum number of connections that are available | availableConnectionCount |
| Connection Count | measurement | the number of connections that are currently in the pool | connectionCount |
| Connection Created Count | measurement | the number of connections that have been created since the datasource was last started | connectionCreatedCount |
| Connection Destroyed Count | measurement | the number of connections that have been destroyed since the datasource was last started | connectionDestroyedCount |
| In Use Connection Count | measurement | the number of connections that are currently in use | inUseConnectionCount |
| Local Transaction | trait | Local Transaction | local-transaction |
| Max Connections In Use Count | measurement | the most connections that have been simultaneously in use since this datasource was started | maxConnectionsInUseCount |
| Max Size | measurement | Max Size | maxSize |
| Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.109.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Name | The global JNDI Name under which to bind the datasource | yes | jndi-name |
| Username | The default username when creating a new connection. | no | user-name |
| Password | The default password when creating a new connection. | no | password |
| Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
| Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
| JDBC Driver Class | The fully qualified name of the JDBC driver class (e.g. "oracle.jdbc.driver.OracleDriver"). | yes | driver-class |
| Connection URL | The JDBC URL for the database (e.g. "jdbc:oracle:thin:@host.example.com:1521:db"). To define a high availablity (HA) datasource, specify a list of URLs separated by URL delimiters (e.g. "jdbc:oracle:thin:@host1.example.com:1521:db1|jdbc:oracle:thin:@host2.example.com:1521:db2"). | yes | connection-url |
| Connection Properties | Arbitrary connection properties that should be passed to the java.sql.Driver.connect(url, props) method. | no | connection-properties |
| Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
| Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
| Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
| Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
| Blocking Timeout in Milliseconds | 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. The default is 30000 (30 seconds). | no | blocking-timeout-millis |
| Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
| Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
| Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
| Metadata | Metadata properties. | no | metadata |
| No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
| Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |
| Security Settings | Security settings for connections in the pool. | no | security-domain |
| Statistics Formatter | The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". | no | statistics-formatter |
| Type Mapping | The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. | no | type-mapping |
| Use Java Context | Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. | no | use-java-context |
| Use Strict Min | Whether idle connections below the min-pool-size should be closed. The default is No. | no | use-strict-min |
| 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. The default is Yes. | no | validate-on-match |
| Check Valid Connection SQL | The SQL statement to use to check the validity of a pool connection. | no | check-valid-connection-sql |
| Connection Definition | The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". | no | connection-definition |
| Exception Sorter Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast. | no | exception-sorter-class-name |
| New Connection SQL | An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc. | no | new-connection-sql |
| Prepared Statement Cache Size | The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0. | no | prepared-statement-cache-size |
| Query Timeout | Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0. | no | query-timeout |
| Rar Name | The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars. | no | rar-name |
| 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. The default is No. | no | set-tx-query-timeout |
| Share Prepared Statements | Should prepared statements be shared? The default is No. | no | share-prepared-statements |
| Stale Connection Checker Class Name | Fully qualified name of the Java class used to check if a connection has become stale. | no | stale-connection-checker-class-name |
| Track Statements | Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". | no | track-statements |
| Transaction Isolation | The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. | no | transaction-isolation |
| Url Delimiter | Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "|". | no | url-delimiter |
| Url Selector Strategy Class Name | The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface. | no | url-selector-strategy-class-name |
| Use Try Lock | Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0. | no | use-try-lock |
| Valid Connection Checker Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool. | no | valid-connection-checker-class-name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.110. Metrics
| Name | Description |
|---|---|
| Flush | Flush the connections in the pool |
| List Formatted Sub Pool Statistics | Obtain a formatted sub pool statistics report |
| List Statistics | Obtain a statistics report |
| Test Connection | Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained |
Package Types
none
3.2.4. JBossAS5 - XA Datasource Service
Overview
Table 3.111. Overview
| Description: | XA Datasources deployed in the instance of JBoss AS |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.112.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.113. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Run State | trait | Run State | runState |
| Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric. | custom.connectionAvailable |
| Pool JNDI Name | trait | the JNDI name of the connection pool for this datasource | poolJndiName |
| Available Connection Count | measurement | the maximum number of connections that are available | availableConnectionCount |
| Connection Count | measurement | the number of connections that are currently in the pool | connectionCount |
| Connection Created Count | measurement | the number of connections that have been created since the datasource was last started | connectionCreatedCount |
| Connection Destroyed Count | measurement | the number of connections that have been destroyed since the datasource was last started | connectionDestroyedCount |
| In Use Connection Count | measurement | the number of connections that are currently in use | inUseConnectionCount |
| Local Transaction | trait | Local Transaction | local-transaction |
| Max Connections In Use Count | measurement | the most connections that have been simultaneously in use since this datasource was started | maxConnectionsInUseCount |
| Max Size | measurement | Max Size | maxSize |
| Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.114.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Name | The global JNDI Name under which to bind the datasource | yes | jndi-name |
| Username | The default username when creating a new connection. | no | user-name |
| Password | The default password when creating a new connection. | no | password |
| Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
| Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
| XA DataSource Class | The fully qualified name of the javax.sql.XADataSource implementation class. | yes | xa-datasource-class |
| XA Datasource Properties | The properties to assign to the XADataSource implementation class. Each property is mapped onto the XADataSource implementation by looking for a JavaBeans style getter method for the property name. If found, the value of the property is set using the JavaBeans setter with the element text translated to the true property type using the java.beans.PropertyEditor for the type. | no | xa-datasource-properties |
| XA Resource Timeout | XA transaction timeout, in seconds (passed to XAResource.setTransactionTimeout()) - default is zero which does not invoke the setter. | no | xa-resource-timeout |
| URL Property | For HA XA datasources, specifies the name of an XADataSource property that contains a list of URLs. | no | url-property |
| Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
| Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
| Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
| Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
| Blocking Timeout in Milliseconds | 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. The default is 30000 (30 seconds). | no | blocking-timeout-millis |
| Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
| Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
| Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
| Metadata | Metadata properties. | no | metadata |
| No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
| Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |
| Security Settings | Security settings for connections in the pool. | no | security-domain |
| Statistics Formatter | The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". | no | statistics-formatter |
| Type Mapping | The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. | no | type-mapping |
| Use Java Context | Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. | no | use-java-context |
| Use Strict Min | Whether idle connections below the min-pool-size should be closed. The default is No. | no | use-strict-min |
| 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. The default is Yes. | no | validate-on-match |
| Check Valid Connection SQL | The SQL statement to use to check the validity of a pool connection. | no | check-valid-connection-sql |
| Connection Definition | The connection definition inside the RAR deployment uniquely identified by the connection factory interface, e.g. "javax.sql.DataSource". | no | connection-definition |
| Exception Sorter Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ExceptionSorter interface that should be used to check if a JDBC exception should be broadcast. | no | exception-sorter-class-name |
| New Connection SQL | An SQL statement to execute whenever a new connection is added to the pool; this can be used to set the connection schema, etc. | no | new-connection-sql |
| Prepared Statement Cache Size | The number of prepared statements per connection to be kept open and reused in subsequent requests. They are stored in an LRU cache. Set to 0 to disable the cache. The default is 0. | no | prepared-statement-cache-size |
| Query Timeout | Any configured query timeout in seconds. A value of 0 means no timeout. The default is 0. | no | query-timeout |
| Rar Name | The RAR deployment to associate with the connection manager MBean. e.g. jms-ra.rar or myapplication.ear#my.rar for nested rars. | no | rar-name |
| 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. The default is No. | no | set-tx-query-timeout |
| Share Prepared Statements | Should prepared statements be shared? The default is No. | no | share-prepared-statements |
| Stale Connection Checker Class Name | Fully qualified name of the Java class used to check if a connection has become stale. | no | stale-connection-checker-class-name |
| Track Statements | Whether to check for unclosed Statements and ResultSets when connections are returned to the pool. The default is "yes-no-warnings". | no | track-statements |
| Transaction Isolation | The Transaction Isolation level. The default setting is to use whichever isolation level is provided by default by the database. | no | transaction-isolation |
| Url Delimiter | Specifies the delimiter for URLs in the value of the connection-url property for HA datasources. The default is "|". | no | url-delimiter |
| Url Selector Strategy Class Name | The fully qualified class name of a Java class implementing the org.jboss.resource.adapter.jdbc.URLSelectorStrategy interface. | no | url-selector-strategy-class-name |
| Use Try Lock | Any configured timeout, in milliseconds, for internal locks on the resource adapter objects. A value of 0 means no timeout. The default is 0. | no | use-try-lock |
| Valid Connection Checker Class Name | The fully qualified name of a Java class implementing the org.jboss.resource.adapter.jdbc.ValidConnectionChecker whose pingDatabase method should be used to check if a connection is still valid before handing it out from the pool. | no | valid-connection-checker-class-name |
| Interleaving | If true, enable transaction interleaving if the DB vendor supports it (most do not). This property supersedes the "track-connection-by-tx" property from earlier versions of JBoss AS. The default is false. | no | interleaving |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.115. Metrics
| Name | Description |
|---|---|
| Flush | Flush the connections in the pool |
| List Formatted Sub Pool Statistics | Obtain a formatted sub pool statistics report |
| List Statistics | Obtain a statistics report |
| Test Connection | Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained |
Package Types
none
3.2.5. JBossAS5 - No Tx ConnectionFactory Service
Overview
Table 3.116. Overview
| Description: | A ConnectionFactory that does not take part in JTA transactions. |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.117.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Custom Properties | Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. | no | customProperties |
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.118. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Run State | trait | Run State | runState |
| Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric. | custom.connectionAvailable |
| Pool JNDI Name | trait | Pool JNDI Name | poolJndiName |
| Available Connection Count | measurement | Number of available connections. | availableConnectionCount |
| Connection Count | measurement | Connection Count | connectionCount |
| Connection Created Count | measurement | Connection Created Count | connectionCreatedCount |
| Connection Destroyed Count | measurement | Connection Destroyed Count | connectionDestroyedCount |
| In Use Connection Count | measurement | Mumber of connections currently in use. | inUseConnectionCount |
| Max Connections In Use Count | measurement | Maximum number of maximum connections that have been in use. | maxConnectionsInUseCount |
| Max Size | measurement | Max Size | maxSize |
| Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.119.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Name | The global JNDI name to bind the connection factory under. | yes | jndi-name |
| RAR Name | The name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar. | yes | rar-name |
| Connection Definition | The connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. | yes | connection-definition |
| Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
| Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
| Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
| Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
| Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
| Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
| Blocking Timeout in Milliseconds | 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. The default is 30000 (30 seconds). | no | blocking-timeout-millis |
| Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
| Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
| Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
| Metadata | Metadata properties. | no | metadata |
| No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
| Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |
| Security Settings | Security settings for connections in the pool. | no | security-domain |
| Statistics Formatter | The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". | no | statistics-formatter |
| Type Mapping | The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. | no | type-mapping |
| Use Java Context | Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. | no | use-java-context |
| Use Strict Min | Whether idle connections below the min-pool-size should be closed. The default is No. | no | use-strict-min |
| 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. The default is Yes. | no | validate-on-match |
| Config Property | Properties to supply to the ManagedConnectionFactory (MCF) MBean service configuration. | no | config-property |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.120. Metrics
| Name | Description |
|---|---|
| Flush | Flush the connections in the pool |
| List Formatted Sub Pool Statistics | Obtain a formatted sub pool statistics report |
| List Statistics | Obtain a statistics report |
| Test Connection | Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained |
Package Types
none
3.2.6. JBossAS5 - Tx ConnectionFactory Service
Overview
Table 3.121. Overview
| Description: | A ConnectionFactory that takes part in JTA transactions. |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.122.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Custom Properties | Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. | no | customProperties |
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.123. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Transaction Type | trait | The type of transactions used by this connection factory - Local or XA | custom.transactionType |
| Run State | trait | Run State | runState |
| Connection Available? | trait | could a connection to the underlying data provider be obtained? Please see the documentation before enabling this metric. | custom.connectionAvailable |
| Pool JNDI Name | trait | Pool JNDI Name | poolJndiName |
| Available Connection Count | measurement | Number of available connections. | availableConnectionCount |
| Connection Count | measurement | Connection Count | connectionCount |
| Connection Created Count | measurement | Connection Created Count | connectionCreatedCount |
| Connection Destroyed Count | measurement | Connection Destroyed Count | connectionDestroyedCount |
| In Use Connection Count | measurement | Mumber of connections currently in use. | inUseConnectionCount |
| Max Connections In Use Count | measurement | Maximum number of maximum connections that have been in use. | maxConnectionsInUseCount |
| Max Size | measurement | Max Size | maxSize |
| Min Size | measurement | Min Size | minSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.124.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Name | The global JNDI name to bind the connection factory under. | yes | jndi-name |
| RAR Name | The name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar. | yes | rar-name |
| Connection Definition | The connection factory interface class. It should match the connectionfactory-interface in the ra.xml file. | yes | connection-definition |
| Minimum Pool Size | The minimum number of connections the pool should hold. The default is 0. | no | min-pool-size |
| Maximum Pool Size | The maximum number of connections the pool should hold. The default is 10. | no | max-pool-size |
| XA Transaction | Whether on not to use XA transactions. The default is No. | no | xa-transaction |
| Allocation Retry | The number of times that allocating a connection should be tried before throwing an exception. The default is 0. | no | allocation-retry |
| Allocation Retry Wait Millis | The time in milliseconds to wait between retrying to allocate a connection. The default is 5000 (5 seconds). | no | allocation-retry-wait-millis |
| Background Validation | Specify if connections should be validated on a background thread versus being validated prior to use. Background validation is meant to reduce the overall load on the RDBMS system when validating a connection. The default is No. | no | background-validation |
| Background Validation Millis | The interval, in milliseconds, at which the ConnectionValidator will run. Set to 0 to disable background validation. The default is 0. | no | background-validation-millis |
| Blocking Timeout in Milliseconds | 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. The default is 30000 (30 seconds). | no | blocking-timeout-millis |
| Idle Timeout | The maximum time, in minutes, a connection may be idle before being closed. The default is 30. | no | idle-timeout-minutes |
| Is Same RM Override Value | If set, unconditionally sets the boolean return value of javax.transaction.xa.XAResource.isSameRM(XAResource). | no | isSameRM-override-value |
| Jmx Invoker Name | The ObjectName of the JMX Invoker MBean associated with this datasource. | no | jmx-invoker-name |
| Metadata | Metadata properties. | no | metadata |
| No Tx Separate Pools | If true, the datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa. The default is Yes. | no | no-tx-separate-pools |
| Prefill | Whether to attempt to prefill the connection pool to the minimum number of connections. NOTE: Only supporting pools (OnePool) support this feature. A warning can be found in the logs if the pool does not support this. The default is No. | no | prefill |
| Security Settings | Security settings for connections in the pool. | no | security-domain |
| Statistics Formatter | The fully qualified class name of the class to use for formatting managed connection pool statistics for this datasource. The class must implement the org.jboss.resource.statistic.formatter.StatisticsFormatter. interface. The default is "org.jboss.resource.statistic.pool.JBossDefaultSubPoolStatisticFormatter". | no | statistics-formatter |
| Type Mapping | The name of the corresponding type-mapping in conf/standardjbosscmp-jdbc.xml. The type mappings provided by default: DB2, InformixDB, MaxDB, mySQL, Oracle9i, PointBase, InterBase, Mimer SQL, McKoi, SapDB, DB2/400, SOLID, Hypersonic SQL, FirstSQL/J, MS SQLSERVER2000, MS SQLSERVER, Cloudscape, Derby, Firebird, PostgreSQL 8.0, PostgreSQL, Sybase, Ingres. Note, there may be custom type mappings defined in addition to these predefined mappings. | no | type-mapping |
| Use Java Context | Indicates whether the JNDI name should be bound under the "java" context, which causes the DataSource to only be accessible from within the JBossAS VM. The default is Yes. | no | use-java-context |
| Use Strict Min | Whether idle connections below the min-pool-size should be closed. The default is No. | no | use-strict-min |
| 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. The default is Yes. | no | validate-on-match |
| Config Property | Properties to supply to the ManagedConnectionFactory (MCF) MBean service configuration. | no | config-property |
| Interleaving | If true, enable transaction interleaving if the DB vendor supports it (most do not). Can only be set to true if XA transactions are enabled. This property supersedes the "track-connection-by-tx" property from earlier versions of JBoss AS. The default is false. | no | interleaving |
| XA Resource Timeout | The maximum time, in minutes, an XA Resource can be idle before it is removed. 0 means no timeout. The default is 0. | no | xa-resource-timeout |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.125. Metrics
| Name | Description |
|---|---|
| Flush | Flush the connections in the pool |
| List Formatted Sub Pool Statistics | Obtain a formatted sub pool statistics report |
| List Statistics | Obtain a statistics report |
| Test Connection | Test if a connection can be obtained - returns true if a connection was obtained, or false if not; NOTE: this operation will always return a status of Successful - the results of the operation must be inspected to see whether or not a connection was obtained |
Package Types
none
3.2.7. JBossAS5 - JBoss Messaging Service
Overview
Table 3.126. Overview
| Description: | the JBoss Messaging JMS provider |
| Singleton: | yes |
| Plugin: | JBossAS5 |
Child Resource Types
Connection Properties
Table 3.127.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.2.7.1. JBossAS5 - Queue Service
Overview
Table 3.128. Overview
| Description: | a JMS queue |
| Singleton: | no |
| Plugin: | JBossAS5 |
Note
The message counter metrics will not be collected by default. In order for these metrics to be collected for all Topics and Queues for a given application server instance, go to the instance's JMX Console, and invoke the {{enableMessageCounters}} operation on the {{jboss.messaging:service=ServerPeer}} MBean. To ensure the message counters are still enabled when the application server is restarted, edit that instance's {{deploy/messaging/messaging-service.xml}} file and set the {{EnableMessageCounters}} attribute to "true".
Child Resource Types
none
Connection Properties
Table 3.129.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jms Type | yes | jms-type | |
| Custom Properties | Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. | no | customProperties |
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.130. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Run State | trait | Run State | runState |
| Created Programmatically | trait | Was this queue created programmatically? If Yes, the queue will not survive a restart of the application server. If No, the queue was created via a deployment XML file. | createdProgrammatically |
| Message Counter History Day Limit | trait | This queue's message counter history day limit - <0: unlimited, =0: history disabled, >0: maximum day count | messageCounterHistoryDayLimit |
| Consumer Count | measurement | The number of consumers on the queue | consumerCount |
| Delivering Count | measurement | The number of messages currently being delivered | deliveringCount |
| Message Count | measurement | The number of messages in the queue | messageCount |
| Scheduled Message Count | measurement | The number of scheduled messages in the queue | scheduledMessageCount |
| Count | measurement | The total message count since startup or last counter reset | messageStatistics.count |
| Count Delta | measurement | The message count delta since last method call | messageStatistics.countDelta |
| Depth | measurement | The current message count of pending messages within the queue waiting for dispatch | messageStatistics.depth |
| Depth Delta | measurement | The message count delta of pending messages since last method call | messageStatistics.depthDelta |
| Time Last Update | measurement | The timestamp of the last message add | messageStatistics.timeLastUpdate |
| Clustered | trait | True if this queue is clustered, false otherwise | clustered |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.131.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of this queue (e.g. 'MyQueue'). | yes | name |
| JNDI Name | This queue's JNDI name (e.g. '/queue/MyQueue'). | yes | JNDIName |
| Clustered | Is this queue clustered? For an existing queue, this property is read-only. If not specified when creating a new queue, the default value is false. | no | clustered |
| Down Cache Size | When paging messages to storage from a subscription, they first go into a "Down Cache" before being written to storage. This enables the write to occur as a single operation, thus aiding performance. This setting determines the maximum number of messages that the Down Cache will hold before they are flushed to storage. Updates to this property will not go into effect until the queue has been restarted. The default value is 2000. | no | downCacheSize |
| Full Size | The maximum number of messages for the queue held in memory at any one time. The actual queue can hold many more messages than this, but these are paged to and from storage as necessary, as messages are added or consumed. Updates to this property will not go into effect until the queue has been restarted. The default value is 200000. | no | fullSize |
| Max Delivery Attempts | The number of delivery attempts before a message to a subscriber of this queue is moved to the DLQ. The default value is 10. A value of -1 indicates the default value should be used. | no | maxDeliveryAttempts |
| Max Size | The maximum number of messages this queue can hold before they are dropped. A value of -1 means there is no maximum. The default value is -1. | no | maxSize |
| Page Size | When loading messages from a subscription, this is the maximum number of messages to pre-load in one operation. Must be less than Full Size and greater than or equal to Down Cache Size. Updates to this property will not go into effect until the queue has been restarted. The default value is 2000. | no | pageSize |
| Redelivery Delay | The delay in milliseconds before a rolled back or recovered message is redelivered. Set to 0 to disable redelivery. The default value is 0. A value of -1 indicates the default value should be used. | no | redeliveryDelay |
| DLQ | The JMX ObjectName of the dead letter queue (DLQ) for this queue (e.g. "jboss.messaging.destination:service=Queue,name=PrivateDLQ") - overrides the default DLQ on the server peer. | no | DLQ |
| Expiry Queue | The JMX ObjectName of the expiry queue for this queue (e.g. "jboss.messaging.destination:service=Queue,name=PrivateExpiryQueue") - overrides the default expiry queue on the server peer. | no | expiryQueue |
| Server Peer | The JMX ObjectName of the server peer this queue was deployed on (e.g. "jboss.messaging:service=ServerPeer"). Updates to this property will not go into effect until the queue has been restarted. | no | serverPeer |
| Security Configurations | This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. | yes | securityConfig |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.132. Metrics
| Name | Description |
|---|---|
| Remove All Messages | Remove all messages from the destination. |
| Start | Start the destination. |
| Stop | Stop the destination. |
| List All Messages | List all messages for the specified selector |
| List Durable Messages | List all durable messages for the specified selector |
| List Non Durable Messages | List all non durable messages for the specified selector |
| List Message Counter As HTML | Get the message counter as HTML |
| List Message Counter History As HTML | Get the message counter history as HTML |
| Reset Message Counter | Reset the message counter |
| Reset Message Counter History | Reset the message counter history |
Package Types
none
3.2.7.2. JBossAS5 - Topic Service
Overview
Table 3.133. Overview
| Description: | a JMS topic |
| Singleton: | no |
| Plugin: | JBossAS5 |
Note
The message counter metrics will not be collected by default. In order for these metrics to be collected for all Topics and Queues for a given application server instance, go to the instance's JMX Console, and invoke the {{enableMessageCounters}} operation on the {{jboss.messaging:service=ServerPeer}} MBean. To ensure the message counters are still enabled when the application server is restarted, edit that instance's {{deploy/messaging/messaging-service.xml}} file and set the {{EnableMessageCounters}} attribute to "true".
Child Resource Types
none
Connection Properties
Table 3.134.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jms Type | yes | jms-type | |
| Custom Properties | Maps a list of custom property names to the the fully qualified class names of the org.rhq.plugins.jbossas5.adapter.api.PropertyAdapter implementations that should be used for those properties. | no | customProperties |
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Template Name | yes | templateName | |
| Component Name Property | The name of the Resource configuration property whose value should be used as the underlying ManagedComponent name when creating a new Resource of this type. | yes | componentNameProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.135. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Run State | trait | Run State | runState |
| Created Programmatically | trait | Was this topic created programmatically? If Yes, the topic will not survive a restart of the application server. If No, the topic was created via a deployment XML file. | createdProgrammatically |
| Message Counter History Day Limit | trait | This topic's message counter history day limit - <0: unlimited, =0: history disabled, >0: maximum day count | messageCounterHistoryDayLimit |
| All Message Count | measurement | The count of all messages in all subscriptions to this topic | allMessageCount |
| All Subscriptions Count | measurement | The count of all subscriptions to this topic | allSubscriptionsCount |
| Durable Message Count | measurement | The count of all messages for all durable subscriptions to this topic | durableMessageCount |
| Durable Subscriptions Count | measurement | The count of all durable subscriptions to this topic | durableSubscriptionsCount |
| Non Durable Message Count | measurement | The count of all messages in all non durable subscriptions to this topic | nonDurableMessageCount |
| Non Durable Subscriptions Count | measurement | The count of all non durable subscriptions to this topic | nonDurableSubscriptionsCount |
| Clustered | trait | True if this topic is clustered, false otherwise | clustered |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.136.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of this topic (e.g. 'MyTopic'). | yes | name |
| JNDI Name | This topic's JNDI name (e.g. '/topic/MyTopic') | yes | JNDIName |
| Clustered | Is this topic clustered? For an existing topic, this property is read-only. If not specified when creating a new topic, the default value is false. | no | clustered |
| Down Cache Size | When paging messages to storage from a subscription, they first go into a "Down Cache" before being written to storage. This enables the write to occur as a single operation, thus aiding performance. This setting determines the maximum number of messages that the Down Cache will hold before they are flushed to storage. Updates to this property will not go into effect until the topic has been restarted. The default value is 2000. | no | downCacheSize |
| Full Size | The maximum number of messages held by the topic subscriptions in memory at any one time. The actual subscription can hold many more messages than this, but these are paged to and from storage as necessary, as messages are added or consumed. Updates to this property will not go into effect until the topic has been restarted. The default value is 200000. | no | fullSize |
| Max Delivery Attempts | The number of delivery attempts before a message to a subscriber of this topic is moved to the DLQ. The default value is 10. A value of -1 indicates the default value should be used. | no | maxDeliveryAttempts |
| Max Size | The maximum number of messages this topic can hold before they are dropped. A value of -1 means there is no maximum. The default value is -1. | no | maxSize |
| Page Size | When loading messages from a subscription, this is the maximum number of messages to pre-load in one operation. Must be less than Full Size and greater than or equal to Down Cache Size. Updates to this property will not go into effect until the topic has been restarted. The default value is 2000. | no | pageSize |
| Redelivery Delay | The delay in milliseconds before a rolled back or recovered message is redelivered. Set to 0 to disable redelivery. The default value is 0. A value of -1 indicates the default value should be used. | no | redeliveryDelay |
| DLQ | The JMX ObjectName of the dead letter queue (DLQ) for this topic (e.g. "jboss.messaging.destination:service=Queue,name=PrivateDLQ") - overrides the default DLQ on the server peer. | no | DLQ |
| Expiry Queue | The JMX ObjectName of the expiry queue for this topic (e.g. "jboss.messaging.destination:service=Queue,name=PrivateExpiryQueue") - overrides the default expiry queue on the server peer. | no | expiryQueue |
| Server Peer | The JMX ObjectName of the server peer this topic was deployed on (e.g. "jboss.messaging:service=ServerPeer"). Updates to this property will not go into effect until the topic has been restarted. | no | serverPeer |
| Security Configurations | This element specifies a XML fragment which describes the access control list to be used by the SecurityManager to authorize client operations against the destination. The content model is the same as for the SecurityManager SecurityConf attribute. | yes | securityConfig |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.137. Metrics
| Name | Description |
|---|---|
| Remove All Messages | Remove all messages from the destination. |
| Start | Start the destination. |
| Stop | Stop the destination. |
| List All Messages | List all messages for the specified subscription with the specified selector |
| List Durable Messages | List all durable messages for the specified subscription with the specified selector |
| List Non Durable Messages | List all non durable messages for the specified subscription with the specified selector |
| List All Subscriptions | Return all subscriptions for the topic |
| List All Subscriptions As HTML | Return all subscriptions for the topic as HTML |
| List Durable Subscriptions | Return all durable subscriptions for the topic |
| List Durable Subscriptions As HTML | Return all durable subscriptions for the topic as HTML |
| List Non-Durable Subscriptions | Return all non-durable subscriptions for the topic |
| List Non-Durable Subscriptions As HTML | Return all non-durable subscriptions for the topic as HTML |
Package Types
none
3.2.8. JBossAS5 - Enterprise Application (EAR) Service
Overview
Table 3.138. Overview
| Description: | JEE enterprise application (EAR) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.139.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Deployment Name | The name of this EAR | yes | deploymentName |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate | |
| Deployment Type Name | The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. | yes | deploymentTypeName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.140. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Path | trait | the absolute path of this EAR file or directory | custom.path |
| Exploded? | trait | whether this EAR is deployed exploded (i.e. as a directory) | custom.exploded |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.141. Metrics
| Name | Description |
|---|---|
| Start | starts this EAR |
| Stop | stops this EAR |
| Restart | stops and then restarts this EAR |
Package Types
Table 3.142. Package Types
| Name | Category | Description |
|---|---|---|
| EAR File | Deployable |
3.2.9. JBossAS5 - Web Application (WAR) Service
Overview
Table 3.143. Overview
| Description: | a standalone web application (WAR) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
Connection Properties
Table 3.144.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Deployment Name | the name of this WAR | yes | deploymentName |
| Context Path | this WAR's context path (e.g. /admin-console) | no | contextPath |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate | |
| Deployment Type Name | The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. | yes | deploymentTypeName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.145. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Path | trait | the absolute path of this WAR file or directory | custom.path |
| Exploded? | trait | whether this WAR is deployed exploded (i.e. as a directory) | custom.exploded |
| Context Root | trait | this context root of this WAR (e.g. jmx-console) - used as a unique path prefix for URLs corresponding to this WAR | contextRoot |
| Virtual Hosts | trait | the virtual host(s) to which this WAR is deployed | virtualHosts |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.146. Metrics
| Name | Description |
|---|---|
| Start | starts this WAR |
| Stop | stops this WAR |
| Restart | stops and then restarts this WAR |
Package Types
Table 3.147. Package Types
| Name | Category | Description |
|---|---|---|
| WAR File | Deployable |
3.2.9.1. JBossAS5 - Web Application Context Service
Overview
Table 3.148. Overview
| Description: | a web application context |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.149.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| 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 |
| Virtual Host | this WAR's virtual host (e.g. localhost) | yes | virtualHost |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.150. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Clustered | trait | True if this web application context is clustered | clustered |
| Virtual Host | trait | the virtual host with which this context is associated | virtualHost |
| 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 for this WAR | activeSessions |
| Maximum Active Sessions | measurement | the maximum number of sessions that have been active for this WAR | maxActive |
| Created Sessions | measurement | the number of sessions created for this WAR | sessionCounter |
| Created Sessions per Minute | measurement | the number of sessions created for this WAR | sessionCounter |
| Expired Sessions | measurement | the number of expired sessions for this WAR | expiredSessions |
| Expired Sessions per Minute | measurement | the number of expired sessions for this WAR | expiredSessions |
| Rejected Sessions | measurement | the number of sessions rejected for this WAR | rejectedSessions |
| Rejected Sessions per Minute | measurement | the number of sessions rejected for this WAR | rejectedSessions |
| Average Session Alive Time | measurement | the average alive time of sessions for this WAR | sessionAverageAliveTime |
| Max Session Alive Time | measurement | the maximum alive time of sessions for this WAR | sessionMaxAliveTime |
| Minimum Response Time | measurement | the minimum response time for requests serviced by this WAR | Servlet.minimumResponseTime |
| Average Response Time | measurement | the average response time for requests serviced by this WAR | Servlet.averageResponseTime |
| Maximum Response Time | measurement | the maximum response time for requests serviced by this WAR | Servlet.maximumResponseTime |
| Total Response Time | measurement | the total response time for requests serviced by this WAR | Servlet.totalResponseTime |
| Total Response Time per Minute | measurement | the total response time for requests serviced by this WAR | Servlet.totalResponseTime |
| Number of Requests Serviced | measurement | the number of requests serviced by this WAR | Servlet.requestCount |
| Number of Requests Serviced per Minute | measurement | the number of requests serviced by this WAR | Servlet.requestCount |
| Number of Error Responses | measurement | the number of error responses sent by this WAR | Servlet.errorCount |
| Number of Error Responses per Minute | measurement | the number of error responses sent by this WAR | Servlet.errorCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.10. JBossAS5 - Embedded Web Application (WAR) Service
Overview
Table 3.151. Overview
| Description: | an embedded web application (WAR) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
Connection Properties
Table 3.152.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Deployment Name | the name of this WAR | yes | deploymentName |
| Context Path | this WAR's context path (e.g. /admin-console | no | contextPath |
| 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 |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate | |
| Deployment Type Name | The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. | yes | deploymentTypeName |
| Embedded | yes | embedded |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.153. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Parent | trait | the name of this WAR's parent deployment | custom.parent |
| Context Root | trait | this context root of this WAR (e.g. jmx-console) - used as a unique path prefix for URLs corresponding to this WAR | contextRoot |
| Virtual Hosts | trait | the virtual host(s) to which this WAR is deployed | virtualHosts |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.10.1. JBossAS5 - Embedded Web Application Context Service
Overview
Table 3.154. Overview
| Description: | a web application context |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.155.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| 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 |
| Virtual Host | this WAR's virtual host (e.g. localhost) | yes | virtualHost |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.156. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Clustered | trait | True if this web application context is clustered | clustered |
| Virtual Host | trait | the virtual host with which this context is associated | virtualHost |
| 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 for this WAR | activeSessions |
| Maximum Active Sessions | measurement | the maximum number of sessions that have been active for this WAR | maxActive |
| Created Sessions | measurement | the number of sessions created for this WAR | sessionCounter |
| Created Sessions per Minute | measurement | the number of sessions created for this WAR | sessionCounter |
| Expired Sessions | measurement | the number of expired sessions for this WAR | expiredSessions |
| Expired Sessions per Minute | measurement | the number of expired sessions for this WAR | expiredSessions |
| Rejected Sessions | measurement | the number of sessions rejected for this WAR | rejectedSessions |
| Rejected Sessions per Minute | measurement | the number of sessions rejected for this WAR | rejectedSessions |
| Average Session Alive Time | measurement | the average alive time of sessions for this WAR | sessionAverageAliveTime |
| Max Session Alive Time | measurement | the maximum alive time of sessions for this WAR | sessionMaxAliveTime |
| Minimum Response Time | measurement | the minimum response time for requests serviced by this WAR | Servlet.minimumResponseTime |
| Average Response Time | measurement | the average response time for requests serviced by this WAR | Servlet.averageResponseTime |
| Maximum Response Time | measurement | the maximum response time for requests serviced by this WAR | Servlet.maximumResponseTime |
| Total Response Time | measurement | the total response time for requests serviced by this WAR | Servlet.totalResponseTime |
| Total Response Time per Minute | measurement | the total response time for requests serviced by this WAR | Servlet.totalResponseTime |
| Number of Requests Serviced | measurement | the number of requests serviced by this WAR | Servlet.requestCount |
| Number of Requests Serviced per Minute | measurement | the number of requests serviced by this WAR | Servlet.requestCount |
| Number of Error Responses | measurement | the number of error responses sent by this WAR | Servlet.errorCount |
| Number of Error Responses per Minute | measurement | the number of error responses sent by this WAR | Servlet.errorCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.11. JBossAS5 - EJB2 JAR Service
Overview
Table 3.157. Overview
| Description: | a standalone EJB 2.x application |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
Connection Properties
Table 3.158.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Deployment Name | the name of this EJB JAR | yes | deploymentName |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate | |
| Deployment Type Name | The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. | yes | deploymentTypeName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.159. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Path | trait | the absolute path of this EJB JAR file or directory | custom.path |
| Exploded? | trait | whether this EJB JAR is deployed exploded (i.e. as a directory) | custom.exploded |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.160. Metrics
| Name | Description |
|---|---|
| Start | starts this EJB JAR |
| Stop | stops this EJB JAR |
| Restart | stops and then restarts this EJB JAR |
Package Types
Table 3.161. Package Types
| Name | Category | Description |
|---|---|---|
| EJB JAR File | Deployable |
3.2.11.1. JBossAS5 - EJB2 Stateless Session Bean Service
Overview
Table 3.162. Overview
| Description: | An EJB2 Stateless Session Bean |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.163.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Invocation Stats Property Name | yes | invocationStatsPropertyName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.164. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Create Count | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Create Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Remove Count | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Remove Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Current Pool Size | measurement | The number of beans in the pool. | CurrentPoolSize |
| Max Pool Size | measurement | The maximum pool size. | MaxPoolSize |
| Method Invocation Time | calltime | The minimum, maximum, and average invocation times for each of the methods exposed by this EJB | methodInvocationTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.165. Metrics
| Name | Description |
|---|---|
| View Method Statistics | Display detailed method invocation statistics. |
Package Types
none
3.2.11.2. JBossAS5 - EJB2 Stateful Session Bean Service
Overview
Table 3.166. Overview
| Description: | An EJB2 Stateful Session Bean |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.167.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Invocation Stats Property Name | yes | invocationStatsPropertyName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.168. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Create Count | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Create Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Remove Count | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Remove Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Current Pool Size | measurement | The number of beans in the pool. | CurrentPoolSize |
| Max Pool Size | measurement | The maximum pool size. | MaxPoolSize |
| Method Invocation Time | calltime | The minimum, maximum, and average invocation times for each of the methods exposed by this EJB | methodInvocationTime |
| Passive Beans | measurement | The count of beans in the passivated state | PassivatedCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.169. Metrics
| Name | Description |
|---|---|
| View Method Statistics | Display detailed method invocation statistics. |
Package Types
none
3.2.11.3. JBossAS5 - EJB2 Message-Driven Bean Service
Overview
Table 3.170. Overview
| Description: | An EJB2 Message Driven Bean |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.171.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.172. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Current Pool Size | measurement | The number of beans in the pool. | CurrentPoolSize |
| Max Pool Size | measurement | The maximum pool size. | MaxPoolSize |
| Message Count | measurement | The number of messages sent/received | MessageCount |
| Message Count per Minute | measurement | The number of messages sent/received | MessageCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.11.4. JBossAS5 - EJB2 Entity Bean Service
Overview
Table 3.173. Overview
| Description: | An EJB2 Entity Bean |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.174.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.175. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Create Count | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Create Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Remove Count | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Remove Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Current Pool Size | measurement | The number of beans in the pool. | CurrentPoolSize |
| Max Pool Size | measurement | The maximum pool size. | MaxPoolSize |
| Cache Size | measurement | Cache Size | CacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.12. JBossAS5 - Embedded EJB2 JAR Service
Overview
Table 3.176. Overview
| Description: | an embedded EJB 2.x application |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
Connection Properties
Table 3.177.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Deployment Name | the name of this EJB JAR | yes | deploymentName |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate | |
| Deployment Type Name | The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. | yes | deploymentTypeName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.178. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Parent | trait | the name of this EJB JAR's parent deployment | custom.parent |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.12.1. JBossAS5 - EJB2 Stateless Session Bean (Embedded) Service
Overview
Table 3.179. Overview
| Description: | An EJB2 Stateless Session Bean |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.180.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Invocation Stats Property Name | yes | invocationStatsPropertyName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.181. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Create Count | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Create Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Remove Count | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Remove Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Current Pool Size | measurement | The number of beans in the pool. | CurrentPoolSize |
| Max Pool Size | measurement | The maximum pool size. | MaxPoolSize |
| Method Invocation Time | calltime | The minimum, maximum, and average invocation times for each of the methods exposed by this EJB | methodInvocationTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.182. Metrics
| Name | Description |
|---|---|
| View Method Statistics | Display detailed method invocation statistics. |
Package Types
none
3.2.12.2. JBossAS5 - EJB2 Stateful Session Bean (Embedded) Service
Overview
Table 3.183. Overview
| Description: | An EJB2 Stateful Session Bean |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.184.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Invocation Stats Property Name | yes | invocationStatsPropertyName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.185. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Create Count | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Create Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Remove Count | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Remove Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Current Pool Size | measurement | The number of beans in the pool. | CurrentPoolSize |
| Max Pool Size | measurement | The maximum pool size. | MaxPoolSize |
| Method Invocation Time | calltime | The minimum, maximum, and average invocation times for each of the methods exposed by this EJB | methodInvocationTime |
| Passive Beans | measurement | The count of beans in the passivated state | PassivatedCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.186. Metrics
| Name | Description |
|---|---|
| View Method Statistics | Display detailed method invocation statistics. |
Package Types
none
3.2.12.3. JBossAS5 - EJB2 Message-Driven Bean (Embedded) Service
Overview
Table 3.187. Overview
| Description: | An EJB2 Message Driven Bean |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.188.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.189. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Current Pool Size | measurement | The number of beans in the pool. | CurrentPoolSize |
| Max Pool Size | measurement | The maximum pool size. | MaxPoolSize |
| Message Count | measurement | The number of messages sent/received | MessageCount |
| Message Count per Minute | measurement | The number of messages sent/received | MessageCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.12.4. JBossAS5 - EJB2 Entity Bean (Embedded) Service
Overview
Table 3.190. Overview
| Description: | An EJB2 Entity Bean |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.191.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.192. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Create Count | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Create Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been created since server start. | CreateCount |
| Remove Count | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Remove Count per Minute | measurement | The number of instances of this EJB2 Session Bean that have been removed since server start. | RemoveCount |
| Current Pool Size | measurement | The number of beans in the pool. | CurrentPoolSize |
| Max Pool Size | measurement | The maximum pool size. | MaxPoolSize |
| Cache Size | measurement | Cache Size | CacheSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.13. JBossAS5 - EJB3 JAR Service
Overview
Table 3.193. Overview
| Description: | a standalone EJB 3.x application |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
Connection Properties
Table 3.194.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Deployment Name | the name of this EJB JAR | yes | deploymentName |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate | |
| Deployment Type Name | The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. | yes | deploymentTypeName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.195. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Path | trait | the absolute path of this EJB JAR file or directory | custom.path |
| Exploded? | trait | whether this EJB JAR is deployed exploded (i.e. as a directory) | custom.exploded |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.196. Metrics
| Name | Description |
|---|---|
| Start | starts this EJB JAR |
| Stop | stops this EJB JAR |
| Restart | stops and then restarts this EJB JAR |
Package Types
Table 3.197. Package Types
| Name | Category | Description |
|---|---|---|
| EJB JAR File | Deployable |
3.2.13.1. JBossAS5 - EJB3 Stateless Session Bean Service
Overview
Table 3.198. Overview
| Description: | An EJB3 Stateless Session Bean (SLSB) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.199.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Invocation Stats Property Name | yes | invocationStatsPropertyName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.200. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| EJB Name | trait | the name of this EJB | name |
| Available Count | measurement | The number of pooled instances of this EJB3 Session Bean in the method-ready state | availableCount |
| Create Count | measurement | The number of instances of this EJB3 Session Bean that have been created since server start | createCount |
| Create Count per Minute | measurement | The number of instances of this EJB3 Session Bean that have been created since server start | createCount |
| Current Count | measurement | The total number of currently pooled instances of this EJB3 Session Bean | currentSize |
| Max Size | measurement | The maximum number of instances that are allowed to be pooled | maxSize |
| Remove Count | measurement | The number of instances of this EJB3 Session Bean that have been removed since server start | removeCount |
| Remove Count per Minute | measurement | The number of instances of this EJB3 Session Bean that have been removed since server start | removeCount |
| Method Invocation Time | calltime | The minimum, maximum, and average invocation times for each of the methods exposed by this EJB | methodInvocationTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.201. Metrics
| Name | Description |
|---|---|
| View Method Statistics | Display detailed method invocation statistics. |
Package Types
none
3.2.13.2. JBossAS5 - EJB3 Stateful Session Bean Service
Overview
Table 3.202. Overview
| Description: | An EJB3 Stateful Session Bean (SFSB) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.203.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Invocation Stats Property Name | yes | invocationStatsPropertyName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.204. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| EJB Name | trait | the name of this EJB | name |
| Available Count | measurement | The number of pooled instances of this EJB3 Session Bean in the method-ready state | availableCount |
| Create Count | measurement | The number of instances of this EJB3 Session Bean that have been created since server start | createCount |
| Create Count per Minute | measurement | The number of instances of this EJB3 Session Bean that have been created since server start | createCount |
| Current Count | measurement | The total number of currently pooled instances of this EJB3 Session Bean | currentSize |
| Max Size | measurement | The maximum number of instances that are allowed to be pooled | maxSize |
| Remove Count | measurement | The number of instances of this EJB3 Session Bean that have been removed since server start | removeCount |
| Remove Count per Minute | measurement | The number of instances of this EJB3 Session Bean that have been removed since server start | removeCount |
| Method Invocation Time | calltime | The minimum, maximum, and average invocation times for each of the methods exposed by this EJB | methodInvocationTime |
| Cache Size | measurement | Cache Size | cacheSize |
| Passivated Count | measurement | Passivated Count | passivatedCount |
| Total Size | measurement | Total Size | totalSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.205. Metrics
| Name | Description |
|---|---|
| View Method Statistics | Display detailed method invocation statistics. |
Package Types
none
3.2.13.3. JBossAS5 - EJB3 Message-Driven Bean Service
Overview
Table 3.206. Overview
| Description: | An EJB3 Message-Driven Bean (MDB) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.207.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Invocation Stats Property Name | yes | invocationStatsPropertyName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.208. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| EJB Name | trait | the name of this EJB | name |
| Minimum Pool Size | measurement | Minimum Pool Size | minPoolSize |
| Maximum Pool Size | measurement | Maximum Pool Size | maxPoolSize |
| Maximum number of Messages | measurement | Maximum number of Messages | maxMessages |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.209. Metrics
| Name | Description |
|---|---|
| View Method Statistics | Display detailed method invocation statistics. |
Package Types
none
3.2.14. JBossAS5 - Embedded EJB3 JAR Service
Overview
Table 3.210. Overview
| Description: | an embedded EJB 3.x application |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
Connection Properties
Table 3.211.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Deployment Name | the name of this EJB JAR | yes | deploymentName |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate | |
| Deployment Type Name | The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. | yes | deploymentTypeName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.212. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Parent | trait | the name of this EJB JAR's parent deployment | custom.parent |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.14.1. JBossAS5 - EJB3 Stateless Session Bean (Embedded) Service
Overview
Table 3.213. Overview
| Description: | An EJB3 Stateless Session Bean (SLSB) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.214.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Invocation Stats Property Name | yes | invocationStatsPropertyName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.215. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| EJB Name | trait | the name of this EJB | name |
| Available Count | measurement | The number of pooled instances of this EJB3 Session Bean in the method-ready state | availableCount |
| Create Count | measurement | The number of instances of this EJB3 Session Bean that have been created since server start | createCount |
| Create Count per Minute | measurement | The number of instances of this EJB3 Session Bean that have been created since server start | createCount |
| Current Count | measurement | The total number of currently pooled instances of this EJB3 Session Bean | currentSize |
| Max Size | measurement | The maximum number of instances that are allowed to be pooled | maxSize |
| Remove Count | measurement | The number of instances of this EJB3 Session Bean that have been removed since server start | removeCount |
| Remove Count per Minute | measurement | The number of instances of this EJB3 Session Bean that have been removed since server start | removeCount |
| Method Invocation Time | calltime | The minimum, maximum, and average invocation times for each of the methods exposed by this EJB | methodInvocationTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.216. Metrics
| Name | Description |
|---|---|
| View Method Statistics | Display detailed method invocation statistics. |
Package Types
none
3.2.14.2. JBossAS5 - EJB3 Stateful Session Bean (Embedded) Service
Overview
Table 3.217. Overview
| Description: | An EJB3 Stateful Session Bean (SFSB) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.218.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Invocation Stats Property Name | yes | invocationStatsPropertyName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.219. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| EJB Name | trait | the name of this EJB | name |
| Available Count | measurement | The number of pooled instances of this EJB3 Session Bean in the method-ready state | availableCount |
| Create Count | measurement | The number of instances of this EJB3 Session Bean that have been created since server start | createCount |
| Create Count per Minute | measurement | The number of instances of this EJB3 Session Bean that have been created since server start | createCount |
| Current Count | measurement | The total number of currently pooled instances of this EJB3 Session Bean | currentSize |
| Max Size | measurement | The maximum number of instances that are allowed to be pooled | maxSize |
| Remove Count | measurement | The number of instances of this EJB3 Session Bean that have been removed since server start | removeCount |
| Remove Count per Minute | measurement | The number of instances of this EJB3 Session Bean that have been removed since server start | removeCount |
| Method Invocation Time | calltime | The minimum, maximum, and average invocation times for each of the methods exposed by this EJB | methodInvocationTime |
| Cache Size | measurement | Cache Size | cacheSize |
| Passivated Count | measurement | Passivated Count | passivatedCount |
| Total Size | measurement | Total Size | totalSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.220. Metrics
| Name | Description |
|---|---|
| View Method Statistics | Display detailed method invocation statistics. |
Package Types
none
3.2.14.3. JBossAS5 - EJB3 Message-Driven Bean (Embedded) Service
Overview
Table 3.221. Overview
| Description: | An EJB3 Message-Driven Bean (MDB) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.222.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName | |
| Invocation Stats Property Name | yes | invocationStatsPropertyName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.223. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| EJB Name | trait | the name of this EJB | name |
| Minimum Pool Size | measurement | Minimum Pool Size | minPoolSize |
| Maximum Pool Size | measurement | Maximum Pool Size | maxPoolSize |
| Maximum number of Messages | measurement | Maximum number of Messages | maxMessages |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.224. Metrics
| Name | Description |
|---|---|
| View Method Statistics | Display detailed method invocation statistics. |
Package Types
none
3.2.15. JBossAS5 - Resource Adapter Archive (RAR) Service
Overview
Table 3.225. Overview
| Description: | a standalone JCA resource adapter archive (RAR) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.226.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Deployment Name | the name of this RAR | yes | deploymentName |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate | |
| Deployment Type Name | The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. | yes | deploymentTypeName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.227. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Path | trait | the absolute path of this RAR file or directory | custom.path |
| Exploded? | trait | whether this RAR is deployed exploded (i.e. as a directory) | custom.exploded |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.228. Metrics
| Name | Description |
|---|---|
| Start | starts this RAR |
| Stop | stops this RAR |
| Restart | stops and then restarts this RAR |
Package Types
Table 3.229. Package Types
| Name | Category | Description |
|---|---|---|
| RAR File | Deployable |
3.2.16. JBossAS5 - Embedded Resource Adapter Archive (RAR) Service
Overview
Table 3.230. Overview
| Description: | an embedded JCA resource adapter archive (RAR) |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.231.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Deployment Name | the name of this RAR | yes | deploymentName |
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate | |
| Deployment Type Name | The name of the item from the org.jboss.deployers.spi.management.KnownDeploymentTypes enum corresponding to this deployment's type. | yes | deploymentTypeName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.232. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Parent | trait | the name of this RAR's parent deployment | custom.parent |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.2.17. JBossAS5 - Script Service
Overview
Table 3.233. Overview
| Description: | provides the ability to execute a script that performs some task related to its parent JBossAS server |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
Table 3.234.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | the absolute path to the script file | yes | path |
| Environment Variables | the environment variables that will be passed to the script; each variable must be on a new line and have the syntax name=value; the variable's value can contain properties with the syntax %propertyName%; the script plugin will interpolate these with the current values of the corresponding properties from the script's parent JBossAS server's connection properties | no | environmentVariables |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.235. Metrics
| Name | Description |
|---|---|
| Execute Script | execute the script; NOTE: environment variables to be passed to the script can be configured via this Script service's connection properties (under its Inventory tab) |
Package Types
Table 3.236. Package Types
| Name | Category | Description |
|---|---|---|
| Executable Script | Executable Script | This is the script file to be uploaded to the server's bin directory. |
3.2.18. JBossAS5 - Service Binding Manager Service
Overview
Table 3.237. Overview
| Description: | The Service Binding Manager manages the ports of the deployed services |
| Singleton: | yes |
| Plugin: | JBossAS5 |
Child Resource Types
Connection Properties
Table 3.238.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Component Type | yes | componentType | |
| Component Subtype | yes | componentSubtype | |
| Component Name | yes | componentName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.239. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Active Binding Set | trait | The active binding set used to obtain port bindings from. | activeBindingSetName |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.240.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Active Binding Set Name | The name of the binding set the Service Binding Manager should use when resolving bindings. Note to JBoss ON or Jopr users (does not apply to JBoss AS admin console): CHANGING THIS PROPERTY IS POTENTIALLY DANGEROUS because if there are any port conflicts on the machine the Application Server is running on, the server will not start up again and it will not be possible to monitor it. To be able to monitor the server again after the restart you have to update the "Naming Provider Url" in the "Connection" subtab in the "Inventory" of the Application Server to the value of "jboss:service=Naming:Port" binding of the active binding set. I.e. if the "jboss:service=Naming:Port" binding of the active binding set has the port set to 4099 and hostname to 127.0.0.1, you have to set the "Naming Provider Url" to jnp://127.0.0.1:4099. | yes | activeBindingSetName |
| Standard Bindings | The standard port bindings inherited by the binding sets. | yes | standardBindings |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.2.18.1. JBossAS5 - Service Binding Set Service
Overview
Table 3.241. Overview
| Description: | The Service Binding Set defines all bindings of a profile. It inherits the standard bindings from the Service Binding Manager and defines a port offset and overridden and additional bindings. |
| Singleton: | no |
| Plugin: | JBossAS5 |
Child Resource Types
none
Connection Properties
none
Metrics
Table 3.242. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Name | trait | The name of this binding set. | name |
| Default Host Name | trait | The default host name of this binding set. | defaultHostName |
| Port Offset | trait | The port offset of this binding set. | portOffset |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.243.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of this binding set. | yes | name |
| Default Host Name | The host name that should be used for all bindings whose configuration does not specify "fixed host name". | yes | defaultHostName |
| Port Offset | A value to add to the port configuration for a standard binding to derive the port to use in this binding set. This doesn't apply to standard bindings defined as 'fixed port'. | yes | portOffset |
| Override Bindings | The binding configurations that apply only to this binding set, either non-standard bindings or ones that override standard binding configurations. The binding set inherits the standard bindings from the Service Binding Manager, applies the port offset to them (unless the standard binding is defined as "fixed port"), and appends the override bindings. These can either redefine a standard binding or define a brand new binding. The standard bindings and the override bindings then define the full set of the bindings that are defined by the binding set. | yes | overrideBindings |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.244. Metrics
| Name | Description |
|---|---|
| Display Bindings | Displays the full set of bindings as they would look if this bindings set was active. |
Package Types
none
3.3. JBoss AS 7 and EAP 6 - Standalone Server
Overview
Table 3.245. Overview
| Description: | Standalone AS7 server |
| Singleton: | no |
| Plugin: | JBossAS7 |
Note
The server can be started, restarted, or stopped via the Start, Restart, and Shutdown operations. The Start and Restart operations start the server by executing the server start script, typically standalone.sh on UNIX or standalone.bat on Windows. The following connection settings can be used to configure the start script execution: * Start Script - the absolute path of the start script (e.g. "/opt/jboss-as-7.1.1.Final/bin/standalone.sh") * Start Script Prefix - a prefix command line to be prepended to the start script command line (e.g. "nohup sudo -u jboss -g jboss") * Start Script Arguments - arguments to be passed to the start script (e.g. "--server-config=standalone-full-ha.xml") * Start Script Environment - environment variables to be set in the start script's environment (e.g. "JAVA_HOME=/usr/java/jdk1.6.0_30") These settings are automatically initialized by the JBossAS7 plugin discovery code to match the currently running server process' command line and environment. The settings are not used by the Stop operation, since it stops the server via the management interface, not via a script. For more detailed descriptions of the settings, see the Connection Settings section below.
Child Resource Types
Autodiscovery Process Scans
Table 3.246. Metrics
| Name | Query |
|---|---|
| StandaloneAS | process|basename|match=^java.*,arg|org.jboss.as.standalone|match=.* |
Connection Properties
Table 3.247.
| 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 |
| Log Event Sources | yes | logEventSources | |
| Hostname | yes | hostname | |
| Port | yes | port | |
| User | Management user for a secured AS | no | user |
| Password | Password for the management user | no | password |
| 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 |
| Deployment directory | Deploy directory for standalone servers | no | deployDir |
| Product Type | Server product type (e.g. AS or EAP) | no | productType |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.248. 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 |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.249.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.250. Metrics
| 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 |
Package Types
none
3.3.1. JBoss AS 7 and EAP 6 - ModCluster Standalone Service
Overview
Table 3.251. Overview
| Description: | Mod_cluster support |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.252.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.253. Metrics
| 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
none
3.3.1.1. JBoss AS 7 and EAP 6 - Service Configuration Service
Overview
Table 3.254. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.255.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.256.
| 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 |
| Domain | loadBalancingGroup name. | no | domain |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.257. Metrics
| 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
none
3.3.1.1.1. JBoss AS 7 and EAP 6 - Dynamic Load Provider Service
Overview
Table 3.258. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.259.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.260.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Decay | Decay. The default value is 2. | no | decay |
| History | History. The default value is 9. | no | history |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.1.1.1.1. JBoss AS 7 and EAP 6 - Custom Load Metric Service
Table 3.261. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.262.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.263.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.1.1.1.2. JBoss AS 7 and EAP 6 - Load Metric Service
Table 3.264. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.265.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.266.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.1.1.2. JBoss AS 7 and EAP 6 - Ssl Service
Overview
Table 3.267. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.268.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.269.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.2. JBoss AS 7 and EAP 6 - JVM Service
Overview
Table 3.270. Overview
| Description: | Information about the underlying JVM |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.271.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.2.1. JBoss AS 7 and EAP 6 - Operating System Service
Overview
Table 3.272. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.273.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.274. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.3.2.2. JBoss AS 7 and EAP 6 - Memory Service
Overview
Table 3.275. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.276.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.277. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.278. Metrics
| Name | Description |
|---|---|
| Trigger GC | Runs the garbage collector. |
Package Types
none
3.3.2.3. JBoss AS 7 and EAP 6 - Runtime Service
Overview
Table 3.279. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.280.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.281. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Uptime | measurement | The uptime of the Java virtual machine in milliseconds. | uptime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.3.2.4. JBoss AS 7 and EAP 6 - Threading Service
Overview
Table 3.282. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.283.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.284. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.285.
| 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 |
| All Thread Ids | All live thread IDs. If a security manager is installed and the caller does not have ManagementPermission('monitor'), the result will be undefined. | yes | all-thread-ids |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.286. Metrics
| 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. |
Package Types
none
3.3.2.5. JBoss AS 7 and EAP 6 - Garbage Collector Service
Overview
Table 3.287. Overview
| Description: | Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.288.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.2.5.1. JBoss AS 7 and EAP 6 - Garbage Collector Resource Service
Overview
Table 3.289. Overview
| Description: | The management interface for one of the garbage collectors in the Java virtual machine. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.290.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.291. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Collection Count | measurement | The total number of collections that have occurred. | collection-count |
| Collection Time | 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.292.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Memory Pool Names | The name of memory pools that this garbage collector manages. | yes | memory-pool-names |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.2.6. JBoss AS 7 and EAP 6 - Memory Pool Service
Overview
Table 3.293. Overview
| Description: | Parent resource for the resources providing the management interface for the Java virtual machine's memory pools. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.294.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.2.6.1. JBoss AS 7 and EAP 6 - Memory Pool Resource Service
Overview
Table 3.295. Overview
| Description: | The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.296.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.297. Metrics
| 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 | measurement | 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 | measurement | 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.298.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.299. Metrics
| Name | Description |
|---|---|
| Reset Peak Usage | Resets the peak memory usage statistic of this memory pool to the current memory usage. |
Package Types
none
3.3.3. JBoss AS 7 and EAP 6 - JBossWeb Service
Overview
Table 3.300. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.301.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.302.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Disabled: 0 | Enable the default Servlet mapping. The default value is false. | no | disabled:0 |
| File Encoding | Force a file encoding. | no | file-encoding |
| Listings | Enable folder listings. The default value is false. | no | listings |
| Max Depth | Maximum recursion for PROPFIND. The default value is 3. | no | max-depth |
| Read Only | Allow write HTTP methods (PUT, DELETE). The default value is true. | no | read-only |
| Sendfile | Enable sendfile if possible, for files bigger than the specified byte size. The default value is 49152. | no | sendfile |
| Secret | Secret for WebDAV locking operations. | no | secret |
| Webdav | Enable WebDAV functionality. The default value is false. | no | webdav |
| Check Interval | Check interval for JSP updates using a background thread. The default value is 0. | no | check-interval |
| Development | Enable the development mode, which gives more information when an error occurs. The default value is false. | no | development |
| Disabled: 1 | Enable the JSP container. The default value is false. | no | disabled:1 |
| 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 | Minimum amount of time between two tests for updates, in seconds. The default value is 4. | no | modification-test-interval |
| 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.5. | 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.5. | 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 |
| Welcome File | A welcome file declaration. | no | welcome-file |
| Default Virtual Server | The web container's default virtual server. The default value is default-host. | yes | default-virtual-server |
| Instance Id | The identifier for this server instance. | no | instance-id |
| Native | Add the native initialization listener to the web container. The default value is true. | no | native |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.3.1. JBoss AS 7 and EAP 6 - Connector Service
Overview
Table 3.303. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.304.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.305. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Bytes Sent | measurement | Number of byte sent by the connector. | bytesSent |
| Bytes Sent per Minute | measurement | Number of byte sent by the connector. | bytesSent |
| Bytes Received | measurement | Number of byte received by the connector (POST data). | bytesReceived |
| Bytes Received per Minute | measurement | Number of byte received by the connector (POST data). | bytesReceived |
| Processing Time | measurement | Processing time used by the connector. Im milli-seconds. | processingTime |
| Processing Time per Minute | measurement | Processing time used by the connector. Im milli-seconds. | processingTime |
| Error Count | measurement | Number of error that occurs when processing requests by the connector. | errorCount |
| Error Count per Minute | measurement | Number of error that occurs when processing requests by the connector. | errorCount |
| Max Time | measurement | Max time spent to process a requests. | maxTime |
| Request Count | measurement | Number of the request processed by the connector. | requestCount |
| Request Count per Minute | measurement | Number of the request processed by the connector. | requestCount |
| Max connections | measurement | Number of max connections this connector can handle (see configuration to set it) | _maxConnections |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.306.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Configuration | no | *Configuration+ | |
| Scheme | The web connector scheme. | yes | scheme |
| Socket Binding | The web connector socket-binding reference, this connector should be bound to. | yes | socket-binding |
| Enabled | Defines whether the connector should be started on startup. The default value is true. | no | enabled |
| Enable Lookups | Enable DNS lookups for Servlet API. The default value is false. | no | enable-lookups |
| Executor | The name of the executor that should be used for the processing threads of this connector. If undefined defaults to using an internal pool. | no | executor |
| Max Connections | Amount of concurrent connections that can be processed by the connector with optimum performance. The default value depends on the connector used and the number of cpu cores (512*cores for HTTP, 32*cores for AJP). | no | max-connections |
| Max Post Size | Maximum size in bytes of a POST request that can be parsed by the container. The default value is 2097152. | no | max-post-size |
| Max Save Post Size | Maximum size in bytes of a POST request that will be saved during certain authentication schemes. The default value is 4096. | no | max-save-post-size |
| Name | A unique name for the connector. | no | name |
| Protocol | The web connector protocol. (e.g. 'HTTP/1.1' or 'AJP' or a name of a class implementing ProtocolHandler and MBeanRegistration ) | yes | protocol |
| Proxy Name | The host name that will be used when sending a redirect. The default value is null. | no | proxy-name |
| Proxy Port | The port that will be used when sending a redirect. | no | proxy-port |
| Redirect Port | The port for redirection to a secure connector. The default value is 8433. | no | redirect-port |
| Secure | Indicates if content sent or received by the connector is secured from the user perspective. The default value is false. | no | secure |
| Virtual Server | The list of virtual servers that can be accessed through this connector. The default is to allow all virtual servers. | no | virtual-server |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.3.2. JBoss AS 7 and EAP 6 - VHost Service
Overview
Table 3.307. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.308.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.309. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| _aliases | trait | Aliases for this virtual host | _aliases |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.310.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Configuration | no | *Configuration+ | |
| Virtual server aliases | The virtual server aliases | yes | alias |
| Default Web Module | The web module deployment name that will be mapped as the root webapp. | yes | default-web-module |
| Enable Welcome Root | Whether or not the bundled welcome directory is used as the root web context. The default value is false. | yes | enable-welcome-root |
| Name | A unique virtual host name | no | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.3.2.1. JBoss AS 7 and EAP 6 - Rewrite Rules Service
Overview
Table 3.311. Overview
| Description: | A list of rewrite rules that will be processed in order on the URL or vhost specified in the request. Those follow the rules for mod_rewrite. Please consult the manual for help on settings |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.312.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.313.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Conditions | no | *1 | |
| Flags | Option flags for this rewrite rule. Consult the mod_rewrite docs. | yes | flags |
| Pattern | The pattern that will be matched. Consult the mod_rewrite docs. | yes | pattern |
| Substitution | The string that will replace the original URL or vhost. Consult the mod_rewrite docs. | yes | substitution |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.3.2.2. JBoss AS 7 and EAP 6 - Access Log Service
Overview
Table 3.314. Overview
| Description: | The access log configuration for this virtual server. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.315.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.316.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | The relative folder path. | no | path |
| Relative To | The folder the path is relative to. The default value is jboss.server.log.dir. | no | relative-to |
| Extended | Enable extended pattern, with more options. The default value is false. | no | extended |
| Pattern | The access log pattern. The default value is common. | no | pattern |
| Prefix | Prefix for the log file name. The default value is false. | no | prefix |
| Resolve Hosts | Host resolution. The default value is false. | no | resolve-hosts |
| Rotate | Rotate the access log every day. The default value is true. | no | rotate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.4. JBoss AS 7 and EAP 6 - General JCA connectors Service
Overview
Table 3.317. Overview
| Description: | General settings of the JCA engine. Not necessarily for end-users |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.318.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.319.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.5. JBoss AS 7 and EAP 6 - Datasources (Standalone) Service
Overview
Table 3.320. Overview
| Description: | Datasources subsystem for Standalone servers. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.321.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.5.1. JBoss AS 7 and EAP 6 - DataSource (Standalone) Service
Overview
Table 3.322. Overview
| Description: | A non-XA data source |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.323.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.324. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.325.
| 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 | 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-cacheSize |
| 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 Minutes | The background-validation-minutes element specifies the amount of time, in minutes, that background validation will run. Changing this value require a server restart. | no | background-validation-minutes |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.326. Metrics
| Name | Description |
|---|---|
| Enable | Enables the data-source |
| Disable | Disables the data-source |
| 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
none
3.3.5.2. JBoss AS 7 and EAP 6 - XADataSource (Standalone) Service
Overview
Table 3.327. Overview
| Description: | An XA data source |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.328.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.329. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.330.
| 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 | 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-cacheSize |
| 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 Minutes | The background-validation-minutes element specifies the amount of time, in minutes, that background validation will run. Changing this value require a server restart. | no | background-validation-minutes |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.331. Metrics
| Name | Description |
|---|---|
| Enable | Enables the data-source |
| Disable | Disables the data-source |
| 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
none
3.3.6. JBoss AS 7 and EAP 6 - Logging Service
Overview
Table 3.332. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.333.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.334.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.6.1. JBoss AS 7 and EAP 6 - Async Handler Service
Overview
Table 3.335. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.336.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.337.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| 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 |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.338. Metrics
| 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
none
3.3.6.2. JBoss AS 7 and EAP 6 - Console Handler Service
Overview
Table 3.339. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.340.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.341.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.342. Metrics
| Name | Description |
|---|---|
| Disable | Disable a logging handler. |
| Enable | Enable a logging handler. |
Package Types
none
3.3.6.3. JBoss AS 7 and EAP 6 - Custom Handler Service
Overview
Table 3.343. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.344.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.345.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.346. Metrics
| Name | Description |
|---|---|
| Disable | Disable a logging handler. |
| Enable | Enable a logging handler. |
Package Types
none
3.3.6.4. JBoss AS 7 and EAP 6 - File Handler Service
Overview
Table 3.347. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.348.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.349.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.350. Metrics
| Name | Description |
|---|---|
| Disable | Disable a logging handler. |
| Enable | Enable a logging handler. |
Package Types
none
3.3.6.5. JBoss AS 7 and EAP 6 - Logger Service
Overview
Table 3.351. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.352.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.353.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.354. Metrics
| Name | Description |
|---|---|
| Change Log Level | Change the logging level for a logger category. |
Package Types
none
3.3.6.6. JBoss AS 7 and EAP 6 - Periodic Rotating File Handler Service
Overview
Table 3.355. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.356.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.357.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.358. Metrics
| Name | Description |
|---|---|
| Disable | Disable a logging handler. |
| Enable | Enable a logging handler. |
Package Types
none
3.3.6.7. JBoss AS 7 and EAP 6 - Size Rotating File Handler Service
Overview
Table 3.359. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.360.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.361.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.362. Metrics
| Name | Description |
|---|---|
| Disable | Disable a logging handler. |
| Enable | Enable a logging handler. |
Package Types
none
3.3.7. JBoss AS 7 and EAP 6 - Webservices Service
Overview
Table 3.363. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.364.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.365.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.7.1. JBoss AS 7 and EAP 6 - Endpoint Service
Overview
Table 3.366. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.367.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.7.1.1. JBoss AS 7 and EAP 6 - Post Handler Chain Service
Overview
Table 3.368. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.369.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.370.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.7.1.1.1. JBoss AS 7 and EAP 6 - Post Handler Service
Table 3.371. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.372.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.373.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Class | Handler class | yes | class |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.7.1.2. JBoss AS 7 and EAP 6 - Pre Handler Chain Service
Overview
Table 3.374. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.375.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.376.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.7.1.2.1. JBoss AS 7 and EAP 6 - Pre Handler Service
Table 3.377. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.378.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.379.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Class | Handler class | yes | class |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.7.1.3. JBoss AS 7 and EAP 6 - Property Service
Overview
Table 3.380. Overview
| Description: | A property |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.381.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.382.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The property value. | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.8. JBoss AS 7 and EAP 6 - Naming Service
Overview
Table 3.383. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.384.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.385. Metrics
| Name | Description |
|---|---|
| JNDIView | Peek at the JNDI tree |
Package Types
none
3.3.8.1. JBoss AS 7 and EAP 6 - Binding Service
Overview
Table 3.386. Overview
| Description: | JNDI bindings for primitive types |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.387.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.388.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.9. JBoss AS 7 and EAP 6 - Transactions Subsystem (Standalone) Service
Overview
Table 3.389. Overview
| Description: | The transactions subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.390.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.391. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.392.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| 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 | relative-to |
| 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. | no | 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 |
| Path | Denotes a relative or absolute filesystem path denoting where the transaction manager core should store data. By default the value is treated as relative to the path denoted by the 'relative-to' attribute. The default value is var. | no | 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.9.1. JBoss AS 7 and EAP 6 - Log Store (Standalone) Service
Overview
Table 3.393. Overview
| Description: | Representation of the transaction logging storage mechanism. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.394.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.395.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Specifies the implementation type of the logging store. | no | type |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.396. Metrics
| Name | Description |
|---|---|
| Probe | Scan for new transaction logs. This operation will creates a child for each pending transaction. |
Package Types
none
3.3.9.1.1. JBoss AS 7 and EAP 6 - Transactions (Standalone) Service
Overview
Table 3.397. Overview
| Description: | The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.398.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.399.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.400. Metrics
| 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. |
Package Types
none
3.3.9.1.1.1. JBoss AS 7 and EAP 6 - Participants (Standalone) Service
Table 3.401. Overview
| Description: | The resources that did work in a transaction. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.402.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.403.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.404. Metrics
| 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). |
none
3.3.10. JBoss AS 7 and EAP 6 - Network Interface Service
Overview
Table 3.405. Overview
| Description: | A named network interface, along with required criteria for determining the IP address to associate with that interface |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.406.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.407.
| 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. | yes | any-address |
| Any Ipv 4 Address | Attribute indicating that sockets using this interface should be bound to the IPv4 wildcard address (0.0.0.0). | yes | any-ipv4-address |
| Any Ipv 6 Address | Attribute indicating that sockets using this interface should be bound to the IPv6 wildcard address (::). | yes | any-ipv6-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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.11. JBoss AS 7 and EAP 6 - SocketBindingGroup Service
Overview
Table 3.408. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.409.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.410.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.12. JBoss AS 7 and EAP 6 - Deployment Service
Overview
Table 3.411. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.412.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.413. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.414.
| 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.) | yes | enabled |
| Name | Unique identifier of the deployment. Must be unique across all deployments. | yes | 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. | yes | 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. | yes | runtime-name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.415. Metrics
| Name | Description |
|---|---|
| Enable | |
| Disable | |
| Restart |
Package Types
Table 3.416. Package Types
| Name | Category | Description |
|---|---|---|
| File | Deployable | Deployments on this server group |
3.3.12.1. JBoss AS 7 and EAP 6 - Subdeployment Service
Overview
Table 3.417. Overview
| Description: | Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.418.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.1.1. JBoss AS 7 and EAP 6 - Web Runtime Service
Overview
Table 3.419. Overview
| Description: | Runtime resources exposed by web components in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.420.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.421. 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 |
| Response Time | calltime | the minimum, maximum, and average response times for requests serviced by this webapp | responseTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.1.2. JBoss AS 7 and EAP 6 - Datasources Runtime Service
Overview
Table 3.422. Overview
| Description: | Runtime resources exposed by data sources included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.423.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.1.2.1. JBoss AS 7 and EAP 6 - XA Datasource Runtime Service
Table 3.424. Overview
| Description: | A JDBC XA data-source configuration |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.425.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.426.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Properties | no | *2 | |
| 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 | 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 |
| Background Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 can be done only on disabled datasource, requires a server restart otherwise | no | background-validation-millis |
| 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 |
| Check Valid Connection Sql | Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool | no | check-valid-connection-sql |
| 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 |
| Enabled | Specifies if the datasource should be enabled | no | enabled |
| Exception Sorter Class Name | An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error | no | exception-sorter-class-name |
| Exception Sorter Properties | The exception sorter properties | no | exception-sorter-properties |
| 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 can be done only on disabled datasource, requires a server restart otherwise. | no | idle-timeout-minutes |
| Interleaving | An element to enable interleaving for XA connections. The default value is false. | no | interleaving |
| Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
| Jta | Enable JTA integration. The default value is true. | no | jta |
| 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 |
| New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool | no | new-connection-sql |
| 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 |
| Password | Specifies the password used when creating a new connection | no | password |
| Pool Prefill | Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 |
| Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
| Query Timeout | Any configured query timeout in seconds. If not provided no timeout will be set | no | query-timeout |
| Reauth Plugin Class Name | The fully qualified class name of the reauthentication plugin implementation | no | reauth-plugin-class-name |
| Reauth Plugin Properties | The properties for the reauthentication plugin | no | reauth-plugin-properties |
| 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 Domain | Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool | no | security-domain |
| 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. The default value is false. | no | set-tx-query-timeout |
| Share Prepared Statements | Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false. | no | share-prepared-statements |
| Spy | Enable spying of SQL statements. The default value is false. | no | spy |
| Stale Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException | no | stale-connection-checker-class-name |
| Stale Connection Checker Properties | The stale connection checker properties | no | stale-connection-checker-properties |
| Track Statements | Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'. | no | track-statements |
| Transaction Isolation | Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE | no | transaction-isolation |
| Url Delimiter | Specifies the delimeter 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 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 datasource 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 |
| User Name | Specify the user name used when creating a new connection | no | user-name |
| Valid Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element | no | valid-connection-checker-class-name |
| Valid Connection Checker Properties | The valid connection checker properties | no | valid-connection-checker-properties |
| Validate On Match | The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false. | no | validate-on-match |
| 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 Datasource Class | The fully qualifed name of the javax.sql.XADataSource implementation | no | xa-datasource-class |
| Xa Resource Timeout | The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero | no | xa-resource-timeout |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.427. Metrics
| 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 |
none
3.3.12.1.2.2. JBoss AS 7 and EAP 6 - Datasource Runtime Service
Table 3.428. Overview
| Description: | A JDBC data-source configuration |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.429.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.430.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connection Property | no | *1 | |
| 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 | 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 |
| Background Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 can be done only on disabled datasource, requires a server restart otherwise | no | background-validation-millis |
| 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 |
| Check Valid Connection Sql | Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool | no | check-valid-connection-sql |
| Connection Url | The JDBC driver connection URL | yes | connection-url |
| Datasource Class | The fully qualifed name of the JDBC datasource class | no | datasource-class |
| Driver Class | The fully qualifed name of the JDBC driver class | no | driver-class |
| 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 |
| Enabled | Specifies if the datasource should be enabled | no | enabled |
| Exception Sorter Class Name | An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error | no | exception-sorter-class-name |
| Exception Sorter Properties | The exception sorter properties | no | exception-sorter-properties |
| 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 can be done only on disabled datasource, requires a server restart otherwise. | no | idle-timeout-minutes |
| Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
| Jta | Enable JTA integration. The default value is true. | no | jta |
| 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 |
| New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool | no | new-connection-sql |
| Password | Specifies the password used when creating a new connection | no | password |
| Pool Prefill | Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 |
| Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
| Query Timeout | Any configured query timeout in seconds. If not provided no timeout will be set | no | query-timeout |
| Reauth Plugin Class Name | The fully qualified class name of the reauthentication plugin implementation | no | reauth-plugin-class-name |
| Reauth Plugin Properties | The properties for the reauthentication plugin | no | reauth-plugin-properties |
| 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 |
| 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. The default value is false. | no | set-tx-query-timeout |
| Share Prepared Statements | Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false. | no | share-prepared-statements |
| Spy | Enable spying of SQL statements. The default value is false. | no | spy |
| Stale Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException | no | stale-connection-checker-class-name |
| Stale Connection Checker Properties | The stale connection checker properties | no | stale-connection-checker-properties |
| Track Statements | Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'. | no | track-statements |
| Transaction Isolation | Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE | no | transaction-isolation |
| Url Delimiter | Specifies the delimeter 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 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 datasource 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 |
| User Name | Specify the user name used when creating a new connection | no | user-name |
| Valid Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element | no | valid-connection-checker-class-name |
| Valid Connection Checker Properties | The valid connection checker properties | no | valid-connection-checker-properties |
| Validate On Match | The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false. | no | validate-on-match |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.431. Metrics
| 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 |
none
3.3.12.1.3. JBoss AS 7 and EAP 6 - Messaging Runtime Service
Overview
Table 3.432. Overview
| Description: | Runtime resources exposed by messaging resources included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.433.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.1.3.1. JBoss AS 7 and EAP 6 - HornetQ Server Runtime Service
Table 3.434. Overview
| Description: | A HornetQ server instance. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.435.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.436. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this server is started. | started |
| Version | trait | The server's version. | version |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.437.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Failback | Whether this server will automatically shutdown if the original live server comes back up. The default value is true. | no | allow-failback |
| 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 |
| Backup | Whether this server is a backup server. The default value is false. | no | backup |
| 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 HORNETQ.CLUSTER.ADMIN.USER. | no | cluster-user |
| Clustered | Whether the server is clustered. The default value is false. | no | clustered |
| Connection Ttl Override | 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 |
| 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 |
| Failback Delay | How long to wait before failback occurs on live server restart. The default value is 5000. | no | failback-delay |
| Failover On Shutdown | Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false. | no | failover-on-shutdown |
| Id Cache Size | The size of the cache for pre-creating message IDs. The default value is 2000. | no | id-cache-size |
| Jmx Domain | The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq. | no | jmx-domain |
| Jmx Management Enabled | Whether HornetQ 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 | The size of the internal buffer on the journal. | no | journal-buffer-size |
| Journal Buffer Timeout | The timeout (in nanoseconds) used to flush internal buffers on the journal. | no | journal-buffer-timeout |
| Journal Compact Min Files | The minimal number of journal data files before we can start compacting. The default value is 10. | no | journal-compact-min-files |
| Journal Compact Percentage | The percentage of live data on which we consider compacting the journal. The default value is 30. | no | journal-compact-percentage |
| Journal File Size | The size (in bytes) of each journal file. The default value is 10485760. | no | journal-file-size |
| Journal Max Io | The maximum number of write requests that can be in the AIO queue at any one time. | no | journal-max-io |
| Journal Min Files | How many journal files to pre-create. The default value is 2. | no | journal-min-files |
| 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 |
| Live Connector Ref | The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'. | no | live-connector-ref |
| 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.hornetq.management. | no | management-address |
| Management Notification Address | The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications. | no | management-notification-address |
| Memory Measure Interval | 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 | Percentage of available memory which if exceeded results in a warning log. The default value is 25. | no | memory-warning-threshold:expr |
| Message Counter Enabled | Whether message counters are enabled. The default value is false. | no | message-counter-enabled |
| Message Counter Max Day History | How many days to keep message counter history. The default value is 10. | no | message-counter-max-day-history |
| Message Counter Sample Period | The sample period (in ms) to use for message counters. The default value is 10000. | no | message-counter-sample-period |
| Message Expiry Scan Period | How often (in ms) to scan for expired messages. The default value is 30000. | no | message-expiry-scan-period |
| Message Expiry Thread Priority | The priority of the thread expiring messages. The default value is 3. | no | message-expiry-thread-priority |
| Page Max Concurrent Io | The maximum number of concurrent reads allowed on paging. The default value is 5. | no | page-max-concurrent-io |
| Perf Blast Pages | TODO. The default value is -1. | no | perf-blast-pages |
| 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 |
| Remoting Interceptors | The list of interceptor classes used by this server. | no | remoting-interceptors |
| 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 | 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 | How long (in ms) to wait before invalidating the security cache. The default value is 10000. | no | security-invalidation-interval |
| Server Dump Interval | 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 |
| Shared Store | Whether this server is using a shared store for failover. The default value is true. | no | shared-store |
| Thread Pool Max Size | 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 | 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 |
| Transaction Timeout Scan Period | How often (in ms) to scan for timeout transactions. The default value is 1000. | no | transaction-timeout-scan-period |
| Wild Card Routing Enabled | Whether the server supports wild card routing. The default value is true. | no | wild-card-routing-enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.438. Metrics
| Name | Description |
|---|---|
| Close Connections for Address | Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise. |
| Commit Prepared Transaction | Heuristically commits a prepared transaction. |
| 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. The returned String is a JSON string containing an array of address settings details. |
| Get Connectors as JSON | Returns the connectors configured for this server using JSON serialization. |
| Get Last Sent Message ID | Returns the ID of the last message sent from the given session to the given address. |
| Get Session Creation Time | Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch. |
| List All Consumers as JSON | Lists all the consumers. |
| List Connection IDs | Lists the IDs of all the connections connected to this server. |
| List Connections as JSON | List all JMS connections. |
| List Consumers as JSON | Lists all the consumers which belongs to the JMS Connection specified by the connection-id. |
| List Heuristic Committed Transactions | Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Heuristic Rolled Back Transactions | Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Prepared Transaction Details as HTML | List all the prepared transaction, sorted by date, oldest first, with details, in HTML format. |
| List Prepared Transaction Details as JSON | List all the prepared transaction, sorted by date, oldest first, with details, in JSON format. |
| List Prepared Transaction JMS Details as HTML | List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format |
| List Prepared Transaction JMS details as JSON | List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format |
| List Prepared Transactions | List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions. |
| 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 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. The returned String is a JSON string containing an array of session ids. |
| List Target Destinations | Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names. |
| Reset All Message Counter Histories | Reset all message counters history. |
| Reset All Message Counters | Reset all message counters. |
| Rollback Prepared Transaction | Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise. |
none
3.3.12.1.3.1.1. JBoss AS 7 and EAP 6 - JMS Queue Runtime Service
Table 3.439. Overview
| Description: | Defines a JMS queue. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.440.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.441. Metrics
| 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 |
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.442.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Entries | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.443. Metrics
| 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. |
none
3.3.12.1.3.1.2. JBoss AS 7 and EAP 6 - JMS Topic Runtime Service
Table 3.444. Overview
| Description: | Defines a JMS queue. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.445.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.446. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.447.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Names | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.448. Metrics
| 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. |
none
3.3.12.1.4. JBoss AS 7 and EAP 6 - EJB3 Runtime Service
Overview
Table 3.449. Overview
| Description: | Runtime resources exposed by EJBs components included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.450.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.1.4.1. JBoss AS 7 and EAP 6 - Message Driven Bean Runtime Service
Table 3.451. Overview
| Description: | Bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.452.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.453. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.454.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.12.1.4.2. JBoss AS 7 and EAP 6 - Singleton Bean Runtime Service
Table 3.455. Overview
| Description: | Singleton bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.456.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.457.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.12.1.4.3. JBoss AS 7 and EAP 6 - Stateless Session Bean Runtime Service
Table 3.458. Overview
| Description: | Stateless session bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.459.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.460. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.461.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.12.1.4.4. JBoss AS 7 and EAP 6 - Entity Bean Runtime Service
Table 3.462. Overview
| Description: | Entity bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.463.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.464. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.465.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.12.1.4.5. JBoss AS 7 and EAP 6 - Stateful Session Bean Runtime Service
Table 3.466. Overview
| Description: | Stateful session bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.467.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.468.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.12.1.5. JBoss AS 7 and EAP 6 - Webservices Runtime Service
Overview
Table 3.469. Overview
| Description: | Runtime resources exposed by web service components in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.470.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.1.5.1. JBoss AS 7 and EAP 6 - Endpoint Runtime Service
Table 3.471. Overview
| Description: | Webservice endpoint. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.472.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.473. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.474.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Class | Webservice endpoint class. | yes | class |
| Context | Webservice endpoint context. | yes | context |
| Name | Webservice endpoint name. | yes | name |
| Type | Webservice endpoint type. | yes | type |
| Wsdl Url | Webservice endpoint WSDL URL. | yes | wsdl-url |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.12.1.6. JBoss AS 7 and EAP 6 - JPA Runtime Service
Overview
Table 3.475. Overview
| Description: | The configuration of the JPA subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.476.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.1.6.1. JBoss AS 7 and EAP 6 - Hibernate Persistence Unit Service
Table 3.477. Overview
| Description: | Runtime information about JPA use in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Table 3.478.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.479. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.480.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Enabled | Determine if statistics are enabled. | no | enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.481. Metrics
| Name | Description |
|---|---|
| Subsystem:clear | Clear statistics. |
| Subsystem:evict All | Evict all entities from second level cache. |
| Subsystem:summary | Log the statistics. |
none
3.3.12.1.6.1.1. JBoss AS 7 and EAP 6 - Entity Cache Service
Table 3.482. Overview
| Description: | Statistics for a Hibernate Second Level Cache region. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.483.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.484. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.3.12.1.6.1.2. JBoss AS 7 and EAP 6 - Query Cache Service
Table 3.485. Overview
| Description: | Statistics for individual queries. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.486.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.487. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Query Cache Hit Count | measurement | Get the number of times query was retrieved from cache. | query-cache-hit-count |
| Query Cache Hit Count per Minute | measurement | Get the number of times query was retrieved from cache. | query-cache-hit-count |
| Query Cache Miss Count | measurement | Get the number of times query was not found in cache. | query-cache-miss-count |
| Query Cache Miss Count per Minute | measurement | Get the number of times query was not found in cache. | query-cache-miss-count |
| Query Cache Put Count | measurement | Get the number of times query was put in cache. | query-cache-put-count |
| Query Cache Put Count per Minute | measurement | Get the number of times query was put in cache. | query-cache-put-count |
| Query Execution Average Time | measurement | Get the average time in milliseconds of the query. | query-execution-average-time |
| Query Execution Count | measurement | Get number of times query has been executed. | query-execution-count |
| Query Execution Count per Minute | measurement | Get number of times query has been executed. | query-execution-count |
| Query Execution Max Time | measurement | Get the time in milliseconds of the query. | query-execution-max-time |
| Query Execution Min Time | measurement | Get the minimum time in milliseconds of the query. | query-execution-min-time |
| Query Execution Row Count | measurement | Get number of rows returned from executions of query. | query-execution-row-count |
| Query Execution Row Count per Minute | measurement | Get number of rows returned from executions of query. | query-execution-row-count |
| Query Name | trait | Query name. | query-name |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.3.12.1.6.1.3. JBoss AS 7 and EAP 6 - Entity Service
Table 3.488. Overview
| Description: | Statistics for individual entities. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.489.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.490. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.3.12.1.6.1.4. JBoss AS 7 and EAP 6 - Collection Service
Table 3.491. Overview
| Description: | Statistics for individual collections. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.492.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.493. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.3.12.2. JBoss AS 7 and EAP 6 - Web Runtime Service
Overview
Table 3.494. Overview
| Description: | Runtime resources exposed by web components in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.495.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.496. 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 |
| Response Time | calltime | the minimum, maximum, and average response times for requests serviced by this webapp | responseTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.3. JBoss AS 7 and EAP 6 - Datasources Runtime Service
Overview
Table 3.497. Overview
| Description: | Runtime resources exposed by data sources included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.498.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.3.1. JBoss AS 7 and EAP 6 - XA Datasource Runtime Service
Overview
Table 3.499. Overview
| Description: | A JDBC XA data-source configuration |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.500.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.501.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Properties | no | *2 | |
| 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 | 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 |
| Background Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 can be done only on disabled datasource, requires a server restart otherwise | no | background-validation-millis |
| 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 |
| Check Valid Connection Sql | Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool | no | check-valid-connection-sql |
| 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 |
| Enabled | Specifies if the datasource should be enabled | no | enabled |
| Exception Sorter Class Name | An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error | no | exception-sorter-class-name |
| Exception Sorter Properties | The exception sorter properties | no | exception-sorter-properties |
| 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 can be done only on disabled datasource, requires a server restart otherwise. | no | idle-timeout-minutes |
| Interleaving | An element to enable interleaving for XA connections. The default value is false. | no | interleaving |
| Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
| Jta | Enable JTA integration. The default value is true. | no | jta |
| 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 |
| New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool | no | new-connection-sql |
| 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 |
| Password | Specifies the password used when creating a new connection | no | password |
| Pool Prefill | Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 |
| Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
| Query Timeout | Any configured query timeout in seconds. If not provided no timeout will be set | no | query-timeout |
| Reauth Plugin Class Name | The fully qualified class name of the reauthentication plugin implementation | no | reauth-plugin-class-name |
| Reauth Plugin Properties | The properties for the reauthentication plugin | no | reauth-plugin-properties |
| 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 Domain | Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool | no | security-domain |
| 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. The default value is false. | no | set-tx-query-timeout |
| Share Prepared Statements | Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false. | no | share-prepared-statements |
| Spy | Enable spying of SQL statements. The default value is false. | no | spy |
| Stale Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException | no | stale-connection-checker-class-name |
| Stale Connection Checker Properties | The stale connection checker properties | no | stale-connection-checker-properties |
| Track Statements | Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'. | no | track-statements |
| Transaction Isolation | Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE | no | transaction-isolation |
| Url Delimiter | Specifies the delimeter 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 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 datasource 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 |
| User Name | Specify the user name used when creating a new connection | no | user-name |
| Valid Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element | no | valid-connection-checker-class-name |
| Valid Connection Checker Properties | The valid connection checker properties | no | valid-connection-checker-properties |
| Validate On Match | The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false. | no | validate-on-match |
| 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 Datasource Class | The fully qualifed name of the javax.sql.XADataSource implementation | no | xa-datasource-class |
| Xa Resource Timeout | The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero | no | xa-resource-timeout |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.502. Metrics
| 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 |
Package Types
none
3.3.12.3.2. JBoss AS 7 and EAP 6 - Datasource Runtime Service
Overview
Table 3.503. Overview
| Description: | A JDBC data-source configuration |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.504.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.505.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connection Property | no | *1 | |
| 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 | 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 |
| Background Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 can be done only on disabled datasource, requires a server restart otherwise | no | background-validation-millis |
| 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 |
| Check Valid Connection Sql | Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool | no | check-valid-connection-sql |
| Connection Url | The JDBC driver connection URL | yes | connection-url |
| Datasource Class | The fully qualifed name of the JDBC datasource class | no | datasource-class |
| Driver Class | The fully qualifed name of the JDBC driver class | no | driver-class |
| 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 |
| Enabled | Specifies if the datasource should be enabled | no | enabled |
| Exception Sorter Class Name | An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error | no | exception-sorter-class-name |
| Exception Sorter Properties | The exception sorter properties | no | exception-sorter-properties |
| 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 can be done only on disabled datasource, requires a server restart otherwise. | no | idle-timeout-minutes |
| Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
| Jta | Enable JTA integration. The default value is true. | no | jta |
| 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 |
| New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool | no | new-connection-sql |
| Password | Specifies the password used when creating a new connection | no | password |
| Pool Prefill | Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 |
| Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
| Query Timeout | Any configured query timeout in seconds. If not provided no timeout will be set | no | query-timeout |
| Reauth Plugin Class Name | The fully qualified class name of the reauthentication plugin implementation | no | reauth-plugin-class-name |
| Reauth Plugin Properties | The properties for the reauthentication plugin | no | reauth-plugin-properties |
| 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 |
| 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. The default value is false. | no | set-tx-query-timeout |
| Share Prepared Statements | Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false. | no | share-prepared-statements |
| Spy | Enable spying of SQL statements. The default value is false. | no | spy |
| Stale Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException | no | stale-connection-checker-class-name |
| Stale Connection Checker Properties | The stale connection checker properties | no | stale-connection-checker-properties |
| Track Statements | Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'. | no | track-statements |
| Transaction Isolation | Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE | no | transaction-isolation |
| Url Delimiter | Specifies the delimeter 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 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 datasource 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 |
| User Name | Specify the user name used when creating a new connection | no | user-name |
| Valid Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element | no | valid-connection-checker-class-name |
| Valid Connection Checker Properties | The valid connection checker properties | no | valid-connection-checker-properties |
| Validate On Match | The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false. | no | validate-on-match |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.506. Metrics
| 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 |
Package Types
none
3.3.12.4. JBoss AS 7 and EAP 6 - Messaging Runtime Service
Overview
Table 3.507. Overview
| Description: | Runtime resources exposed by messaging resources included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.508.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.4.1. JBoss AS 7 and EAP 6 - HornetQ Server Runtime Service
Overview
Table 3.509. Overview
| Description: | A HornetQ server instance. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.510.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.511. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this server is started. | started |
| Version | trait | The server's version. | version |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.512.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Failback | Whether this server will automatically shutdown if the original live server comes back up. The default value is true. | no | allow-failback |
| 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 |
| Backup | Whether this server is a backup server. The default value is false. | no | backup |
| 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 HORNETQ.CLUSTER.ADMIN.USER. | no | cluster-user |
| Clustered | Whether the server is clustered. The default value is false. | no | clustered |
| Connection Ttl Override | 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 |
| 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 |
| Failback Delay | How long to wait before failback occurs on live server restart. The default value is 5000. | no | failback-delay |
| Failover On Shutdown | Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false. | no | failover-on-shutdown |
| Id Cache Size | The size of the cache for pre-creating message IDs. The default value is 2000. | no | id-cache-size |
| Jmx Domain | The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq. | no | jmx-domain |
| Jmx Management Enabled | Whether HornetQ 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 | The size of the internal buffer on the journal. | no | journal-buffer-size |
| Journal Buffer Timeout | The timeout (in nanoseconds) used to flush internal buffers on the journal. | no | journal-buffer-timeout |
| Journal Compact Min Files | The minimal number of journal data files before we can start compacting. The default value is 10. | no | journal-compact-min-files |
| Journal Compact Percentage | The percentage of live data on which we consider compacting the journal. The default value is 30. | no | journal-compact-percentage |
| Journal File Size | The size (in bytes) of each journal file. The default value is 10485760. | no | journal-file-size |
| Journal Max Io | The maximum number of write requests that can be in the AIO queue at any one time. | no | journal-max-io |
| Journal Min Files | How many journal files to pre-create. The default value is 2. | no | journal-min-files |
| 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 |
| Live Connector Ref | The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'. | no | live-connector-ref |
| 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.hornetq.management. | no | management-address |
| Management Notification Address | The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications. | no | management-notification-address |
| Memory Measure Interval | 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 | Percentage of available memory which if exceeded results in a warning log. The default value is 25. | no | memory-warning-threshold:expr |
| Message Counter Enabled | Whether message counters are enabled. The default value is false. | no | message-counter-enabled |
| Message Counter Max Day History | How many days to keep message counter history. The default value is 10. | no | message-counter-max-day-history |
| Message Counter Sample Period | The sample period (in ms) to use for message counters. The default value is 10000. | no | message-counter-sample-period |
| Message Expiry Scan Period | How often (in ms) to scan for expired messages. The default value is 30000. | no | message-expiry-scan-period |
| Message Expiry Thread Priority | The priority of the thread expiring messages. The default value is 3. | no | message-expiry-thread-priority |
| Page Max Concurrent Io | The maximum number of concurrent reads allowed on paging. The default value is 5. | no | page-max-concurrent-io |
| Perf Blast Pages | TODO. The default value is -1. | no | perf-blast-pages |
| 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 |
| Remoting Interceptors | The list of interceptor classes used by this server. | no | remoting-interceptors |
| 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 | 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 | How long (in ms) to wait before invalidating the security cache. The default value is 10000. | no | security-invalidation-interval |
| Server Dump Interval | 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 |
| Shared Store | Whether this server is using a shared store for failover. The default value is true. | no | shared-store |
| Thread Pool Max Size | 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 | 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 |
| Transaction Timeout Scan Period | How often (in ms) to scan for timeout transactions. The default value is 1000. | no | transaction-timeout-scan-period |
| Wild Card Routing Enabled | Whether the server supports wild card routing. The default value is true. | no | wild-card-routing-enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.513. Metrics
| Name | Description |
|---|---|
| Close Connections for Address | Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise. |
| Commit Prepared Transaction | Heuristically commits a prepared transaction. |
| 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. The returned String is a JSON string containing an array of address settings details. |
| Get Connectors as JSON | Returns the connectors configured for this server using JSON serialization. |
| Get Last Sent Message ID | Returns the ID of the last message sent from the given session to the given address. |
| Get Session Creation Time | Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch. |
| List All Consumers as JSON | Lists all the consumers. |
| List Connection IDs | Lists the IDs of all the connections connected to this server. |
| List Connections as JSON | List all JMS connections. |
| List Consumers as JSON | Lists all the consumers which belongs to the JMS Connection specified by the connection-id. |
| List Heuristic Committed Transactions | Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Heuristic Rolled Back Transactions | Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Prepared Transaction Details as HTML | List all the prepared transaction, sorted by date, oldest first, with details, in HTML format. |
| List Prepared Transaction Details as JSON | List all the prepared transaction, sorted by date, oldest first, with details, in JSON format. |
| List Prepared Transaction JMS Details as HTML | List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format |
| List Prepared Transaction JMS details as JSON | List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format |
| List Prepared Transactions | List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions. |
| 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 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. The returned String is a JSON string containing an array of session ids. |
| List Target Destinations | Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names. |
| Reset All Message Counter Histories | Reset all message counters history. |
| Reset All Message Counters | Reset all message counters. |
| Rollback Prepared Transaction | Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise. |
Package Types
none
3.3.12.4.1.1. JBoss AS 7 and EAP 6 - JMS Queue Runtime Service
Table 3.514. Overview
| Description: | Defines a JMS queue. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.515.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.516. Metrics
| 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 |
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.517.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Entries | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.518. Metrics
| 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. |
none
3.3.12.4.1.2. JBoss AS 7 and EAP 6 - JMS Topic Runtime Service
Table 3.519. Overview
| Description: | Defines a JMS queue. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.520.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.521. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.522.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Names | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.523. Metrics
| 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. |
none
3.3.12.5. JBoss AS 7 and EAP 6 - EJB3 Runtime Service
Overview
Table 3.524. Overview
| Description: | Runtime resources exposed by EJBs components included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.525.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.5.1. JBoss AS 7 and EAP 6 - Message Driven Bean Runtime Service
Overview
Table 3.526. Overview
| Description: | Bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.527.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.528. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.529.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.12.5.2. JBoss AS 7 and EAP 6 - Singleton Bean Runtime Service
Overview
Table 3.530. Overview
| Description: | Singleton bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.531.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.532.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.12.5.3. JBoss AS 7 and EAP 6 - Stateless Session Bean Runtime Service
Overview
Table 3.533. Overview
| Description: | Stateless session bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.534.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.535. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.536.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.12.5.4. JBoss AS 7 and EAP 6 - Entity Bean Runtime Service
Overview
Table 3.537. Overview
| Description: | Entity bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.538.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.539. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.540.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.12.5.5. JBoss AS 7 and EAP 6 - Stateful Session Bean Runtime Service
Overview
Table 3.541. Overview
| Description: | Stateful session bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.542.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.543.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.12.6. JBoss AS 7 and EAP 6 - Webservices Runtime Service
Overview
Table 3.544. Overview
| Description: | Runtime resources exposed by web service components in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.545.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.6.1. JBoss AS 7 and EAP 6 - Endpoint Runtime Service
Overview
Table 3.546. Overview
| Description: | Webservice endpoint. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.547.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.548. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.549.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Class | Webservice endpoint class. | yes | class |
| Context | Webservice endpoint context. | yes | context |
| Name | Webservice endpoint name. | yes | name |
| Type | Webservice endpoint type. | yes | type |
| Wsdl Url | Webservice endpoint WSDL URL. | yes | wsdl-url |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.12.7. JBoss AS 7 and EAP 6 - JPA Runtime Service
Overview
Table 3.550. Overview
| Description: | The configuration of the JPA subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.551.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.12.7.1. JBoss AS 7 and EAP 6 - Hibernate Persistence Unit Service
Overview
Table 3.552. Overview
| Description: | Runtime information about JPA use in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.553.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.554. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.555.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Enabled | Determine if statistics are enabled. | no | enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.556. Metrics
| Name | Description |
|---|---|
| Subsystem:clear | Clear statistics. |
| Subsystem:evict All | Evict all entities from second level cache. |
| Subsystem:summary | Log the statistics. |
Package Types
none
3.3.12.7.1.1. JBoss AS 7 and EAP 6 - Entity Cache Service
Table 3.557. Overview
| Description: | Statistics for a Hibernate Second Level Cache region. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.558.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.559. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.3.12.7.1.2. JBoss AS 7 and EAP 6 - Query Cache Service
Table 3.560. Overview
| Description: | Statistics for individual queries. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.561.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.562. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Query Cache Hit Count | measurement | Get the number of times query was retrieved from cache. | query-cache-hit-count |
| Query Cache Hit Count per Minute | measurement | Get the number of times query was retrieved from cache. | query-cache-hit-count |
| Query Cache Miss Count | measurement | Get the number of times query was not found in cache. | query-cache-miss-count |
| Query Cache Miss Count per Minute | measurement | Get the number of times query was not found in cache. | query-cache-miss-count |
| Query Cache Put Count | measurement | Get the number of times query was put in cache. | query-cache-put-count |
| Query Cache Put Count per Minute | measurement | Get the number of times query was put in cache. | query-cache-put-count |
| Query Execution Average Time | measurement | Get the average time in milliseconds of the query. | query-execution-average-time |
| Query Execution Count | measurement | Get number of times query has been executed. | query-execution-count |
| Query Execution Count per Minute | measurement | Get number of times query has been executed. | query-execution-count |
| Query Execution Max Time | measurement | Get the time in milliseconds of the query. | query-execution-max-time |
| Query Execution Min Time | measurement | Get the minimum time in milliseconds of the query. | query-execution-min-time |
| Query Execution Row Count | measurement | Get number of rows returned from executions of query. | query-execution-row-count |
| Query Execution Row Count per Minute | measurement | Get number of rows returned from executions of query. | query-execution-row-count |
| Query Name | trait | Query name. | query-name |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.3.12.7.1.3. JBoss AS 7 and EAP 6 - Entity Service
Table 3.563. Overview
| Description: | Statistics for individual entities. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.564.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.565. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.3.12.7.1.4. JBoss AS 7 and EAP 6 - Collection Service
Table 3.566. Overview
| Description: | Statistics for individual collections. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.567.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.568. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.3.13. JBoss AS 7 and EAP 6 - DeploymentScanner Service
Overview
Table 3.569. Overview
| Description: | Management of the deployment scanner |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.570.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.571.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Scanners | List of scanners | yes | * |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.14. JBoss AS 7 and EAP 6 - JacORB Service
Overview
Table 3.572. Overview
| Description: | JacORB subsystem configuration |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.573.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.574.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.15. JBoss AS 7 and EAP 6 - JDR Service
Overview
Table 3.575. Overview
| Description: | JBoss Diagnostic Reporter (JDR) Subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.576.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.577. Metrics
| Name | Description |
|---|---|
| Generate JDR Report | Request the generation of a JDR report. |
Package Types
none
3.3.16. JBoss AS 7 and EAP 6 - JCA Service
Overview
Table 3.578. Overview
| Description: | The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.579.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.580.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.16.1. JBoss AS 7 and EAP 6 - BootstrapContext Service
Overview
Table 3.581. Overview
| Description: | Bootstrap context for resource adapters. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.582.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.583.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of the BootstrapContext | no | name |
| Workmanager | The WorkManager instance for the BootstrapContext | no | workmanager |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.16.2. JBoss AS 7 and EAP 6 - Workmanager Service
Overview
Table 3.584. Overview
| Description: | WorkManager for resource adapters. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.585.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.586.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of the WorkManager | no | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.16.2.1. JBoss AS 7 and EAP 6 - Long Running Thread Pool Service
Overview
Table 3.587. Overview
| Description: | Long running thread pool executor with a bounded queue where threads submitting tasks may block. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.588.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.589. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
| Keepalive Time:time | measurement | The time | keepalive-time:time |
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.590.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.16.2.2. JBoss AS 7 and EAP 6 - Short Running Thread Pool Service
Overview
Table 3.591. Overview
| Description: | Short running thread pool executor with a bounded queue where threads submitting tasks may block. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.592.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.593. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
| Keepalive Time:time | measurement | The time | keepalive-time:time |
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.594.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.17. JBoss AS 7 and EAP 6 - JAXR Service
Overview
Table 3.595. Overview
| Description: | The configuration of the JAXR subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.596.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.597.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.17.1. JBoss AS 7 and EAP 6 - Property (JAXR) Service
Overview
Table 3.598. Overview
| Description: | A JAXR property. The identity of the resource defines the property name. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.599.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.600.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The JAXR property value. | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.18. JBoss AS 7 and EAP 6 - JPA Service
Overview
Table 3.601. Overview
| Description: | The configuration of the JPA subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.602.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.603.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Default Datasource | The name of the default global datasource. | no | default-datasource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.19. JBoss AS 7 and EAP 6 - CMP Service
Overview
Table 3.604. Overview
| Description: | The configuration of the cmp subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.605.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.19.1. JBoss AS 7 and EAP 6 - HiloKeygenerator Service
Overview
Table 3.606. Overview
| Description: | HiLo based key generators. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.607.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.608.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.20. JBoss AS 7 and EAP 6 - EE Service
Overview
Table 3.609. Overview
| Description: | The configuration of the EE subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.610.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.611.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.21. JBoss AS 7 and EAP 6 - Security Service
Overview
Table 3.612. Overview
| Description: | The configuration of the security subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.613.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.614.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.21.1. JBoss AS 7 and EAP 6 - Security Domain Service
Overview
Table 3.615. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.616.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.617.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.618. Metrics
| 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
none
3.3.21.1.1. JBoss AS 7 and EAP 6 - ACL Service
Overview
Table 3.619. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.620.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.621.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Acl Modules | List of acl modules | no | acl-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.21.1.2. JBoss AS 7 and EAP 6 - Audit Service
Overview
Table 3.622. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.623.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.624.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Provider Modules | List of provider modules | no | provider-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.21.1.3. JBoss AS 7 and EAP 6 - Authentication (Classic) Service
Overview
Table 3.625. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.626.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.627.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Login Modules | List of authentication modules | no | login-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.21.1.4. JBoss AS 7 and EAP 6 - Authentication (Jaspi) Service
Overview
Table 3.628. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.629.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.630.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Auth Modules | List of authentication modules to be used. | yes | auth-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.21.1.4.1. JBoss AS 7 and EAP 6 - Login Module Stack Service
Table 3.631. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.632.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.633.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Login Modules | List of authentication modules | yes | login-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.21.1.5. JBoss AS 7 and EAP 6 - Authorization Service
Overview
Table 3.634. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.635.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.636.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Policy Modules | List of authorization modules | no | policy-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.21.1.6. JBoss AS 7 and EAP 6 - Identity Trust Service
Overview
Table 3.637. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.638.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.639.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Trust Modules | List of trust modules | no | trust-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.21.1.7. JBoss AS 7 and EAP 6 - JSSE Service
Overview
Table 3.640. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.641.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.642.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.21.1.8. JBoss AS 7 and EAP 6 - Mapping Service
Overview
Table 3.643. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.644.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.645.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Mapping Modules | List of modules that map principal, role, and credential information | no | mapping-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.21.2. JBoss AS 7 and EAP 6 - Vault Service
Overview
Table 3.646. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.647.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.648.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Code | Fully Qualified Name of the Security Vault Implementation. | no | code |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.22. JBoss AS 7 and EAP 6 - Threads Service
Overview
Table 3.649. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.650.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.22.1. JBoss AS 7 and EAP 6 - ThreadFactory Service
Overview
Table 3.651. Overview
| Description: | A thread factory (implementing java.util.concurrent.ThreadFactory). |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.652.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.653.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.22.2. JBoss AS 7 and EAP 6 - ThreadPool Service
Overview
Table 3.654. Overview
| Description: | A thread pool executor |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.655.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.656. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.657.
| 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 |
| 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 |
| Thread Pool Type | Thread pool type | yes | __type |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23. JBoss AS 7 and EAP 6 - EJB3 Service
Overview
Table 3.658. Overview
| Description: | The configuration of the ejb3 subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.659.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.660.
| 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 hornetq-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 |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23.1. JBoss AS 7 and EAP 6 - EJB3 Thread Pool Service
Overview
Table 3.661. 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: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.662.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.663. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.664.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23.2. JBoss AS 7 and EAP 6 - File Passivation Store Service
Overview
Table 3.665. Overview
| Description: | A file system based passivation store. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.666.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.667.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23.3. JBoss AS 7 and EAP 6 - Strict Max Bean Instance Pool Service
Overview
Table 3.668. Overview
| Description: | A bean instance pool with a strict upper limit |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.669.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.670.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Max Pool Size | The maximum number of bean instances that the pool can hold at a given point in time. The default value is 20. | no | max-pool-size:expr |
| 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:expr |
| Timeout Unit | The instance acquisition timeout unit. The default value is MINUTES. | no | timeout-unit |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23.4. JBoss AS 7 and EAP 6 - SFSB Cache Service
Overview
Table 3.671. Overview
| Description: | A SFSB cache. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.672.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.673.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23.5. JBoss AS 7 and EAP 6 - Cluster Passivation Store Service
Overview
Table 3.674. Overview
| Description: | A clustered passivation store. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.675.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.676.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23.6. JBoss AS 7 and EAP 6 - Async Service
Overview
Table 3.677. Overview
| Description: | The EJB3 Asynchronous Invocation Service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.678.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.679.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Thread Pool Name | The name of the thread pool which handles asynchronous invocations | no | thread-pool-name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23.7. JBoss AS 7 and EAP 6 - IIOP Service
Overview
Table 3.680. Overview
| Description: | The IIOP service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.681.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.682.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23.8. JBoss AS 7 and EAP 6 - Remote Service
Overview
Table 3.683. Overview
| Description: | The EJB3 remote service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.684.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.685.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23.8.1. JBoss AS 7 and EAP 6 - Channel Creation Options Service
Overview
Table 3.686. Overview
| Description: | The options that will be used during the EJB remote channel creation |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.687.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.688.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.23.9. JBoss AS 7 and EAP 6 - Timer Service
Overview
Table 3.689. Overview
| Description: | The EJB timer service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.690.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.691.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.24. JBoss AS 7 and EAP 6 - JMX Service
Overview
Table 3.692. Overview
| Description: | The configuration of the JMX subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.693.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.694.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Show Model | Set to 'true' to include MBeans for the model controller resources | no | show-model |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.24.1. JBoss AS 7 and EAP 6 - Remoting Connector Service
Overview
Table 3.695. Overview
| Description: | The configuration of a resource adapter. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.696.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.697.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.25. JBoss AS 7 and EAP 6 - Resource Adapters Service
Overview
Table 3.698. Overview
| Description: | Configuration of the resource adapters subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.699.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.25.1. JBoss AS 7 and EAP 6 - Resource Adapter Service
Overview
Table 3.700. Overview
| Description: | The configuration of a resource adapter. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.701.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.702.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.25.1.1. JBoss AS 7 and EAP 6 - Admin Objects Service
Overview
Table 3.703. Overview
| Description: | Specifies the administration objects. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.704.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.705.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.25.1.2. JBoss AS 7 and EAP 6 - Connection Definitions Service
Overview
Table 3.706. Overview
| Description: | Specifies the connection definitions. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.707.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.708.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.709. Metrics
| 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 |
Package Types
none
3.3.25.1.2.1. JBoss AS 7 and EAP 6 - Config Properties Service
Table 3.710. Overview
| Description: | Custom defined config properties. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.711.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.712.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | Custom defined config property value | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.25.1.3. JBoss AS 7 and EAP 6 - Config Properties Service
Overview
Table 3.713. Overview
| Description: | Custom defined config properties. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.714.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.715.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | Custom defined config property value | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.26. JBoss AS 7 and EAP 6 - Infinispan Service
Overview
Table 3.716. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.717.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.26.1. JBoss AS 7 and EAP 6 - Cache Container Service
Overview
Table 3.718. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.719.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.720.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Default Cache | The default infinispan cache | no | default-cache |
| Aliases | The list of aliases for this cache container | no | aliases |
| Jndi Name | The jndi name to which to bind this cache container | no | jndi-name |
| Start | The cache container start mode, which can be EAGER (immediate start) or LAZY (on-demand start). | no | start |
| Listener Executor | The executor used for the replication queue | no | listener-executor |
| Eviction Executor | The scheduled executor used for eviction | no | eviction-executor |
| 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 |
| Replication Queue Executor | The executor used for asynchronous cache operations | no | replication-queue-executor |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.26.1.1. JBoss AS 7 and EAP 6 - Cache Service
Overview
Table 3.721. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.722.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.723.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Start | The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start). | no | start |
| Batching | If enabled, the invocation batching API will be made available for this cache. | no | batching |
| Indexing | If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed. | no | indexing |
| 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 |
| 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 |
| 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 |
| 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 |
| Async Marshalling | If enabled, this will cause marshalling of entries to be performed asynchronously. The default value is false. | no | async-marshalling |
| 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 |
| 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 |
| Virtual Nodes | Controls the number of virtual nodes per 'real' node. If numVirtualNodes is 1, then virtual nodes are disabled. The topology aware consistent hash must be used if you wish to take advantage of virtual nodes. A default of 1 is used. The default value is 1. | no | virtual-nodes |
| Type of cache | Type of cache | yes | __type |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.26.1.2. JBoss AS 7 and EAP 6 - Transport Service
Overview
Table 3.724. Overview
| Description: | The description of the transport used by this cache container |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.725.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.726.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Cluster | The name of the group communication cluster | no | cluster |
| Executor | The executor to use for the transport | no | executor |
| Lock Timeout | The timeout for locks for the transport. The default value is 240000. | no | lock-timeout |
| Machine | A machine identifier for the transport | no | machine |
| Rack | A rack identifier for the transport | no | rack |
| Site | A site identifier for the transport | no | site |
| Stack | The jgroups stack to use for the transport | no | stack |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.27. JBoss AS 7 and EAP 6 - JGroups Service
Overview
Table 3.727. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.728.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.729.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Default Stack | Default stack to use | yes | default-stack |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.28. JBoss AS 7 and EAP 6 - Remoting Service
Overview
Table 3.730. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.731.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.732.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.29. JBoss AS 7 and EAP 6 - Osgi Service
Overview
Table 3.733. Overview
| Description: | The OSGi subsystem configuration. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.734.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.735.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.736. Metrics
| Name | Description |
|---|---|
| Activate | Activate the OSGi subsystem. |
Package Types
none
3.3.29.1. JBoss AS 7 and EAP 6 - Capability Service
Overview
Table 3.737. 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: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.738.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.739.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Startlevel | The startlevel for the capability. Can only be specified for OSGi bundles. | no | startlevel |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.29.2. JBoss AS 7 and EAP 6 - Bundle Service
Overview
Table 3.740. Overview
| Description: | Runtime bundle information. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.741.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.742.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.743. Metrics
| Name | Description |
|---|---|
| Start | Starts the bundle. |
| Stop | Stops the bundle. |
Package Types
none
3.3.29.3. JBoss AS 7 and EAP 6 - Property Service
Overview
Table 3.744. Overview
| Description: | A property |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.745.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.746.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The property value. | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.30. JBoss AS 7 and EAP 6 - Mail Service
Overview
Table 3.747. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.748.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.30.1. JBoss AS 7 and EAP 6 - Mail Session Service
Overview
Table 3.749. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.750.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.751.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.30.1.1. JBoss AS 7 and EAP 6 - SMTP Mail Server Service
Overview
Table 3.752. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.753.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.754.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.30.1.2. JBoss AS 7 and EAP 6 - IMAP Mail Server Service
Overview
Table 3.755. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.756.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.757.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.30.1.3. JBoss AS 7 and EAP 6 - POP3 Mail Server Service
Overview
Table 3.758. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.759.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.760.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31. JBoss AS 7 and EAP 6 - Messaging Service
Overview
Table 3.761. Overview
| Description: | The messaging subsystems |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.762.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.31.1. JBoss AS 7 and EAP 6 - HornetQ Service
Overview
Table 3.763. Overview
| Description: | The HornetQ based messaging subsystem |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.764.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.765. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this server is started. | started |
| Version | trait | The server's version. | version |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.766.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Failback | Whether this server will automatically shutdown if the original live server comes back up. The default value is true. | no | allow-failback |
| 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 |
| Backup | Whether this server is a backup server. The default value is false. | no | backup |
| 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 HORNETQ.CLUSTER.ADMIN.USER. | no | cluster-user |
| Clustered | Whether the server is clustered. The default value is false. | no | clustered |
| Connection Ttl Override | 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 |
| 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 |
| Failback Delay | How long to wait before failback occurs on live server restart. The default value is 5000. | no | failback-delay |
| Failover On Shutdown | Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false. | no | failover-on-shutdown |
| Id Cache Size | The size of the cache for pre-creating message IDs. The default value is 2000. | no | id-cache-size |
| Jmx Domain | The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq. | no | jmx-domain |
| Jmx Management Enabled | Whether HornetQ 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 | The size of the internal buffer on the journal. | no | journal-buffer-size |
| Journal Buffer Timeout | The timeout (in nanoseconds) used to flush internal buffers on the journal. | no | journal-buffer-timeout |
| Journal Compact Min Files | The minimal number of journal data files before we can start compacting. The default value is 10. | no | journal-compact-min-files |
| Journal Compact Percentage | The percentage of live data on which we consider compacting the journal. The default value is 30. | no | journal-compact-percentage |
| Journal File Size | The size (in bytes) of each journal file. The default value is 10485760. | no | journal-file-size |
| Journal Max Io | The maximum number of write requests that can be in the AIO queue at any one time. | no | journal-max-io |
| Journal Min Files | How many journal files to pre-create. The default value is 2. | no | journal-min-files |
| 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 |
| Live Connector Ref | The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'. | no | live-connector-ref |
| 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.hornetq.management. | no | management-address |
| Management Notification Address | The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications. | no | management-notification-address |
| Memory Measure Interval | 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 | Percentage of available memory which if exceeded results in a warning log. The default value is 25. | no | memory-warning-threshold:expr |
| Message Counter Enabled | Whether message counters are enabled. The default value is false. | no | message-counter-enabled |
| Message Counter Max Day History | How many days to keep message counter history. The default value is 10. | no | message-counter-max-day-history |
| Message Counter Sample Period | The sample period (in ms) to use for message counters. The default value is 10000. | no | message-counter-sample-period |
| Message Expiry Scan Period | How often (in ms) to scan for expired messages. The default value is 30000. | no | message-expiry-scan-period |
| Message Expiry Thread Priority | The priority of the thread expiring messages. The default value is 3. | no | message-expiry-thread-priority |
| Page Max Concurrent Io | The maximum number of concurrent reads allowed on paging. The default value is 5. | no | page-max-concurrent-io |
| Perf Blast Pages | TODO. The default value is -1. | no | perf-blast-pages |
| 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 |
| Remoting Interceptors | The list of interceptor classes used by this server. | no | remoting-interceptors |
| 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 | 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 | How long (in ms) to wait before invalidating the security cache. The default value is 10000. | no | security-invalidation-interval |
| Server Dump Interval | 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 |
| Shared Store | Whether this server is using a shared store for failover. The default value is true. | no | shared-store |
| Thread Pool Max Size | 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 | 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 |
| Transaction Timeout Scan Period | How often (in ms) to scan for timeout transactions. The default value is 1000. | no | transaction-timeout-scan-period |
| Wild Card Routing Enabled | Whether the server supports wild card routing. The default value is true. | no | wild-card-routing-enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.767. Metrics
| Name | Description |
|---|---|
| Close Connections for Address | Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise. |
| Commit Prepared Transaction | Heuristically commits a prepared transaction. |
| 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. The returned String is a JSON string containing an array of address settings details. |
| Get Connectors as JSON | Returns the connectors configured for this server using JSON serialization. |
| Get Last Sent Message ID | Returns the ID of the last message sent from the given session to the given address. |
| Get Session Creation Time | Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch. |
| List All Consumers as JSON | Lists all the consumers. |
| List Connection IDs | Lists the IDs of all the connections connected to this server. |
| List Connections as JSON | List all JMS connections. |
| List Consumers as JSON | Lists all the consumers which belongs to the JMS Connection specified by the connection-id. |
| List Heuristic Committed Transactions | Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Heuristic Rolled Back Transactions | Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Prepared Transaction Details as HTML | List all the prepared transaction, sorted by date, oldest first, with details, in HTML format. |
| List Prepared Transaction Details as JSON | List all the prepared transaction, sorted by date, oldest first, with details, in JSON format. |
| List Prepared Transaction JMS Details as HTML | List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format |
| List Prepared Transaction JMS details as JSON | List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format |
| List Prepared Transactions | List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions. |
| 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 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. The returned String is a JSON string containing an array of session ids. |
| List Target Destinations | Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names. |
| Reset All Message Counter Histories | Reset all message counters history. |
| Reset All Message Counters | Reset all message counters. |
| Rollback Prepared Transaction | Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise. |
Package Types
none
3.3.31.1.1. JBoss AS 7 and EAP 6 - JMS Queue Service
Overview
Table 3.768. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.769.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.770. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.771.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.772. Metrics
| 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. |
Package Types
none
3.3.31.1.2. JBoss AS 7 and EAP 6 - JMS Topic Service
Overview
Table 3.773. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.774.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.775. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.776.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Names | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.777. Metrics
| 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. |
Package Types
none
3.3.31.1.3. JBoss AS 7 and EAP 6 - Connection Factory Service
Overview
Table 3.778. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.779.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.780.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connector | Defines the connector to be used. This is mutually exclusive with discovery-group-name | no | connector:collapsed |
| JNDI Names | The jndi names the connection factory should be bound to. | yes | entries |
| 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 Timeout | The call time out. The default value is 30000. | no | call-timeout |
| Client Failure Check Period | The client failure check period. The default value is 30000. | no | client-failure-check-period |
| 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 | The confirmation window size. The default value is -1. | no | confirmation-window-size |
| 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.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. | no | connection-load-balancing-policy-class-name |
| Connection Ttl | The connection ttl. The default value is 60000. | no | connection-ttl |
| Consumer Max Rate | The consumer max rate. The default value is -1. | no | consumer-max-rate |
| Consumer Window Size | The consumer window size. The default value is 1048576. | no | consumer-window-size |
| Discovery Group Name | The discovery group name. | no | discovery-group-name |
| Discovery Initial Wait Timeout | The discovery initial wait time out. | no | discovery-initial-wait-timeout |
| Dups Ok Batch Size | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size |
| Factory Type | The type of connection factory. | no | factory-type |
| Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
| Failover On Server Shutdown | True to fail over on server shutdown. | no | failover-on-server-shutdown |
| Group Id | The group id. | no | group-id |
| Ha | Whether the connection factory supports High Availability. The default value is false. | yes | ha |
| Initial Message Packet Size | The initial size of messages created through this factory. | yes | initial-message-packet-size |
| Max Retry Interval | The max retry interval. The default value is 2000. | no | max-retry-interval |
| Min Large Message Size | The min large message size. The default value is 102400. | no | min-large-message-size |
| Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
| Producer Max Rate | The producer max rate. The default value is -1. | no | producer-max-rate |
| Producer Window Size | The producer window size. The default value is 65536. | no | producer-window-size |
| Reconnect Attempts | The reconnect attempts. The default value is 0. | no | reconnect-attempts |
| Retry Interval | The retry interval. The default value is 2000. | no | retry-interval |
| Retry Interval Multiplier | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier |
| Scheduled Thread Pool Max Size | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
| Thread Pool Max Size | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
| Transaction Batch Size | The transaction batch size. The default value is 1048576. | no | transaction-batch-size |
| Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.4. JBoss AS 7 and EAP 6 - Pooled Connection Factory Service
Overview
Table 3.781. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.782.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.783.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connector | Defines the connectors. These are stored in a map by connector name, with the backup connectors stored as the value, or an undefined value if there is no backup connector. | no | connector:collapsed |
| JNDI Names | The jndi names the connection factory should be bound to. | yes | entries |
| 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 Timeout | The call time out. The default value is 30000. | no | call-timeout |
| Client Failure Check Period | The client failure check period. The default value is 30000. | no | client-failure-check-period |
| Client Id | The client id. | no | client-id |
| Confirmation Window Size | The confirmation window size. The default value is -1. | no | confirmation-window-size |
| 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.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. | no | connection-load-balancing-policy-class-name |
| Connection Ttl | The connection ttl. The default value is 60000. | no | connection-ttl |
| Consumer Max Rate | The consumer max rate. The default value is -1. | no | consumer-max-rate |
| Consumer Window Size | The consumer window size. The default value is 1048576. | no | consumer-window-size |
| Discovery Group Name | The discovery group name. | no | discovery-group-name |
| Discovery Initial Wait Timeout | The discovery initial wait time out. | no | discovery-initial-wait-timeout |
| Dups Ok Batch Size | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size |
| Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
| Failover On Server Shutdown | True to fail over on server shutdown. | no | failover-on-server-shutdown |
| Group Id | The group id. | no | group-id |
| Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
| Jndi Params | The JNDI params to use for locating the destination for incoming connections. | no | jndi-params |
| Max Pool Size | The maximum size for the pool. The default value is -1. | no | max-pool-size:expr |
| Max Retry Interval | The max retry interval. The default value is 2000. | no | max-retry-interval |
| Min Large Message Size | The min large message size. The default value is 102400. | no | min-large-message-size |
| Min Pool Size | 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 | The producer max rate. The default value is -1. | no | producer-max-rate |
| Producer Window Size | The producer window size. The default value is 65536. | no | producer-window-size |
| Reconnect Attempts | The reconnect attempts. The default value is 0. | no | reconnect-attempts |
| Retry Interval | The retry interval. The default value is 2000. | no | retry-interval |
| Retry Interval Multiplier | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier |
| Scheduled Thread Pool Max Size | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
| Setup Attempts | The number of times to set up an MDB endpoint | no | setup-attempts |
| Setup Interval | The interval between attempts at setting up an MDB endpoint. | no | setup-interval |
| Thread Pool Max Size | 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 | The transaction batch size. The default value is 1048576. | no | transaction-batch-size |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.5. JBoss AS 7 and EAP 6 - Security Setting Service
Overview
Table 3.784. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.785.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.3.31.1.5.1. JBoss AS 7 and EAP 6 - Role Service
Table 3.786. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.787.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.788.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.6. JBoss AS 7 and EAP 6 - Address Setting Service
Overview
Table 3.789. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.790.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.791.
| 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 |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.7. JBoss AS 7 and EAP 6 - Grouping Handler Service
Overview
Table 3.792. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.793.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.794.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.8. JBoss AS 7 and EAP 6 - Acceptor Service
Overview
Table 3.795. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.796.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.797. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this acceptor is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.798.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | The factory class. | yes | factory-class |
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.799. Metrics
| Name | Description |
|---|---|
| Start | Starts the acceptor. |
| Stop | Stops the acceptor. |
Package Types
none
3.3.31.1.8.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.800. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.801.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.802.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.9. JBoss AS 7 and EAP 6 - Connector (HornetQ) Service
Overview
Table 3.803. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.804.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.805.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | The factory class. | yes | factory-class |
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.9.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.806. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.807.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.808.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.10. JBoss AS 7 and EAP 6 - In VM Acceptor Service
Overview
Table 3.809. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.810.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.811. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether it's stopped or started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.812.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Server Id | The server id. | yes | server-id |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.813. Metrics
| Name | Description |
|---|---|
| Start | Starts the acceptor. |
| Stop | Stops the acceptor. |
Package Types
none
3.3.31.1.10.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.814. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.815.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.816.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.11. JBoss AS 7 and EAP 6 - In VM Connector Service
Overview
Table 3.817. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.818.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.819.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Server Id | The server id. | yes | server-id |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.11.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.820. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.821.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.822.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.12. JBoss AS 7 and EAP 6 - Remote Acceptor Service
Overview
Table 3.823. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.824.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.825. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this acceptor is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.826.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.827. Metrics
| Name | Description |
|---|---|
| Start | Starts the acceptor. |
| Stop | Stops the acceptor. |
Package Types
none
3.3.31.1.12.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.828. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.829.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.830.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.13. JBoss AS 7 and EAP 6 - Remote Connector Service
Overview
Table 3.831. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.832.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.833.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.13.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.834. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.835.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.836.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.3.31.1.14. JBoss AS 7 and EAP 6 - Divert Service
Overview
Table 3.837. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.838.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.839.
| 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 HornetQ filter expression syntax described in the HornetQ 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.15. JBoss AS 7 and EAP 6 - Queue Service
Overview
Table 3.840. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.841.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.842. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.843.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.844. Metrics
| 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. |
Package Types
none
3.3.31.1.16. JBoss AS 7 and EAP 6 - Core Address Service
Overview
Table 3.845. Overview
| Description: | A runtime-only resource representing a HornetQ 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: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.846.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.847.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.17. JBoss AS 7 and EAP 6 - Cluster Connection Service
Overview
Table 3.848. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.849.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.850. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.851.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Direct Connections Only | Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined. The default value is false. | no | allow-direct-connections-only |
| 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 HornetQ 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. HornetQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other HornetQ 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 |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.852. Metrics
| 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. |
Package Types
none
3.3.31.1.18. JBoss AS 7 and EAP 6 - Broadcast Group Service
Overview
Table 3.853. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.854.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.855. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether the broadcast group is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.856.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.857. Metrics
| 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. |
Package Types
none
3.3.31.1.19. JBoss AS 7 and EAP 6 - Path Service
Overview
Table 3.858. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.859.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.860.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.20. JBoss AS 7 and EAP 6 - Bridge Service
Overview
Table 3.861. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.862.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.863. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether the bridge is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.864.
| 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 HornetQ filter expression syntax described in the HornetQ 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 |
| Transformer Class Name | The name of a user-defined class which implements the org.hornetq.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 HORNETQ.CLUSTER.ADMIN.USER. | no | user |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.865. Metrics
| Name | Description |
|---|---|
| Start | Starts the bridge. |
| Stop | Stops the bridge. |
Package Types
none
3.3.31.1.21. JBoss AS 7 and EAP 6 - Discovery Group Service
Overview
Table 3.866. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.867.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.868.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.22. JBoss AS 7 and EAP 6 - Connector Service
Overview
Table 3.869. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.870.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.871.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | Class name of the factory class that can instantiate the connector service. | yes | factory-class |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.3.31.1.22.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.872. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.873.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.874.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4. JBoss AS 7 and EAP 6 - Host Controller Server
Overview
Table 3.875. Overview
| Description: | Domain controller (delegate) for this host |
| Singleton: | no |
| Plugin: | JBossAS7 |
Note
The server can be started, restarted, or stopped via the Start, Restart, and Shutdown operations. The Start and Restart operations start the server by executing the server start script, typically domain.sh on UNIX or domain.bat on Windows. The following connection settings can be used to configure the start script execution: * Start Script - the absolute path of the start script (e.g. "/opt/jboss-as-7.1.1.Final/bin/domain.sh") * Start Script Prefix - a prefix command line to be prepended to the start script command line (e.g. "nohup sudo -u jboss -g jboss") * Start Script Arguments - arguments to be passed to the start script (e.g. "--host-config=host-master.xml") * Start Script Environment - environment variables to be set in the start script's environment (e.g. "JAVA_HOME=/usr/java/jdk1.6.0_30") These settings are automatically initialized by the JBossAS7 plugin discovery code to match the currently running server process' command line and environment. The settings are not used by the Stop operation, since it stops the server via the management interface, not via a script. For more detailed descriptions of the settings, see the Connection Settings section below.
Child Resource Types
Autodiscovery Process Scans
Table 3.876. Metrics
| Name | Query |
|---|---|
| HostController | process|basename|match=^java.*,arg|org.jboss.as.host-controller|match=.* |
Connection Properties
Table 3.877.
| 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 |
| Log Event Sources | yes | logEventSources | |
| Hostname | Host name of the domain API | yes | hostname |
| Port | Port of the domain API | yes | port |
| User | Management user for a secured Host controller | no | user |
| Password | Password for the management user | no | password |
| 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 | no | domainHost |
| Product Type | Server product type (e.g. AS or EAP) | no | productType |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.878. 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 |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.879.
| 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 | * |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.880. Metrics
| 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 |
Package Types
none
3.4.1. JBoss AS 7 and EAP 6 - ServerGroup Service
Overview
Table 3.881. Overview
| Description: | A server group on this domain |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.882.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.883.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.884. Metrics
| 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
none
3.4.1.1. JBoss AS 7 and EAP 6 - JVM Definition Service
Overview
Table 3.885. Overview
| Description: | A JVM definition that can override host and server group level definitions with the same name |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.886.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.887.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.1.2. JBoss AS 7 and EAP 6 - Deployment Service
Overview
Table 3.888. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.889.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.890. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.891.
| 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.) | yes | enabled |
| Name | Unique identifier of the deployment. Must be unique across all deployments. | yes | 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. | yes | 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. | yes | runtime-name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.892. Metrics
| Name | Description |
|---|---|
| Enable | |
| Disable | |
| Restart |
Package Types
Table 3.893. Package Types
| Name | Category | Description |
|---|---|---|
| File | Deployable | Deployments on this server group |
3.4.1.2.1. JBoss AS 7 and EAP 6 - Subdeployment Service
Overview
Table 3.894. Overview
| Description: | Runtime resources associated with a child deployment packaged inside another deployment; for example a war packaged inside an ear. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.895.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.2.1.1. JBoss AS 7 and EAP 6 - Web Runtime Service
Table 3.896. Overview
| Description: | Runtime resources exposed by web components in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.897.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.898. 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 |
| Response Time | calltime | the minimum, maximum, and average response times for requests serviced by this webapp | responseTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.4.1.2.1.2. JBoss AS 7 and EAP 6 - Datasources Runtime Service
Table 3.899. Overview
| Description: | Runtime resources exposed by data sources included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Table 3.900.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
none
none
3.4.1.2.1.2.1. JBoss AS 7 and EAP 6 - XA Datasource Runtime Service
Table 3.901. Overview
| Description: | A JDBC XA data-source configuration |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.902.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.903.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Properties | no | *2 | |
| 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 | 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 |
| Background Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 can be done only on disabled datasource, requires a server restart otherwise | no | background-validation-millis |
| 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 |
| Check Valid Connection Sql | Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool | no | check-valid-connection-sql |
| 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 |
| Enabled | Specifies if the datasource should be enabled | no | enabled |
| Exception Sorter Class Name | An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error | no | exception-sorter-class-name |
| Exception Sorter Properties | The exception sorter properties | no | exception-sorter-properties |
| 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 can be done only on disabled datasource, requires a server restart otherwise. | no | idle-timeout-minutes |
| Interleaving | An element to enable interleaving for XA connections. The default value is false. | no | interleaving |
| Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
| Jta | Enable JTA integration. The default value is true. | no | jta |
| 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 |
| New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool | no | new-connection-sql |
| 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 |
| Password | Specifies the password used when creating a new connection | no | password |
| Pool Prefill | Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 |
| Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
| Query Timeout | Any configured query timeout in seconds. If not provided no timeout will be set | no | query-timeout |
| Reauth Plugin Class Name | The fully qualified class name of the reauthentication plugin implementation | no | reauth-plugin-class-name |
| Reauth Plugin Properties | The properties for the reauthentication plugin | no | reauth-plugin-properties |
| 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 Domain | Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool | no | security-domain |
| 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. The default value is false. | no | set-tx-query-timeout |
| Share Prepared Statements | Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false. | no | share-prepared-statements |
| Spy | Enable spying of SQL statements. The default value is false. | no | spy |
| Stale Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException | no | stale-connection-checker-class-name |
| Stale Connection Checker Properties | The stale connection checker properties | no | stale-connection-checker-properties |
| Track Statements | Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'. | no | track-statements |
| Transaction Isolation | Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE | no | transaction-isolation |
| Url Delimiter | Specifies the delimeter 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 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 datasource 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 |
| User Name | Specify the user name used when creating a new connection | no | user-name |
| Valid Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element | no | valid-connection-checker-class-name |
| Valid Connection Checker Properties | The valid connection checker properties | no | valid-connection-checker-properties |
| Validate On Match | The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false. | no | validate-on-match |
| 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 Datasource Class | The fully qualifed name of the javax.sql.XADataSource implementation | no | xa-datasource-class |
| Xa Resource Timeout | The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero | no | xa-resource-timeout |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.904. Metrics
| 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 |
none
3.4.1.2.1.2.2. JBoss AS 7 and EAP 6 - Datasource Runtime Service
Table 3.905. Overview
| Description: | A JDBC data-source configuration |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.906.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.907.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connection Property | no | *1 | |
| 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 | 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 |
| Background Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 can be done only on disabled datasource, requires a server restart otherwise | no | background-validation-millis |
| 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 |
| Check Valid Connection Sql | Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool | no | check-valid-connection-sql |
| Connection Url | The JDBC driver connection URL | yes | connection-url |
| Datasource Class | The fully qualifed name of the JDBC datasource class | no | datasource-class |
| Driver Class | The fully qualifed name of the JDBC driver class | no | driver-class |
| 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 |
| Enabled | Specifies if the datasource should be enabled | no | enabled |
| Exception Sorter Class Name | An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error | no | exception-sorter-class-name |
| Exception Sorter Properties | The exception sorter properties | no | exception-sorter-properties |
| 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 can be done only on disabled datasource, requires a server restart otherwise. | no | idle-timeout-minutes |
| Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
| Jta | Enable JTA integration. The default value is true. | no | jta |
| 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 |
| New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool | no | new-connection-sql |
| Password | Specifies the password used when creating a new connection | no | password |
| Pool Prefill | Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 |
| Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
| Query Timeout | Any configured query timeout in seconds. If not provided no timeout will be set | no | query-timeout |
| Reauth Plugin Class Name | The fully qualified class name of the reauthentication plugin implementation | no | reauth-plugin-class-name |
| Reauth Plugin Properties | The properties for the reauthentication plugin | no | reauth-plugin-properties |
| 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 |
| 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. The default value is false. | no | set-tx-query-timeout |
| Share Prepared Statements | Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false. | no | share-prepared-statements |
| Spy | Enable spying of SQL statements. The default value is false. | no | spy |
| Stale Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException | no | stale-connection-checker-class-name |
| Stale Connection Checker Properties | The stale connection checker properties | no | stale-connection-checker-properties |
| Track Statements | Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'. | no | track-statements |
| Transaction Isolation | Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE | no | transaction-isolation |
| Url Delimiter | Specifies the delimeter 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 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 datasource 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 |
| User Name | Specify the user name used when creating a new connection | no | user-name |
| Valid Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element | no | valid-connection-checker-class-name |
| Valid Connection Checker Properties | The valid connection checker properties | no | valid-connection-checker-properties |
| Validate On Match | The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false. | no | validate-on-match |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.908. Metrics
| 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 |
none
3.4.1.2.1.3. JBoss AS 7 and EAP 6 - Messaging Runtime Service
Table 3.909. Overview
| Description: | Runtime resources exposed by messaging resources included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Table 3.910.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
none
none
3.4.1.2.1.3.1. JBoss AS 7 and EAP 6 - HornetQ Server Runtime Service
Table 3.911. Overview
| Description: | A HornetQ server instance. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.912.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.913. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this server is started. | started |
| Version | trait | The server's version. | version |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.914.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Failback | Whether this server will automatically shutdown if the original live server comes back up. The default value is true. | no | allow-failback |
| 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 |
| Backup | Whether this server is a backup server. The default value is false. | no | backup |
| 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 HORNETQ.CLUSTER.ADMIN.USER. | no | cluster-user |
| Clustered | Whether the server is clustered. The default value is false. | no | clustered |
| Connection Ttl Override | 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 |
| 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 |
| Failback Delay | How long to wait before failback occurs on live server restart. The default value is 5000. | no | failback-delay |
| Failover On Shutdown | Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false. | no | failover-on-shutdown |
| Id Cache Size | The size of the cache for pre-creating message IDs. The default value is 2000. | no | id-cache-size |
| Jmx Domain | The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq. | no | jmx-domain |
| Jmx Management Enabled | Whether HornetQ 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 | The size of the internal buffer on the journal. | no | journal-buffer-size |
| Journal Buffer Timeout | The timeout (in nanoseconds) used to flush internal buffers on the journal. | no | journal-buffer-timeout |
| Journal Compact Min Files | The minimal number of journal data files before we can start compacting. The default value is 10. | no | journal-compact-min-files |
| Journal Compact Percentage | The percentage of live data on which we consider compacting the journal. The default value is 30. | no | journal-compact-percentage |
| Journal File Size | The size (in bytes) of each journal file. The default value is 10485760. | no | journal-file-size |
| Journal Max Io | The maximum number of write requests that can be in the AIO queue at any one time. | no | journal-max-io |
| Journal Min Files | How many journal files to pre-create. The default value is 2. | no | journal-min-files |
| 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 |
| Live Connector Ref | The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'. | no | live-connector-ref |
| 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.hornetq.management. | no | management-address |
| Management Notification Address | The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications. | no | management-notification-address |
| Memory Measure Interval | 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 | Percentage of available memory which if exceeded results in a warning log. The default value is 25. | no | memory-warning-threshold:expr |
| Message Counter Enabled | Whether message counters are enabled. The default value is false. | no | message-counter-enabled |
| Message Counter Max Day History | How many days to keep message counter history. The default value is 10. | no | message-counter-max-day-history |
| Message Counter Sample Period | The sample period (in ms) to use for message counters. The default value is 10000. | no | message-counter-sample-period |
| Message Expiry Scan Period | How often (in ms) to scan for expired messages. The default value is 30000. | no | message-expiry-scan-period |
| Message Expiry Thread Priority | The priority of the thread expiring messages. The default value is 3. | no | message-expiry-thread-priority |
| Page Max Concurrent Io | The maximum number of concurrent reads allowed on paging. The default value is 5. | no | page-max-concurrent-io |
| Perf Blast Pages | TODO. The default value is -1. | no | perf-blast-pages |
| 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 |
| Remoting Interceptors | The list of interceptor classes used by this server. | no | remoting-interceptors |
| 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 | 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 | How long (in ms) to wait before invalidating the security cache. The default value is 10000. | no | security-invalidation-interval |
| Server Dump Interval | 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 |
| Shared Store | Whether this server is using a shared store for failover. The default value is true. | no | shared-store |
| Thread Pool Max Size | 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 | 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 |
| Transaction Timeout Scan Period | How often (in ms) to scan for timeout transactions. The default value is 1000. | no | transaction-timeout-scan-period |
| Wild Card Routing Enabled | Whether the server supports wild card routing. The default value is true. | no | wild-card-routing-enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.915. Metrics
| Name | Description |
|---|---|
| Close Connections for Address | Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise. |
| Commit Prepared Transaction | Heuristically commits a prepared transaction. |
| 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. The returned String is a JSON string containing an array of address settings details. |
| Get Connectors as JSON | Returns the connectors configured for this server using JSON serialization. |
| Get Last Sent Message ID | Returns the ID of the last message sent from the given session to the given address. |
| Get Session Creation Time | Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch. |
| List All Consumers as JSON | Lists all the consumers. |
| List Connection IDs | Lists the IDs of all the connections connected to this server. |
| List Connections as JSON | List all JMS connections. |
| List Consumers as JSON | Lists all the consumers which belongs to the JMS Connection specified by the connection-id. |
| List Heuristic Committed Transactions | Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Heuristic Rolled Back Transactions | Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Prepared Transaction Details as HTML | List all the prepared transaction, sorted by date, oldest first, with details, in HTML format. |
| List Prepared Transaction Details as JSON | List all the prepared transaction, sorted by date, oldest first, with details, in JSON format. |
| List Prepared Transaction JMS Details as HTML | List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format |
| List Prepared Transaction JMS details as JSON | List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format |
| List Prepared Transactions | List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions. |
| 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 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. The returned String is a JSON string containing an array of session ids. |
| List Target Destinations | Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names. |
| Reset All Message Counter Histories | Reset all message counters history. |
| Reset All Message Counters | Reset all message counters. |
| Rollback Prepared Transaction | Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise. |
none
3.4.1.2.1.3.1.1. JBoss AS 7 and EAP 6 - JMS Queue Runtime Service
Table 3.916. Overview
| Description: | Defines a JMS queue. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.917.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.918. Metrics
| 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 |
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.919.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Entries | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.920. Metrics
| 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. |
none
3.4.1.2.1.3.1.2. JBoss AS 7 and EAP 6 - JMS Topic Runtime Service
Table 3.921. Overview
| Description: | Defines a JMS queue. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.922.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.923. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.924.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Names | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.925. Metrics
| 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. |
none
3.4.1.2.1.4. JBoss AS 7 and EAP 6 - EJB3 Runtime Service
Table 3.926. Overview
| Description: | Runtime resources exposed by EJBs components included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Table 3.927.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
none
none
3.4.1.2.1.4.1. JBoss AS 7 and EAP 6 - Message Driven Bean Runtime Service
Table 3.928. Overview
| Description: | Bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.929.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.930. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.931.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.1.4.2. JBoss AS 7 and EAP 6 - Singleton Bean Runtime Service
Table 3.932. Overview
| Description: | Singleton bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.933.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.934.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.1.4.3. JBoss AS 7 and EAP 6 - Stateless Session Bean Runtime Service
Table 3.935. Overview
| Description: | Stateless session bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.936.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.937. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.938.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.1.4.4. JBoss AS 7 and EAP 6 - Entity Bean Runtime Service
Table 3.939. Overview
| Description: | Entity bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.940.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.941. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.942.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.1.4.5. JBoss AS 7 and EAP 6 - Stateful Session Bean Runtime Service
Table 3.943. Overview
| Description: | Stateful session bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.944.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.945.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.1.5. JBoss AS 7 and EAP 6 - Webservices Runtime Service
Table 3.946. Overview
| Description: | Runtime resources exposed by web service components in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Table 3.947.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
none
none
3.4.1.2.1.5.1. JBoss AS 7 and EAP 6 - Endpoint Runtime Service
Table 3.948. Overview
| Description: | Webservice endpoint. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.949.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.950. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.951.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Class | Webservice endpoint class. | yes | class |
| Context | Webservice endpoint context. | yes | context |
| Name | Webservice endpoint name. | yes | name |
| Type | Webservice endpoint type. | yes | type |
| Wsdl Url | Webservice endpoint WSDL URL. | yes | wsdl-url |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.1.6. JBoss AS 7 and EAP 6 - JPA Runtime Service
Table 3.952. Overview
| Description: | The configuration of the JPA subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Table 3.953.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
none
none
3.4.1.2.1.6.1. JBoss AS 7 and EAP 6 - Hibernate Persistence Unit Service
Table 3.954. Overview
| Description: | Runtime information about JPA use in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Table 3.955.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.956. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.957.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Enabled | Determine if statistics are enabled. | no | enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.958. Metrics
| Name | Description |
|---|---|
| Subsystem:clear | Clear statistics. |
| Subsystem:evict All | Evict all entities from second level cache. |
| Subsystem:summary | Log the statistics. |
none
3.4.1.2.1.6.1.1. JBoss AS 7 and EAP 6 - Entity Cache Service
Table 3.959. Overview
| Description: | Statistics for a Hibernate Second Level Cache region. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.960.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.961. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.4.1.2.1.6.1.2. JBoss AS 7 and EAP 6 - Query Cache Service
Table 3.962. Overview
| Description: | Statistics for individual queries. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.963.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.964. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Query Cache Hit Count | measurement | Get the number of times query was retrieved from cache. | query-cache-hit-count |
| Query Cache Hit Count per Minute | measurement | Get the number of times query was retrieved from cache. | query-cache-hit-count |
| Query Cache Miss Count | measurement | Get the number of times query was not found in cache. | query-cache-miss-count |
| Query Cache Miss Count per Minute | measurement | Get the number of times query was not found in cache. | query-cache-miss-count |
| Query Cache Put Count | measurement | Get the number of times query was put in cache. | query-cache-put-count |
| Query Cache Put Count per Minute | measurement | Get the number of times query was put in cache. | query-cache-put-count |
| Query Execution Average Time | measurement | Get the average time in milliseconds of the query. | query-execution-average-time |
| Query Execution Count | measurement | Get number of times query has been executed. | query-execution-count |
| Query Execution Count per Minute | measurement | Get number of times query has been executed. | query-execution-count |
| Query Execution Max Time | measurement | Get the time in milliseconds of the query. | query-execution-max-time |
| Query Execution Min Time | measurement | Get the minimum time in milliseconds of the query. | query-execution-min-time |
| Query Execution Row Count | measurement | Get number of rows returned from executions of query. | query-execution-row-count |
| Query Execution Row Count per Minute | measurement | Get number of rows returned from executions of query. | query-execution-row-count |
| Query Name | trait | Query name. | query-name |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.4.1.2.1.6.1.3. JBoss AS 7 and EAP 6 - Entity Service
Table 3.965. Overview
| Description: | Statistics for individual entities. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.966.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.967. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.4.1.2.1.6.1.4. JBoss AS 7 and EAP 6 - Collection Service
Table 3.968. Overview
| Description: | Statistics for individual collections. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.969.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.970. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.4.1.2.2. JBoss AS 7 and EAP 6 - Web Runtime Service
Overview
Table 3.971. Overview
| Description: | Runtime resources exposed by web components in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.972.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.973. 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 |
| Response Time | calltime | the minimum, maximum, and average response times for requests serviced by this webapp | responseTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.2.3. JBoss AS 7 and EAP 6 - Datasources Runtime Service
Overview
Table 3.974. Overview
| Description: | Runtime resources exposed by data sources included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.975.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.2.3.1. JBoss AS 7 and EAP 6 - XA Datasource Runtime Service
Table 3.976. Overview
| Description: | A JDBC XA data-source configuration |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.977.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.978.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Properties | no | *2 | |
| 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 | 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 |
| Background Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 can be done only on disabled datasource, requires a server restart otherwise | no | background-validation-millis |
| 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 |
| Check Valid Connection Sql | Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool | no | check-valid-connection-sql |
| 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 |
| Enabled | Specifies if the datasource should be enabled | no | enabled |
| Exception Sorter Class Name | An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error | no | exception-sorter-class-name |
| Exception Sorter Properties | The exception sorter properties | no | exception-sorter-properties |
| 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 can be done only on disabled datasource, requires a server restart otherwise. | no | idle-timeout-minutes |
| Interleaving | An element to enable interleaving for XA connections. The default value is false. | no | interleaving |
| Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
| Jta | Enable JTA integration. The default value is true. | no | jta |
| 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 |
| New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool | no | new-connection-sql |
| 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 |
| Password | Specifies the password used when creating a new connection | no | password |
| Pool Prefill | Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 |
| Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
| Query Timeout | Any configured query timeout in seconds. If not provided no timeout will be set | no | query-timeout |
| Reauth Plugin Class Name | The fully qualified class name of the reauthentication plugin implementation | no | reauth-plugin-class-name |
| Reauth Plugin Properties | The properties for the reauthentication plugin | no | reauth-plugin-properties |
| 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 Domain | Specifies the security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool | no | security-domain |
| 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. The default value is false. | no | set-tx-query-timeout |
| Share Prepared Statements | Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false. | no | share-prepared-statements |
| Spy | Enable spying of SQL statements. The default value is false. | no | spy |
| Stale Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException | no | stale-connection-checker-class-name |
| Stale Connection Checker Properties | The stale connection checker properties | no | stale-connection-checker-properties |
| Track Statements | Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'. | no | track-statements |
| Transaction Isolation | Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE | no | transaction-isolation |
| Url Delimiter | Specifies the delimeter 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 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 datasource 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 |
| User Name | Specify the user name used when creating a new connection | no | user-name |
| Valid Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element | no | valid-connection-checker-class-name |
| Valid Connection Checker Properties | The valid connection checker properties | no | valid-connection-checker-properties |
| Validate On Match | The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false. | no | validate-on-match |
| 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 Datasource Class | The fully qualifed name of the javax.sql.XADataSource implementation | no | xa-datasource-class |
| Xa Resource Timeout | The value is passed to XAResource.setTransactionTimeout(), in seconds. Default is zero | no | xa-resource-timeout |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.979. Metrics
| 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 |
none
3.4.1.2.3.2. JBoss AS 7 and EAP 6 - Datasource Runtime Service
Table 3.980. Overview
| Description: | A JDBC data-source configuration |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.981.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.982.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connection Property | no | *1 | |
| 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 | 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 |
| Background Validation | An element to specify that connections should be validated on a background thread versus being validated prior to use. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 can be done only on disabled datasource, requires a server restart otherwise | no | background-validation-millis |
| 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 |
| Check Valid Connection Sql | Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is obtained from the pool | no | check-valid-connection-sql |
| Connection Url | The JDBC driver connection URL | yes | connection-url |
| Datasource Class | The fully qualifed name of the JDBC datasource class | no | datasource-class |
| Driver Class | The fully qualifed name of the JDBC driver class | no | driver-class |
| 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 |
| Enabled | Specifies if the datasource should be enabled | no | enabled |
| Exception Sorter Class Name | An org.jboss.jca.adapters.jdbc.ExceptionSorter that provides an isExceptionFatal(SQLException) method to validate if an exception should broadcast an error | no | exception-sorter-class-name |
| Exception Sorter Properties | The exception sorter properties | no | exception-sorter-properties |
| 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 can be done only on disabled datasource, requires a server restart otherwise. | no | idle-timeout-minutes |
| Jndi Name | Specifies the JNDI name for the datasource | yes | jndi-name |
| Jta | Enable JTA integration. The default value is true. | no | jta |
| 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 |
| New Connection Sql | Specifies an SQL statement to execute whenever a connection is added to the connection pool | no | new-connection-sql |
| Password | Specifies the password used when creating a new connection | no | password |
| Pool Prefill | Should the pool be prefilled. Changing this value can be done only on disabled datasource, requires a server restart otherwise. 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 |
| Prepared Statements Cache Size | The number of prepared statements per connection in an LRU cache | no | prepared-statements-cache-size |
| Query Timeout | Any configured query timeout in seconds. If not provided no timeout will be set | no | query-timeout |
| Reauth Plugin Class Name | The fully qualified class name of the reauthentication plugin implementation | no | reauth-plugin-class-name |
| Reauth Plugin Properties | The properties for the reauthentication plugin | no | reauth-plugin-properties |
| 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 |
| 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. The default value is false. | no | set-tx-query-timeout |
| Share Prepared Statements | Whether to share prepared statements, i.e. whether asking for same statement twice without closing uses the same underlying prepared statement. The default value is false. | no | share-prepared-statements |
| Spy | Enable spying of SQL statements. The default value is false. | no | spy |
| Stale Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.StaleConnectionChecker that provides an isStaleConnection(SQLException) method which if it returns true will wrap the exception in an org.jboss.jca.adapters.jdbc.StaleConnectionException | no | stale-connection-checker-class-name |
| Stale Connection Checker Properties | The stale connection checker properties | no | stale-connection-checker-properties |
| Track Statements | Whether to check for unclosed statements when a connection is returned to the pool, result sets are closed, a statement is closed or return to the prepared statement cache. Valid values are: 'false' - do not track statements, 'true' - track statements and result sets and warn when they are not closed, 'nowarn' - track statements but do not warn about them being unclosed. The default value is 'NOWARN'. | no | track-statements |
| Transaction Isolation | Set the java.sql.Connection transaction isolation level. Valid values are: TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE and TRANSACTION_NONE | no | transaction-isolation |
| Url Delimiter | Specifies the delimeter 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 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 datasource 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 |
| User Name | Specify the user name used when creating a new connection | no | user-name |
| Valid Connection Checker Class Name | An org.jboss.jca.adapters.jdbc.ValidConnectionChecker that provides an isValidConnection(Connection) method to validate a connection. If an exception is returned that means the connection is invalid. This overrides the check-valid-connection-sql element | no | valid-connection-checker-class-name |
| Valid Connection Checker Properties | The valid connection checker properties | no | valid-connection-checker-properties |
| Validate On Match | The validate-on-match element specifies if connection validation should be done when a connection factory attempts to match a managed connection. This is typically exclusive to the use of background validation. The default value is false. | no | validate-on-match |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.983. Metrics
| 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 |
none
3.4.1.2.4. JBoss AS 7 and EAP 6 - Messaging Runtime Service
Overview
Table 3.984. Overview
| Description: | Runtime resources exposed by messaging resources included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.985.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.2.4.1. JBoss AS 7 and EAP 6 - HornetQ Server Runtime Service
Table 3.986. Overview
| Description: | A HornetQ server instance. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.987.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.988. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this server is started. | started |
| Version | trait | The server's version. | version |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.989.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Failback | Whether this server will automatically shutdown if the original live server comes back up. The default value is true. | no | allow-failback |
| 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 |
| Backup | Whether this server is a backup server. The default value is false. | no | backup |
| 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 HORNETQ.CLUSTER.ADMIN.USER. | no | cluster-user |
| Clustered | Whether the server is clustered. The default value is false. | no | clustered |
| Connection Ttl Override | 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 |
| 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 |
| Failback Delay | How long to wait before failback occurs on live server restart. The default value is 5000. | no | failback-delay |
| Failover On Shutdown | Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false. | no | failover-on-shutdown |
| Id Cache Size | The size of the cache for pre-creating message IDs. The default value is 2000. | no | id-cache-size |
| Jmx Domain | The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq. | no | jmx-domain |
| Jmx Management Enabled | Whether HornetQ 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 | The size of the internal buffer on the journal. | no | journal-buffer-size |
| Journal Buffer Timeout | The timeout (in nanoseconds) used to flush internal buffers on the journal. | no | journal-buffer-timeout |
| Journal Compact Min Files | The minimal number of journal data files before we can start compacting. The default value is 10. | no | journal-compact-min-files |
| Journal Compact Percentage | The percentage of live data on which we consider compacting the journal. The default value is 30. | no | journal-compact-percentage |
| Journal File Size | The size (in bytes) of each journal file. The default value is 10485760. | no | journal-file-size |
| Journal Max Io | The maximum number of write requests that can be in the AIO queue at any one time. | no | journal-max-io |
| Journal Min Files | How many journal files to pre-create. The default value is 2. | no | journal-min-files |
| 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 |
| Live Connector Ref | The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'. | no | live-connector-ref |
| 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.hornetq.management. | no | management-address |
| Management Notification Address | The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications. | no | management-notification-address |
| Memory Measure Interval | 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 | Percentage of available memory which if exceeded results in a warning log. The default value is 25. | no | memory-warning-threshold:expr |
| Message Counter Enabled | Whether message counters are enabled. The default value is false. | no | message-counter-enabled |
| Message Counter Max Day History | How many days to keep message counter history. The default value is 10. | no | message-counter-max-day-history |
| Message Counter Sample Period | The sample period (in ms) to use for message counters. The default value is 10000. | no | message-counter-sample-period |
| Message Expiry Scan Period | How often (in ms) to scan for expired messages. The default value is 30000. | no | message-expiry-scan-period |
| Message Expiry Thread Priority | The priority of the thread expiring messages. The default value is 3. | no | message-expiry-thread-priority |
| Page Max Concurrent Io | The maximum number of concurrent reads allowed on paging. The default value is 5. | no | page-max-concurrent-io |
| Perf Blast Pages | TODO. The default value is -1. | no | perf-blast-pages |
| 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 |
| Remoting Interceptors | The list of interceptor classes used by this server. | no | remoting-interceptors |
| 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 | 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 | How long (in ms) to wait before invalidating the security cache. The default value is 10000. | no | security-invalidation-interval |
| Server Dump Interval | 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 |
| Shared Store | Whether this server is using a shared store for failover. The default value is true. | no | shared-store |
| Thread Pool Max Size | 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 | 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 |
| Transaction Timeout Scan Period | How often (in ms) to scan for timeout transactions. The default value is 1000. | no | transaction-timeout-scan-period |
| Wild Card Routing Enabled | Whether the server supports wild card routing. The default value is true. | no | wild-card-routing-enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.990. Metrics
| Name | Description |
|---|---|
| Close Connections for Address | Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise. |
| Commit Prepared Transaction | Heuristically commits a prepared transaction. |
| 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. The returned String is a JSON string containing an array of address settings details. |
| Get Connectors as JSON | Returns the connectors configured for this server using JSON serialization. |
| Get Last Sent Message ID | Returns the ID of the last message sent from the given session to the given address. |
| Get Session Creation Time | Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch. |
| List All Consumers as JSON | Lists all the consumers. |
| List Connection IDs | Lists the IDs of all the connections connected to this server. |
| List Connections as JSON | List all JMS connections. |
| List Consumers as JSON | Lists all the consumers which belongs to the JMS Connection specified by the connection-id. |
| List Heuristic Committed Transactions | Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Heuristic Rolled Back Transactions | Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Prepared Transaction Details as HTML | List all the prepared transaction, sorted by date, oldest first, with details, in HTML format. |
| List Prepared Transaction Details as JSON | List all the prepared transaction, sorted by date, oldest first, with details, in JSON format. |
| List Prepared Transaction JMS Details as HTML | List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format |
| List Prepared Transaction JMS details as JSON | List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format |
| List Prepared Transactions | List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions. |
| 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 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. The returned String is a JSON string containing an array of session ids. |
| List Target Destinations | Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names. |
| Reset All Message Counter Histories | Reset all message counters history. |
| Reset All Message Counters | Reset all message counters. |
| Rollback Prepared Transaction | Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise. |
none
3.4.1.2.4.1.1. JBoss AS 7 and EAP 6 - JMS Queue Runtime Service
Table 3.991. Overview
| Description: | Defines a JMS queue. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.992.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.993. Metrics
| 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 |
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.994.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Entries | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.995. Metrics
| 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. |
none
3.4.1.2.4.1.2. JBoss AS 7 and EAP 6 - JMS Topic Runtime Service
Table 3.996. Overview
| Description: | Defines a JMS queue. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.997.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.998. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.999.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Names | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1000. Metrics
| 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. |
none
3.4.1.2.5. JBoss AS 7 and EAP 6 - EJB3 Runtime Service
Overview
Table 3.1001. Overview
| Description: | Runtime resources exposed by EJBs components included in this deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1002.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.2.5.1. JBoss AS 7 and EAP 6 - Message Driven Bean Runtime Service
Table 3.1003. Overview
| Description: | Bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1004.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1005. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1006.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.5.2. JBoss AS 7 and EAP 6 - Singleton Bean Runtime Service
Table 3.1007. Overview
| Description: | Singleton bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1008.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1009.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.5.3. JBoss AS 7 and EAP 6 - Stateless Session Bean Runtime Service
Table 3.1010. Overview
| Description: | Stateless session bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1011.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1012. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1013.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.5.4. JBoss AS 7 and EAP 6 - Entity Bean Runtime Service
Table 3.1014. Overview
| Description: | Entity bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1015.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1016. Metrics
| 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 bean instances that have been created. | pool-create-count |
| Pool Current Size | measurement | The current size of the pool. | pool-current-size |
| Pool Max Size | measurement | The maximum size of the pool. | pool-max-size |
| Pool Remove Count | measurement | The number of bean instances that have been removed. | pool-remove-count |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1017.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.5.5. JBoss AS 7 and EAP 6 - Stateful Session Bean Runtime Service
Table 3.1018. Overview
| Description: | Stateful session bean component included in the deployment. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1019.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1020.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.6. JBoss AS 7 and EAP 6 - Webservices Runtime Service
Overview
Table 3.1021. Overview
| Description: | Runtime resources exposed by web service components in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1022.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.2.6.1. JBoss AS 7 and EAP 6 - Endpoint Runtime Service
Table 3.1023. Overview
| Description: | Webservice endpoint. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1024.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1025. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1026.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Class | Webservice endpoint class. | yes | class |
| Context | Webservice endpoint context. | yes | context |
| Name | Webservice endpoint name. | yes | name |
| Type | Webservice endpoint type. | yes | type |
| Wsdl Url | Webservice endpoint WSDL URL. | yes | wsdl-url |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.1.2.7. JBoss AS 7 and EAP 6 - JPA Runtime Service
Overview
Table 3.1027. Overview
| Description: | The configuration of the JPA subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1028.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.1.2.7.1. JBoss AS 7 and EAP 6 - Hibernate Persistence Unit Service
Table 3.1029. Overview
| Description: | Runtime information about JPA use in the deployment. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Table 3.1030.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1031. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1032.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Enabled | Determine if statistics are enabled. | no | enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1033. Metrics
| Name | Description |
|---|---|
| Subsystem:clear | Clear statistics. |
| Subsystem:evict All | Evict all entities from second level cache. |
| Subsystem:summary | Log the statistics. |
none
3.4.1.2.7.1.1. JBoss AS 7 and EAP 6 - Entity Cache Service
Table 3.1034. Overview
| Description: | Statistics for a Hibernate Second Level Cache region. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1035.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1036. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.4.1.2.7.1.2. JBoss AS 7 and EAP 6 - Query Cache Service
Table 3.1037. Overview
| Description: | Statistics for individual queries. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1038.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1039. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Query Cache Hit Count | measurement | Get the number of times query was retrieved from cache. | query-cache-hit-count |
| Query Cache Hit Count per Minute | measurement | Get the number of times query was retrieved from cache. | query-cache-hit-count |
| Query Cache Miss Count | measurement | Get the number of times query was not found in cache. | query-cache-miss-count |
| Query Cache Miss Count per Minute | measurement | Get the number of times query was not found in cache. | query-cache-miss-count |
| Query Cache Put Count | measurement | Get the number of times query was put in cache. | query-cache-put-count |
| Query Cache Put Count per Minute | measurement | Get the number of times query was put in cache. | query-cache-put-count |
| Query Execution Average Time | measurement | Get the average time in milliseconds of the query. | query-execution-average-time |
| Query Execution Count | measurement | Get number of times query has been executed. | query-execution-count |
| Query Execution Count per Minute | measurement | Get number of times query has been executed. | query-execution-count |
| Query Execution Max Time | measurement | Get the time in milliseconds of the query. | query-execution-max-time |
| Query Execution Min Time | measurement | Get the minimum time in milliseconds of the query. | query-execution-min-time |
| Query Execution Row Count | measurement | Get number of rows returned from executions of query. | query-execution-row-count |
| Query Execution Row Count per Minute | measurement | Get number of rows returned from executions of query. | query-execution-row-count |
| Query Name | trait | Query name. | query-name |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.4.1.2.7.1.3. JBoss AS 7 and EAP 6 - Entity Service
Table 3.1040. Overview
| Description: | Statistics for individual entities. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1041.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1042. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.4.1.2.7.1.4. JBoss AS 7 and EAP 6 - Collection Service
Table 3.1043. Overview
| Description: | Statistics for individual collections. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1044.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1045. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
none
none
none
3.4.2. JBoss AS 7 and EAP 6 - Host Service
Overview
Table 3.1046. Overview
| Description: | A host involved in this domain |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1047.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1048. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1049.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.1. JBoss AS 7 and EAP 6 - JVM Service
Overview
Table 3.1050. Overview
| Description: | Information about the underlying JVM |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1051.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.1.1. JBoss AS 7 and EAP 6 - Operating System Service
Overview
Table 3.1052. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1053.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1054. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.1.2. JBoss AS 7 and EAP 6 - Memory Service
Overview
Table 3.1055. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1056.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1057. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.1058. Metrics
| Name | Description |
|---|---|
| Trigger GC | Runs the garbage collector. |
Package Types
none
3.4.2.1.3. JBoss AS 7 and EAP 6 - Runtime Service
Overview
Table 3.1059. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1060.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1061. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Uptime | measurement | The uptime of the Java virtual machine in milliseconds. | uptime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.1.4. JBoss AS 7 and EAP 6 - Threading Service
Overview
Table 3.1062. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1063.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1064. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1065.
| 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 |
| All Thread Ids | All live thread IDs. If a security manager is installed and the caller does not have ManagementPermission('monitor'), the result will be undefined. | yes | all-thread-ids |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1066. Metrics
| 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. |
Package Types
none
3.4.2.1.5. JBoss AS 7 and EAP 6 - Garbage Collector Service
Overview
Table 3.1067. Overview
| Description: | Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1068.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.1.5.1. JBoss AS 7 and EAP 6 - Garbage Collector Resource Service
Table 3.1069. Overview
| Description: | The management interface for one of the garbage collectors in the Java virtual machine. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1070.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1071. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Collection Count | measurement | The total number of collections that have occurred. | collection-count |
| Collection Time | 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1072.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Memory Pool Names | The name of memory pools that this garbage collector manages. | yes | memory-pool-names |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.2.1.6. JBoss AS 7 and EAP 6 - Memory Pool Service
Overview
Table 3.1073. Overview
| Description: | Parent resource for the resources providing the management interface for the Java virtual machine's memory pools. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1074.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.2.1.6.1. JBoss AS 7 and EAP 6 - Memory Pool Resource Service
Table 3.1075. Overview
| Description: | The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1076.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1077. Metrics
| 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 | measurement | 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 | measurement | 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1078.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1079. Metrics
| Name | Description |
|---|---|
| Reset Peak Usage | Resets the peak memory usage statistic of this memory pool to the current memory usage. |
none
3.4.2.2. JBoss AS 7 and EAP 6 - JVM Definition (Host) Service
Overview
Table 3.1080. Overview
| Description: | A JVM Definition on Host level, that can serve as templates for server groups and managed servers |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1081.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1082.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.2.3. JBoss AS 7 and EAP 6 - Network Interface Service
Overview
Table 3.1083. Overview
| Description: | A named network interface, along with required criteria for determining the IP address to associate with that interface |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1084.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1085.
| 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. | yes | any-address |
| Any Ipv 4 Address | Attribute indicating that sockets using this interface should be bound to the IPv4 wildcard address (0.0.0.0). | yes | any-ipv4-address |
| Any Ipv 6 Address | Attribute indicating that sockets using this interface should be bound to the IPv6 wildcard address (::). | yes | any-ipv6-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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.3. JBoss AS 7 and EAP 6 - DomainDeployment Service
Overview
Table 3.1086. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1087.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1088.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | yes | name | |
| Runtime Name | yes | runtime-name | |
| Content | yes | content |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1089. Metrics
| Name | Description |
|---|---|
| Assign to Server-Group | Assign this deployment to a server group |
Package Types
Table 3.1090. Package Types
| Name | Category | Description |
|---|---|---|
| File | Deployable | Deployments on this domain |
3.4.4. JBoss AS 7 and EAP 6 - Managed Server
Overview
Table 3.1091. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Autodiscovery Process Scans
none
Connection Properties
Table 3.1092.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Log Event Sources | yes | logEventSources | |
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1093. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1094.
| 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 | yes | auto-start |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1095. Metrics
| Name | Description |
|---|---|
| Start | Start this server instance. |
| Stop | Stop this server instance. |
| Restart | Restart this server instance. |
Package Types
none
3.4.4.1. JBoss AS 7 and EAP 6 - ManagedServerDeployment Service
Overview
Table 3.1096. Overview
| Description: | Deployed package on a managed server. Go to server groups to manipulate it |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1097.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1098. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1099.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | yes | name | |
| Runtime Name | yes | runtime-name | |
| Content | yes | content |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.2. JBoss AS 7 and EAP 6 - Naming (Managed Server) Service
Overview
Table 3.1100. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1101.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.1102. Metrics
| Name | Description |
|---|---|
| JNDIView | Peek at the JNDI tree |
Package Types
none
3.4.4.2.1. JBoss AS 7 and EAP 6 - Binding (Managed Server) Service
Overview
Table 3.1103. Overview
| Description: | JNDI bindings for primitive types |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1104.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1105.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.3. JBoss AS 7 and EAP 6 - Webservices (Managed Server) Service
Overview
Table 3.1106. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1107.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1108.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.3.1. JBoss AS 7 and EAP 6 - Endpoint (Managed Server) Service
Overview
Table 3.1109. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1110.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.3.1.1. JBoss AS 7 and EAP 6 - Post Handler Chain (Managed Server) Service
Table 3.1111. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1112.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1113.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.3.1.1.1. JBoss AS 7 and EAP 6 - Post Handler (Managed Server) Service
Table 3.1114. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1115.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1116.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Class | Handler class | yes | class |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.3.1.2. JBoss AS 7 and EAP 6 - Pre Handler Chain (Managed Server) Service
Table 3.1117. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1118.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1119.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.3.1.2.1. JBoss AS 7 and EAP 6 - Pre Handler (Managed Server) Service
Table 3.1120. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1121.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1122.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Class | Handler class | yes | class |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.3.1.3. JBoss AS 7 and EAP 6 - Property (Read Only) Service
Table 3.1123. Overview
| Description: | A property |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1124.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1125.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The property value. | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.4. JBoss AS 7 and EAP 6 - JacORB (Managed Server) Service
Overview
Table 3.1126. Overview
| Description: | JacORB subsystem configuration |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1127.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1128.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.5. JBoss AS 7 and EAP 6 - JAXR (Managed Server) Service
Overview
Table 3.1129. Overview
| Description: | The configuration of the JAXR subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1130.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1131.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.5.1. JBoss AS 7 and EAP 6 - Property (JAXR - Managed Server) Service
Overview
Table 3.1132. Overview
| Description: | A JAXR property. The identity of the resource defines the property name. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1133.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1134.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The JAXR property value. | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.6. JBoss AS 7 and EAP 6 - JPA (Managed Server) Service
Overview
Table 3.1135. Overview
| Description: | The configuration of the JPA subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1136.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1137.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Default Datasource | The name of the default global datasource. | no | default-datasource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.7. JBoss AS 7 and EAP 6 - EE (Managed Server) Service
Overview
Table 3.1138. Overview
| Description: | The configuration of the EE subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1139.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1140.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.8. JBoss AS 7 and EAP 6 - Infinispan (Managed Server) Service
Overview
Table 3.1141. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1142.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.8.1. JBoss AS 7 and EAP 6 - Cache Container (Managed Server) Service
Overview
Table 3.1143. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1144.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1145.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Default Cache | The default infinispan cache | no | default-cache |
| Aliases | The list of aliases for this cache container | no | aliases |
| Jndi Name | The jndi name to which to bind this cache container | no | jndi-name |
| Start | The cache container start mode, which can be EAGER (immediate start) or LAZY (on-demand start). | no | start |
| Listener Executor | The executor used for the replication queue | no | listener-executor |
| Eviction Executor | The scheduled executor used for eviction | no | eviction-executor |
| 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 |
| Replication Queue Executor | The executor used for asynchronous cache operations | no | replication-queue-executor |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.8.1.1. JBoss AS 7 and EAP 6 - Cache (Managed Server) Service
Table 3.1146. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1147.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1148.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Start | The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start). | no | start |
| Batching | If enabled, the invocation batching API will be made available for this cache. | no | batching |
| Indexing | If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed. | no | indexing |
| 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 |
| 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 |
| 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 |
| 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 |
| Async Marshalling | If enabled, this will cause marshalling of entries to be performed asynchronously. The default value is false. | no | async-marshalling |
| 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 |
| 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 |
| Virtual Nodes | Controls the number of virtual nodes per 'real' node. If numVirtualNodes is 1, then virtual nodes are disabled. The topology aware consistent hash must be used if you wish to take advantage of virtual nodes. A default of 1 is used. The default value is 1. | no | virtual-nodes |
| Type of cache | Type of cache | yes | __type |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.8.1.2. JBoss AS 7 and EAP 6 - Transport (Managed Server) Service
Table 3.1149. Overview
| Description: | The description of the transport used by this cache container |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1150.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1151.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Cluster | The name of the group communication cluster | no | cluster |
| Executor | The executor to use for the transport | no | executor |
| Lock Timeout | The timeout for locks for the transport. The default value is 240000. | no | lock-timeout |
| Machine | A machine identifier for the transport | no | machine |
| Rack | A rack identifier for the transport | no | rack |
| Site | A site identifier for the transport | no | site |
| Stack | The jgroups stack to use for the transport | no | stack |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.9. JBoss AS 7 and EAP 6 - JGroups (Managed Server) Service
Overview
Table 3.1152. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1153.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1154.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Default Stack | Default stack to use | yes | default-stack |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.10. JBoss AS 7 and EAP 6 - Remoting (Managed Server) Service
Overview
Table 3.1155. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1156.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1157.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.11. JBoss AS 7 and EAP 6 - Mail (Managed Server) Service
Overview
Table 3.1158. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1159.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.11.1. JBoss AS 7 and EAP 6 - Mail Session (Managed Server) Service
Overview
Table 3.1160. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1161.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1162.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.11.1.1. JBoss AS 7 and EAP 6 - SMTP Mail Server (Managed Server) Service
Table 3.1163. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1164.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1165.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.11.1.2. JBoss AS 7 and EAP 6 - IMAP Mail Server (Managed Server) Service
Table 3.1166. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1167.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1168.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.11.1.3. JBoss AS 7 and EAP 6 - POP3 Mail Server (Managed Server) Service
Table 3.1169. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1170.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1171.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.12. JBoss AS 7 and EAP 6 - JBossWeb (Managed Server) Service
Overview
Table 3.1172. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1173.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1174.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Disabled: 0 | Enable the default Servlet mapping. The default value is false. | no | disabled:0 |
| File Encoding | Force a file encoding. | no | file-encoding |
| Listings | Enable folder listings. The default value is false. | no | listings |
| Max Depth | Maximum recursion for PROPFIND. The default value is 3. | no | max-depth |
| Read Only | Allow write HTTP methods (PUT, DELETE). The default value is true. | no | read-only |
| Sendfile | Enable sendfile if possible, for files bigger than the specified byte size. The default value is 49152. | no | sendfile |
| Secret | Secret for WebDAV locking operations. | no | secret |
| Webdav | Enable WebDAV functionality. The default value is false. | no | webdav |
| Check Interval | Check interval for JSP updates using a background thread. The default value is 0. | no | check-interval |
| Development | Enable the development mode, which gives more information when an error occurs. The default value is false. | no | development |
| Disabled: 1 | Enable the JSP container. The default value is false. | no | disabled:1 |
| 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 | Minimum amount of time between two tests for updates, in seconds. The default value is 4. | no | modification-test-interval |
| 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.5. | 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.5. | 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 |
| Welcome File | A welcome file declaration. | no | welcome-file |
| Default Virtual Server | The web container's default virtual server. The default value is default-host. | yes | default-virtual-server |
| Instance Id | The identifier for this server instance. | no | instance-id |
| Native | Add the native initialization listener to the web container. The default value is true. | no | native |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.12.1. JBoss AS 7 and EAP 6 - Connector (Managed Server) Service
Overview
Table 3.1175. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1176.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1177. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Bytes Sent | measurement | Number of byte sent by the connector. | bytesSent |
| Bytes Sent per Minute | measurement | Number of byte sent by the connector. | bytesSent |
| Bytes Received | measurement | Number of byte received by the connector (POST data). | bytesReceived |
| Bytes Received per Minute | measurement | Number of byte received by the connector (POST data). | bytesReceived |
| Processing Time | measurement | Processing time used by the connector. Im milli-seconds. | processingTime |
| Processing Time per Minute | measurement | Processing time used by the connector. Im milli-seconds. | processingTime |
| Error Count | measurement | Number of error that occurs when processing requests by the connector. | errorCount |
| Error Count per Minute | measurement | Number of error that occurs when processing requests by the connector. | errorCount |
| Max Time | measurement | Max time spent to process a requests. | maxTime |
| Request Count | measurement | Number of the request processed by the connector. | requestCount |
| Request Count per Minute | measurement | Number of the request processed by the connector. | requestCount |
| Max connections | measurement | Number of max connections this connector can handle (see configuration to set it) | _maxConnections |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1178.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Configuration | no | *Configuration+ | |
| Scheme | The web connector scheme. | yes | scheme |
| Socket Binding | The web connector socket-binding reference, this connector should be bound to. | yes | socket-binding |
| Enabled | Defines whether the connector should be started on startup. The default value is true. | no | enabled |
| Enable Lookups | Enable DNS lookups for Servlet API. The default value is false. | no | enable-lookups |
| Executor | The name of the executor that should be used for the processing threads of this connector. If undefined defaults to using an internal pool. | no | executor |
| Max Connections | Amount of concurrent connections that can be processed by the connector with optimum performance. The default value depends on the connector used and the number of cpu cores (512*cores for HTTP, 32*cores for AJP). | no | max-connections |
| Max Post Size | Maximum size in bytes of a POST request that can be parsed by the container. The default value is 2097152. | no | max-post-size |
| Max Save Post Size | Maximum size in bytes of a POST request that will be saved during certain authentication schemes. The default value is 4096. | no | max-save-post-size |
| Name | A unique name for the connector. | no | name |
| Protocol | The web connector protocol. (e.g. 'HTTP/1.1' or 'AJP' or a name of a class implementing ProtocolHandler and MBeanRegistration ) | yes | protocol |
| Proxy Name | The host name that will be used when sending a redirect. The default value is null. | no | proxy-name |
| Proxy Port | The port that will be used when sending a redirect. | no | proxy-port |
| Redirect Port | The port for redirection to a secure connector. The default value is 8433. | no | redirect-port |
| Secure | Indicates if content sent or received by the connector is secured from the user perspective. The default value is false. | no | secure |
| Virtual Server | The list of virtual servers that can be accessed through this connector. The default is to allow all virtual servers. | no | virtual-server |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.12.2. JBoss AS 7 and EAP 6 - VHost (Managed Server) Service
Overview
Table 3.1179. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1180.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1181. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| _aliases | trait | Aliases for this virtual host | _aliases |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1182.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Configuration | no | *Configuration+ | |
| Virtual server aliases | The virtual server aliases | yes | alias |
| Default Web Module | The web module deployment name that will be mapped as the root webapp. | yes | default-web-module |
| Enable Welcome Root | Whether or not the bundled welcome directory is used as the root web context. The default value is false. | yes | enable-welcome-root |
| Name | A unique virtual host name | no | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.12.2.1. JBoss AS 7 and EAP 6 - Rewrite Rules (Managed Server) Service
Table 3.1183. Overview
| Description: | A list of rewrite rules that will be processed in order on the URL or vhost specified in the request. Those follow the rules for mod_rewrite. Please consult the manual for help on settings |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1184.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1185.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Conditions | no | *1 | |
| Flags | Option flags for this rewrite rule. Consult the mod_rewrite docs. | yes | flags |
| Pattern | The pattern that will be matched. Consult the mod_rewrite docs. | yes | pattern |
| Substitution | The string that will replace the original URL or vhost. Consult the mod_rewrite docs. | yes | substitution |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.12.2.2. JBoss AS 7 and EAP 6 - Access Log (Managed Server) Service
Table 3.1186. Overview
| Description: | The access log configuration for this virtual server. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1187.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1188.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | The relative folder path. | no | path |
| Relative To | The folder the path is relative to. The default value is jboss.server.log.dir. | no | relative-to |
| Extended | Enable extended pattern, with more options. The default value is false. | no | extended |
| Pattern | The access log pattern. The default value is common. | no | pattern |
| Prefix | Prefix for the log file name. The default value is false. | no | prefix |
| Resolve Hosts | Host resolution. The default value is false. | no | resolve-hosts |
| Rotate | Rotate the access log every day. The default value is true. | no | rotate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.13. JBoss AS 7 and EAP 6 - JCA (Managed Server) Service
Overview
Table 3.1189. Overview
| Description: | The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1190.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1191.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.13.1. JBoss AS 7 and EAP 6 - BootstrapContext (Managed Server) Service
Overview
Table 3.1192. Overview
| Description: | Bootstrap context for resource adapters. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1193.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1194.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of the BootstrapContext | no | name |
| Workmanager | The WorkManager instance for the BootstrapContext | no | workmanager |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.13.2. JBoss AS 7 and EAP 6 - Workmanager (Managed Server) Service
Overview
Table 3.1195. Overview
| Description: | WorkManager for resource adapters. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1196.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1197.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of the WorkManager | no | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.13.2.1. JBoss AS 7 and EAP 6 - Long Running Thread Pool (Managed Server) Service
Table 3.1198. Overview
| Description: | Long running thread pool executor with a bounded queue where threads submitting tasks may block. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1199.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1200. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
| Keepalive Time:time | measurement | The time | keepalive-time:time |
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1201.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.13.2.2. JBoss AS 7 and EAP 6 - Short Running Thread Pool (Managed Server) Service
Table 3.1202. Overview
| Description: | Short running thread pool executor with a bounded queue where threads submitting tasks may block. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1203.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1204. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Current Thread Count | measurement | The current number of threads in the pool. | current-thread-count |
| Keepalive Time:time | measurement | The time | keepalive-time:time |
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1205.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.14. JBoss AS 7 and EAP 6 - Osgi (Managed Server) Service
Overview
Table 3.1206. Overview
| Description: | The OSGi subsystem configuration. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1207.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1208.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1209. Metrics
| Name | Description |
|---|---|
| Activate | Activate the OSGi subsystem. |
Package Types
none
3.4.4.14.1. JBoss AS 7 and EAP 6 - Capability (Managed Server) Service
Overview
Table 3.1210. 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: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1211.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1212.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Startlevel | The startlevel for the capability. Can only be specified for OSGi bundles. | no | startlevel |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.14.2. JBoss AS 7 and EAP 6 - Bundle (Managed Server) Service
Overview
Table 3.1213. Overview
| Description: | Runtime bundle information. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1214.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1215.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1216. Metrics
| Name | Description |
|---|---|
| Start | Starts the bundle. |
| Stop | Stops the bundle. |
Package Types
none
3.4.4.14.3. JBoss AS 7 and EAP 6 - Property (Read Only) Service
Overview
Table 3.1217. Overview
| Description: | A property |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1218.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1219.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The property value. | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.15. JBoss AS 7 and EAP 6 - JMX (Managed Server) Service
Overview
Table 3.1220. Overview
| Description: | The configuration of the JMX subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1221.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1222.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Show Model | Set to 'true' to include MBeans for the model controller resources | no | show-model |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.15.1. JBoss AS 7 and EAP 6 - Remoting Connector (Managed Server) Service
Overview
Table 3.1223. Overview
| Description: | The configuration of a resource adapter. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1224.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1225.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.16. JBoss AS 7 and EAP 6 - Resource Adapters (Managed Server) Service
Overview
Table 3.1226. Overview
| Description: | Configuration of the resource adapters subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1227.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.16.1. JBoss AS 7 and EAP 6 - Resource Adapter (Managed Server) Service
Overview
Table 3.1228. Overview
| Description: | The configuration of a resource adapter. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1229.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1230.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.16.1.1. JBoss AS 7 and EAP 6 - Admin Objects (Managed Server) Service
Table 3.1231. Overview
| Description: | Specifies the administration objects. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1232.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1233.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.16.1.2. JBoss AS 7 and EAP 6 - Connection Definitions (Managed Server) Service
Table 3.1234. Overview
| Description: | Specifies the connection definitions. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1235.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1236.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1237. Metrics
| 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 |
none
3.4.4.16.1.2.1. JBoss AS 7 and EAP 6 - Config Properties (Read Only) Service
Table 3.1238. Overview
| Description: | Custom defined config properties. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1239.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1240.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | Custom defined config property value | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.16.1.3. JBoss AS 7 and EAP 6 - Config Properties (Read Only) Service
Table 3.1241. Overview
| Description: | Custom defined config properties. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1242.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1243.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | Custom defined config property value | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.17. JBoss AS 7 and EAP 6 - CMP (Managed Server) Service
Overview
Table 3.1244. Overview
| Description: | The configuration of the cmp subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1245.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.17.1. JBoss AS 7 and EAP 6 - HiloKeygenerator (Managed Server) Service
Overview
Table 3.1246. Overview
| Description: | HiLo based key generators. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1247.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1248.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.18. JBoss AS 7 and EAP 6 - EJB3 (Managed Server) Service
Overview
Table 3.1249. Overview
| Description: | The configuration of the ejb3 subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1250.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1251.
| 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 hornetq-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 |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.18.1. JBoss AS 7 and EAP 6 - EJB3 Thread Pool (Managed Server) Service
Overview
Table 3.1252. 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: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1253.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1254. 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 |
| Keepalive Time:time | measurement | The time | keepalive-time:time |
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1255.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.18.2. JBoss AS 7 and EAP 6 - File Passivation Store (Managed Server) Service
Overview
Table 3.1256. Overview
| Description: | A file system based passivation store. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1257.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1258.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.18.3. JBoss AS 7 and EAP 6 - Strict Max Bean Instance Pool (Managed Server) Service
Overview
Table 3.1259. Overview
| Description: | A bean instance pool with a strict upper limit |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1260.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1261.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Max Pool Size | The maximum number of bean instances that the pool can hold at a given point in time. The default value is 20. | no | max-pool-size:expr |
| 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:expr |
| Timeout Unit | The instance acquisition timeout unit. The default value is MINUTES. | no | timeout-unit |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.18.4. JBoss AS 7 and EAP 6 - SFSB Cache (Managed Server) Service
Overview
Table 3.1262. Overview
| Description: | A SFSB cache. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1263.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1264.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.18.5. JBoss AS 7 and EAP 6 - Cluster Passivation Store (Managed Server) Service
Overview
Table 3.1265. Overview
| Description: | A clustered passivation store. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1266.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1267.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.18.6. JBoss AS 7 and EAP 6 - Async Service (Managed Server) Service
Overview
Table 3.1268. Overview
| Description: | The EJB3 Asynchronous Invocation Service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1269.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1270.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Thread Pool Name | The name of the thread pool which handles asynchronous invocations | no | thread-pool-name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.18.7. JBoss AS 7 and EAP 6 - IIOP Service (Managed Server) Service
Overview
Table 3.1271. Overview
| Description: | The IIOP service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1272.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1273.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.18.8. JBoss AS 7 and EAP 6 - Remote Service (Managed Server) Service
Overview
Table 3.1274. Overview
| Description: | The EJB3 remote service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1275.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1276.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.18.8.1. JBoss AS 7 and EAP 6 - Channel Creation Options (Managed Server) Service
Table 3.1277. Overview
| Description: | The options that will be used during the EJB remote channel creation |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1278.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1279.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.18.9. JBoss AS 7 and EAP 6 - Timer Service (Managed Server) Service
Overview
Table 3.1280. Overview
| Description: | The EJB timer service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1281.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1282.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.19. JBoss AS 7 and EAP 6 - Threads (Managed Server) Service
Overview
Table 3.1283. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1284.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.19.1. JBoss AS 7 and EAP 6 - ThreadFactory (Managed Server) Service
Overview
Table 3.1285. Overview
| Description: | A thread factory (implementing java.util.concurrent.ThreadFactory). |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1286.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1287.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.19.2. JBoss AS 7 and EAP 6 - ThreadPool (Managed Server) Service
Overview
Table 3.1288. Overview
| Description: | A thread pool executor |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1289.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1290. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1291.
| 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 |
| 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 |
| Thread Pool Type | Thread pool type | yes | __type |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.20. JBoss AS 7 and EAP 6 - Security (Managed Server) Service
Overview
Table 3.1292. Overview
| Description: | The configuration of the security subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1293.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1294.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.20.1. JBoss AS 7 and EAP 6 - Security Domain (Managed Server) Service
Overview
Table 3.1295. Overview
| Description: | Configures a security domain. Authentication, authorization, ACL, mapping, auditing and identity trust are configured here. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1296.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1297.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1298. Metrics
| 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
none
3.4.4.20.1.1. JBoss AS 7 and EAP 6 - ACL (Managed Server) Service
Table 3.1299. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1300.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1301.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Acl Modules | List of acl modules | no | acl-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.20.1.2. JBoss AS 7 and EAP 6 - Audit (Managed Server) Service
Table 3.1302. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1303.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1304.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Provider Modules | List of provider modules | no | provider-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.20.1.3. JBoss AS 7 and EAP 6 - Authentication (Classic - Managed Server) Service
Table 3.1305. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1306.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1307.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Login Modules | List of authentication modules | no | login-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.20.1.4. JBoss AS 7 and EAP 6 - Authentication (Jaspi - Managed Server) Service
Table 3.1308. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Table 3.1309.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1310.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Auth Modules | List of authentication modules to be used. | yes | auth-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.20.1.4.1. JBoss AS 7 and EAP 6 - Login Module Stack (Managed Server) Service
Table 3.1311. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1312.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1313.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Login Modules | List of authentication modules | yes | login-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.20.1.5. JBoss AS 7 and EAP 6 - Authorization (Managed Server) Service
Table 3.1314. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1315.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1316.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Policy Modules | List of authorization modules | no | policy-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.20.1.6. JBoss AS 7 and EAP 6 - Identity Trust (Managed Server) Service
Table 3.1317. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1318.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1319.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Trust Modules | List of trust modules | no | trust-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.20.1.7. JBoss AS 7 and EAP 6 - JSSE (Managed Server) Service
Table 3.1320. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1321.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1322.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.20.1.8. JBoss AS 7 and EAP 6 - Mapping (Managed Server) Service
Table 3.1323. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1324.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1325.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Mapping Modules | List of modules that map principal, role, and credential information | no | mapping-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.20.2. JBoss AS 7 and EAP 6 - Vault (Managed Server) Service
Overview
Table 3.1326. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1327.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1328.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Code | Fully Qualified Name of the Security Vault Implementation. | no | code |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.21. JBoss AS 7 and EAP 6 - Messaging (Managed Server) Service
Overview
Table 3.1329. Overview
| Description: | The messaging subsystems |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1330.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.21.1. JBoss AS 7 and EAP 6 - HornetQ (Managed Server) Service
Overview
Table 3.1331. Overview
| Description: | The HornetQ based messaging subsystem |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1332.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1333. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this server is started. | started |
| Version | trait | The server's version. | version |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1334.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Failback | Whether this server will automatically shutdown if the original live server comes back up. The default value is true. | no | allow-failback |
| 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 |
| Backup | Whether this server is a backup server. The default value is false. | no | backup |
| 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 HORNETQ.CLUSTER.ADMIN.USER. | no | cluster-user |
| Clustered | Whether the server is clustered. The default value is false. | no | clustered |
| Connection Ttl Override | 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 |
| 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 |
| Failback Delay | How long to wait before failback occurs on live server restart. The default value is 5000. | no | failback-delay |
| Failover On Shutdown | Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false. | no | failover-on-shutdown |
| Id Cache Size | The size of the cache for pre-creating message IDs. The default value is 2000. | no | id-cache-size |
| Jmx Domain | The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq. | no | jmx-domain |
| Jmx Management Enabled | Whether HornetQ 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 | The size of the internal buffer on the journal. | no | journal-buffer-size |
| Journal Buffer Timeout | The timeout (in nanoseconds) used to flush internal buffers on the journal. | no | journal-buffer-timeout |
| Journal Compact Min Files | The minimal number of journal data files before we can start compacting. The default value is 10. | no | journal-compact-min-files |
| Journal Compact Percentage | The percentage of live data on which we consider compacting the journal. The default value is 30. | no | journal-compact-percentage |
| Journal File Size | The size (in bytes) of each journal file. The default value is 10485760. | no | journal-file-size |
| Journal Max Io | The maximum number of write requests that can be in the AIO queue at any one time. | no | journal-max-io |
| Journal Min Files | How many journal files to pre-create. The default value is 2. | no | journal-min-files |
| 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 |
| Live Connector Ref | The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'. | no | live-connector-ref |
| 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.hornetq.management. | no | management-address |
| Management Notification Address | The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications. | no | management-notification-address |
| Memory Measure Interval | 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 | Percentage of available memory which if exceeded results in a warning log. The default value is 25. | no | memory-warning-threshold:expr |
| Message Counter Enabled | Whether message counters are enabled. The default value is false. | no | message-counter-enabled |
| Message Counter Max Day History | How many days to keep message counter history. The default value is 10. | no | message-counter-max-day-history |
| Message Counter Sample Period | The sample period (in ms) to use for message counters. The default value is 10000. | no | message-counter-sample-period |
| Message Expiry Scan Period | How often (in ms) to scan for expired messages. The default value is 30000. | no | message-expiry-scan-period |
| Message Expiry Thread Priority | The priority of the thread expiring messages. The default value is 3. | no | message-expiry-thread-priority |
| Page Max Concurrent Io | The maximum number of concurrent reads allowed on paging. The default value is 5. | no | page-max-concurrent-io |
| Perf Blast Pages | TODO. The default value is -1. | no | perf-blast-pages |
| 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 |
| Remoting Interceptors | The list of interceptor classes used by this server. | no | remoting-interceptors |
| 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 | 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 | How long (in ms) to wait before invalidating the security cache. The default value is 10000. | no | security-invalidation-interval |
| Server Dump Interval | 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 |
| Shared Store | Whether this server is using a shared store for failover. The default value is true. | no | shared-store |
| Thread Pool Max Size | 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 | 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 |
| Transaction Timeout Scan Period | How often (in ms) to scan for timeout transactions. The default value is 1000. | no | transaction-timeout-scan-period |
| Wild Card Routing Enabled | Whether the server supports wild card routing. The default value is true. | no | wild-card-routing-enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1335. Metrics
| Name | Description |
|---|---|
| Close Connections for Address | Closes all the connections of clients connected to this server whose remote address contains the specified IP address. Returns true if any connections were closed, false otherwise. |
| Commit Prepared Transaction | Heuristically commits a prepared transaction. |
| 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. The returned String is a JSON string containing an array of address settings details. |
| Get Connectors as JSON | Returns the connectors configured for this server using JSON serialization. |
| Get Last Sent Message ID | Returns the ID of the last message sent from the given session to the given address. |
| Get Session Creation Time | Gets the session's creation time. Returns the creation time, represented as a string showing the number of milliseconds since the epoch. |
| List All Consumers as JSON | Lists all the consumers. |
| List Connection IDs | Lists the IDs of all the connections connected to this server. |
| List Connections as JSON | List all JMS connections. |
| List Consumers as JSON | Lists all the consumers which belongs to the JMS Connection specified by the connection-id. |
| List Heuristic Committed Transactions | Lists transactions which have been heuristically committed. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Heuristic Rolled Back Transactions | Lists transactions which have been heuristically rolled back. Returns a list of strings. The Strings are Base-64 representation of the transaction XID. |
| List Prepared Transaction Details as HTML | List all the prepared transaction, sorted by date, oldest first, with details, in HTML format. |
| List Prepared Transaction Details as JSON | List all the prepared transaction, sorted by date, oldest first, with details, in JSON format. |
| List Prepared Transaction JMS Details as HTML | List all the prepared transactions, sorted by date, oldest first, with details in JMS, in HTML format |
| List Prepared Transaction JMS details as JSON | List all the prepared transactions, sorted by date, oldest first, with details in JMS format, in JSON format |
| List Prepared Transactions | List all the prepared transaction, sorted by date, oldest first. Returns a list of strings. The Strings are Base-64 representation of the transaction XID and can be used to heuristically commit or rollback the transactions. |
| 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 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. The returned String is a JSON string containing an array of session ids. |
| List Target Destinations | Lists all addresses to which the designated session has sent messages. The returned String is a JSON string containing an array of address names. |
| Reset All Message Counter Histories | Reset all message counters history. |
| Reset All Message Counters | Reset all message counters. |
| Rollback Prepared Transaction | Heuristically rolls back a prepared transaction. Returns true if the transaction was successfully rolled back, false otherwise. |
Package Types
none
3.4.4.21.1.1. JBoss AS 7 and EAP 6 - JMS Queue (Managed Server) Service
Table 3.1336. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1337.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1338. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1339.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1340. Metrics
| 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. |
none
3.4.4.21.1.2. JBoss AS 7 and EAP 6 - JMS Topic (Managed Server) Service
Table 3.1341. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1342.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1343. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1344.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Names | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1345. Metrics
| 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. |
none
3.4.4.21.1.3. JBoss AS 7 and EAP 6 - Connection Factory (Managed Server) Service
Table 3.1346. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1347.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1348.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connector | Defines the connector to be used. This is mutually exclusive with discovery-group-name | no | connector:collapsed |
| JNDI Names | The jndi names the connection factory should be bound to. | yes | entries |
| 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 Timeout | The call time out. The default value is 30000. | no | call-timeout |
| Client Failure Check Period | The client failure check period. The default value is 30000. | no | client-failure-check-period |
| 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 | The confirmation window size. The default value is -1. | no | confirmation-window-size |
| 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.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. | no | connection-load-balancing-policy-class-name |
| Connection Ttl | The connection ttl. The default value is 60000. | no | connection-ttl |
| Consumer Max Rate | The consumer max rate. The default value is -1. | no | consumer-max-rate |
| Consumer Window Size | The consumer window size. The default value is 1048576. | no | consumer-window-size |
| Discovery Group Name | The discovery group name. | no | discovery-group-name |
| Discovery Initial Wait Timeout | The discovery initial wait time out. | no | discovery-initial-wait-timeout |
| Dups Ok Batch Size | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size |
| Factory Type | The type of connection factory. | no | factory-type |
| Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
| Failover On Server Shutdown | True to fail over on server shutdown. | no | failover-on-server-shutdown |
| Group Id | The group id. | no | group-id |
| Ha | Whether the connection factory supports High Availability. The default value is false. | yes | ha |
| Initial Message Packet Size | The initial size of messages created through this factory. | yes | initial-message-packet-size |
| Max Retry Interval | The max retry interval. The default value is 2000. | no | max-retry-interval |
| Min Large Message Size | The min large message size. The default value is 102400. | no | min-large-message-size |
| Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
| Producer Max Rate | The producer max rate. The default value is -1. | no | producer-max-rate |
| Producer Window Size | The producer window size. The default value is 65536. | no | producer-window-size |
| Reconnect Attempts | The reconnect attempts. The default value is 0. | no | reconnect-attempts |
| Retry Interval | The retry interval. The default value is 2000. | no | retry-interval |
| Retry Interval Multiplier | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier |
| Scheduled Thread Pool Max Size | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
| Thread Pool Max Size | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
| Transaction Batch Size | The transaction batch size. The default value is 1048576. | no | transaction-batch-size |
| Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.4. JBoss AS 7 and EAP 6 - Pooled Connection Factory (Managed Server) Service
Table 3.1349. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1350.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1351.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connector | Defines the connectors. These are stored in a map by connector name, with the backup connectors stored as the value, or an undefined value if there is no backup connector. | no | connector:collapsed |
| JNDI Names | The jndi names the connection factory should be bound to. | yes | entries |
| 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 Timeout | The call time out. The default value is 30000. | no | call-timeout |
| Client Failure Check Period | The client failure check period. The default value is 30000. | no | client-failure-check-period |
| Client Id | The client id. | no | client-id |
| Confirmation Window Size | The confirmation window size. The default value is -1. | no | confirmation-window-size |
| 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.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. | no | connection-load-balancing-policy-class-name |
| Connection Ttl | The connection ttl. The default value is 60000. | no | connection-ttl |
| Consumer Max Rate | The consumer max rate. The default value is -1. | no | consumer-max-rate |
| Consumer Window Size | The consumer window size. The default value is 1048576. | no | consumer-window-size |
| Discovery Group Name | The discovery group name. | no | discovery-group-name |
| Discovery Initial Wait Timeout | The discovery initial wait time out. | no | discovery-initial-wait-timeout |
| Dups Ok Batch Size | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size |
| Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
| Failover On Server Shutdown | True to fail over on server shutdown. | no | failover-on-server-shutdown |
| Group Id | The group id. | no | group-id |
| Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
| Jndi Params | The JNDI params to use for locating the destination for incoming connections. | no | jndi-params |
| Max Pool Size | The maximum size for the pool. The default value is -1. | no | max-pool-size:expr |
| Max Retry Interval | The max retry interval. The default value is 2000. | no | max-retry-interval |
| Min Large Message Size | The min large message size. The default value is 102400. | no | min-large-message-size |
| Min Pool Size | 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 | The producer max rate. The default value is -1. | no | producer-max-rate |
| Producer Window Size | The producer window size. The default value is 65536. | no | producer-window-size |
| Reconnect Attempts | The reconnect attempts. The default value is 0. | no | reconnect-attempts |
| Retry Interval | The retry interval. The default value is 2000. | no | retry-interval |
| Retry Interval Multiplier | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier |
| Scheduled Thread Pool Max Size | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
| Setup Attempts | The number of times to set up an MDB endpoint | no | setup-attempts |
| Setup Interval | The interval between attempts at setting up an MDB endpoint. | no | setup-interval |
| Thread Pool Max Size | 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 | The transaction batch size. The default value is 1048576. | no | transaction-batch-size |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.5. JBoss AS 7 and EAP 6 - Security Setting (Managed Server) Service
Table 3.1352. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1353.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
none
none
3.4.4.21.1.5.1. JBoss AS 7 and EAP 6 - Role (Managed Server) Service
Table 3.1354. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1355.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1356.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.6. JBoss AS 7 and EAP 6 - Address Setting (Managed Server) Service
Table 3.1357. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1358.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1359.
| 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 |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.7. JBoss AS 7 and EAP 6 - Grouping Handler (Managed Server) Service
Table 3.1360. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1361.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1362.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.8. JBoss AS 7 and EAP 6 - Acceptor (Managed Server) Service
Table 3.1363. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1364.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1365. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this acceptor is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1366.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | The factory class. | yes | factory-class |
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1367. Metrics
| Name | Description |
|---|---|
| Start | Starts the acceptor. |
| Stop | Stops the acceptor. |
none
3.4.4.21.1.8.1. JBoss AS 7 and EAP 6 - Param (Read Only) Service
Table 3.1368. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1369.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1370.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.9. JBoss AS 7 and EAP 6 - Connector (HornetQ - Managed Server) Service
Table 3.1371. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1372.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1373.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | The factory class. | yes | factory-class |
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.9.1. JBoss AS 7 and EAP 6 - Param (Read Only) Service
Table 3.1374. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1375.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1376.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.10. JBoss AS 7 and EAP 6 - In VM Acceptor (Managed Server) Service
Table 3.1377. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1378.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1379. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether it's stopped or started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1380.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Server Id | The server id. | yes | server-id |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1381. Metrics
| Name | Description |
|---|---|
| Start | Starts the acceptor. |
| Stop | Stops the acceptor. |
none
3.4.4.21.1.10.1. JBoss AS 7 and EAP 6 - Param (Read Only) Service
Table 3.1382. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1383.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1384.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.11. JBoss AS 7 and EAP 6 - In VM Connector (Managed Server) Service
Table 3.1385. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1386.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1387.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Server Id | The server id. | yes | server-id |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.11.1. JBoss AS 7 and EAP 6 - Param (Read Only) Service
Table 3.1388. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1389.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1390.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.12. JBoss AS 7 and EAP 6 - Remote Acceptor (Managed Server) Service
Table 3.1391. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1392.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1393. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether this acceptor is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1394.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1395. Metrics
| Name | Description |
|---|---|
| Start | Starts the acceptor. |
| Stop | Stops the acceptor. |
none
3.4.4.21.1.12.1. JBoss AS 7 and EAP 6 - Param (Read Only) Service
Table 3.1396. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1397.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1398.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.13. JBoss AS 7 and EAP 6 - Remote Connector (Managed Server) Service
Table 3.1399. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1400.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1401.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.13.1. JBoss AS 7 and EAP 6 - Param (Read Only) Service
Table 3.1402. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1403.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1404.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.14. JBoss AS 7 and EAP 6 - Divert (Managed Server) Service
Table 3.1405. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1406.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1407.
| 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 HornetQ filter expression syntax described in the HornetQ 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.15. JBoss AS 7 and EAP 6 - Queue (Managed Server) Service
Table 3.1408. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1409.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1410. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1411.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1412. Metrics
| 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. |
none
3.4.4.21.1.16. JBoss AS 7 and EAP 6 - Core Address (Managed Server) Service
Table 3.1413. Overview
| Description: | A runtime-only resource representing a HornetQ 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: | JBossAS7 |
none
Table 3.1414.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1415.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.17. JBoss AS 7 and EAP 6 - Cluster Connection (Managed Server) Service
Table 3.1416. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1417.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1418. Metrics
| 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1419.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Direct Connections Only | Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined. The default value is false. | no | allow-direct-connections-only |
| 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 HornetQ 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. HornetQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other HornetQ 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 |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1420. Metrics
| 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. |
none
3.4.4.21.1.18. JBoss AS 7 and EAP 6 - Broadcast Group (Managed Server) Service
Table 3.1421. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1422.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1423. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether the broadcast group is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1424.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1425. Metrics
| 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. |
none
3.4.4.21.1.19. JBoss AS 7 and EAP 6 - Path (Managed Server) Service
Table 3.1426. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1427.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1428.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.20. JBoss AS 7 and EAP 6 - Bridge (Managed Server) Service
Table 3.1429. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1430.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1431. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Started | trait | Whether the bridge is started. | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1432.
| 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 HornetQ filter expression syntax described in the HornetQ 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 |
| Transformer Class Name | The name of a user-defined class which implements the org.hornetq.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 HORNETQ.CLUSTER.ADMIN.USER. | no | user |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1433. Metrics
| Name | Description |
|---|---|
| Start | Starts the bridge. |
| Stop | Stops the bridge. |
none
3.4.4.21.1.21. JBoss AS 7 and EAP 6 - Discovery Group (Managed Server) Service
Table 3.1434. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1435.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1436.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.22. JBoss AS 7 and EAP 6 - Connector Service (Managed Server) Service
Table 3.1437. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1438.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1439.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | Class name of the factory class that can instantiate the connector service. | yes | factory-class |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.21.1.22.1. JBoss AS 7 and EAP 6 - Param (Read Only) Service
Table 3.1440. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1441.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1442.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.22. JBoss AS 7 and EAP 6 - Logging (Managed Server) Service
Overview
Table 3.1443. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1444.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1445.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.22.1. JBoss AS 7 and EAP 6 - Async Handler (Managed Server) Service
Overview
Table 3.1446. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1447.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1448.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| 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 |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.22.2. JBoss AS 7 and EAP 6 - Console Handler (Managed Server) Service
Overview
Table 3.1449. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1450.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1451.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.22.3. JBoss AS 7 and EAP 6 - Custom Handler (Managed Server) Service
Overview
Table 3.1452. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1453.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1454.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.22.4. JBoss AS 7 and EAP 6 - File Handler (Managed Server) Service
Overview
Table 3.1455. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1456.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1457.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.22.5. JBoss AS 7 and EAP 6 - Logger (Managed Server) Service
Overview
Table 3.1458. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1459.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1460.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.22.6. JBoss AS 7 and EAP 6 - Periodic Rotating File Handler (Managed Server) Service
Overview
Table 3.1461. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1462.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1463.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.22.7. JBoss AS 7 and EAP 6 - Size Rotating File Handler (Managed Server) Service
Overview
Table 3.1464. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1465.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1466.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.23. JBoss AS 7 and EAP 6 - JVM Service
Overview
Table 3.1467. Overview
| Description: | Information about the underlying JVM |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1468.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.23.1. JBoss AS 7 and EAP 6 - Operating System Service
Overview
Table 3.1469. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1470.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1471. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.23.2. JBoss AS 7 and EAP 6 - Memory Service
Overview
Table 3.1472. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1473.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1474. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.1475. Metrics
| Name | Description |
|---|---|
| Trigger GC | Runs the garbage collector. |
Package Types
none
3.4.4.23.3. JBoss AS 7 and EAP 6 - Runtime Service
Overview
Table 3.1476. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1477.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1478. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Uptime | measurement | The uptime of the Java virtual machine in milliseconds. | uptime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.23.4. JBoss AS 7 and EAP 6 - Threading Service
Overview
Table 3.1479. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1480.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1481. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1482.
| 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 |
| All Thread Ids | All live thread IDs. If a security manager is installed and the caller does not have ManagementPermission('monitor'), the result will be undefined. | yes | all-thread-ids |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1483. Metrics
| 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. |
Package Types
none
3.4.4.23.5. JBoss AS 7 and EAP 6 - Garbage Collector Service
Overview
Table 3.1484. Overview
| Description: | Parent resource for the resources providing the management interface for the garbage collection of the Java virtual machine. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1485.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.23.5.1. JBoss AS 7 and EAP 6 - Garbage Collector Resource Service
Table 3.1486. Overview
| Description: | The management interface for one of the garbage collectors in the Java virtual machine. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1487.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1488. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Collection Count | measurement | The total number of collections that have occurred. | collection-count |
| Collection Time | 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1489.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Memory Pool Names | The name of memory pools that this garbage collector manages. | yes | memory-pool-names |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.23.6. JBoss AS 7 and EAP 6 - Memory Pool Service
Overview
Table 3.1490. Overview
| Description: | Parent resource for the resources providing the management interface for the Java virtual machine's memory pools. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1491.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.23.6.1. JBoss AS 7 and EAP 6 - Memory Pool Resource Service
Table 3.1492. Overview
| Description: | The management interface for a memory pool. A memory pool represents the memory resource managed by the Java virtual machine and is managed by one or more memory managers. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1493.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1494. Metrics
| 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 | measurement | 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 | measurement | 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Table 3.1495.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Table 3.1496. Metrics
| Name | Description |
|---|---|
| Reset Peak Usage | Resets the peak memory usage statistic of this memory pool to the current memory usage. |
none
3.4.4.24. JBoss AS 7 and EAP 6 - Datasources (Managed) Service
Overview
Table 3.1497. Overview
| Description: | Datasources subsystem for Managed servers. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1498.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.24.1. JBoss AS 7 and EAP 6 - DataSource (Managed) Service
Overview
Table 3.1499. Overview
| Description: | A non-XA data source |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1500.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1501. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1502.
| 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 | 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-cacheSize |
| 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 Minutes | The background-validation-minutes element specifies the amount of time, in minutes, that background validation will run. Changing this value require a server restart. | no | background-validation-minutes |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1503. Metrics
| 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 |
Package Types
none
3.4.4.24.2. JBoss AS 7 and EAP 6 - XADataSource (Managed) Service
Overview
Table 3.1504. Overview
| Description: | An XA data source |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1505.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1506. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1507.
| 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 | 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-cacheSize |
| 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 Minutes | The background-validation-minutes element specifies the amount of time, in minutes, that background validation will run. Changing this value require a server restart. | no | background-validation-minutes |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1508. Metrics
| 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 |
Package Types
none
3.4.4.25. JBoss AS 7 and EAP 6 - JVM Definition Service
Overview
Table 3.1509. Overview
| Description: | A JVM definition that can override host and server group level definitions with the same name |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1510.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1511.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.26. JBoss AS 7 and EAP 6 - Transactions Subsystem (Managed) Service
Overview
Table 3.1512. Overview
| Description: | The transactions subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1513.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1514. 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
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.4.4.26.1. JBoss AS 7 and EAP 6 - Log Store (Managed) Service
Overview
Table 3.1515. Overview
| Description: | Representation of the transaction logging storage mechanism. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1516.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1517.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Specifies the implementation type of the logging store. | no | type |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.4.26.1.1. JBoss AS 7 and EAP 6 - Transactions (Managed) Service
Table 3.1518. Overview
| Description: | The persistent information that the transaction manager stores for the purpose of recovering a transaction in the event of failure. The probe operation will add and remove transactions from the model as the corresponding real transactions start and finish the prepare and commit phases. A stuck transaction will remain in the model until either it is completed or explicitly removed by the delete operation. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1519.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1520.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.26.1.1.1. JBoss AS 7 and EAP 6 - Participants (Managed) Service
Table 3.1521. Overview
| Description: | The resources that did work in a transaction. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1522.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1523.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.4.27. JBoss AS 7 and EAP 6 - JDR Service
Overview
Table 3.1524. Overview
| Description: | JBoss Diagnostic Reporter (JDR) Subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1525.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.1526. Metrics
| Name | Description |
|---|---|
| Generate JDR Report | Request the generation of a JDR report. |
Package Types
none
3.4.5. JBoss AS 7 and EAP 6 - Profile Service
Overview
Table 3.1527. Overview
| Description: | A profile in a domain. Profiles are assigned to server groups. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1528.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.1. JBoss AS 7 and EAP 6 - ModCluster Domain Service
Overview
Table 3.1529. Overview
| Description: | Mod_cluster support |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1530.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.1.1. JBoss AS 7 and EAP 6 - Domain Service Configuration Service
Overview
Table 3.1531. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1532.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1533.
| 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 |
| Domain | loadBalancingGroup name. | no | domain |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1534. Metrics
| 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
none
3.4.5.1.1.1. JBoss AS 7 and EAP 6 - Domain Dynamic Load Provider Service
Table 3.1535. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1536.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1537.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Decay | Decay. The default value is 2. | no | decay |
| History | History. The default value is 9. | no | history |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.1.1.1.1. JBoss AS 7 and EAP 6 - Domain Custom Load Metric Service
Table 3.1538. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1539.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1540.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.1.1.1.2. JBoss AS 7 and EAP 6 - Domain Load Metric Service
Table 3.1541. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1542.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1543.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.1.1.2. JBoss AS 7 and EAP 6 - Domain Ssl Service
Table 3.1544. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1545.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1546.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.2. JBoss AS 7 and EAP 6 - Naming (Profile) Service
Overview
Table 3.1547. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1548.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.2.1. JBoss AS 7 and EAP 6 - Binding (Profile) Service
Overview
Table 3.1549. Overview
| Description: | JNDI bindings for primitive types |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1550.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1551.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.3. JBoss AS 7 and EAP 6 - JBossWeb (Profile) Service
Overview
Table 3.1552. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1553.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1554.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Disabled: 0 | Enable the default Servlet mapping. The default value is false. | no | disabled:0 |
| File Encoding | Force a file encoding. | no | file-encoding |
| Listings | Enable folder listings. The default value is false. | no | listings |
| Max Depth | Maximum recursion for PROPFIND. The default value is 3. | no | max-depth |
| Read Only | Allow write HTTP methods (PUT, DELETE). The default value is true. | no | read-only |
| Sendfile | Enable sendfile if possible, for files bigger than the specified byte size. The default value is 49152. | no | sendfile |
| Secret | Secret for WebDAV locking operations. | no | secret |
| Webdav | Enable WebDAV functionality. The default value is false. | no | webdav |
| Check Interval | Check interval for JSP updates using a background thread. The default value is 0. | no | check-interval |
| Development | Enable the development mode, which gives more information when an error occurs. The default value is false. | no | development |
| Disabled: 1 | Enable the JSP container. The default value is false. | no | disabled:1 |
| 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 | Minimum amount of time between two tests for updates, in seconds. The default value is 4. | no | modification-test-interval |
| 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.5. | 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.5. | 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 |
| Welcome File | A welcome file declaration. | no | welcome-file |
| Default Virtual Server | The web container's default virtual server. The default value is default-host. | yes | default-virtual-server |
| Instance Id | The identifier for this server instance. | no | instance-id |
| Native | Add the native initialization listener to the web container. The default value is true. | no | native |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.3.1. JBoss AS 7 and EAP 6 - Connector (Profile) Service
Overview
Table 3.1555. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1556.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1557.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Configuration | no | *Configuration+ | |
| Scheme | The web connector scheme. | yes | scheme |
| Socket Binding | The web connector socket-binding reference, this connector should be bound to. | yes | socket-binding |
| Enabled | Defines whether the connector should be started on startup. The default value is true. | no | enabled |
| Enable Lookups | Enable DNS lookups for Servlet API. The default value is false. | no | enable-lookups |
| Executor | The name of the executor that should be used for the processing threads of this connector. If undefined defaults to using an internal pool. | no | executor |
| Max Connections | Amount of concurrent connections that can be processed by the connector with optimum performance. The default value depends on the connector used and the number of cpu cores (512*cores for HTTP, 32*cores for AJP). | no | max-connections |
| Max Post Size | Maximum size in bytes of a POST request that can be parsed by the container. The default value is 2097152. | no | max-post-size |
| Max Save Post Size | Maximum size in bytes of a POST request that will be saved during certain authentication schemes. The default value is 4096. | no | max-save-post-size |
| Name | A unique name for the connector. | no | name |
| Protocol | The web connector protocol. (e.g. 'HTTP/1.1' or 'AJP' or a name of a class implementing ProtocolHandler and MBeanRegistration ) | yes | protocol |
| Proxy Name | The host name that will be used when sending a redirect. The default value is null. | no | proxy-name |
| Proxy Port | The port that will be used when sending a redirect. | no | proxy-port |
| Redirect Port | The port for redirection to a secure connector. The default value is 8433. | no | redirect-port |
| Secure | Indicates if content sent or received by the connector is secured from the user perspective. The default value is false. | no | secure |
| Virtual Server | The list of virtual servers that can be accessed through this connector. The default is to allow all virtual servers. | no | virtual-server |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.3.2. JBoss AS 7 and EAP 6 - VHost (Profile) Service
Overview
Table 3.1558. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1559.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1560.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Configuration | no | *Configuration+ | |
| Virtual server aliases | The virtual server aliases | yes | alias |
| Default Web Module | The web module deployment name that will be mapped as the root webapp. | yes | default-web-module |
| Enable Welcome Root | Whether or not the bundled welcome directory is used as the root web context. The default value is false. | yes | enable-welcome-root |
| Name | A unique virtual host name | no | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.3.2.1. JBoss AS 7 and EAP 6 - Rewrite Rules (Profile) Service
Table 3.1561. Overview
| Description: | A list of rewrite rules that will be processed in order on the URL or vhost specified in the request. Those follow the rules for mod_rewrite. Please consult the manual for help on settings |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1562.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1563.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Conditions | no | *1 | |
| Flags | Option flags for this rewrite rule. Consult the mod_rewrite docs. | yes | flags |
| Pattern | The pattern that will be matched. Consult the mod_rewrite docs. | yes | pattern |
| Substitution | The string that will replace the original URL or vhost. Consult the mod_rewrite docs. | yes | substitution |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.3.2.2. JBoss AS 7 and EAP 6 - Access Log (Profile) Service
Table 3.1564. Overview
| Description: | The access log configuration for this virtual server. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1565.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1566.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | The relative folder path. | no | path |
| Relative To | The folder the path is relative to. The default value is jboss.server.log.dir. | no | relative-to |
| Extended | Enable extended pattern, with more options. The default value is false. | no | extended |
| Pattern | The access log pattern. The default value is common. | no | pattern |
| Prefix | Prefix for the log file name. The default value is false. | no | prefix |
| Resolve Hosts | Host resolution. The default value is false. | no | resolve-hosts |
| Rotate | Rotate the access log every day. The default value is true. | no | rotate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.4. JBoss AS 7 and EAP 6 - JCA (Profile) Service
Overview
Table 3.1567. Overview
| Description: | The Java EE Connector Architecture (JCA) subsystem providing general configuration for resource adapters |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1568.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1569.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.4.1. JBoss AS 7 and EAP 6 - BootstrapContext (Profile) Service
Overview
Table 3.1570. Overview
| Description: | Bootstrap context for resource adapters. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1571.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1572.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of the BootstrapContext | no | name |
| Workmanager | The WorkManager instance for the BootstrapContext | no | workmanager |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.4.2. JBoss AS 7 and EAP 6 - Workmanager (Profile) Service
Overview
Table 3.1573. Overview
| Description: | WorkManager for resource adapters. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1574.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1575.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of the WorkManager | no | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.4.2.1. JBoss AS 7 and EAP 6 - Long Running Thread Pool (Profile) Service
Table 3.1576. Overview
| Description: | Long running thread pool executor with a bounded queue where threads submitting tasks may block. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1577.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1578.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.4.2.2. JBoss AS 7 and EAP 6 - Short Running Thread Pool (Profile) Service
Table 3.1579. Overview
| Description: | Short running thread pool executor with a bounded queue where threads submitting tasks may block. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1580.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1581.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.5. JBoss AS 7 and EAP 6 - Osgi (Profile) Service
Overview
Table 3.1582. Overview
| Description: | The OSGi subsystem configuration. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1583.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1584.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.5.1. JBoss AS 7 and EAP 6 - Capability (Profile) Service
Overview
Table 3.1585. 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: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1586.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1587.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Startlevel | The startlevel for the capability. Can only be specified for OSGi bundles. | no | startlevel |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.5.2. JBoss AS 7 and EAP 6 - Property Service
Overview
Table 3.1588. Overview
| Description: | A property |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1589.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1590.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The property value. | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.6. JBoss AS 7 and EAP 6 - Resource Adapters (Profile) Service
Overview
Table 3.1591. Overview
| Description: | Configuration of the resource adapters subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1592.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.6.1. JBoss AS 7 and EAP 6 - Resource Adapter (Profile) Service
Overview
Table 3.1593. Overview
| Description: | The configuration of a resource adapter. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1594.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1595.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.6.1.1. JBoss AS 7 and EAP 6 - Admin Objects (Profile) Service
Table 3.1596. Overview
| Description: | Specifies the administration objects. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1597.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1598.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.6.1.2. JBoss AS 7 and EAP 6 - Connection Definitions (Profile) Service
Table 3.1599. Overview
| Description: | Specifies the connection definitions. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1600.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1601.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.6.1.2.1. JBoss AS 7 and EAP 6 - Config Properties Service
Table 3.1602. Overview
| Description: | Custom defined config properties. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1603.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1604.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | Custom defined config property value | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.6.1.3. JBoss AS 7 and EAP 6 - Config Properties Service
Table 3.1605. Overview
| Description: | Custom defined config properties. |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1606.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1607.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | Custom defined config property value | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.7. JBoss AS 7 and EAP 6 - EJB3 (Profile) Service
Overview
Table 3.1608. Overview
| Description: | The configuration of the ejb3 subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1609.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1610.
| 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 hornetq-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 |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.7.1. JBoss AS 7 and EAP 6 - EJB3 Thread Pool (Profile) Service
Overview
Table 3.1611. 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: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1612.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1613.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.7.2. JBoss AS 7 and EAP 6 - File Passivation Store (Profile) Service
Overview
Table 3.1614. Overview
| Description: | A file system based passivation store. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1615.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1616.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.7.3. JBoss AS 7 and EAP 6 - Strict Max Bean Instance Pool (Profile) Service
Overview
Table 3.1617. Overview
| Description: | A bean instance pool with a strict upper limit |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1618.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1619.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Max Pool Size | The maximum number of bean instances that the pool can hold at a given point in time. The default value is 20. | no | max-pool-size:expr |
| 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:expr |
| Timeout Unit | The instance acquisition timeout unit. The default value is MINUTES. | no | timeout-unit |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.7.4. JBoss AS 7 and EAP 6 - SFSB Cache (Profile) Service
Overview
Table 3.1620. Overview
| Description: | A SFSB cache. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1621.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1622.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.7.5. JBoss AS 7 and EAP 6 - Cluster Passivation Store (Profile) Service
Overview
Table 3.1623. Overview
| Description: | A clustered passivation store. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1624.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1625.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.7.6. JBoss AS 7 and EAP 6 - Async Service (Profile) Service
Overview
Table 3.1626. Overview
| Description: | The EJB3 Asynchronous Invocation Service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1627.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1628.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Thread Pool Name | The name of the thread pool which handles asynchronous invocations | no | thread-pool-name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.7.7. JBoss AS 7 and EAP 6 - IIOP Service (Profile) Service
Overview
Table 3.1629. Overview
| Description: | The IIOP service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1630.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1631.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.7.8. JBoss AS 7 and EAP 6 - Remote Service (Profile) Service
Overview
Table 3.1632. Overview
| Description: | The EJB3 remote service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1633.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1634.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.7.8.1. JBoss AS 7 and EAP 6 - Channel Creation Options (Profile) Service
Table 3.1635. Overview
| Description: | The options that will be used during the EJB remote channel creation |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1636.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1637.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.7.9. JBoss AS 7 and EAP 6 - Timer Service (Profile) Service
Overview
Table 3.1638. Overview
| Description: | The EJB timer service |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1639.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1640.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.8. JBoss AS 7 and EAP 6 - Threads (Profile) Service
Overview
Table 3.1641. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1642.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.8.1. JBoss AS 7 and EAP 6 - ThreadFactory (Profile) Service
Overview
Table 3.1643. Overview
| Description: | A thread factory (implementing java.util.concurrent.ThreadFactory). |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1644.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1645.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.8.2. JBoss AS 7 and EAP 6 - ThreadPool (Profile) Service
Overview
Table 3.1646. Overview
| Description: | A thread pool executor |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1647.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1648.
| 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 |
| 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 |
| Thread Pool Type | Thread pool type | yes | __type |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.9. JBoss AS 7 and EAP 6 - Security (Profile) Service
Overview
Table 3.1649. Overview
| Description: | The configuration of the security subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1650.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1651.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.9.1. JBoss AS 7 and EAP 6 - Security Domain (Profile) Service
Overview
Table 3.1652. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1653.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1654.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.9.1.1. JBoss AS 7 and EAP 6 - ACL (Profile) Service
Table 3.1655. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1656.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1657.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Acl Modules | List of acl modules | no | acl-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.9.1.2. JBoss AS 7 and EAP 6 - Audit (Profile) Service
Table 3.1658. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1659.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1660.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Provider Modules | List of provider modules | no | provider-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.9.1.3. JBoss AS 7 and EAP 6 - Authentication (Classic - Profile) Service
Table 3.1661. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1662.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1663.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Login Modules | List of authentication modules | no | login-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.9.1.4. JBoss AS 7 and EAP 6 - Authentication (Jaspi - Profile) Service
Table 3.1664. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Table 3.1665.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1666.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Auth Modules | List of authentication modules to be used. | yes | auth-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.9.1.4.1. JBoss AS 7 and EAP 6 - Login Module Stack (Profile) Service
Table 3.1667. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1668.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1669.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Login Modules | List of authentication modules | yes | login-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.9.1.5. JBoss AS 7 and EAP 6 - Authorization (Profile) Service
Table 3.1670. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1671.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1672.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Policy Modules | List of authorization modules | no | policy-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.9.1.6. JBoss AS 7 and EAP 6 - Identity Trust (Profile) Service
Table 3.1673. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1674.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1675.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Trust Modules | List of trust modules | no | trust-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.9.1.7. JBoss AS 7 and EAP 6 - JSSE (Profile) Service
Table 3.1676. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1677.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1678.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.9.1.8. JBoss AS 7 and EAP 6 - Mapping (Profile) Service
Table 3.1679. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1680.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1681.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Mapping Modules | List of modules that map principal, role, and credential information | no | mapping-modules |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.9.2. JBoss AS 7 and EAP 6 - Vault (Profile) Service
Overview
Table 3.1682. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1683.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1684.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Code | Fully Qualified Name of the Security Vault Implementation. | no | code |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.10. JBoss AS 7 and EAP 6 - Messaging (Profile) Service
Overview
Table 3.1685. Overview
| Description: | The messaging subsystems |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1686.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.10.1. JBoss AS 7 and EAP 6 - HornetQ (Profile) Service
Overview
Table 3.1687. Overview
| Description: | The HornetQ based messaging subsystem |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1688.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1689.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Failback | Whether this server will automatically shutdown if the original live server comes back up. The default value is true. | no | allow-failback |
| 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 |
| Backup | Whether this server is a backup server. The default value is false. | no | backup |
| 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 HORNETQ.CLUSTER.ADMIN.USER. | no | cluster-user |
| Clustered | Whether the server is clustered. The default value is false. | no | clustered |
| Connection Ttl Override | 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 |
| 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 |
| Failback Delay | How long to wait before failback occurs on live server restart. The default value is 5000. | no | failback-delay |
| Failover On Shutdown | Whether this backup server (if it is a backup server) should come live on a normal server shutdown. The default value is false. | no | failover-on-shutdown |
| Id Cache Size | The size of the cache for pre-creating message IDs. The default value is 2000. | no | id-cache-size |
| Jmx Domain | The JMX domain used to register internal HornetQ MBeans in the MBeanServer. The default value is org.hornetq. | no | jmx-domain |
| Jmx Management Enabled | Whether HornetQ 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 | The size of the internal buffer on the journal. | no | journal-buffer-size |
| Journal Buffer Timeout | The timeout (in nanoseconds) used to flush internal buffers on the journal. | no | journal-buffer-timeout |
| Journal Compact Min Files | The minimal number of journal data files before we can start compacting. The default value is 10. | no | journal-compact-min-files |
| Journal Compact Percentage | The percentage of live data on which we consider compacting the journal. The default value is 30. | no | journal-compact-percentage |
| Journal File Size | The size (in bytes) of each journal file. The default value is 10485760. | no | journal-file-size |
| Journal Max Io | The maximum number of write requests that can be in the AIO queue at any one time. | no | journal-max-io |
| Journal Min Files | How many journal files to pre-create. The default value is 2. | no | journal-min-files |
| 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 |
| Live Connector Ref | The name of the connector used to connect to the live connector. If this server is not a backup that uses shared nothing HA, it's value is 'undefined'. | no | live-connector-ref |
| 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.hornetq.management. | no | management-address |
| Management Notification Address | The name of the address that consumers bind to to receive management notifications. The default value is hornetq.notifications. | no | management-notification-address |
| Memory Measure Interval | 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 | Percentage of available memory which if exceeded results in a warning log. The default value is 25. | no | memory-warning-threshold:expr |
| Message Counter Enabled | Whether message counters are enabled. The default value is false. | no | message-counter-enabled |
| Message Counter Max Day History | How many days to keep message counter history. The default value is 10. | no | message-counter-max-day-history |
| Message Counter Sample Period | The sample period (in ms) to use for message counters. The default value is 10000. | no | message-counter-sample-period |
| Message Expiry Scan Period | How often (in ms) to scan for expired messages. The default value is 30000. | no | message-expiry-scan-period |
| Message Expiry Thread Priority | The priority of the thread expiring messages. The default value is 3. | no | message-expiry-thread-priority |
| Page Max Concurrent Io | The maximum number of concurrent reads allowed on paging. The default value is 5. | no | page-max-concurrent-io |
| Perf Blast Pages | TODO. The default value is -1. | no | perf-blast-pages |
| 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 |
| Remoting Interceptors | The list of interceptor classes used by this server. | no | remoting-interceptors |
| 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 | 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 | How long (in ms) to wait before invalidating the security cache. The default value is 10000. | no | security-invalidation-interval |
| Server Dump Interval | 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 |
| Shared Store | Whether this server is using a shared store for failover. The default value is true. | no | shared-store |
| Thread Pool Max Size | 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 | 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 |
| Transaction Timeout Scan Period | How often (in ms) to scan for timeout transactions. The default value is 1000. | no | transaction-timeout-scan-period |
| Wild Card Routing Enabled | Whether the server supports wild card routing. The default value is true. | no | wild-card-routing-enabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.10.1.1. JBoss AS 7 and EAP 6 - JMS Queue (Profile) Service
Table 3.1690. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1691.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1692.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.2. JBoss AS 7 and EAP 6 - JMS Topic (Profile) Service
Table 3.1693. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1694.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1695.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| JNDI Names | The jndi names the queue will be bound to. | yes | entries |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.3. JBoss AS 7 and EAP 6 - Connection Factory (Profile) Service
Table 3.1696. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1697.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1698.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connector | Defines the connector to be used. This is mutually exclusive with discovery-group-name | no | connector:collapsed |
| JNDI Names | The jndi names the connection factory should be bound to. | yes | entries |
| 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 Timeout | The call time out. The default value is 30000. | no | call-timeout |
| Client Failure Check Period | The client failure check period. The default value is 30000. | no | client-failure-check-period |
| 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 | The confirmation window size. The default value is -1. | no | confirmation-window-size |
| 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.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. | no | connection-load-balancing-policy-class-name |
| Connection Ttl | The connection ttl. The default value is 60000. | no | connection-ttl |
| Consumer Max Rate | The consumer max rate. The default value is -1. | no | consumer-max-rate |
| Consumer Window Size | The consumer window size. The default value is 1048576. | no | consumer-window-size |
| Discovery Group Name | The discovery group name. | no | discovery-group-name |
| Discovery Initial Wait Timeout | The discovery initial wait time out. | no | discovery-initial-wait-timeout |
| Dups Ok Batch Size | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size |
| Factory Type | The type of connection factory. | no | factory-type |
| Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
| Failover On Server Shutdown | True to fail over on server shutdown. | no | failover-on-server-shutdown |
| Group Id | The group id. | no | group-id |
| Ha | Whether the connection factory supports High Availability. The default value is false. | yes | ha |
| Initial Message Packet Size | The initial size of messages created through this factory. | yes | initial-message-packet-size |
| Max Retry Interval | The max retry interval. The default value is 2000. | no | max-retry-interval |
| Min Large Message Size | The min large message size. The default value is 102400. | no | min-large-message-size |
| Pre Acknowledge | True to pre-acknowledge. The default value is false. | no | pre-acknowledge |
| Producer Max Rate | The producer max rate. The default value is -1. | no | producer-max-rate |
| Producer Window Size | The producer window size. The default value is 65536. | no | producer-window-size |
| Reconnect Attempts | The reconnect attempts. The default value is 0. | no | reconnect-attempts |
| Retry Interval | The retry interval. The default value is 2000. | no | retry-interval |
| Retry Interval Multiplier | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier |
| Scheduled Thread Pool Max Size | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
| Thread Pool Max Size | The thread pool max size. The default value is 30. | no | thread-pool-max-size:expr |
| Transaction Batch Size | The transaction batch size. The default value is 1048576. | no | transaction-batch-size |
| Use Global Pools | True to use global pools. The default value is true. | no | use-global-pools |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.4. JBoss AS 7 and EAP 6 - Pooled Connection Factory (Profile) Service
Table 3.1699. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1700.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1701.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connector | Defines the connectors. These are stored in a map by connector name, with the backup connectors stored as the value, or an undefined value if there is no backup connector. | no | connector:collapsed |
| JNDI Names | The jndi names the connection factory should be bound to. | yes | entries |
| 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 Timeout | The call time out. The default value is 30000. | no | call-timeout |
| Client Failure Check Period | The client failure check period. The default value is 30000. | no | client-failure-check-period |
| Client Id | The client id. | no | client-id |
| Confirmation Window Size | The confirmation window size. The default value is -1. | no | confirmation-window-size |
| 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.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy. | no | connection-load-balancing-policy-class-name |
| Connection Ttl | The connection ttl. The default value is 60000. | no | connection-ttl |
| Consumer Max Rate | The consumer max rate. The default value is -1. | no | consumer-max-rate |
| Consumer Window Size | The consumer window size. The default value is 1048576. | no | consumer-window-size |
| Discovery Group Name | The discovery group name. | no | discovery-group-name |
| Discovery Initial Wait Timeout | The discovery initial wait time out. | no | discovery-initial-wait-timeout |
| Dups Ok Batch Size | The dups ok batch size. The default value is 1048576. | no | dups-ok-batch-size |
| Failover On Initial Connection | True to fail over on initial connection. The default value is false. | no | failover-on-initial-connection |
| Failover On Server Shutdown | True to fail over on server shutdown. | no | failover-on-server-shutdown |
| Group Id | The group id. | no | group-id |
| Ha | Whether the connection factory supports High Availability. The default value is false. | no | ha |
| Jndi Params | The JNDI params to use for locating the destination for incoming connections. | no | jndi-params |
| Max Pool Size | The maximum size for the pool. The default value is -1. | no | max-pool-size:expr |
| Max Retry Interval | The max retry interval. The default value is 2000. | no | max-retry-interval |
| Min Large Message Size | The min large message size. The default value is 102400. | no | min-large-message-size |
| Min Pool Size | 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 | The producer max rate. The default value is -1. | no | producer-max-rate |
| Producer Window Size | The producer window size. The default value is 65536. | no | producer-window-size |
| Reconnect Attempts | The reconnect attempts. The default value is 0. | no | reconnect-attempts |
| Retry Interval | The retry interval. The default value is 2000. | no | retry-interval |
| Retry Interval Multiplier | The retry interval multiplier. The default value is 1.0. | no | retry-interval-multiplier |
| Scheduled Thread Pool Max Size | The scheduled thread pool max size. The default value is 5. | no | scheduled-thread-pool-max-size:expr |
| Setup Attempts | The number of times to set up an MDB endpoint | no | setup-attempts |
| Setup Interval | The interval between attempts at setting up an MDB endpoint. | no | setup-interval |
| Thread Pool Max Size | 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 | The transaction batch size. The default value is 1048576. | no | transaction-batch-size |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.5. JBoss AS 7 and EAP 6 - Security Setting (Profile) Service
Table 3.1702. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1703.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
none
none
3.4.5.10.1.5.1. JBoss AS 7 and EAP 6 - Role (Profile) Service
Table 3.1704. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1705.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1706.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.6. JBoss AS 7 and EAP 6 - Address Setting (Profile) Service
Table 3.1707. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1708.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1709.
| 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 |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.7. JBoss AS 7 and EAP 6 - Grouping Handler (Profile) Service
Table 3.1710. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1711.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1712.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.8. JBoss AS 7 and EAP 6 - Acceptor (Profile) Service
Table 3.1713. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1714.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1715.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | The factory class. | yes | factory-class |
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.8.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.1716. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1717.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1718.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.9. JBoss AS 7 and EAP 6 - Connector (HornetQ - Profile) Service
Table 3.1719. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1720.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1721.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | The factory class. | yes | factory-class |
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.9.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.1722. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1723.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1724.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.10. JBoss AS 7 and EAP 6 - In VM Acceptor (Profile) Service
Table 3.1725. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1726.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1727.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Server Id | The server id. | yes | server-id |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.10.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.1728. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1729.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1730.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.11. JBoss AS 7 and EAP 6 - In VM Connector (Profile) Service
Table 3.1731. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1732.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1733.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Server Id | The server id. | yes | server-id |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.11.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.1734. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1735.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1736.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.12. JBoss AS 7 and EAP 6 - Remote Acceptor (Profile) Service
Table 3.1737. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1738.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1739.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.12.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.1740. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1741.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1742.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.13. JBoss AS 7 and EAP 6 - Remote Connector (Profile) Service
Table 3.1743. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1744.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1745.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Socket Binding | The socket binding reference. | no | socket-binding |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.13.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.1746. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1747.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1748.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.14. JBoss AS 7 and EAP 6 - Divert (Profile) Service
Table 3.1749. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1750.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1751.
| 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 HornetQ filter expression syntax described in the HornetQ 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.15. JBoss AS 7 and EAP 6 - Queue (Profile) Service
Table 3.1752. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1753.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1754.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.16. JBoss AS 7 and EAP 6 - Core Address (Profile) Service
Table 3.1755. Overview
| Description: | A runtime-only resource representing a HornetQ 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: | JBossAS7 |
none
Table 3.1756.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Include Runtime | yes | includeRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1757.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.17. JBoss AS 7 and EAP 6 - Cluster Connection (Profile) Service
Table 3.1758. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1759.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1760.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Allow Direct Connections Only | Whether, if a node learns of the existence of a node that is more than 1 hop away, we do not create a bridge for direct cluster connection. Only relevant if 'static-connectors' is defined. The default value is false. | no | allow-direct-connections-only |
| 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 HornetQ 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. HornetQ can be configured to also load balance messages to nodes which might be connected to it only indirectly with other HornetQ 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 |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.18. JBoss AS 7 and EAP 6 - Broadcast Group (Profile) Service
Table 3.1761. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1762.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1763.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.19. JBoss AS 7 and EAP 6 - Path (Profile) Service
Table 3.1764. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1765.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1766.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.20. JBoss AS 7 and EAP 6 - Bridge (Profile) Service
Table 3.1767. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1768.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1769.
| 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 HornetQ filter expression syntax described in the HornetQ 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 |
| Transformer Class Name | The name of a user-defined class which implements the org.hornetq.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 HORNETQ.CLUSTER.ADMIN.USER. | no | user |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.21. JBoss AS 7 and EAP 6 - Discovery Group (Profile) Service
Table 3.1770. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1771.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1772.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.22. JBoss AS 7 and EAP 6 - Connector Service (Profile) Service
Table 3.1773. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1774.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1775.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Factory Class | Class name of the factory class that can instantiate the connector service. | yes | factory-class |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.10.1.22.1. JBoss AS 7 and EAP 6 - Param Service
Table 3.1776. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1777.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1778.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The parameter value | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.11. JBoss AS 7 and EAP 6 - Datasources (Profile) Service
Overview
Table 3.1779. Overview
| Description: | Datasources subsystem for profile. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1780.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.11.1. JBoss AS 7 and EAP 6 - DataSource (Profile) Service
Overview
Table 3.1781. Overview
| Description: | A non-XA data source |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1782.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1783.
| 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 | 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-cacheSize |
| 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 Minutes | The background-validation-minutes element specifies the amount of time, in minutes, that background validation will run. Changing this value require a server restart. | no | background-validation-minutes |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1784. Metrics
| Name | Description |
|---|---|
| Enable | Enables the data-source |
| Disable | Disables the data-source |
Package Types
none
3.4.5.11.2. JBoss AS 7 and EAP 6 - XADataSource (Profile) Service
Overview
Table 3.1785. Overview
| Description: | An XA data source |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1786.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1787.
| 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 | 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-cacheSize |
| 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 Minutes | The background-validation-minutes element specifies the amount of time, in minutes, that background validation will run. Changing this value require a server restart. | no | background-validation-minutes |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1788. Metrics
| Name | Description |
|---|---|
| Enable | Enables the data-source |
| Disable | Disables the data-source |
Package Types
none
3.4.5.12. JBoss AS 7 and EAP 6 - Logging Service
Overview
Table 3.1789. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1790.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1791.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.12.1. JBoss AS 7 and EAP 6 - Async Handler Service
Overview
Table 3.1792. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1793.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1794.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| 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 |
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1795. Metrics
| 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
none
3.4.5.12.2. JBoss AS 7 and EAP 6 - Console Handler Service
Overview
Table 3.1796. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1797.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1798.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1799. Metrics
| Name | Description |
|---|---|
| Disable | Disable a logging handler. |
| Enable | Enable a logging handler. |
Package Types
none
3.4.5.12.3. JBoss AS 7 and EAP 6 - Custom Handler Service
Overview
Table 3.1800. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1801.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1802.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1803. Metrics
| Name | Description |
|---|---|
| Disable | Disable a logging handler. |
| Enable | Enable a logging handler. |
Package Types
none
3.4.5.12.4. JBoss AS 7 and EAP 6 - File Handler Service
Overview
Table 3.1804. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1805.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1806.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1807. Metrics
| Name | Description |
|---|---|
| Disable | Disable a logging handler. |
| Enable | Enable a logging handler. |
Package Types
none
3.4.5.12.5. JBoss AS 7 and EAP 6 - Logger Service
Overview
Table 3.1808. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1809.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1810.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1811. Metrics
| Name | Description |
|---|---|
| Change Log Level | Change the logging level for a logger category. |
Package Types
none
3.4.5.12.6. JBoss AS 7 and EAP 6 - Periodic Rotating File Handler Service
Overview
Table 3.1812. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1813.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1814.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1815. Metrics
| Name | Description |
|---|---|
| Disable | Disable a logging handler. |
| Enable | Enable a logging handler. |
Package Types
none
3.4.5.12.7. JBoss AS 7 and EAP 6 - Size Rotating File Handler Service
Overview
Table 3.1816. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1817.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1818.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1819. Metrics
| Name | Description |
|---|---|
| Disable | Disable a logging handler. |
| Enable | Enable a logging handler. |
Package Types
none
3.4.5.13. JBoss AS 7 and EAP 6 - Webservices Service
Overview
Table 3.1820. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1821.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path | |
| Managed Runtime | yes | managedRuntime |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1822.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.13.1. JBoss AS 7 and EAP 6 - Endpoint Service
Overview
Table 3.1823. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1824.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.13.1.1. JBoss AS 7 and EAP 6 - Post Handler Chain Service
Table 3.1825. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1826.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1827.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.13.1.1.1. JBoss AS 7 and EAP 6 - Post Handler Service
Table 3.1828. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1829.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1830.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Class | Handler class | yes | class |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.13.1.2. JBoss AS 7 and EAP 6 - Pre Handler Chain Service
Table 3.1831. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Table 3.1832.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1833.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Protocol Bindings | Protocol binding | no | protocol-bindings |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.13.1.2.1. JBoss AS 7 and EAP 6 - Pre Handler Service
Table 3.1834. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1835.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1836.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Class | Handler class | yes | class |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.13.1.3. JBoss AS 7 and EAP 6 - Property Service
Table 3.1837. Overview
| Description: | A property |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1838.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1839.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The property value. | no | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.14. JBoss AS 7 and EAP 6 - Transactions Subsystem (Profile) Service
Overview
Table 3.1840. Overview
| Description: | The transactions subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1841.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1842.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| 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 | relative-to |
| 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. | no | 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 |
| Path | Denotes a relative or absolute filesystem path denoting where the transaction manager core should store data. By default the value is treated as relative to the path denoted by the 'relative-to' attribute. The default value is var. | no | 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.14.1. JBoss AS 7 and EAP 6 - Log Store (Profile) Service
Overview
Table 3.1843. Overview
| Description: | Representation of the transaction logging storage mechanism. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1844.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1845.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | Specifies the implementation type of the logging store. | no | type |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1846. Metrics
| Name | Description |
|---|---|
| Probe | Scan for new transaction logs. This operation will creates a child for each pending transaction. |
Package Types
none
3.4.5.15. JBoss AS 7 and EAP 6 - JacORB Service
Overview
Table 3.1847. Overview
| Description: | JacORB subsystem configuration |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1848.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1849.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.16. JBoss AS 7 and EAP 6 - JAXR Service
Overview
Table 3.1850. Overview
| Description: | The configuration of the JAXR subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1851.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1852.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.16.1. JBoss AS 7 and EAP 6 - Property (JAXR) Service
Overview
Table 3.1853. Overview
| Description: | A JAXR property. The identity of the resource defines the property name. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1854.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1855.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Value | The JAXR property value. | yes | value |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.17. JBoss AS 7 and EAP 6 - JPA Service
Overview
Table 3.1856. Overview
| Description: | The configuration of the JPA subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1857.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1858.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Default Datasource | The name of the default global datasource. | no | default-datasource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.18. JBoss AS 7 and EAP 6 - CMP Service
Overview
Table 3.1859. Overview
| Description: | The configuration of the cmp subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1860.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.18.1. JBoss AS 7 and EAP 6 - HiloKeygenerator Service
Overview
Table 3.1861. Overview
| Description: | HiLo based key generators. |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1862.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1863.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.19. JBoss AS 7 and EAP 6 - EE Service
Overview
Table 3.1864. Overview
| Description: | The configuration of the EE subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1865.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1866.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.20. JBoss AS 7 and EAP 6 - JMX Service
Overview
Table 3.1867. Overview
| Description: | The configuration of the JMX subsystem. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1868.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1869.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Show Model | Set to 'true' to include MBeans for the model controller resources | no | show-model |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.20.1. JBoss AS 7 and EAP 6 - Remoting Connector Service
Overview
Table 3.1870. Overview
| Description: | The configuration of a resource adapter. |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1871.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1872.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.21. JBoss AS 7 and EAP 6 - Infinispan Service
Overview
Table 3.1873. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1874.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.21.1. JBoss AS 7 and EAP 6 - Cache Container Service
Overview
Table 3.1875. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1876.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1877.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Default Cache | The default infinispan cache | no | default-cache |
| Aliases | The list of aliases for this cache container | no | aliases |
| Jndi Name | The jndi name to which to bind this cache container | no | jndi-name |
| Start | The cache container start mode, which can be EAGER (immediate start) or LAZY (on-demand start). | no | start |
| Listener Executor | The executor used for the replication queue | no | listener-executor |
| Eviction Executor | The scheduled executor used for eviction | no | eviction-executor |
| 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 |
| Replication Queue Executor | The executor used for asynchronous cache operations | no | replication-queue-executor |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.21.1.1. JBoss AS 7 and EAP 6 - Cache Service
Table 3.1878. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
none
Table 3.1879.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1880.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Start | The cache start mode, which can be EAGER (immediate start) or LAZY (on-demand start). | no | start |
| Batching | If enabled, the invocation batching API will be made available for this cache. | no | batching |
| Indexing | If enabled, entries will be indexed when they are added to the cache. Indexes will be updated as entries change or are removed. | no | indexing |
| 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 |
| 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 |
| 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 |
| 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 |
| Async Marshalling | If enabled, this will cause marshalling of entries to be performed asynchronously. The default value is false. | no | async-marshalling |
| 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 |
| 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 |
| Virtual Nodes | Controls the number of virtual nodes per 'real' node. If numVirtualNodes is 1, then virtual nodes are disabled. The topology aware consistent hash must be used if you wish to take advantage of virtual nodes. A default of 1 is used. The default value is 1. | no | virtual-nodes |
| Type of cache | Type of cache | yes | __type |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.21.1.2. JBoss AS 7 and EAP 6 - Transport Service
Table 3.1881. Overview
| Description: | The description of the transport used by this cache container |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1882.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1883.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Cluster | The name of the group communication cluster | no | cluster |
| Executor | The executor to use for the transport | no | executor |
| Lock Timeout | The timeout for locks for the transport. The default value is 240000. | no | lock-timeout |
| Machine | A machine identifier for the transport | no | machine |
| Rack | A rack identifier for the transport | no | rack |
| Site | A site identifier for the transport | no | site |
| Stack | The jgroups stack to use for the transport | no | stack |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.22. JBoss AS 7 and EAP 6 - JGroups Service
Overview
Table 3.1884. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1885.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1886.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Default Stack | Default stack to use | yes | default-stack |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.23. JBoss AS 7 and EAP 6 - Remoting Service
Overview
Table 3.1887. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1888.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1889.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.24. JBoss AS 7 and EAP 6 - Mail Service
Overview
Table 3.1890. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1891.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.4.5.24.1. JBoss AS 7 and EAP 6 - Mail Session Service
Overview
Table 3.1892. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
Connection Properties
Table 3.1893.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1894.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.5.24.1.1. JBoss AS 7 and EAP 6 - SMTP Mail Server Service
Table 3.1895. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1896.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1897.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.24.1.2. JBoss AS 7 and EAP 6 - IMAP Mail Server Service
Table 3.1898. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1899.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1900.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.5.24.1.3. JBoss AS 7 and EAP 6 - POP3 Mail Server Service
Table 3.1901. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JBossAS7 |
none
Table 3.1902.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
Table 3.1903.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
none
none
3.4.6. JBoss AS 7 and EAP 6 - Network Interface Service
Overview
Table 3.1904. Overview
| Description: | A named network interface, along with required criteria for determining the IP address to associate with that interface |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1905.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1906.
| 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. | yes | any-address |
| Any Ipv 4 Address | Attribute indicating that sockets using this interface should be bound to the IPv4 wildcard address (0.0.0.0). | yes | any-ipv4-address |
| Any Ipv 6 Address | Attribute indicating that sockets using this interface should be bound to the IPv6 wildcard address (::). | yes | any-ipv6-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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.4.7. JBoss AS 7 and EAP 6 - SocketBindingGroup Service
Overview
Table 3.1907. Overview
| Description: | |
| Singleton: | no |
| Plugin: | JBossAS7 |
Child Resource Types
none
Connection Properties
Table 3.1908.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Path | yes | path |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1909.
| 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
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.5. mod_cluster Service (Tech Preview)
Note
This is a tech preview plug-in available for JBoss AS/EAP 4 servers and JBoss AS/EAP 5 servers.
Upgrade from a tech preview plug-in to a release plug-in is not supported. If you install and use this mod_cluster plug-in, it may be necessary to remove the plug-in — and any resources and data associated with it — to install the release version.
Overview
Table 3.1910. Overview
| Description: | mod_cluster plugin |
| Singleton: | yes |
| Plugin: | mod_cluster |
Child Resource Types
Connection Properties
Table 3.1911.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Engine Object Name | yes | engineObjectName | |
| Name Template | yes | nameTemplate | |
| Modcluster Config File | yes | modclusterConfigFile |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1912. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Proxy Information | trait | Proxy Information | ProxyInformation |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.1913. Metrics
| Name | Description |
|---|---|
| Reset the node | Move this application server out of an error state. |
| Refresh configuration | Refresh configuration for this application server. |
Package Types
none
3.5.1. mod_cluster - HA Service
Overview
Table 3.1914. Overview
| Description: | HA Service |
| Singleton: | yes |
| Plugin: | mod_cluster |
Child Resource Types
none
Connection Properties
Table 3.1915.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Class Name | yes | className | |
| Proxy Info Property | yes | proxyInfoProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1916. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Master Node | trait | Master Node | MasterNode |
| Proxy Configuration | trait | Proxy Configuration | ProxyConfiguration |
| Proxy Info | trait | Proxy Info | ProxyInfo |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1917.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Process Status Frequency | Process status frequency. | no | processStatusFrequency |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1918. Metrics
| Name | Description |
|---|---|
| Disable domain | Disables all contexts on each node within the current domain. If the current domain is null, then all nodes are stopped. |
| Enable domain | Enable all contexts on each node within the current domain. If the current domain is null, then all nodes are stopped. |
| Stop domain | Gracefully stops all contexts on each node within the current domain. If the current domain is null, then all nodes are stopped. |
| Ping httpd | Ping httpd and determine whether each proxy is accessible and healthy. Returns the PING_RSP grouped by proxy address. |
| Ping node by JVM Route | Ping a node from httpd and returns the PING_RSP grouped by proxy address. Dtermines whether the node configured with the specified jvm route is accessible from each proxy returning the PING_RSP grouped by proxy address. |
| Ping node by address | Ping a node from httpd and returns the PING_RSP grouped by proxy address. Determines whether the node configured with the specified jvm route is accessible from each proxy returning the PING_RSP grouped by proxy address. |
| Add a proxy | Add a proxy. |
| Remove a proxy | Remove a proxy. |
| Disable all webpapps | Disable all webapps for all virtual hosts of this application server. |
| Enable all webapps | Enable all webapps for all virtual hosts of this application server. |
| Stop all webapps | Gracefully stops all webapps for all virtual hosts of this application server. |
Package Types
none
3.5.2. mod_cluster - HA Service Configuration Service
Overview
Table 3.1919. Overview
| Description: | HA Service Configuration |
| Singleton: | yes |
| Plugin: | mod_cluster |
Child Resource Types
none
Connection Properties
Table 3.1920.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Class Name | yes | className | |
| Dependency Class Name | yes | dependencyClassName | |
| Proxy Info Property | yes | proxyInfoProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1921.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Master Per Load Balancing Group | Enable current node to be master in the load balancing group. | no | masterPerLoadBalancingGroup |
| Advertise | Enable autodiscovery of httpd servers. | no | advertise |
| Advertise Group Address | Multicast address on which to listen for advertisements. | yes | advertiseGroupAddress |
| Advertise Port | Multicast port for discovery | no | advertisePort |
| Advertise Interface | Multicast interface for discovery | no | advertiseInterface |
| Advertise Security Key | Security key for discovery. | no | advertiseSecurityKey |
| Proxy List | Comma separated list of address:port listing the httpd servers where mod_cluster is running. | no | proxyList |
| Proxy URL | URL prefix to send with commands to mod_cluster. Default is no prefix. | no | proxyURL |
| Socket Timeout | Connection timeout for communication with the proxy. | no | socketTimeout |
| Excluded Contexts | Comma delimited list of contexts that should *not* be auto-registered with httpd. Contexts may be qualified by host using a colon, e.g. host1:context1. If no host is defined, localhost is assumed. | no | excludedContexts |
| Auto Enable Contexts | Toggle for context auto-enable during mod_cluster startup. | no | autoEnableContexts |
| Load Balancing Group | Load balancing group. | no | loadBalancingGroup |
| Flush Packets | Allows controlling flusing of packets. | no | flushPackets |
| Flush Wait | Time in ms to wait before flushing packets. | no | flushWait |
| Ping | Time in s to wait for a pong answer to a ping. | no | ping |
| Smax | Maximum time on seconds for idle connections above smax. | no | smax |
| Ttl | TTL | no | ttl |
| Node Timeout | Node timeout | no | nodeTimeout |
| Balancer | Name of the balancer | no | balancer |
| Sticky Session | Enables sticky session for the node. | yes | stickySession |
| Sticky Session Remove | Remove session when the request cannot be routed to the right node for this cluster. | yes | stickySessionRemove |
| Sticky Session Force | Return an error when the request cannot be routed to the right node. | yes | stickySessionForce |
| Worker Timeout | Timeout to wait for an available worker (default is no wait). | yes | workerTimeout |
| Max Attempts | Maximum number of attempts to send the request to the backend server. | yes | maxAttempts |
| Ssl | Whether to use SSL to communicate with mod_cluster. Note this has nothing to do with handling of https requests by JBoss Web | yes | ssl |
| Ssl Ciphers | SSL ciphers. | no | sslCiphers |
| Ssl Protocol | SSL protocol. | no | sslProtocol |
| Ssl Certificate Encoding Algorithm | Certificate encoding algorithm. | no | sslCertificateEncodingAlgorithm |
| Ssl Key Store | SSL keystore. | no | sslKeyStore |
| Ssl Key Store Password | SSL keystore password. | no | sslKeyStorePassword |
| Ssl Key Store Type | SSL keystore type. | no | sslKeyStoreType |
| Ssl Key Store Provider | SSL keystore provider. | no | sslKeyStoreProvider |
| Ssl Trust Algorithm | Truststore algorithm. | no | sslTrustAlgorithm |
| Ssl Key Alias | Key alias. | no | sslKeyAlias |
| Ssl Crl File | Certificate revocation list. | no | sslCrlFile |
| Ssl Trust Max Cert Length | Trust max certificate length. | no | sslTrustMaxCertLength |
| Ssl Trust Store | Trust store file. | no | sslTrustStore |
| Ssl Trust Store Password | Trust store password. | no | sslTrustStorePassword |
| Ssl Trust Store Type | Trust store type. | no | sslTrustStoreType |
| Ssl Trust Store Provider | Trust store provider. | no | sslTrustStoreProvider |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.5.3. mod_cluster - Service Service
Overview
Table 3.1922. Overview
| Description: | Service |
| Singleton: | yes |
| Plugin: | mod_cluster |
Child Resource Types
none
Connection Properties
Table 3.1923.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Class Name | yes | className | |
| Proxy Info Property | yes | proxyInfoProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1924. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Proxy Configuration | trait | Proxy Configuration | ProxyConfiguration |
| Proxy Info | trait | Proxy Info | ProxyInfo |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.1925. Metrics
| Name | Description |
|---|---|
| Ping httpd | Ping httpd and determine whether each proxy is accessible and healthy. Returns the PING_RSP grouped by proxy address. |
| Ping node by JVM Route | Ping a node from httpd and returns the PING_RSP grouped by proxy address. Dtermines whether the node configured with the specified jvm route is accessible from each proxy returning the PING_RSP grouped by proxy address. |
| Ping node by address | Ping a node from httpd and returns the PING_RSP grouped by proxy address. Determines whether the node configured with the specified jvm route is accessible from each proxy returning the PING_RSP grouped by proxy address. |
| Add a proxy | Add a proxy. |
| Remove a proxy | Remove a proxy. |
| Disable all webpapps | Disable all webapps for all virtual hosts of this application server. |
| Enable all webapps | Enable all webapps for all virtual hosts of this application server. |
| Stop all webapps | Gracefully stops all webapps for all virtual hosts of this application server. |
Package Types
none
3.5.4. mod_cluster - Service Configuration Service
Overview
Table 3.1926. Overview
| Description: | Service Configuration |
| Singleton: | yes |
| Plugin: | mod_cluster |
Child Resource Types
none
Connection Properties
Table 3.1927.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Class Name | yes | className | |
| Dependency Class Name | yes | dependencyClassName | |
| Proxy Info Property | yes | proxyInfoProperty |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1928.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Advertise | Enable autodiscovery of httpd servers. | no | advertise |
| Advertise Group Address | Multicast address on which to listen for advertisements. | yes | advertiseGroupAddress |
| Advertise Port | Multicast port for discovery | no | advertisePort |
| Advertise Interface | Multicast interface for discovery | no | advertiseInterface |
| Advertise Security Key | Security key for discovery. | no | advertiseSecurityKey |
| Proxy List | Comma separated list of address:port listing the httpd servers where mod_cluster is running. | no | proxyList |
| Proxy URL | URL prefix to send with commands to mod_cluster. Default is no prefix. | no | proxyURL |
| Socket Timeout | Connection timeout for communication with the proxy. | no | socketTimeout |
| Excluded Contexts | Comma delimited list of contexts that should *not* be auto-registered with httpd. Contexts may be qualified by host using a colon, e.g. host1:context1. If no host is defined, localhost is assumed. | no | excludedContexts |
| Auto Enable Contexts | Toggle for context auto-enable during mod_cluster startup. | no | autoEnableContexts |
| Load Balancing Group | Load balancing group. | no | loadBalancingGroup |
| Flush Packets | Allows controlling flusing of packets. | no | flushPackets |
| Flush Wait | Time in ms to wait before flushing packets. | no | flushWait |
| Ping | Time in s to wait for a pong answer to a ping. | no | ping |
| Smax | Maximum time on seconds for idle connections above smax. | no | smax |
| Ttl | TTL | no | ttl |
| Node Timeout | Node timeout | no | nodeTimeout |
| Balancer | Name of the balancer | no | balancer |
| Sticky Session | Enables sticky session for the node. | yes | stickySession |
| Sticky Session Remove | Remove session when the request cannot be routed to the right node for this cluster. | yes | stickySessionRemove |
| Sticky Session Force | Return an error when the request cannot be routed to the right node. | yes | stickySessionForce |
| Worker Timeout | Timeout to wait for an available worker (default is no wait). | yes | workerTimeout |
| Max Attempts | Maximum number of attempts to send the request to the backend server. | yes | maxAttempts |
| Ssl | Whether to use SSL to communicate with mod_cluster. Note this has nothing to do with handling of https requests by JBoss Web | yes | ssl |
| Ssl Ciphers | SSL ciphers. | no | sslCiphers |
| Ssl Protocol | SSL protocol. | no | sslProtocol |
| Ssl Certificate Encoding Algorithm | Certificate encoding algorithm. | no | sslCertificateEncodingAlgorithm |
| Ssl Key Store | SSL keystore. | no | sslKeyStore |
| Ssl Key Store Password | SSL keystore password. | no | sslKeyStorePassword |
| Ssl Key Store Type | SSL keystore type. | no | sslKeyStoreType |
| Ssl Key Store Provider | SSL keystore provider. | no | sslKeyStoreProvider |
| Ssl Trust Algorithm | Truststore algorithm. | no | sslTrustAlgorithm |
| Ssl Key Alias | Key alias. | no | sslKeyAlias |
| Ssl Crl File | Certificate revocation list. | no | sslCrlFile |
| Ssl Trust Max Cert Length | Trust max certificate length. | no | sslTrustMaxCertLength |
| Ssl Trust Store | Trust store file. | no | sslTrustStore |
| Ssl Trust Store Password | Trust store password. | no | sslTrustStorePassword |
| Ssl Trust Store Type | Trust store type. | no | sslTrustStoreType |
| Ssl Trust Store Provider | Trust store provider. | no | sslTrustStoreProvider |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.5.5. mod_cluster - Catalina Service
Overview
Table 3.1929. Overview
| Description: | Catalina Service |
| Singleton: | yes |
| Plugin: | mod_cluster |
Child Resource Types
none
Connection Properties
Table 3.1930.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1931. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Proxy Configuration | trait | Proxy Configuration | proxyConfiguration |
| Proxy Info | trait | Proxy Info | proxyInfo |
| Type of the modeled resource | trait | Type of the modeled resource | modelerType |
| Fully qualified class name of the managed object | trait | Fully qualified class name of the managed object | className |
| Enable autodiscovery of httpd servers. | trait | Enable autodiscovery of httpd servers. | advertise |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1932.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Worker Timeout | Timeout to wait for an available worker (default is no wait). | yes | workerTimeout |
| Sticky Session | Enables sticky session for the cluster. | yes | stickySession |
| Sticky Session Remove | Remove session when the request cannot be routed to the right node for this cluster. | yes | stickySessionRemove |
| Smax | Maximum time on seconds for idle connections above smax. | yes | smax |
| Max Attempts | Maximum number of attempts to send the request to the backend server. | yes | maxAttempts |
| Advertise Security Key | Security key for discovery. | no | advertiseSecurityKey |
| Sticky Session Force | Return an error when the request cannot be routed to the right node. | yes | stickySessionForce |
| Balancer | Name of the balancer. | no | balancer |
| Flush Packets | Allows controlling flusing of packets. | yes | flushPackets |
| Socket Timeout | Connection timeout for communication with the proxy. | yes | socketTimeout |
| Advertise Port | Multicast port for discovery | no | advertisePort |
| Advertise Group Address | Multicast address for discovery. | no | advertiseGroupAddress |
| Flush Wait | Time in ms to wait before flushing packets. | yes | flushWait |
| Ping | Time in s to wait for a pong answer to a ping. | yes | ping |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1933. Metrics
| Name | Description |
|---|---|
| Add a proxy | Add a proxy. |
| Remove a proxy | Remove a proxy. |
| Disable all webpapps | Disable all webapps for all virtual hosts of this application server. |
| Enable all webapps | Enable all webapps for all virtual hosts of this application server. |
| Stop all webapps | Gracefully stops all webapps for all virtual hosts of this application server. |
Package Types
none
3.5.6. mod_cluster - Dynamic Load Balancer Factor Service
Overview
Table 3.1934. Overview
| Description: | Dynamic Load balancer factor for mod_cluster |
| Singleton: | yes |
| Plugin: | mod_cluster |
Child Resource Types
none
Connection Properties
Table 3.1935.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Class Name | yes | className | |
| Name Template | yes | nameTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1936.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Decay Factor | The number of historical load values used to determine load factor. | no | decayFactor |
| History | The exponential decay factor for historical load values. | no | history |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.5.7. mod_cluster - Simple Load Balancer Factor Service
Overview
Table 3.1937. Overview
| Description: | Simple load balancer factor for mod_cluster |
| Singleton: | yes |
| Plugin: | mod_cluster |
Child Resource Types
none
Connection Properties
Table 3.1938.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Class Name | yes | className | |
| Name Template | yes | nameTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.1939.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Load Balance Factor | The load balance factor. | yes | loadBalanceFactor |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.5.8. mod_cluster - Load Metric Service
Overview
Table 3.1940. Overview
| Description: | Load Metric |
| Singleton: | no |
| Plugin: | mod_cluster |
Child Resource Types
none
Connection Properties
Table 3.1941.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1942. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Load | measurement | The current load of this metric as a percent of the metric's capacity. | Load |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1943.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Weight | The significance of this load metric compared to the other metrics. | yes | weight |
| Capacity | Used to normalize the value returned by load expressed as a percentage of the capacity, such that: 0 < (load/capacity) < 1 | yes | capacity |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.5.9. mod_cluster - Webapp Context Service
Overview
Table 3.1944. Overview
| Description: | Webapp Context |
| Singleton: | no |
| Plugin: | mod_cluster |
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
Table 3.1945. Metrics
| Name | Description |
|---|---|
| Disable webapp | Disable this webapp. |
| Stop webapp | Gracefully stops this webapp. |
| Enable webapp | Enable this webapp. |
Package Types
none
3.6. Hibernate - Statistics Service
Overview
Table 3.1946. Overview
| Description: | Statistics for Hibernate |
| Singleton: | no |
| Plugin: | Hibernate |
Note
In order to monitor Hibernate statistics via JON, the Hibernate Session Manager MBean must be deployed to an object name of the format {{_"Hibernate:application=%application%,type=statistics"_}}, and statistics must be enabled. Some example code is provided below to register the Hibernate Session MBean within an EJB3 application. {code} public static void enableHibernateStatistics(EntityManager entityManager) { try { StatisticsService mBean = new StatisticsService(); SessionFactory sessionFactory = getHibernateSession(entityManager).getSessionFactory(); mBean.setSessionFactory(sessionFactory); ObjectName objectName = new ObjectName(HIBERNATE_STATISTICS_MBEAN_OBJECTNAME); MBeanServer jbossMBeanServer = getJBossMBeanServer(); jbossMBeanServer.registerMBean(mBean, objectName); sessionFactory.getStatistics().setStatisticsEnabled(true); } catch (InstanceAlreadyExistsException iaee) { LOG.info("Duplicate MBean registration ignored: " + HIBERNATE_STATISTICS_MBEAN_OBJECTNAME); } catch (Exception e) { LOG.warn("Couldn't register Hibernate statistics MBean.", e); } } private static Session getHibernateSession(EntityManager entityManager) { Session session; if (entityManager.getDelegate() instanceof EntityManagerImpl) { EntityManagerImpl entityManagerImpl = (EntityManagerImpl) entityManager.getDelegate(); session = entityManagerImpl.getSession(); } else { session = (Session) entityManager.getDelegate(); } return session; } private static MBeanServer getJBossMBeanServer() { List<MBeanServer> servers = MBeanServerFactory.findMBeanServer(null); MBeanServer jbossServer = null; for (MBeanServer server : servers) { if ("jboss".equals(server.getDefaultDomain())) { jbossServer = server; } } if (jbossServer == null) { jbossServer = ManagementFactory.getPlatformMBeanServer(); } return jbossServer; } {code} See also [Publishing statistics through JMX|http://hibernate.org/216.html] and [Enabling Hibernate statistics|http://www.redhat.com/docs/manuals/jboss/jboss-eap-4.3/doc/hibernate/Hibernate_Reference_Guide/Optional_configuration_properties-Hibernate_statistics.html]
Child Resource Types
Connection Properties
Table 3.1947.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Application | the Hibernate application name | yes | application |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1948. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Entity Insert Count | measurement | The global number of entity inserts since the statistics were reset | EntityInsertCount |
| Entity Insert Count per Minute | measurement | The global number of entity inserts since the statistics were reset | EntityInsertCount |
| Query Execution Max Time | measurement | The amount of time taken by the slowest recorded query since the statistics were reset | QueryExecutionMaxTime |
| Entity Update Count | measurement | The global number of entity updates since the statistics were reset | EntityUpdateCount |
| Entity Update Count per Minute | measurement | The global number of entity updates since the statistics were reset | EntityUpdateCount |
| Collection Update Count | measurement | The global number of collections updated since the statistics were reset | CollectionUpdateCount |
| Collection Update Count per Minute | measurement | The global number of collections updated since the statistics were reset | CollectionUpdateCount |
| Entity Load Count | measurement | The global number of entity loads since the statistics were reset | EntityLoadCount |
| Entity Load Count per Minute | measurement | The global number of entity loads since the statistics were reset | EntityLoadCount |
| Entity Fetch Count | measurement | The global number of entity fetches since the statistics were reset | EntityFetchCount |
| Entity Fetch Count per Minute | measurement | The global number of entity fetches since the statistics were reset | EntityFetchCount |
| Entity Delete Count | measurement | The global number of entity deletes since the statistics were reset | EntityDeleteCount |
| Entity Delete Count per Minute | measurement | The global number of entity deletes since the statistics were reset | EntityDeleteCount |
| Collection Recreate Count | measurement | The global number of collections recreated since the statistics were reset | CollectionRecreateCount |
| Collection Recreate Count per Minute | measurement | The global number of collections recreated since the statistics were reset | CollectionRecreateCount |
| Query Execution Count | measurement | The global number of queries executed since the statistics were reset | QueryExecutionCount |
| Query Execution Count per Minute | measurement | The global number of queries executed since the statistics were reset | QueryExecutionCount |
| Flush Count | measurement | The global number of flushes executed by sessions (either implicit or explicit) since the statistics were reset | FlushCount |
| Flush Count per Minute | measurement | The global number of flushes executed by sessions (either implicit or explicit) since the statistics were reset | FlushCount |
| Collection Load Count | measurement | The global number of collections loaded since the statistics were reset | CollectionLoadCount |
| Collection Load Count per Minute | measurement | The global number of collections loaded since the statistics were reset | CollectionLoadCount |
| Successful Transaction Count | measurement | The global number of transactions known to have been successful since the statistics were reset | SuccessfulTransactionCount |
| Successful Transaction Count per Minute | measurement | The global number of transactions known to have been successful since the statistics were reset | SuccessfulTransactionCount |
| Query Cache Hit Count | measurement | The global number of cached queries successfully retrieved from cache since the statistics were reset | QueryCacheHitCount |
| Query Cache Hit Count per Minute | measurement | The global number of cached queries successfully retrieved from cache since the statistics were reset | QueryCacheHitCount |
| Collection Remove Count | measurement | The global number of collections removed since the statistics were reset | CollectionRemoveCount |
| Collection Remove Count per Minute | measurement | The global number of collections removed since the statistics were reset | CollectionRemoveCount |
| Connect Count | measurement | The global number of connections asked by the sessions (the actual number of connections used may be much smaller depending whether you use a connection pool or not) since the statistics were reset | ConnectCount |
| Connect Count per Minute | measurement | The global number of connections asked by the sessions (the actual number of connections used may be much smaller depending whether you use a connection pool or not) since the statistics were reset | ConnectCount |
| Start Time | trait | The time when the statistics collection started or were last reset | StartTime |
| Second Level Cache Put Count | measurement | The global number of cacheable entities/collections put in the cache since the statistics were reset | SecondLevelCachePutCount |
| Second Level Cache Put Count per Minute | measurement | The global number of cacheable entities/collections put in the cache since the statistics were reset | SecondLevelCachePutCount |
| Query Cache Put Count | measurement | The global number of cacheable queries put in cache since the statistics were reset | QueryCachePutCount |
| Query Cache Put Count per Minute | measurement | The global number of cacheable queries put in cache since the statistics were reset | QueryCachePutCount |
| Session Open Count | measurement | The global number of sessions closed since the statistics were reset | SessionOpenCount |
| Session Open Count per Minute | measurement | The global number of sessions closed since the statistics were reset | SessionOpenCount |
| Transaction Count | measurement | The global number of transactions known to have completed since the statistics were reset | TransactionCount |
| Transaction Count per Minute | measurement | The global number of transactions known to have completed since the statistics were reset | TransactionCount |
| Collection Fetch Count | measurement | The global number of collections fetched since the statistics were reset | CollectionFetchCount |
| Collection Fetch Count per Minute | measurement | The global number of collections fetched since the statistics were reset | CollectionFetchCount |
| Session Close Count | measurement | The global number of sessions closed since the statistics were reset | SessionCloseCount |
| Session Close Count per Minute | measurement | The global number of sessions closed since the statistics were reset | SessionCloseCount |
| Query Cache Miss Count | measurement | The global number of cached queries *not* found in cache since the statistics were reset | QueryCacheMissCount |
| Query Cache Miss Count per Minute | measurement | The global number of cached queries *not* found in cache since the statistics were reset | QueryCacheMissCount |
| Second Level Cache Miss Count | measurement | The global number of cacheable entities/collections not found in the cache and loaded from the database since the statistics were reset | SecondLevelCacheMissCount |
| Second Level Cache Miss Count per Minute | measurement | The global number of cacheable entities/collections not found in the cache and loaded from the database since the statistics were reset | SecondLevelCacheMissCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.1949. Metrics
| Name | Description |
|---|---|
| Clear Statistics | Clear the collected statistics and begin collecting again |
| View Queries | View statistical information about queries executed by Hibernate |
Package Types
none
3.6.1. Hibernate - Entity Service
Overview
Table 3.1950. Overview
| Description: | A Hibernate persistent entity |
| Singleton: | no |
| Plugin: | Hibernate |
Child Resource Types
none
Connection Properties
none
Metrics
Table 3.1951. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Load Count | measurement | The number of times this entity was loaded since the statistics were reset | loadCount |
| Update Count | measurement | The number of times this entity was updated since the statistics were reset | updateCount |
| Insert Count | measurement | The number of times this entity was inserted since the statistics were reset | insertCount |
| Delete Count | measurement | The number of times this entity was deleted since the statistics were reset | deleteCount |
| Fetch Count | measurement | The number of times this entity was fetched since the statistics were reset | fetchCount |
| Optimistic Lock Failure Count | measurement | The number of StaleObjectStateExceptions for this entity that occurred since the statistics were reset | optimisticFailureCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.7. JBossCache - Subsystem Server
Overview
Table 3.1952. Overview
| Description: | The JBoss Cache instances on this server |
| Singleton: | yes |
| Plugin: | JBossCache |
Child Resource Types
Autodiscovery Process Scans
none
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.7.1. JBossCache - Service
Overview
Table 3.1953. Overview
| Description: | Statistics for JBossCache |
| Singleton: | no |
| Plugin: | JBossCache |
Note
Please note that the number of possible metrics varies depending on the configuration and flavour of Cache used.
Child Resource Types
Connection Properties
Table 3.1954.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Is Tree Cache | Is this a TreeCache instance or a POJO Cache | yes | isTreeCache |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1955. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number of Nodes | measurement | Number of Nodes | :numberOfNodes |
| Activations | measurement | Number of passivated nodes that have been activated. | ActivationInterceptor:activations |
| Cache Loader Loads | measurement | Number of nodes loaded through a cache loader. | CacheLoaderInterceptor:cacheLoaderLoads |
| Cache Loader Loads per Minute | measurement | Number of nodes loaded through a cache loader. | CacheLoaderInterceptor:cacheLoaderLoads |
| Cache Loader Misses | measurement | Number of unsuccessful attempts to load a node through a cache loader. | CacheLoaderInterceptor:cacheLoaderMisses |
| Cache Loader Misses per Minute | measurement | Number of unsuccessful attempts to load a node through a cache loader. | CacheLoaderInterceptor:cacheLoaderMisses |
| Cache Hits | measurement | Number of successful attribute retrievals. | CacheMgmtInterceptor:hits |
| Cache Hits per Minute | measurement | Number of successful attribute retrievals. | CacheMgmtInterceptor:hits |
| Cache Misses | measurement | Number of unsuccessful attribute retrievals. | CacheMgmtInterceptor:misses |
| Cache Misses per Minute | measurement | Number of unsuccessful attribute retrievals. | CacheMgmtInterceptor:misses |
| Hit-miss-ratio | measurement | Ratio of hits to hits and misses. A hit is a get attribute operation that results in an object being returned to the client. The retrieval may be from a cache loader if the entry isn't in the local cache. | CacheMgmtInterceptor:hitMissRatio |
| Read-write-ratio | measurement | Ratio of read operations to write operations. This is the ratio of cache hits and misses to cache stores. | CacheMgmtInterceptor:readWriteRatio |
| Cache Stores | measurement | Number of attribute store operations. | CacheMgmtInterceptor:stores |
| Cache Stores per Minute | measurement | Number of attribute store operations. | CacheMgmtInterceptor:stores |
| Cache Evictions | measurement | Number of node evictions. | CacheMgmtInterceptor:evictions |
| Cache Evictions per Minute | measurement | Number of node evictions. | CacheMgmtInterceptor:evictions |
| Number of Attributes | measurement | Number of attributes currently cached. | CacheMgmtInterceptor:numberOfAttributes |
| Number of Nodes cached | measurement | Number of nodes currently cached. | CacheMgmtInterceptor:numberOfNodes |
| Elapsed Time | measurement | Number of seconds that the cache has been running. | CacheMgmtInterceptor:elapsedTime |
| Elapsed Time per Minute | measurement | Number of seconds that the cache has been running. | CacheMgmtInterceptor:elapsedTime |
| Time since reset | measurement | Number of seconds since the cache statistics have been reset. | CacheMgmtInterceptor:timeSinceReset |
| Time since reset per Minute | measurement | Number of seconds since the cache statistics have been reset. | CacheMgmtInterceptor:timeSinceReset |
| Average Read Time | measurement | Average time in milliseconds to retrieve a cache attribute, including unsuccessful attribute retrievals. | CacheMgmtInterceptor:averageReadTime |
| Average Write Time | measurement | Average time in milliseconds to write a cache attribute. | CacheMgmtInterceptor:averageWriteTime |
| Cache Loader Stores | measurement | Number of nodes written to the cache loader. | CacheStoreInterceptor:cacheLoaderStores |
| Cache Loader Stores per Minute | measurement | Number of nodes written to the cache loader. | CacheStoreInterceptor:cacheLoaderStores |
| Invalidations | measurement | Number of cached nodes that have been invalidated. | InvalidationInterceptor:invalidations |
| Invalidations per Minute | measurement | Number of cached nodes that have been invalidated. | InvalidationInterceptor:invalidations |
| Passivations | measurement | Number of cached nodes that have been passivated. | PassivationInterceptor:passivations |
| Passivations per Minute | measurement | Number of cached nodes that have been passivated. | PassivationInterceptor:passivations |
| Tx prepares | measurement | Number of transaction prepare operations performed. | TxInterceptor:prepares |
| Tx prepares per Minute | measurement | Number of transaction prepare operations performed. | TxInterceptor:prepares |
| Tx commits | measurement | Number of transaction commit operations performed. | TxInterceptor:commits |
| Tx commits per Minute | measurement | Number of transaction commit operations performed. | TxInterceptor:commits |
| Tx rollbacks | measurement | Number of transaction rollback operations performed. | TxInterceptor:rollbacks |
| Tx rollbacks per Minute | measurement | Number of transaction rollback operations performed. | TxInterceptor:rollbacks |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1956.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Flavor | Is this going to be a POJO Cache or a Tree Cache | yes | Flavour |
| Transaction Manager Lookup Class | What class should be used to get a transaction manager instance | yes | TransactionManagerLookupClass |
| Isolation Level | The isolation level for access to the cache (default is REPEATABLE_READ) | no | IsolationLevel |
| Node Locking Scheme | the node locking scheme for this cache (default is PESSIMISTIC) | no | NodeLockingScheme |
| Cache Mode | the cache mode - a cache can be configured to be either local (standalone) or clustered. If in a cluster, the cache can be configured to replicate changes, or to invalidate changes (default is LOCAL) | no | CacheMode |
| Use Repl Queue | should a replication queue be used for asynchronous replication? (default is false) | no | UseReplQueue |
| Repl Queue Interval | Time in milliseconds for elements from the replication queue to be replicated. Only used if UseReplQueue is enabled. (default is 100) | no | ReplQueueInterval |
| Repl Queue Max Elements | Maximum number of elements which trigger replication (default is 10) | no | ReplQueueMaxElements |
| Cluster Name | Name of cluster. Needs to be the same for all clusters, in order to find each other | yes | ClusterName |
| Fetch State On Startup | Whether or not to fetch state on joining a cluster (default is true) | no | FetchStateOnStartup |
| Initial State Retrieval Timeout | Maximum number of milliseconds to wait until the initial state (i.e. the contents of the cache) are retrieved from existing members in a clustered environment | yes | InitialStateRetrievalTimeout |
| Sync Repl Timeout | Maximum number of milliseconds to wait until all responses for a synchronous call have been received. | yes | SyncReplTimeout |
| Lock Acquisition Timeout | Maximum number of milliseconds to wait for a lock acquisition. | yes | LockAcquisitionTimeout |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1957. Metrics
| Name | Description |
|---|---|
| Reset Statistics | Resets all statistics |
| List associated MBeans | List all MBeans that form this Cache instance |
Package Types
none
3.7.1.1. JBossCache - JGroupsChannel Service
Overview
Table 3.1958. Overview
| Description: | The underlying JGroups channel for this cache instance |
| Singleton: | no |
| Plugin: | JBossCache |
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.8. JBossCache3 - JBoss Cache Service
Overview
Table 3.1959. Overview
| Description: | The JBoss Cache instances on this server |
| Singleton: | no |
| Plugin: | JBossCache3 |
Child Resource Types
Connection Properties
Table 3.1960.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Search String | yes | searchString |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.8.1. JBossCache3 - Cache Service
Overview
Table 3.1961. Overview
| Description: | JBoss Cache |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Child Resource Types
none
Connection Properties
Table 3.1962.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1963. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Cluster Config | trait | Cluster Config | ClusterConfig |
| Node Locking Scheme | trait | Node Locking Scheme | NodeLockingScheme |
| Expose Management Statistics? | trait | Expose Management Statistics? | ExposeManagementStatistics |
| Register JMX Resource? | trait | Register JMX Resource? | RegisterJmxResource |
| Cache Loader Configuration | trait | Cache Loader Configuration | CacheLoaderConfiguration |
| Multiplexer Stack | trait | Multiplexer Stack | MultiplexerStack |
| Replication Queue Max Elements | measurement | Replication Queue Max Elements | ReplQueueMaxElements |
| Number of Attributes | measurement | Number of Attributes | NumberOfAttributes |
| Cache Loader Config | trait | Cache Loader Config | CacheLoaderConfig |
| Cluster Name | trait | Cluster Name | ClusterName |
| Inactive on Startup? | trait | Inactive on Startup? | InactiveOnStartup |
| Cache Mode | trait | Cache Mode | CacheMode |
| Isolation Level | trait | Isolation Level | IsolationLevel |
| Replication Version | trait | Replication Version | ReplicationVersion |
| Fetch In-Memory State? | trait | Fetch In-Memory State? | FetchInMemoryState |
| Initial State Retrieval Timeout | measurement | Initial State Retrieval Timeout | InitialStateRetrievalTimeout |
| Buddy Replication Config | trait | Buddy Replication Config | BuddyReplicationConfig |
| Replication Queue Interval | measurement | Replication Queue Interval | ReplQueueInterval |
| Use Replication Queue? | trait | Use Replication Queue? | UseReplQueue |
| Use Region-Based Marshalling? | trait | Use Region-Based Marshalling? | UseRegionBasedMarshalling |
| Lock Acquisition Timeout | measurement | Lock Acquisition Timeout | LockAcquisitionTimeout |
| Number of Nodes | measurement | Number of Nodes | NumberOfNodes |
| Sync Commit Phase? | trait | Sync Commit Phase? | SyncCommitPhase |
| Sync Replication Timeout | measurement | Sync Replication Timeout | SyncReplTimeout |
| Eviction Policy Config | trait | Eviction Policy Config | EvictionPolicyConfig |
| State | trait | State | State |
| State Retrieval Timeout | measurement | State Retrieval Timeout | StateRetrievalTimeout |
| Transaction Manager Lookup Class | trait | Transaction Manager Lookup Class | TransactionManagerLookupClass |
| Cluster Properties | trait | Cluster Properties | ClusterProperties |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.1964. Metrics
| Name | Description |
|---|---|
| Destroy this cache. | |
| Stop this cache. | |
| Create this cache. | |
| Start this cache. | |
| Print lock information. | |
| Print cache details. | |
| Print cache details as HTML. | |
| Print configuration as plain text. | |
| Print lock info as HTML. | |
| Print configuration as HTML. |
Package Types
none
3.8.2. JBossCache3 - Interceptor Service
Overview
Table 3.1965. Overview
| Description: | JBoss Cache Interceptor |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Child Resource Types
none
Connection Properties
Table 3.1966.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1967. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Evictions | measurement | the number of cache eviction operations | Evictions |
| Evictions per Minute | measurement | the number of cache eviction operations | Evictions |
| Hit/Miss Ratio | measurement | Hit/Miss Ratio | HitMissRatio |
| Read/Write Ratio | measurement | Read/Write Ratio | ReadWriteRatio |
| NumberOfNodes | measurement | the number of nodes in the cache | NumberOfNodes |
| Hits | measurement | the number of cache attribute hits | Hits |
| Hits per Minute | measurement | the number of cache attribute hits | Hits |
| Number Of Attributes | measurement | the number of cache attributes | NumberOfAttributes |
| Statistics Enabled | trait | Statistics Enabled | StatisticsEnabled |
| Elapsed Time | measurement | the time elapsed since the cache was started | ElapsedTime |
| Elapsed Time per Minute | measurement | the time elapsed since the cache was started | ElapsedTime |
| Time Since Reset | measurement | the time elapsed since the cache statistics were last reset | TimeSinceReset |
| Time Since Reset per Minute | measurement | the time elapsed since the cache statistics were last reset | TimeSinceReset |
| Misses | measurement | the number of cache attribute misses | Misses |
| Misses per Minute | measurement | the number of cache attribute misses | Misses |
| Average Write Time | measurement | the average amount of time per write operation | AverageWriteTime |
| Stores | measurement | the number of cache attribute put operations | Stores |
| Stores per Minute | measurement | the number of cache attribute put operations | Stores |
| Average Read Time | measurement | the average amount of time per read operation | AverageReadTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.1968. Metrics
| Name | Description |
|---|---|
| Reset Statistics | Reset all statistics. |
Package Types
none
3.8.3. JBossCache3 - Data Container Service
Overview
Table 3.1969. Overview
| Description: | JBoss Cache Data Container |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Child Resource Types
none
Connection Properties
Table 3.1970.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 3.1971. Metrics
| Name | Description |
|---|---|
| Get the number of nodes. | Returns the number of nodes in the data container |
| Get the number of attributes. | Returns the number of nodes in the data container |
| Print details as plain text. | Prints details about the data container |
| Print details as HTML. | Prints details about the data container, formatted as HTML |
Package Types
none
3.8.4. JBossCache3 - RPC Manager Service
Overview
Table 3.1972. Overview
| Description: | JBoss Cache RPC Manager |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Child Resource Types
none
Connection Properties
Table 3.1973.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1974. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| RPC Enabled? | trait | whether or not the RPC Manager is used in this cache instance | Enabled |
| Failed Replications | measurement | the number of failed replications | ReplicationFailures |
| Local Address | trait | Local address | LocalAddressString |
| Statistics Enabled | trait | Statistics Enabled | StatisticsEnabled |
| Successful Replications | measurement | the number of successful replications | ReplicationCount |
| Success Ratio | trait | RPC call success ratio | SuccessRatio |
| Members | trait | cluster view | MembersString |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.1975. Metrics
| Name | Description |
|---|---|
| Reset Statistics | Reset all statistics. |
Package Types
none
3.8.5. JBossCache3 - RegionManager Service
Overview
Table 3.1976. Overview
| Description: | JBoss Cache RegionManager |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Child Resource Types
none
Connection Properties
Table 3.1977.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1978. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number of Regions | measurement | the total number of regions | numRegions |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.1979. Metrics
| Name | Description |
|---|---|
| Dump Regions | Dump a list of all registered regions. |
Package Types
none
3.8.6. JBossCache3 - Transaction Table Service
Overview
Table 3.1980. Overview
| Description: | JBoss Cache TransactionTable |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Child Resource Types
none
Connection Properties
Table 3.1981.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1982. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number Of Registered Transactions | measurement | the number of registered transactions | numberOfRegisteredTransactions |
| Transaction Map | trait | a string representation of the transaction map | transactionMap |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.8.7. JBossCache3 - Tx Interceptor Service
Overview
Table 3.1983. Overview
| Description: | JBoss Cache TxInterceptor |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Child Resource Types
none
Connection Properties
Table 3.1984.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1985. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Commits | measurement | the number of transaction commits | Commits |
| Statistics Enabled? | trait | a String representation of the transaction map | StatisticsEnabled |
| Rollbacks | measurement | the number of transaction rollbacks | Rollbacks |
| Prepares | measurement | the number of transaction prepares | Prepares |
| Number Of Syncs Registered | measurement | the number of transaction synchronizations currently registered | numberOfSyncsRegistered |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.8.8. JBossCache3 - Lock Manager Service
Overview
Table 3.1986. Overview
| Description: | MVCC Lock Manager |
| Singleton: | yes |
| Plugin: | JBossCache3 |
Child Resource Types
none
Connection Properties
Table 3.1987.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Jmx Resource | yes | jmx-resource |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1988. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Concurrency Level | measurement | The concurrency level that the MVCC Lock Manager has been configured with. | concurrency level |
| Locks Held | measurement | The number of exclusive locks that are held. | locks held |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.9. JMX - Server
Overview
Table 3.1989. Overview
| Description: | Generic JMX Server |
| Singleton: | no |
| Plugin: | JMX |
Note
In order to monitor your Java applications via JMX, you need to expose their MBeans to remote JMX clients. In order to do this, you must pass in some system properties when starting your application's Java virtual machine. To run a JVM with JMX remoting enabled without authentication, you must pass in the following system properties: * -Dcom.sun.management.jmxremote.port=19988 * -Dcom.sun.management.jmxremote.ssl=false * -Dcom.sun.management.jmxremote.authenticate=false You can require your remote JMX endpoint to demand authentication for clients to be able to connect to it. To run a JVM with JMX remoting enabled with password authentication: * -Dcom.sun.management.jmxremote.port=19988 * -Dcom.sun.management.jmxremote.ssl=false * -Dcom.sun.management.jmxremote.authenticate=true * -Dcom.sun.management.jmxremote.password.file=/some/directory/jmxremote.password Note that "jmxremote.password" must be read-only. On Windows, you must use "cacls" command to do this: {code}cacls /some/directory/jmxremote.password /P username:R{code} A password file template is located at $JRE_HOME/lib/management/jmxremote.password.template. There is also an auth file that you can use to define other roles. For more information on setting this up and setting up SSL, see [Monitoring and Management Using JMX|http://java.sun.com/j2se/1.5.0/docs/guide/management/agent.html]. If you wish to expose your JBossAS 4 application server's MBeans over this remote JMX mechanism, you must pass in these extra properties, in addition to the properties specified above: * -Djboss.platform.mbeanserver * -Djavax.management.builder.initial=org.jboss.system.server.jmx.MBeanServerBuilderImpl
Child Resource Types
Autodiscovery Process Scans
Table 3.1990. Metrics
| Name | Query |
|---|---|
| java | process|basename|match=^java.* |
Connection Properties
Table 3.1991.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Type | The EMS connection type for this JMX Server | yes | type |
| Connector Address | The connection url in the form of a JMXServiceURL - this should only be set if the JVM has JMX Remoting enabled | no | connectorAddress |
| Install URI | The installation path for the selected server type which will be used to find client libraries (if appropriate) | no | installURI |
| Principal | The login principal/username | no | principal |
| Credentials | The login credentials/password | no | credentials |
| Additional Class Path Entries | Comma-separated list of directories and filenames that contain resources and classes needed to communicate with the JMX Server and its MBeans. If you specify 'some/directory/*.jar', all jars found in the given directory will be added. | no | additionalClassPathEntries |
| Command Line | the command line of the JVM at the time it was discovered - only used by JVMs with type Local; if the command line of the JVM changes, this property's value will need to be updated accordingly in order for RHQ to connect to the JVM | no | commandLine |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.9.1. JMX - Operating System Service
Overview
Table 3.1992. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | JMX |
Child Resource Types
none
Connection Properties
Table 3.1993.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1994. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Free Physical Memory | measurement | The amount of free physical memory for the OS | FreePhysicalMemorySize |
| Free Swap Memory | measurement | The amount of free swap space for the OS | FreeSwapSpaceSize |
| Process CPU Time | measurement | The cpu time used by this process | ProcessCpuTime |
| Process CPU Time per Minute | measurement | The cpu time used by this process | ProcessCpuTime |
| Committed Virtual Memory | measurement | Size of virtual memory used by this process | CommittedVirtualMemorySize |
| Open Files | measurement | The number of files opened by this process. Note that this metric is not supported on Windows. | OpenFileDescriptorCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.9.2. JMX - Threading Service
Overview
Table 3.1995. Overview
| Description: | Information on threading in the VM |
| Singleton: | yes |
| Plugin: | JMX |
Child Resource Types
none
Connection Properties
Table 3.1996.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.1997. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Thread Count | measurement | Number of active threads in the system | ThreadCount |
| Peak Thread Count | measurement | Peak count of active threads in the system | PeakThreadCount |
| Total Started Thread Count | measurement | Count of threads started since system start | TotalStartedThreadCount |
| Daemon Thread Count | measurement | Count of threads marked as daemons in the system | DaemonThreadCount |
| Suspended Thread Count | measurement | Count of suspended threads | SuspendedThreadCount |
| Deadlocked Thread Count | measurement | Count of threads that are deadlocked waiting to acquire object monitors. This is a CPU-time consuming metric. | DeadLockedThreadCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.1998.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Thread Contention Monitoring Enabled | yes | ThreadContentionMonitoringEnabled | |
| Thread Cpu Time Enabled | yes | ThreadCpuTimeEnabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.1999. Metrics
| Name | Description |
|---|---|
| Reset Peak Thread Metrics | Reset the peak number of threads |
| Find Monitor Deadlocked Threads | Finds cycles of threads that are in deadlock waiting to acquire object monitors |
| Thread Dump | Returns a summary of all live threads, including both daemon and non-daemon threads |
Package Types
none
3.9.3. JMX - VM Memory System Service
Overview
Table 3.2000. Overview
| Description: | The memory system of the Java virtual machine including both the heap and non-heap memory. |
| Singleton: | yes |
| Plugin: | JMX |
Child Resource Types
Connection Properties
Table 3.2001.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2002. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Heap Usage | measurement | Current heap memory usage | {HeapMemoryUsage.used} |
| Heap Committed | measurement | Current heap memory allocated. This amount of memory is guaranteed for the Java virtual machine to use | {HeapMemoryUsage.committed} |
| Non-Heap Usage | measurement | Current memory usage outside the heap | {NonHeapMemoryUsage.used} |
| Non-Heap Committed | measurement | Current memory allocated outside the heap. This amount of memory is guaranteed for the Java virtual machine to use | {NonHeapMemoryUsage.committed} |
| Objects Pending Finalization | measurement | The approximate number of objects for which finalization is pending. | ObjectPendingFinalizationCount |
| Heap Initial Size | trait | The amount of heap that the Java virtual machine initially requests from the operating system | {HeapMemoryUsage.init} |
| Heap Maximum Size | trait | Maximum amount of heap that can be used for memory management. This amount of memory is not guaranteed to be available if it is greater than the amount of committed memory. The Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size. | {HeapMemoryUsage.max} |
| Non-Heap Initial Size | trait | The amount of non-heap memory that the Java virtual machine initially requests from the operating system | {NonHeapMemoryUsage.init} |
| Non-Heap Maximum Size | trait | Maximum amount of non-heap memory that can be used for memory management. This amount of memory is not guaranteed to be available if it is greater than the amount of committed memory. The Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size. | {NonHeapMemoryUsage.max} |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2003.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Verbose | Output verbose information to the output stream to regarding Memory. Typically, a Java virtual machine implementation prints a message when it frees memory through garbage collection. | yes | Verbose |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2004. Metrics
| Name | Description |
|---|---|
| Run Garbage Collection | Runs the garbage collector. |
Package Types
none
3.9.3.1. JMX - Memory Pool Service
Overview
Table 3.2005. Overview
| Description: | 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: | JMX |
Child Resource Types
none
Connection Properties
Table 3.2006.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The memory pool's name | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2007. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Used | measurement | Current memory usage | {Usage.used} |
| Committed | measurement | Current memory allocated | {Usage.committed} |
| Initial Size | trait | The amount of memory that the Java virtual machine initially requests from the operating system | {Usage.init} |
| Maximum Size | trait | Maximum amount of memory that can be used for memory management. This amount of memory is not guaranteed to be available if it is greater than the amount of committed memory. The Java virtual machine may fail to allocate memory even if the amount of used memory does not exceed this maximum size. | {Usage.max} |
| Memory Manager Names | trait | Garbage collectors for this space | MemoryManagerNames |
| Type | trait | Pool location | Type |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.9.3.2. JMX - Garbage Collector Service
Overview
Table 3.2008. Overview
| Description: | A garbage collector that collects one or more memory pool. |
| Singleton: | no |
| Plugin: | JMX |
Child Resource Types
none
Connection Properties
Table 3.2009.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Name | The garbage collector's name | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2010. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Collection Count | measurement | Number of collections | CollectionCount |
| Collection Count per Minute | measurement | Number of collections | CollectionCount |
| Collection Time | measurement | The amount of time spent in collection | CollectionTime |
| Collection Time per Minute | measurement | The amount of time spent in collection | CollectionTime |
| Memory Pool Names | trait | The names of the memory pools used by this type of garbage collector | MemoryPoolNames |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.9.4. JMX - VM Compilation System Service
Overview
Table 3.2011. Overview
| Description: | The compilation system of the Java virtual machine |
| Singleton: | yes |
| Plugin: | JMX |
Child Resource Types
none
Connection Properties
Table 3.2012.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2013. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Total Compilation Time | measurement | The approximate accumulated elapsed time spent in compilation | TotalCompilationTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
3.9.5. JMX - VM Class Loading System Service
Overview
Table 3.2014. Overview
| Description: | The class loading system of the Java virtual machine |
| Singleton: | yes |
| Plugin: | JMX |
Child Resource Types
none
Connection Properties
Table 3.2015.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 3.2016. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Loaded Classes | measurement | The number of classes currently loaded in the VM | LoadedClassCount |
| Total Classes Loaded | measurement | The total number of classes loaded since the start of the VM | TotalLoadedClassCount |
| Total Classes Loaded per Minute | measurement | The total number of classes loaded since the start of the VM | TotalLoadedClassCount |
| Unloaded Classes | measurement | The total number of classes unloaded since the start of the VM | UnloadedClassCount |
| Unloaded Classes per Minute | measurement | The total number of classes unloaded since the start of the VM | UnloadedClassCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2017.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Verbose | Output verbose information to the output stream to regarding class loading. Typically, a Java virtual machine implementation prints a message each time a class file is loaded. | yes | Verbose |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.9.6. JMX - java.util.logging Service
Overview
Table 3.2018. Overview
| Description: | Logging control for the java.util.logging subsystem |
| Singleton: | yes |
| Plugin: | JMX |
Child Resource Types
none
Connection Properties
Table 3.2019.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Config Management Enabled | When false, configuration reading for this resource will fail. | yes | configManagementEnabled |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 3.2020.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Appender List | yes | AppenderList |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
3.10. HornetQ - JMS Manager Service
Overview
Table 3.2021. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | HornetQ |
Child Resource Types
Connection Properties
none
Metrics
Table 3.2022. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Provider Name | trait | The JMS Provider | provider |
| Is Started | trait | The HornetQ version | started |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 3.2023. Metrics
| Name | Description |
|---|---|
| List Remote Addresses | List all remote addresses connected to HornetQ. |
| List Remote Addresses | List all remote addresses connected to HornetQ that match an ip address. |
| Close Connection | Closes all the connections for the given IP Address. |
| List connections | List all the connection IDs. |
| List sessions | List the sessions for the given connectionID. |
| Enable Message Counters | Enable Message Counters. |
| Disable Message Counters | Disable Message Counters. |
| Reset All MessageCounters | Reset All MessageCounters. |
| Reset All Message Counter Histories | Reset All Message Counter Histories. |
Package Types
none
3.10.1. HornetQ - JMS Queue Service
Overview
Table 3.2024. Overview
| Description: | |
| Singleton: | no |
| Plugin: | HornetQ |
Child Resource Types
none
Connection Properties
none
Metrics
Table 3.2025. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Name | trait | name of this destination | getName |
| JNDI Binding | trait | JNDI Binding of this destination | getJNDIBindings |
| Address | trait | Address of this destination | getAddress |
| Temporary | trait | If this destination is temporary | isTemporary |
| Message Count | measurement | number of messages currently held in this queue awaiting delivery | getMessageCount |
| Scheduled Message Count | measurement | number of scheduled messages in this queue awaiting scheduled delivery | getScheduledCount |
| Consumer Count | measurement | number of consumers currently consuming messages from this queue | getConsumerCount |
| Delivering Count | measurement | number of messages that this queue is currently delivering to its consumers that have not been acknowledged | getDeliveringCount |
| Messages Added | measurement | number of messages added to this queue since it was initially created | getMessagesAdded |
| Paused | trait | Is the queue currently paused | isPaused |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2026.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The name of the queue | yes | name |
| JNDI Name | comma-separated list of JNDI bindings (use ',' if u need to use commas in your jndi name) | yes | jndiBindings |
| Dead Letter Address | The address to route messages to once the message has been delivered more than the configured number of times. This is specified by 'Max Delivery Attempts'. Default is no dead letter address | no | dla |
| Expiry Address | The Address to route messages to once they have expired. Default is no Expiry Address | no | expiryAddress |
| Max Size of Address | The maximum size in bytes of messages that can be delivered to this queue. -1 means no limit, if limit is set then 'Address Full Message Policy' specifies what should happen | yes | maxSize |
| Page Size | The size in bytes that an address can reach before paging starts. -1 means no limit. | yes | pageSize |
| Page Cache Max Size | The max number of pages in the soft memory cache. | yes | pageMaxCacheSize |
| Max Delivery Attempts | The maximum time to attempt delivery of a message to a consumer, once hit the message is routed to which ever address is specified by 'Dead Letter Address' | yes | maxDeliveryAttempts |
| Redelivery Delay | The delay (in milli seconds) before re routing a message to this Address after an unsuccessful delivery attempt has occurred. default 0 means no delay | yes | redeliveryDelay |
| Last Value Queue | Is this queue a last value queue. A last value queue can only ever contain a single message for each value for the message property '_HQ_LVQ_NAME'. | yes | lastValueQueue |
| Redistribution Delay | How long to wait (in milli seconds) before redistributing messages to another node when clustered when a queue has no consumers. Default -1 means do not re distribute. | yes | redistributionDelay |
| Send To dead letter address on no route | Whether or not messages routed to this address gets sent to dead letter address when no consumers are available | yes | sendToDLAOnNoRoute |
| Address Full Message Policy | The policy to use when this Address is full. PAGE means that the message will be paged, DROP means that messages are just dropped and BLOCK means that the client will block on send until the queue clears some messages | yes | addressFullMessagePolicy |
| Roles | These are the roles for this queue. The 'name' of the role, 'send' allows a producer to send a message, 'consume' allows a consumer to receive a message. | yes | roles |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2027. Metrics
| Name | Description |
|---|---|
| Remove Messages | Remove all the messages from this queue. |
| List Messages | list all the messages currently in this queue. |
| Count Messages | Returns the number of the messages in the queue. |
| Remove Message | Remove the message corresponding to the given messageID. |
| Expire Messages | Expires messages. |
| Expire Message | Expire the message corresponding to the given messageID. |
| Send Message to dead letter address | Send the message corresponding to the given messageID 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. |
| Change Message Priority | Change the priority of the message corresponding to the given messageID. |
| Change Messages Priority | Change the priority of the messages corresponding to the given filter. |
| Move Message | Move the message corresponding to the given messageID to another queue. |
| Move Messages | Move the messages corresponding to the given filter. |
| List Message Counter | List the message counters for this queue. This will show statistics for the queue |
| Reset Message Counter | Reset the message counters. |
| List Message Counter in HTML | List the message counters in HTML. |
| List Message Counter History | List the message counters history. |
| List Message Counter History in HTML | List the message counters history in HTML. |
| Pause the Queue | Pause the Queue. If the queue is paused no messages can be routed to it or consumed from it. |
| Restart the Queue | Restart the Queue from its paused state. |
Package Types
none
3.10.2. HornetQ - JMS Topic Service
Overview
Table 3.2028. Overview
| Description: | |
| Singleton: | no |
| Plugin: | HornetQ |
Child Resource Types
none
Connection Properties
none
Metrics
Table 3.2029. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Name | trait | name of this destination | getName |
| JNDI Binding | trait | JNDI Binding of this destination | getJNDIBindings |
| Address | trait | Address of this destination | getAddress |
| Temporary | trait | If this destination is temporary | isTemporary |
| Subscription Count | measurement | number of (durable and non-durable) subscribers for this topic | getSubscriptionCount |
| Durable Subscription Count | measurement | number of durable subscribers for this topic | getDurableSubscriptionCount |
| Non Durable Subscription Count | measurement | number of non-durable subscribers for this topic | getNonDurableSubscriptionCount |
| Message Count | measurement | number of messages for all subscribers for this topic | getMessageCount |
| Durable Message Count | measurement | number of messages for all durable subscribers for this topic | getDurableMessageCount |
| Non Durable Message Count | measurement | number of messages for all non-durable subscribers for this topic | getNonDurableMessageCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2030.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The Name of the topic to deploy | yes | name |
| JNDI Name | comma-separated list of JNDI bindings (use ',' if u need to use commas in your jndi name) | yes | jndiBindings |
| Dead Letter Address | The address to route messages to once the message has been delivered more than the configured number of times. This is specified by 'Max Delivery Attempts'. The default is no dead letter address | no | dla |
| Expiry Address | The Address to route messages to once they have expired. The default is no expiry address | no | expiryAddress |
| Max Size of Address | The maximum size in bytes of messages that can be delivered to this queue. -1 means no limit, if limit is set then 'Address Full Message Policy' specifies what should happen | yes | maxSize |
| Page Size | The size in bytes an address can reach before paging occurs | yes | pageSize |
| Page Cache Max Size | The max number of pages in the soft memory cache. | yes | pageMaxCacheSize |
| Max Delivery Attempts | The maximum time to attempt delivery of a message to a consumer, once hit the message is routed to which ever address is specified by 'Dead Letter Address' | yes | maxDeliveryAttempts |
| Redelivery Delay | The delay (in milli seconds) before re routing a message to this Address after an unsuccessful delivery attempt has occurred. default 0 means no delay | yes | redeliveryDelay |
| Last Value Queue | Is this queue a last value queue. A last value queue can only ever contain a single message for each value for the message property '_HQ_LVQ_NAME'. | yes | lastValueQueue |
| Redistribution Delay | How long to wait (in milli seconds) before redistributing messages to another node when clustered when a queue has no consumers. Default -1 means do not re distribute. | yes | redistributionDelay |
| Send To dead letter address on no route | Whether or not messages routed to this address gets sent to dead letter address when no consumers are available | yes | sendToDLAOnNoRoute |
| Address Full Message Policy | The policy to use when this Address is full. PAGE means that the message will be paged, DROP means that messages are just dropped and BLOCK means that the client will block on send until the queue clears some messages | yes | addressFullMessagePolicy |
| Roles | These are the role defined for this topic. The 'name' of the role, 'send' allows a producer to send a message, 'consume' allows a consumer or subscriber to receive a message. The create/delete (non) durable subscriber specifies whether the queue representing the subscription can be created or deleted | yes | roles |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 3.2031. Metrics
| Name | Description |
|---|---|
| List all Subscriptions | Lists all the subscriptions for this topic (both durable and non-durable). |
| List all Durable Dubscriptions | Lists all the durable subscriptions for this topic. |
| List all non Durable Subscriptions | Lists all the non-durable subscriptions for this topic. |
| List all Messages | list all the messages. |
| List Messages for Subscription | Count the number of messages matching the filter for the given subscription. |
| Drop Durable Subscription | Drop a durable subscription. |
| Drop Durable Subscriptions | Drop all durable subscription. |
Package Types
none
3.10.3. HornetQ - JMS Connection Factory Service
Overview
Table 3.2032. Overview
| Description: | |
| Singleton: | no |
| Plugin: | HornetQ |
Child Resource Types
none
Connection Properties
none
Metrics
Table 3.2033. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Name | trait | name of this connection factory | getName |
| JNDI Bindings | trait | JNDI Bindings of this connection factory | getJNDIBindings |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 3.2034.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connection Factory Name | Name of the connection factory to deploy | yes | name |
| supports high availability | whether or not this connection factory will support high availability | yes | ha |
| use discovery | whether or not to use connectors or discovery | yes | useDiscovery |
| the type of factory | the connection factory type | yes | cfType |
| Connectors to live servers | comma-separated list of either connector names or a discovery group name | yes | connectorNames |
| JNDI Bindings | comma-separated list of JNDI bindings (use ',' if u need to use commas in your jndi name) | yes | Bindings |
| Client ID | Client ID for connections created by this connection factory | no | ClientID |
| Dups OK Batch Size | batch size (in bytes) between acknowledgements when using DUPS_OK_ACKNOWLEDGE mode | yes | DupsOKBatchSize |
| Transaction Batch Size | batch size (in bytes) between acknowledgements when using a transacted session | yes | TransactionBatchSize |
| Client Failure Check Period | period used, in milli seconds to check if a client has failed to receive pings from the server | yes | ClientFailureCheckPeriod |
| Connection TTL | connection time-to-live (in milliseconds) | yes | ConnectionTTL |
| Call Timeout | blocking calls timeout (in milliseconds) | yes | CallTimeout |
| Consumer Window Size | window size (in bytes) used for consumer flow control | yes | ConsumerWindowSize |
| Consumer Max Rate | maximum rate of message consumption (in messages per seconds), -1 means no rate set. | yes | ConsumerMaxRate |
| Confirmation Window Size | size (in bytes) for the confirmation window of clients using this connection factory, -1 means no window. | yes | ConfirmationWindowSize |
| Producer Max Rate | maximum rate of message production (in messages per seconds), -1 means no rate set. | yes | ProducerMaxRate |
| Producer Window Size | window size (in bytes) used for producer flow control, -1 means no window. | yes | ProducerWindowSize |
| Cache Large Messages Client | Whether consumers created through this factory will cache large messages in temporary files | yes | CacheLargeMessagesClient |
| Minimum Large Message Size | message size threshold (in bytes) before treating messages as large messages | yes | MinLargeMessageSize |
| Block On Non Durable Send | whether producers will block while sending non-durable messages or send them asynchronously | yes | BlockOnNonDurableSend |
| Block On Acknowledge | whether consumers will block while sending message acknowledgements or send them asynchronously | yes | BlockOnAcknowledge |
| Block On Durable Send | whether producers will block while sending persistent messages or send them asynchronously | yes | BlockOnDurableSend |
| Auto Group | whether producers will automatically assign a group ID to their messages | yes | AutoGroup |
| Pre Acknowledge | whether messages will pre-acknowledged on the server before they are sent to the consumers or not | yes | PreAcknowledge |
| Retry Interval | interval (in milliseconds) to retry connections created by this factory after failure | yes | RetryInterval |
| Maximum Retry Interval | maximum retry interval (in milliseconds) | yes | MaxRetryInterval |
| Retry Interval Multiplier | multiplier to apply to successive retry intervals | yes | RetryIntervalMultiplier |
| Reconnect Attempts | maximum number of attempts to retry connection in case of failure | yes | ReconnectAttempts |
| Scheduled Thread Pool Max Size | maximum size of the scheduled thread pool | yes | ScheduledThreadPoolMaxSize |
| Thread Pool Max Size | maximum size of the thread pool, -1 means unlimited | yes | ThreadPoolMaxSize |
| Group ID | group ID that will be eventually set on each message, default is no group id. | no | GroupID |
| Initial Message Packet Size | initial size (in bytes) of messages created through this factory | yes | InitialMessagePacketSize |
| Use Global Pools | whether this factory will use global thread pools (shared among all the factories in the same JVM) or its own pools | yes | UseGlobalPools |
| Connection Load Balancing Policy Class Name | class name of the connection load balancing policy | yes | ConnectionLoadBalancingPolicyClassName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
Chapter 4. Available JBoss Plug-in Packs
Additional JBoss products can be managed by JBoss ON by installing additional plug-in packs.
4.1. JBoss Service Oriented Architecture Platform (ESB5) Plug-in
Overview
Table 4.1. Overview
| Description: | Overall metrics for JBoss ESB |
| Singleton: | yes |
| Plugin: | JBossESB5 |
Child Resource Types
Connection Properties
Table 4.2.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Naming Provider URL | The JNP URL with which to connect to the JBoss Application Server instance (e.g. jnp://127.0.0.1:1099). | yes | namingURL |
| Principal | The name of the principal (i.e. user) to authenticate. | no | principal |
| Credentials | The credentials (i.e. password) that should be used to authenticate the principal. | no | credentials |
| JBoss Home Directory | The absolute path to the directory where JBossAS is installed (e.g. /opt/jboss-4.2.2.GA). | yes | jbossHomeDir |
| Configuration Path | The path to the configuration directory under which this instance operates (e.g. /opt/jboss-4.2.2.GA/server/default); if the path is not absolute, then it will be resolved relative to {jbossHomeDir}. | yes | configurationPath |
| Configuration Set | The name of the server configuration (e.g. minimal, default, or all); if not specified, it will default to the last path component of {configurationPath}. | no | configurationSet |
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 4.3. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Message Count (Successful) | measurement | Overall Successful Message Count | SuccessfulMessageCount |
| Message Count (Total) | measurement | Total Message Count | TotalMessageCount |
| Message Count (Failed) | measurement | Failed Message Count | FailedMessageCount |
| Processed Bytes | measurement | Overall Bytes Processed | ProcessedBytes |
| Last Successful Message Date | trait | Last Successful Message Date | LastSuccessfulMessageDate |
| Last Failed Message Date | trait | Last Failed Message Date | LastFailedMessageDate |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 4.4. Metrics
| Name | Description |
|---|---|
| Reset Counts | Reset the overall counter |
Package Types
Table 4.5. Package Types
| Name | Category | Description |
|---|---|---|
| Jar Library | Deployable | Library Jar files deployed in JBoss AS |
4.1.1. JBossESB5 - Deployment Service
Overview
Table 4.6. Overview
| Description: | Metrics for Deployments |
| Singleton: | no |
| Plugin: | JBossESB5 |
Child Resource Types
Connection Properties
Table 4.7.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Extension | yes | extension | |
| Description Template | yes | descriptionTemplate | |
| Deployment Type Name | yes | deploymentTypeName | |
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Deployment | the deployment name | yes | deployment |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 4.8. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Deployment Type | trait | Type of deployment | Name |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 4.9. Metrics
| Name | Description |
|---|---|
| Start deployment | Start the deployment |
| Stop deployment | Stop the deployment |
Package Types
Table 4.10. Package Types
| Name | Category | Description |
|---|---|---|
| ESB Package | Deployable |
4.1.1.1. JBossESB5 - Services Service
Overview
Table 4.11. Overview
| Description: | Services |
| Singleton: | no |
| Plugin: | JBossESB5 |
Note
Services are the services available within a deployment.
Child Resource Types
Connection Properties
Table 4.12.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | DescriptionTemplate | |
| Service Name | the service name | yes | serviceName |
| Category Name | the service category name | yes | categoryName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 4.13. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Message Count | measurement | Message Count | overallMessageCount |
| Message Count (avg) | measurement | Message Count (avg) | overallMessageCountByMinute |
| Message Count (avg) per Minute | measurement | Message Count (avg) | overallMessageCountByMinute |
| Overall Bytes | measurement | Overall Bytes | overallBytes |
| Overall Bytes Processed | measurement | Overall Bytes Processed | bytesProcessed |
| Overall Bytes Failed | measurement | Overall Bytes Failed | bytesFailed |
| Overall Service Time Processed | measurement | Overall Service Time Processed | overallTimeProcessed |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 4.14. Metrics
| Name | Description |
|---|---|
| Reset the message counter | Reset the message counter |
Package Types
none
4.1.1.1.1. JBossESB5 - Listeners Service
Overview
Table 4.15. Overview
| Description: | Listeners |
| Singleton: | no |
| Plugin: | JBossESB5 |
Note
Listener configuration shows the config of the listener.
Child Resource Types
none
Connection Properties
Table 4.16.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Service Category | the service category of the listener | yes | serviceCategory |
| Listener Name | the name of the Listener | yes | listenerName |
| Deployment Name | name of deployment | yes | deploymentName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 4.17. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| MEP | trait | Type of deployment | mep |
| Lifecycle State | trait | Lifecycle State | LifeCycleState |
| Maximum Number of Threads | trait | Maximum number of threads | maxThreads |
| Start Date | trait | Start Date | StartDate |
| Service Category | trait | Service Category | service-category |
| Service Description | trait | Service Description | service-description |
| Service Name | trait | Service Name | service-name |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 4.18. Metrics
| Name | Description |
|---|---|
| Start listener | Start the listener. |
| Stop listener | Stop the listener. |
Package Types
none
4.1.1.1.2. JBossESB5 - Gateways Service
Overview
Table 4.19. Overview
| Description: | Gateways |
| Singleton: | no |
| Plugin: | JBossESB5 |
Note
Gateway configuration shows the config of the listener.
Child Resource Types
none
Connection Properties
Table 4.20.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Service Category | the service category of the listener | yes | serviceCategory |
| Listener Name | the name of the Listener | yes | listenerName |
| Deployment Name | name of deployment | yes | deploymentName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 4.21. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Lifecycle State | trait | Lifecycle State | LifeCycleState |
| Maximum Number of Threads | trait | Maximum number of threads | maxThreads |
| Service Category | trait | Service Category | target-service-category |
| Service Description | trait | Service Description | target-service-description |
| Service Name | trait | Service Name | target-service-name |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 4.22. Metrics
| Name | Description |
|---|---|
| Start listener | Start the listener. |
| Stop listener | Stop the listener. |
Package Types
none
4.1.1.1.3. JBossESB5 - Actions Service
Overview
Table 4.23. Overview
| Description: | Actions |
| Singleton: | no |
| Plugin: | JBossESB5 |
Note
Actions are the actions executed within a service.
Child Resource Types
none
Connection Properties
Table 4.24.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Action Name | the action name | yes | actionName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 4.25. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Message Count | measurement | Message Count | overallMessagesCount |
| Message Count (avg) | measurement | Message Count (avg) | overallMessagesCountMinute |
| Message Count (avg) per Minute | measurement | Message Count (avg) | overallMessagesCountMinute |
| Messages Failed | measurement | Messages Failed | failedProcessedCount |
| Messages Failed (avg) | measurement | Messages Failed (avg) | failedProcessedCountMinute |
| Messages Failed (avg) per Minute | measurement | Messages Failed (avg) | failedProcessedCountMinute |
| Messages Successfully Processed | measurement | Messages Successfully Processed | successProcessedCount |
| Messages Successfully Processed (avg) | measurement | Messages Successfully Processed (avg) | successProcessedCountMinute |
| Messages Successfully Processed (avg) per Minute | measurement | Messages Successfully Processed (avg) | successProcessedCountMinute |
| Overall Bytes | measurement | Overall Bytes | overallBytesProcessed |
| Overall Bytes Processed | measurement | Overall Bytes Processed | bytesSuccessful |
| Overall Bytes Failed | measurement | Overall Bytes Failed | overallBytesFailed |
| Processing Time | measurement | Processing Time | processingTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
4.2. JBoss Business Rules Management Server (Drools) JMX Plug-in
4.2.1. DroolsRHQPlugin - Drools Knowledge Bases Service
Overview
Table 4.26. Overview
| Description: | The Drools Knowledge Base monitoring service. |
| Singleton: | no |
| Plugin: | DroolsRHQPlugin |
Child Resource Types
none
Connection Properties
Table 4.27.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate | |
| Kbase Id | The Knowledge Base Id | yes | kbaseId |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 4.28. Metrics
| Name | Description |
|---|---|
| Start Internal MBeans | Starts all the internal dependent MBeans. |
| Stop Internal MBeans | Stops all the internal dependent MBeans. |
Package Types
none
4.2.2. DroolsRHQPlugin - Drools Service
Overview
Table 4.29. Overview
| Description: | Drools service |
| Singleton: | no |
| Plugin: | DroolsRHQPlugin |
Child Resource Types
none
Connection Properties
Table 4.30.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
4.3. JBoss Data Services Server (Teiid) Plug-in
Overview
Table 4.31. Overview
| Description: | Teiid Data Services |
| Singleton: | yes |
| Plugin: | TeiidPlugin |
Child Resource Types
Autodiscovery Process Scans
none
Connection Properties
none
Metrics
Table 4.32. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Query Count | measurement | The number of queries currently active. | queryCount |
| Long Running Queries | measurement | The number of queries that have been running longer than the limit set for queries. | longRunningQueries |
| Session Count | measurement | The number of user connections currently active. | sessionCount |
| Used Buffer Space | measurement | The currently used file buffer space in MB. | userBufferSpace |
| Prepared Plan Cache Hit Ratio % | measurement | Percentage of positive cache hits | PREPARED_PLAN_CACHE.hitRatio |
| Prepared Plan Cache Size | measurement | Current number of entries in cache | PREPARED_PLAN_CACHE.totalEntries |
| Prepared Plan Cache # of Requests | measurement | Total number of requests made against cache | PREPARED_PLAN_CACHE.requestCount |
| ResultSet Cache Hit Ratio % | measurement | Percentage of positive cache hits | QUERY_SERVICE_RESULT_SET_CACHE.hitRatio |
| ResultSet Cache Size | measurement | Current number of entries in cache | QUERY_SERVICE_RESULT_SET_CACHE.totalEntries |
| ResultSet Cache # of Requests | measurement | Total number of requests made against cache | QUERY_SERVICE_RESULT_SET_CACHE.requestCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 4.33.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Display Preview VDBs | If 'Yes', Preview VDBs (created by the Teiid Designer) will display in the Virtual Database resource grouping. The default is 'No' | yes | displayPreviewVDBS |
| Max Rows Fetch Size | Maximum allowed fetch size, set via JDBC. User requested value ignored above this value. (default 20480) | no | RuntimeEngineDeployer.maxRowsFetchSize |
| Max Threads | Process pool maximum thread count. (default 64) | no | RuntimeEngineDeployer.maxThreads |
| Maximum Concurrent Active plans | Increase this value on highly concurrent systems - but ensure that the underlying pools can handle the increased load without timeouts.(default 20) | no | RuntimeEngineDeployer.maxActivePlans |
| Time Slice In Milliseconds | Query processor time slice, in milliseconds. (default 2000) | no | RuntimeEngineDeployer.timeSliceInMilli |
| Lob Chunk Size In KB | The max lob chunk size in KB transferred to the client for xml, blobs, clobs (default 100KB) | no | RuntimeEngineDeployer.lobChunkSizeInKB |
| Long Running Query Threshold | Length of time in seconds before a query is considered long running | no | RuntimeEngineDeployer.queryThresholdInSecs |
| Data Roles Enabled | Turn on role checking of resources based on the roles defined in VDB (default true) | no | RuntimeEngineDeployer.useDataRoles |
| Detecting Change Events | Set to true for the engine to detect local change events. Should be disabled if using external change data capture tools. (default true) | no | RuntimeEngineDeployer.detectingChangeEvents |
| Enabled | Denotes whether or not result set caching is enabled. (default true) | no | RuntimeEngineDeployer.resultSetCacheEnabled |
| Max Entries | The maximum number of result set cache entries. -1 indicates no limit. (default 1024) | no | ResultSetCacheConfig.maxEntries |
| Max Entry Age | The maximum age of a result set cache entry in seconds. -1 indicates no max. (default 7200) | no | ResultSetCacheConfig.maxAgeInSeconds |
| Max Entry Staleness | The maximum staleness of a result set cache entry in seconds based upon data modifications. -1 indicates no max. (default 60) | no | ResultSetCacheConfig.maxStaleness |
| Max Entries | The maximum number of prepared plan cache entries. -1 indicates no limit. (default 512 | no | PreparedPlanCacheConfig.maxEntries |
| Max Entry Age | The maximum age of a prepared plan cache entry in seconds. -1 indicates no max. (default 28800) | no | PreparedPlanCacheConfig.maxAgeInSeconds |
| Max Entry Staleness | The maximum staleness of a prepared plan cache entry in seconds based upon metadata modifications. -1 indicates no max. (default 0) | no | PreparedPlanCacheConfig.maxStaleness |
| Max Buffer Space | Max file storage space, in MB, to be used for buffer files (default 50G) | no | BufferService.maxBufferSpace |
| Processor Batch Size | The max row count of a batch sent internally within the query processor. Should be <= the connectorBatchSize. (default 512) | no | BufferService.processorBatchSize |
| Connector Batch Size | The max row count of a batch from a connector. Should be even multiple of processorBatchSize. (default 1024) | no | BufferService.connectorBatchSize |
| Max Processing Memory | The approximate amount of buffer memory in kilobytes allowable for a single processing operation (sort, grouping, etc.) regardless of existing memory commitments. -1 means to automatically calculate a value (default -1). | no | BufferService.maxProcessingKb |
| Max File Size | Max file size for buffer files (default 2GB) | no | BufferService.maxFileSize |
| Max Reserve Memory | The approximate amount of memory in kilobytes allowed to be held by the buffer manager. -1 means to automatically calculate a value (default -1). | no | BufferService.maxReserveKb |
| Enable | Enable Socket based JDBC access | no | JdbcSocketConfiguration.enabled |
| Host Name | Host Name | no | JdbcSocketConfiguration.hostName |
| Port Number | Port Number | no | JdbcSocketConfiguration.portNumber |
| SSL Enabled | SSL enabled | no | JdbcSocketConfiguration.sslEnabled |
| Max Socket Threads | Max NIO threads | no | JdbcSocketConfiguration.maxSocketThreads |
| Input Buffer Size | SO_RCVBUF size, 0 indicates that system default should be used (default 0) | no | JdbcSocketConfiguration.inputBufferSize |
| Output Buffer Size | SO_SNDBUF size, 0 indicates that system default should be used (default 0) | no | JdbcSocketConfiguration.outputBufferSize |
| Session Expiration Time Limit | Max allowed time before the session is terminated by the system, 0 indicates unlimited (default 0) | no | SessionService.sessionExpirationTimeLimit |
| Session Max Limit | Maximum number of sessions allowed by the system (default 5000) | no | SessionService.sessionMaxLimit |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 4.34. Metrics
| Name | Description |
|---|---|
| View current long running queries | List current queries executing against the Teiid System that have surpassed the long running query threshhold |
| View current sessions | Get current sessions connected to the Teiid instance |
| Deploy a VDB via URL | Deploy a VDB using a URL |
| Terminate Session | Terminate a specified session |
| View current requests | Get current requests executing against this Teiid instance |
| Terminate request | Terminate the processing of a query and its source queries |
| View current transactions | Get current transactions executing against this VDB |
| Terminate Transaction | Terminate a specified transaction |
Package Types
none
4.3.1. TeiidPlugin - Virtual Database (VDB)s Service
Overview
Table 4.35. Overview
| Description: | Teiid Data Services Virtual Databases |
| Singleton: | no |
| Plugin: | TeiidPlugin |
Child Resource Types
Connection Properties
none
Metrics
Table 4.36. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Status | trait | The status of this VDB | status |
| Errors | trait | Whether or not errors exist for this VDB | errorCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 4.37.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | The Virtual Database Name | no | name |
| Version | The Virtual Database Version | no | version |
| Description | The Virtual Database Description | no | description |
| Status | The Virtual Database Status | no | status |
| Connection Type | Allowable Connections: 1) NONE - disallow new connections 2) BY VERSION - allow connections only if the version is specified or if this is the earliest 'BY VERSION' vdb and there are no vdbs marked as 'ANY' 3) ANY - allow connections with or without a version specified. If multiple versions of same VDB are deployed, connect to one specified with ANY, or if there are multiple VDBs with ANY then connect to the latest version with ANY | no | connectionType |
| Url | The Virtual Database URL | no | url |
| Overrides | The translator overrides for this VDB | yes | translators |
| Single Source Models | The source models for this VDB | yes | singleSourceModels |
| Multi Source Models | The multi-source model sources for this VDB | yes | multiSourceModels |
| Logical Models | The logical models for this VDB | yes | logicalModels |
| Error List | VDB Errors | yes | errorList |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 4.38. Metrics
| Name | Description |
|---|---|
| View VDB Sessions | Get current sessions currently connected to this VDB |
| View VDB requests | Get current requests executing against this VDB |
| List Materialized View Info | List any Materialized Views for this VDB |
| Refresh a Materialized View | Refresh a given Materialized View for this VDB |
| Clear Cache | Clears the cache for a given type for this VDB |
Package Types
Table 4.39. Package Types
| Name | Category | Description |
|---|---|---|
| VDB File | Deployable |
4.3.1.1. TeiidPlugin - Data Roles Service
Overview
Table 4.40. Overview
| Description: | Data Roles for this VDB |
| Singleton: | no |
| Plugin: | TeiidPlugin |
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties
Table 4.41.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | Name of the data role | no | name |
| Any Authenticated | Indicates if the role is mapped to any authenticated user | no | anyAuthenticated |
| Description | Description of this data role | no | description |
| Mapped Role Names | Mapped role names for this data role | no | mappedRoleNameList |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
4.3.2. TeiidPlugin - Translators Service
Overview
Table 4.42. Overview
| Description: | Teiid Translators |
| Singleton: | no |
| Plugin: | TeiidPlugin |
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties
Table 4.43.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Name | Name of the translator | no | name |
| Description | Description the translator | no | description |
| Properties | Translator properties | no | translatorList |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
4.4. ModeShape Engine Server
Overview
Table 4.44. Overview
| Description: | ModeShape JCR Engine |
| Singleton: | yes |
| Plugin: | ModeShapePlugin |
Child Resource Types
Autodiscovery Process Scans
none
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
Table 4.45. Metrics
| Name | Description |
|---|---|
| Start/restart | Start the engine or restart if it's already running |
| Shutdown | Shutdown the engine |
Package Types
none
4.4.1. ModeShapePlugin - Repositories Service
Overview
Table 4.46. Overview
| Description: | ModeShape Repositories |
| Singleton: | no |
| Plugin: | ModeShapePlugin |
Child Resource Types
none
Connection Properties
none
Metrics
Table 4.47. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Total Active Sessions | measurement | The number of JCR sessions that are currently active | getActiveSessions |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 4.48.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Properties | Properties for this sequencer | yes | propertyList |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
4.4.2. ModeShapePlugin - Sequencing Service
Overview
Table 4.49. Overview
| Description: | ModeShape Sequencing Service |
| Singleton: | yes |
| Plugin: | ModeShapePlugin |
Child Resource Types
none
Connection Properties
none
Metrics
Table 4.50. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number Of Nodes Sequenced | measurement | The number of nodes sequenced | getNodesSequencedCount |
| Number Of Nodes Skipped | measurement | The number of nodes that were skipped because no sequencers applied | getNodesSkippedCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
4.4.3. ModeShapePlugin - Sequencers Service
Overview
Table 4.51. Overview
| Description: | Sequencers deployed to this ModeShape instance |
| Singleton: | no |
| Plugin: | ModeShapePlugin |
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties
Table 4.52.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Properties | Properties for this sequencer | yes | propertyList |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
4.4.4. ModeShapePlugin - Connectors Service
Overview
Table 4.53. Overview
| Description: | Connectors for repository |
| Singleton: | no |
| Plugin: | ModeShapePlugin |
Child Resource Types
none
Connection Properties
none
Metrics
Table 4.54. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Total Connections in Use | measurement | The number of connections in use | getInUseConnections |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 4.55.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connector Properties | Properties for this connector | yes | connectorPropertyList |
| Connection Pool Properties | Properties for this connector's connection pool | yes | connectionpoolPropertyList |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 4.56. Metrics
| Name | Description |
|---|---|
| Ping | Ping the connector to test availability |
Package Types
none
4.5. Enterprise Portal Platform (GateIn) - Portal Service
Overview
Table 4.57. Overview
| Description: | Monitors Portals |
| Singleton: | no |
| Plugin: | GateIn |
Child Resource Types
Connection Properties
Table 4.58.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 4.59. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Minimum execution time in seconds for this portal | measurement | Minimum execution time in seconds for this portal | minExecutionTime |
| Maximum execution time in seconds for this portal | measurement | Maximum execution time in seconds for this portal | maxExecutionTime |
| Average execution time in seconds for this portal | measurement | Average execution time in seconds for this portal | averageExecutionTime |
| Number of requests per second for this portal | measurement | Number of requests per second for this portal | throughput |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
4.5.1. GateIn - Portlets Service
Overview
Table 4.60. Overview
| Description: | Monitors Portlets deployed in GateIn |
| Singleton: | no |
| Plugin: | GateIn |
Child Resource Types
none
Connection Properties
Table 4.61.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 4.62. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Minimum execution time in seconds for this portlet | measurement | Minimum execution time in seconds for this portlet | minExecutionTime |
| Maximum execution time in seconds for this portlet | measurement | Maximum execution time in seconds for this portlet | maxExecutionTime |
| Average execution time in seconds for this portlet | measurement | Average execution time in seconds for this portlet | averageExecutionTime |
| Number of times this portlet has been called | measurement | Number of times this portlet has been called | executionCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
4.6. JBoss Data Grid (Infinispan) - Cache Manager Server Plug-in
Overview
Table 4.63. Overview
| Description: | |
| Singleton: | yes |
| Plugin: | Infinispan |
Child Resource Types
Autodiscovery Process Scans
none
Connection Properties
Table 4.64.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Connector Address | JMX Remoting address of the remote Infinispan Instance | yes | connectorAddress |
| Object Name | ObjectName of the Manager | yes | objectName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 4.65. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Cache manager name | trait | The name of this cache manager | Name |
| Infinispan version | trait | Infinispan version. | Version |
| Cache manager status | trait | The status of the cache manager instance. | CacheManagerStatus |
| List of defined caches | trait | The defined cache names and their statuses. The default cache is not included in this representation. | DefinedCacheNames |
| Number of caches defined | measurement | The total number of defined caches, excluding the default cache. | DefinedCacheCount |
| Number of caches created | measurement | The total number of created caches, including the default cache. | CreatedCacheCount |
| Number of running caches | measurement | The total number of running caches, including the default cache. | RunningCacheCount |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 4.66. Metrics
| Name | Description |
|---|---|
| Starts a cache with the given name | Starts a named cache from this cache manager |
| Starts the default cache | Starts the default cache associated with this cache manager |
Package Types
none
4.6.1. Infinispan - Cache Service
Overview
Table 4.67. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Infinispan |
Child Resource Types
none
Connection Properties
none
Metrics
Table 4.68. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| [Activation] Number of cache entries activated | measurement | Number of activation events | Activation.Activations |
| [Activation] Number of cache store loads | measurement | Number of entries loaded from cache store | Activation.CacheLoaderLoads |
| [Activation] Number of cache store load misses | measurement | Number of entries that did not exist in cache store | Activation.CacheLoaderMisses |
| [RpcManager] Cluster members | trait | List of members in the cluster | RpcManager.Members |
| [RpcManager] Statistics enabled | trait | Statistics enabled | RpcManager.StatisticsEnabled |
| [RpcManager] Number of successful replications | measurement | Number of successful replications | RpcManager.ReplicationCount |
| [RpcManager] Number of failed replications | measurement | Number of failed replications | RpcManager.ReplicationFailures |
| [RpcManager] Network address | trait | The network address associated with this instance | RpcManager.NodeAddress |
| [RpcManager] Physical network addresses | trait | The physical network addresses associated with this instance | RpcManager.PhysicalAddresses |
| [RpcManager] Cluster size | measurement | Size of the cluster in number of nodes | RpcManager.ClusterSize |
| [RpcManager] Successful replication ratio | measurement | Successful replications as a ratio of total replications in numeric double format | RpcManager.SuccessRatioFloatingPoint |
| [RpcManager] Average time spent in the transport layer | measurement | The average time spent in the transport layer, in milliseconds | RpcManager.AverageReplicationTime |
| [LockManager] Concurrency level | trait | The concurrency level that the MVCC Lock Manager has been configured with. | LockManager.ConcurrencyLevel |
| [LockManager] Number of locks held | measurement | The number of exclusive locks that are held. | LockManager.NumberOfLocksHeld |
| [LockManager] Number of locks available | measurement | The number of exclusive locks that are available. | LockManager.NumberOfLocksAvailable |
| [DistributionManager] Is rehash in progress? | trait | Checks whether the node is involved in a rehash. | DistributionManager.RehashInProgress |
| [DistributionManager] Is join completed? | trait | If true, the node has successfully joined the grid and is considered to hold state. If false, the join process is still in progress. | DistributionManager.JoinComplete |
| [CacheStore] Number of cache stores | measurement | number of cache loader stores | CacheStore.CacheLoaderStores |
| [Transactions] Statistics enabled | trait | Statistics enabled | Transactions.StatisticsEnabled |
| [Transactions] Prepares | measurement | Number of transaction prepares performed since last reset | Transactions.Prepares |
| [Transactions] Commits | measurement | Number of transaction commits performed since last reset | Transactions.Commits |
| [Transactions] Rollbacks | measurement | Number of transaction rollbacks performed since last reset | Transactions.Rollbacks |
| [CacheLoader] Number of cache store loads | measurement | Number of entries loaded from cache store | CacheLoader.CacheLoaderLoads |
| [CacheLoader] Number of cache store load misses | measurement | Number of entries that did not exist in cache store | CacheLoader.CacheLoaderMisses |
| [Cache] Cache status | trait | Returns the cache status | Cache.CacheStatus |
| [Cache] Cache name | trait | Returns the cache name | Cache.CacheName |
| [DeadlockDetectingLockManager] Number of total detected deadlocks | measurement | Total number of local detected deadlocks | DeadlockDetectingLockManager.TotalNumberOfDetectedDeadlocks |
| [DeadlockDetectingLockManager] Number of remote transaction that were roll backed due to deadlocks | measurement | Number of remote transaction that were roll backed due to deadlocks | DeadlockDetectingLockManager.DetectedRemoteDeadlocks |
| [DeadlockDetectingLockManager] Number of local transaction that were roll backed due to deadlocks | measurement | Number of local transaction that were roll backed due to deadlocks | DeadlockDetectingLockManager.DetectedLocalDeadlocks |
| [DeadlockDetectingLockManager] Number of unsolvable deadlock situations | measurement | Number of situations when we try to determine a deadlock and the other lock owner is NOT a transaction. In this scenario we cannot run the deadlock detection mechanism | DeadlockDetectingLockManager.OverlapWithNotDeadlockAwareLockOwners |
| [DeadlockDetectingLockManager] Number of interrupted local transactions | measurement | Number of locally originated transactions that were interrupted as a deadlock situation was detected | DeadlockDetectingLockManager.LocallyInterruptedTransactions |
| [DeadlockDetectingLockManager] Concurrency level | trait | The concurrency level that the MVCC Lock Manager has been configured with. | DeadlockDetectingLockManager.ConcurrencyLevel |
| [DeadlockDetectingLockManager] Number of locks held | measurement | The number of exclusive locks that are held. | DeadlockDetectingLockManager.NumberOfLocksHeld |
| [DeadlockDetectingLockManager] Number of locks available | measurement | The number of exclusive locks that are available. | DeadlockDetectingLockManager.NumberOfLocksAvailable |
| [Invalidation] Statistics enabled | trait | Statistics enabled | Invalidation.StatisticsEnabled |
| [Invalidation] Number of invalidations | measurement | Number of invalidations | Invalidation.Invalidations |
| [Passivation] Number of cache passivations | measurement | Number of passivation events | Passivation.Passivations |
| [Statistics] Number of cache hits | measurement | Number of cache attribute hits | Statistics.Hits |
| [Statistics] Number of cache misses | measurement | Number of cache attribute misses | Statistics.Misses |
| [Statistics] Number of cache removal hits | measurement | Number of cache removal hits | Statistics.RemoveHits |
| [Statistics] Number of cache removal misses | measurement | Number of cache removals where keys were not found | Statistics.RemoveMisses |
| [Statistics] Number of cache puts | measurement | number of cache attribute put operations | Statistics.Stores |
| [Statistics] Number of cache evictions | measurement | Number of cache eviction operations | Statistics.Evictions |
| [Statistics] Hit ratio | measurement | Percentage hit/(hit+miss) ratio for the cache | Statistics.HitRatio |
| [Statistics] Read/write ratio | measurement | read/writes ratio for the cache | Statistics.ReadWriteRatio |
| [Statistics] Average read time | measurement | Average number of milliseconds for a read operation on the cache | Statistics.AverageReadTime |
| [Statistics] Average write time | measurement | Average number of milliseconds for a write operation in the cache | Statistics.AverageWriteTime |
| [Statistics] Number of current cache entries | measurement | Number of entries currently in the cache | Statistics.NumberOfEntries |
| [Statistics] Seconds since cache started | measurement | Number of seconds since cache started | Statistics.ElapsedTime |
| [Statistics] Seconds since cache statistics were reset | measurement | Number of seconds since the cache statistics were last reset | Statistics.TimeSinceReset |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 4.69. Metrics
| Name | Description |
|---|---|
| [Activation] Reset statistics | Resets statistics gathered by this component |
| [RpcManager] Reset statistics | Resets statistics gathered by this component |
| [RpcManager] Enable/disable statistics | Enable/disable statistics |
| [DistributionManager] Could key be affected by rehash? | Determines whether a given key is affected by an ongoing rehash, if any. |
| [DistributionManager] Is key local? | Tells you whether a given key is local to this instance of the cache. Only works with String keys. |
| [DistributionManager] Locate key | Locates an object in a cluster. Only works with String keys. |
| [CacheStore] Reset statistics | Resets statistics gathered by this component |
| [Transactions] Reset Statistics | Resets statistics gathered by this component |
| [Transactions] Enable/disable statistics | Enable/disable statistics |
| [CacheLoader] Reset Statistics | Resets statistics gathered by this component |
| [Cache] Starts cache. | Starts the cache. |
| [Cache] Stops cache. | Stops the cache. |
| [DeadlockDetectingLockManager] Reset statistics | Resets statistics gathered by this component |
| [Invalidation] Reset statistics | Resets statistics gathered by this component |
| [Invalidation] Enable/disable statistics | Enable/disable statistics |
| [Passivation] Reset statistics | Resets statistics gathered by this component |
| [Statistics] Reset Statistics (Statistics) | Resets statistics gathered by this component |
Package Types
none
Chapter 5. Resources for JBoss ON
These default resources are available to manage JBoss ON servers, agents, and functionality.
5.1. RHQAgent - RHQ Agent Server
Overview
Table 5.1. Overview
| Description: | Management Agent |
| Singleton: | yes |
| Plugin: | RHQAgent |
Child Resource Types
Autodiscovery Process Scans
none
Connection Properties
Table 5.2.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Log Event Sources | The list of log files that can be tracked | yes | logEventSources |
| Snapshot Config Enabled | If true, take a snapshot of the configuration | yes | snapshotConfigEnabled |
| Snapshot Log Enabled | If true, take a snapshot of the log files | yes | snapshotLogEnabled |
| Snapshot Data Enabled | If true, take a snapshot of the data files | yes | snapshotDataEnabled |
| JVM Name | The name of the child JVM resource. | no | childJmxServerName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 5.3. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| SIGAR Version | trait | The version of the SIGAR (System Information Gatherer and Reporter) native library used by the Agent | Trait.SigarVersion |
| Reason For Last Restart | trait | Indicates what caused the last agent restart | Trait.ReasonForLastRestart |
| Agent Home Directory | trait | The directory where the agent is installed | Trait.AgentHomeDirectory |
| Number of Agent Restarts | measurement | Number of times the agent was restarted during the lifetime of its Java Virtual Machine | NumberAgentRestarts |
| Agent-Server Clock Difference | measurement | Number of milliseconds the agent's clock differs from its server's clock | AgentServerClockDifference |
| Up Time | measurement | Total number of seconds since the agent was started | Uptime |
| Total Number Of Commands Received | measurement | Total number of messages this agent has received from the RHQ Server | NumberTotalCommandsReceived |
| Total Number Of Commands Received per Minute | measurement | Total number of messages this agent has received from the RHQ Server | NumberTotalCommandsReceived |
| Number of Commands Received Successfully | measurement | Number of messages this agent has received from the RHQ Server and succesfully processed | NumberSuccessfulCommandsReceived |
| Number of Commands Received Successfully per Minute | measurement | Number of messages this agent has received from the RHQ Server and succesfully processed | NumberSuccessfulCommandsReceived |
| Number of Commands Received but Failed | measurement | Number of messages this agent has received from the RHQ Server but failed to process | NumberFailedCommandsReceived |
| Number of Commands Received but Failed per Minute | measurement | Number of messages this agent has received from the RHQ Server but failed to process | NumberFailedCommandsReceived |
| Avg Execution Time Commands Received Successfully | measurement | Average time it took to process incoming commands that are ultimately successful | AverageExecutionTimeReceived |
| Avg Execution Time Commands Sent Successfully | measurement | Average time it took to send commands that are ultimately successful | AverageExecutionTimeSent |
| Total Number of Commands Sent | measurement | Total number of messages this agent has sent to the RHQ Server | NumberTotalCommandsSent |
| Total Number of Commands Sent per Minute | measurement | Total number of messages this agent has sent to the RHQ Server | NumberTotalCommandsSent |
| Number of Commands Successfully Sent | measurement | Number of messages this agent has sent to the RHQ Server successfully | NumberSuccessfulCommandsSent |
| Number of Commands Successfully Sent per Minute | measurement | Number of messages this agent has sent to the RHQ Server successfully | NumberSuccessfulCommandsSent |
| Number of Commands Sent but Failed | measurement | Number of messages this agent has either tried, but failed, to send or were not processed succesfully by the RHQ Server | NumberFailedCommandsSent |
| Number of Commands Sent but Failed per Minute | measurement | Number of messages this agent has either tried, but failed, to send or were not processed succesfully by the RHQ Server | NumberFailedCommandsSent |
| Number Of Active Commands Being Sent | measurement | The number of messages this agent is currently sending | NumberCommandsActiveSent |
| Number of Commands In Queue | measurement | Number of messages currently queued waiting to be sent to the RHQ Server | NumberCommandsInQueue |
| Number of Commands Spooled To Disk | measurement | Number of messages spooled to disk waiting to be sent to the RHQ Server | NumberCommandsSpooled |
| JVM Free Memory | measurement | The amount of free memory the agent JVM has in its heap | JVMFreeMemory |
| JVM Total Memory | measurement | The amount of total memory the agent JVM has in its heap | JVMTotalMemory |
| JVM Active Threads | measurement | The number of active threads currently running in the agent JVM | JVMActiveThreads |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 5.4.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Agent Name | The name that this agent is known as. This is read-only - once assigned, it cannot change. | yes | rhq.agent.name |
| Plugins Directory | Location on the file system where the plugin jar files are stored | yes | rhq.agent.plugins.directory |
| Server Discovery Initial Delay | Startup delay before the first server discovery is run (in seconds) | no | rhq.agent.plugins.server-discovery.initial-delay-secs |
| Server Discovery Period | Time between server discoveries (in seconds) | no | rhq.agent.plugins.server-discovery.period-secs |
| Service Discovery Initial Delay | Startup delay before the first service discovery is run (in seconds) | no | rhq.agent.plugins.service-discovery.initial-delay-secs |
| Service Discovery Period | Time between service discoveries (in seconds) | no | rhq.agent.plugins.service-discovery.period-secs |
| Availability Scan Initial Delay | Startup delay before the first availability scan is run (in seconds) | no | rhq.agent.plugins.availability-scan.initial-delay-secs |
| Availability Scan Period | Time between availability scans (in seconds) | no | rhq.agent.plugins.availability-scan.period-secs |
| Measurement Collection Initial Delay | Startup delay before the first measurement collection is run (in seconds) | no | rhq.agent.plugins.measurement-collection.initial-delay-secs |
| Measurement Collection Threadpool Size | Number of concurrent measurement collections that can be run | no | rhq.agent.plugins.measurement-collection.threadpool-size |
| Drift Detection Initial Delay | Startup delay before the first drift detection scan is run (in seconds) | no | rhq.agent.plugins.drift-detection.initial-delay-secs |
| Drift Detection Period | Time between drift detection scans (in seconds) | no | rhq.agent.plugins.drift-detection.period-secs |
| Operation Invocation Timeout | Time before an operation invocation is aborted (in seconds) | no | rhq.agent.plugins.operation-invocation-timeout-secs |
| Operation Invoker Threadpool Size | Number of concurrent operation invocations that can be run | no | rhq.agent.plugins.operation-invoker.threadpool-size |
| Content Discovery Initial Delay | Startup delay before the first content discovery is run (in seconds) | no | rhq.agent.plugins.content-discovery.initial-delay-secs |
| Content Discovery Period | Time between content discoveries (in seconds) | no | rhq.agent.plugins.content-discovery.period-secs |
| Content Discovery Threadpool Size | Number of concurrent content discoveries that can be run | no | rhq.agent.plugins.content-discovery.threadpool-size |
| Configuration Change Detection Startup Delay | Time before configuration change detection starts (in seconds) | no | rhq.agent.plugins.configuration-discovery.initial-delay-secs |
| Configuration Change Detection Interval | Time period for checking for configuration changes (in seconds) | no | rhq.agent.plugins.configuration-discovery.period-secs |
| Event Sender Initial Delay | Defines the delay before the first event report gets sent to the server (in seconds) | no | rhq.agent.plugins.event-sender.initial-delay-secs |
| Event Sender Period | Defines how often event reports get sent to the server (in seconds) | no | rhq.agent.plugins.event-sender.period-secs |
| Event Report Max Per Source | Defines the maximum number of events for any given event source that can be placed in a single event report that is sent up to the server. If this number is larger than the max-total setting, then this setting is ignored | no | rhq.agent.plugins.event-report.max-per-source |
| Event Report Max Total | Defines the total maximum number of events that can be placed in a single event report that is sent up to the server | no | rhq.agent.plugins.event-report.max-total |
| Disabled Plugins | Defines the plugins that should be disabled and not loaded by the plugin container. This is a comma-separated list of plugin names. | no | rhq.agent.plugins.disabled |
| RHQ Server Transport Protocol | The transport protocol used to send commands to the RHQ Server. If you want secure communications, the RHQ Server must use an SSL-enabled transport | yes | rhq.agent.server.transport |
| RHQ Server IP Address | The RHQ Server address that it is bound to | yes | rhq.agent.server.bind-address |
| RHQ Server Port | The port that the RHQ Server is listening to | yes | rhq.agent.server.bind-port |
| RHQ Server Transport Parameters | Custom set of transport parameters used when sending commands to the RHQ Server. Please see the documentation for more information on transport params. | no | rhq.agent.server.transport-params |
| RHQ Server Alias | If the RHQ Server IP address is not defined, this is the DNS alias name that will be looked up to determine the RHQ Server IP address. | no | rhq.agent.server.alias |
| Agent Transport Protocol | The transport protocol used to receive commands from the RHQ Server. e.g. socket, sslsocket. If you want secure communications, you must use an SSL-enabled transport | yes | rhq.communications.connector.transport |
| Agent IP Address | The address the agent binds to when listening for incoming commands from the RHQ Server | no | rhq.communications.connector.bind-address |
| Agent Port | The port the agent listens to for incoming commands from the RHQ Server | yes | rhq.communications.connector.bind-port |
| Agent Transport Parameters | Custom set of transport parameters. Please see the documentation for more information on transport params. | no | rhq.communications.connector.transport-params |
| Incoming: Secure Socket Protocol | no | rhq.communications.connector.security.secure-socket-protocol | |
| Incoming: Keystore File | no | rhq.communications.connector.security.keystore.file | |
| Incoming: Keystore Algorithm | no | rhq.communications.connector.security.keystore.algorithm | |
| Incoming: Keystore Type | no | rhq.communications.connector.security.keystore.type | |
| Incoming: Keystore Password | no | rhq.communications.connector.security.keystore.password | |
| Incoming: Keystore Key Password | no | rhq.communications.connector.security.keystore.key-password | |
| Incoming: Keystore Alias | no | rhq.communications.connector.security.keystore.alias | |
| Incoming: Truststore File | no | rhq.communications.connector.security.truststore.file | |
| Incoming: Truststore Algorithm | no | rhq.communications.connector.security.truststore.algorithm | |
| Incoming: Truststore Type | no | rhq.communications.connector.security.truststore.type | |
| Incoming: Truststore Password | no | rhq.communications.connector.security.truststore.password | |
| Incoming: Client Authentication Mode | Determines if the agent should authenticate a RHQ Server before accepting incoming commands from it | no | rhq.communications.connector.security.client-auth-mode |
| Outgoing: Secure Socket Protocol | no | rhq.agent.client.security.secure-socket-protocol | |
| Outgoing: Keystore File | no | rhq.agent.client.security.keystore.file | |
| Outgoing: Keystore Algorithm | no | rhq.agent.client.security.keystore.algorithm | |
| Outgoing: Keystore Type | no | rhq.agent.client.security.keystore.type | |
| Outgoing: Keystore Password | no | rhq.agent.client.security.keystore.password | |
| Outgoing: Keystore Key Password | no | rhq.agent.client.security.keystore.key-password | |
| Outgoing: Keystore Alias | no | rhq.agent.client.security.keystore.alias | |
| Outgoing: Truststore File | no | rhq.agent.client.security.truststore.file | |
| Outgoing: Truststore Algorithm | no | rhq.agent.client.security.truststore.algorithm | |
| Outgoing: Truststore Type | no | rhq.agent.client.security.truststore.type | |
| Outgoing: Truststore Password | no | rhq.agent.client.security.truststore.password | |
| Outgoing: Authenticate Server? | If true, then the agent must authenticate the RHQ Server before it can send it messages | no | rhq.agent.client.security.server-auth-mode-enabled |
| RHQ Server Polling Interval | If this value is larger than 0, it indicates the agent should periodically poll the RHQ Server to make sure it's still up or (if it was down) see when it comes back up. The value is the number of milliseconds to wait in between polls | no | rhq.agent.client.server-polling-interval-msecs |
| Auto-Detect RHQ Server? | If true, the agent will use multicast detection to auto-detect the RHQ Server. If this is enabled, make sure you enable and configure the multicast detector | no | rhq.agent.server-auto-detection |
| Multicast Detector Enabled? | The multicast detector must be enabled if you want the RHQ Agent to auto-detect the RHQ Server and vice versa. Disable this if your network does not support multicast traffic. | no | rhq.communications.multicast-detector.enabled |
| Multicast Detector Multicast Address | The address used by JBoss ON to broadcast detection messages. All RHQ Servers and RHQ Agents must be using the same address. | no | rhq.communications.multicast-detector.multicast-address |
| Multicast Detector Bind Address | The address bound by the network interface | no | rhq.communications.multicast-detector.bind-address |
| Multicast Detector Port | The port that the detector is multicasting to | no | rhq.communications.multicast-detector.port |
| Multicast Detector Heartbeat | The number of milliseconds between heartbeat messages emitted by the multicast detector. This value must be less than the default time delay. | no | rhq.communications.multicast-detector.heartbeat-time-delay |
| Multicast Detector Time Delay | Amount of milliseconds that must pass without hearing a RHQ Server's heartbeat before assuming its down. This value must be greater than the heartbeat time delay. | no | rhq.communications.multicast-detector.default-time-delay |
| Queue Size | Maximum number of commands that the agent can queue up for sending to the RHQ Server. Setting this to 0 makes the queue unbounded. | no | rhq.agent.client.queue-size |
| Maximum Concurrency | Maximum number of commands that the agent can send to the RHQ Server at the same time. | no | rhq.agent.client.max-concurrent |
| Timeout | The default time in milliseconds the agent will wait before aborting a command being sent | no | rhq.agent.client.command-timeout-msecs |
| Retry Interval | This is the minimum amount of time, in milliseconds, the agent will wait before trying to resend a guaranteed command that previously failed | no | rhq.agent.client.retry-interval-msecs |
| Max Retries | This is the maximum amount of times the agent will resend a guaranteed command that previously failed due to something other than a cannot-connect error | no | rhq.agent.client.max-retries |
| Send Throttling | Configures the send throttle. See the documentation for more information on send throttling | no | rhq.agent.client.send-throttling |
| Queue Throttling | Configures the queue throttle. See the documentation for more information on queue throttling | no | rhq.agent.client.queue-throttling |
| Register with RHQ Server At Startup? | This will force the agent to register with the RHQ Server, even if it is already registered | no | rhq.agent.register-with-server-at-startup |
| Time To Wait For RHQ Server At Startup | This is the number of milliseconds the agent will wait for the RHQ Server to come up | no | rhq.agent.wait-for-server-at-startup-msecs |
| Update Plugins At Startup | This will force the agent to download plugin updates from the RHQ Server | no | rhq.agent.update-plugins-at-startup |
| Test Failover List At Startup | If true, the agent will attempt to connect to all servers found in its failover list. Warning messages will be logged if errors occur while attempting to connect to one or more servers. | no | rhq.agent.test-failover-list-at-startup |
| Enable Agent Update | If true, the agent will be allowed to update itself if it finds there is a new agent update binary available. If this feature is not enabled, the agent will never be allowed to update itself. | no | rhq.agent.agent-update.enabled |
| Agent Update Binary Version URL | If defined, this will be the URL the agent uses when it needs to retrieve information about the latest available agent update binary. If this is not defined, the agent will ask its server for the agent update binary version information. | no | rhq.agent.agent-update.version-url |
| Agent Update Binary Download URL | If defined, this will be the URL the agent uses when it needs to download the latest available agent update binary. If this is not defined, the agent will download the agent update binary from its server. | no | rhq.agent.agent-update.download-url |
| Data Directory | Location where the agent can persist data to the file system | no | rhq.agent.data-directory |
| Disable Native System | Disables the native system; agent will not use the native JNI libraries | no | rhq.agent.disable-native-system |
| Primary Server Switchover Check Interval | The amount of milliseconds in between checking that the agent is connected to the primary server, as opposed to a failover server. The check is disabled if this is 0. | no | rhq.agent.primary-server-switchover-check-interval-msecs |
| Remote Stream Idle Timeout | The maximum amount of milliseconds an agent-hosted remote stream is allowed to remain idle before it will be closed. | no | rhq.communications.remote-stream-max-idle-time-msecs |
| Command Spool Filename | Defines the name of the command spool file. This file must be located in the data directory (if one does not exist, it will be created) | no | rhq.agent.client.command-spool-file.name |
| Command Spool File Parameters | Defines the maximum size the spool file is allowed to be and how it is to be purged. See the documentation on the format of this value. | no | rhq.agent.client.command-spool-file.params |
| Compress Spool File? | If true, data in the spool file will be compressed. Note that this saves disk space at the expense of performance | no | rhq.agent.client.command-spool-file.compressed |
| VM Health Check Interval | The amount of milliseconds in between checking the health of the agent's Java Virtual Machine. The check is disabled if this is set to 0. | no | rhq.agent.vm-health-check.interval-msecs |
| VM Health Check Low Heap Memory Threshold | The threshold percentage that must be crossed if the agent's VM health check is to consider the JVM with critically low memory. This value is a percentage of used heap memory out of the maximum heap size. | no | rhq.agent.vm-health-check.low-heap-mem-threshold |
| VM Health Check Low NonHeap Memory Threshold | The threshold percentage that must be crossed if the agent's VM health check is to consider the JVM with critically low memory. This value is a percentage of used non-heap memory out of the maximum non-heap size. | no | rhq.agent.vm-health-check.low-nonheap-mem-threshold |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 5.5. Metrics
| Name | Description |
|---|---|
| Restart Agent | Shuts down the agent's comm layer and plugin container and starts them up again. This does *not* restart the agent's VM - use the launcher services to do that. |
| Shutdown Agent | Shuts down the agent's comm layer and plugin container. If the agent is in daemon mode, the entire agent VM will exit |
| Restart Plugin Container | Recycles the plugin container. |
| Download Latest Failover List | Tells the agent to download an updated server failover list. This will also check to make sure the agent is pointing to its primary server as found in the new failover list and, if not, will attempt to switch to the primary server now. |
| Update All Plugins | Tells the agent to update its plugins. This pulls new/updated plugins down from the RHQ Server |
| Get Info On All Plugins | Retrieves information on all deployed plugins. |
| Get Plugin Info | Retrieves information on a specific plugin. |
| Execute Availability Scan | Runs an availability scan and returns a report of its findings. An availability report tells you what resources are up or down. This operation will send the report to the server for processing, as well as return the results. |
| Get Current Date/Time | Obtains the agent's current date/time. |
| Set Debug Mode | Turns on or off debug mode, which causes the agent to emit verbose log messages. |
| Execute Prompt Command | Executes an agent prompt command, just as if you invoked the command at the agent prompt in a console. Note that you must ensure the prompt command does not require additional input, since the agent will look for that input from another source (e.g. console keyboard). |
| Switch To Server | Tell the agent to immediately switch to another server. The given server can be a simple hostname in which case, the current transport, port and transport parameters being used to talk to the current server will stay the same. Otherwise, it will be assumed the server is a full endpoint URL. |
Package Types
none
5.1.1. RHQAgent - Measurement Subsystem Service
Overview
Table 5.6. Overview
| Description: | The measurement subsystem within an agent's plugin container |
| Singleton: | yes |
| Plugin: | RHQAgent |
Child Resource Types
none
Connection Properties
Table 5.7.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 5.8. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Currently Schedule Measurements | measurement | The total number of active measurement schedules currently being collected by this RHQ Agent | CurrentlyScheduleMeasurements |
| Measurements Collected | measurement | The total number of measurements collected since this RHQ Agent was started | MeasurementsCollected |
| Measurements Collected per Minute | measurement | The total number of measurements collected since this RHQ Agent was started | MeasurementsCollected |
| Total Time Collecting Measurements | measurement | The amount of time this RHQ Agent has spent collecting measurements since it was started | TotalTimeCollectingMeasurements |
| Total Time Collecting Measurements per Minute | measurement | The amount of time this RHQ Agent has spent collecting measurements since it was started | TotalTimeCollectingMeasurements |
| Failed Collections | measurement | The number of individual measurement collections that have failed since this RHQ Agent was started | FailedCollections |
| Failed Collections per Minute | measurement | The number of individual measurement collections that have failed since this RHQ Agent was started | FailedCollections |
| Late Collections | measurement | The number of individual measurement collections that have fallen behind from their desired schedule | LateCollections |
| Late Collections per Minute | measurement | The number of individual measurement collections that have fallen behind from their desired schedule | LateCollections |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
5.1.2. RHQAgent - Plugin Container Service
Overview
Table 5.9. Overview
| Description: | The plugin container itself, which hosts the plugins and manages their lifecycle |
| Singleton: | yes |
| Plugin: | RHQAgent |
Child Resource Types
none
Connection Properties
Table 5.10.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 5.11. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number Of Plugin Class Loaders | measurement | The total number of plugin classloaders currently created and actively managed. | NumberOfPluginClassLoaders |
| Number Of Discovery Class Loaders | measurement | The total number of discovery classloaders currently created and actively managed. | NumberOfDiscoveryClassLoaders |
| Number Of Resource Class Loaders | measurement | The total number of individual resource classloaders currently created and assigned to resources. | NumberOfResourceClassLoaders |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 5.12. Metrics
| Name | Description |
|---|---|
| Retrieve Plugin Dependency Graph | Get the list of plugins and show what plugins they depend on. The order of this list is the order in which the plugins are deployed. |
| Retrieve Plugin ClassLoader Information | Get information on all plugin classloaders. There is one plugin classloader for each deployed plugin. |
| Retrieve Discovery ClassLoader Information | Get information on all discovery classloaders. These are created for discovery components that need to discover resources under a parent resource where that parent resource is from a different plugin than the discovery component. |
| Retrieve ClassLoader Information For All Resources | Get information on classloaders for all resources. Depending on the number of resources being managed, this is potentially an expensive operation. |
| Retrieve Unique Resource ClassLoader Information | Get information on all unique resource classloader instances that are created. Depending on the number of resources being managed, this is potentially an expensive operation. |
Package Types
none
5.1.3. RHQAgent - Environment Setup Script Service
Overview
Table 5.13. Overview
| Description: | The agent startup script that sets up the agent environment |
| Singleton: | yes |
| Plugin: | RHQAgent |
Child Resource Types
none
Connection Properties
Table 5.14.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Pathname | The full path to the script | yes | Pathname |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 5.15.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Environment Variables | Environment variables that are set when starting the RHQ Agent JVM process | yes | environmentVariables |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
none
Package Types
none
5.1.4. RHQAgent - Launcher Script Service
Overview
Table 5.16. Overview
| Description: | The script that can run the agent as a daemon service. The Environment Setup Script configures the behavior of this service. |
| Singleton: | yes |
| Plugin: | RHQAgent |
Child Resource Types
none
Connection Properties
Table 5.17.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Pathname | The full path to launcher script file | yes | Pathname |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Table 5.18. Metrics
| Name | Description |
|---|---|
| Restart | Restarts the agent VM. This will completely kill the agent VM process (if it is running as this service) and then attempt to restart it. If the agent executing this operation will quickly die, no confirmation will be available as to the success or failure of this operation. |
| Stop | Stops the agent VM gracefully. This will completely kill the agent VM process (if it is running as this service). If the agent executing this operation will quickly die, no confirmation will be available as to the success or failure of this operation. |
| Kill | Performs a hard kill on the agent VM. This will completely kill the agent VM process (if it is running as this service). If the agent executing this operation will quickly die, no confirmation will be available as to the success or failure of this operation. |
| Status | Gets the status of agent VM, if it was launched by the launcher script. |
Package Types
none
5.1.5. RHQAgent - Java Service Wrapper Launcher Service
Overview
Table 5.19. Overview
| Description: | The Java Service Wrapper that can run the agent as a daemon service |
| Singleton: | yes |
| Plugin: | RHQAgent |
Child Resource Types
none
Connection Properties
Table 5.20.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Launcher Script | The full path to wrapper launcher script file | yes | launcherScript |
| Configuration File | The full path to the configuration file | yes | configurationFile |
| Environment File | The full path to the environment setup file | no | environmentFile |
| Include File | The full path to the include file | no | includeFile |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
Table 5.21.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Main Configuration Settings | The main JSW configuration. This is read-only - to customize the configuration, add settings to the environment and/or includes. | yes | mainConfigurationSettings |
| Environment Settings | Environment settings to further customize the JSW. These are set prior to applying the main configuration and include settings. Variables set here can be placed in the main config or includes using the %VAR% notation. | yes | environmentSettings |
| Include Settings | Override settings that augment the existing JSW configuration. These are applied after the main configuration is set. | yes | includeSettings |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 5.22. Metrics
| Name | Description |
|---|---|
| Install | Installs the Java Service Wrapper so it starts the agent at boot time |
| Restart | Restarts the Java Service Wrapper and the agent it contains. This will completely kill the agent VM process (if it is running as this service) and then attempt to restart it. If the agent executing this operation will quickly die, no confirmation will be available as to the success or failure of this operation. |
| Stop | Stops the Java Service Wrapper and the agent it contains. This will completely kill the agent VM process (if it is running as this service). If the agent executing this operation will quickly die, no confirmation will be available as to the success or failure of this operation. |
| Remove | Removes the Java Service Wrapper so it no longer starts the agent at boot time. *NOTE* This will completely kill the agent VM process if it is running as this service. If the agent executing this operation will quickly die, no confirmation will be available as to the success or failure of this operation. |
| Status | Gets the status of the Java Service Wrapper |
Package Types
none
5.2. RHQServer - RHQ Server Alerts Engine Subsystem Service
Overview
Table 5.23. Overview
| Description: | RHQ Server Alerts Engine Subsystem |
| Singleton: | yes |
| Plugin: | RHQServer |
Child Resource Types
none
Connection Properties
Table 5.24.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 5.25. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Total Cache Element Count | measurement | The total number of elements in all alert caches that check all types of conditions | TotalCacheElementCount |
| Availability Cache Element Count | measurement | The number of elements in the alerts cache that check conditions against availability data | AvailabilityCacheElementCount |
| Measurement Cache Element Count | measurement | The number of elements in the alerts cache that check conditions against measurement numeric or trait data | MeasurementCacheElementCount |
| Event Cache Element Count | measurement | The number of elements in the alerts cache that check conditions against event history data | EventCacheElementCount |
| Operation Cache Element Count | measurement | The number of elements in the alerts cache that check conditions against operation history data | OperationCacheElementCount |
| Call Time Cache Element Count | measurement | The number of elements in the alerts cache that check conditions against calltime measurement data | CallTimeCacheElementCount |
| Resource Configuration Cache Element Count | measurement | The number of elements in the alerts cache that check conditions against resource configuration data | ResourceConfigurationCacheElementCount |
| Drift Cache Element Count | measurement | The number of elements in the alerts cache that check conditions against drift data | DriftCacheElementCount |
| Total Cache Element Matches | measurement | The total number of times ANY cache element has triggered against incoming data since this RHQ Server instance was started | TotalCacheElementMatches |
| Total Cache Element Matches per Minute | measurement | The total number of times ANY cache element has triggered against incoming data since this RHQ Server instance was started | TotalCacheElementMatches |
| Availability Cache Element Matches | measurement | The total number of times availability-based conditions have triggered against incoming data since this RHQ Server instance was started | AvailabilityCacheElementMatches |
| Availability Cache Element Matches per Minute | measurement | The total number of times availability-based conditions have triggered against incoming data since this RHQ Server instance was started | AvailabilityCacheElementMatches |
| Measurement Cache Element Matches | measurement | The total number of times measurement-based conditions have triggered against incoming data since this RHQ Server instance was started | MeasurementCacheElementMatches |
| Measurement Cache Element Matches per Minute | measurement | The total number of times measurement-based conditions have triggered against incoming data since this RHQ Server instance was started | MeasurementCacheElementMatches |
| Event Cache Element Matches | measurement | The total number of times events-based conditions have triggered against incoming data since this RHQ Server instance was started | EventCacheElementMatches |
| Event Cache Element Matches per Minute | measurement | The total number of times events-based conditions have triggered against incoming data since this RHQ Server instance was started | EventCacheElementMatches |
| Resource Configuration Cache Element Matches | measurement | The total number of times resource configuration-based conditions have triggered against incoming data since this RHQ Server instance was started | ResourceConfigurationCacheElementMatches |
| Resource Configuration Cache Element Matches per Minute | measurement | The total number of times resource configuration-based conditions have triggered against incoming data since this RHQ Server instance was started | ResourceConfigurationCacheElementMatches |
| Operation Cache Element Matches | measurement | The total number of times operation-based conditions have triggered against incoming data since this RHQ Server instance was started | OperationCacheElementMatches |
| Operation Cache Element Matches per Minute | measurement | The total number of times operation-based conditions have triggered against incoming data since this RHQ Server instance was started | OperationCacheElementMatches |
| Call Time Cache Element Matches | measurement | The total number of times calltime-based conditions have triggered against incoming data since this RHQ Server instance was started | CallTimeCacheElementMatches |
| Call Time Cache Element Matches per Minute | measurement | The total number of times calltime-based conditions have triggered against incoming data since this RHQ Server instance was started | CallTimeCacheElementMatches |
| Drift Cache Element Matches | measurement | The total number of times drift conditions have triggered against incoming data since this RHQ Server instance was started | DriftCacheElementMatches |
| Drift Cache Element Matches per Minute | measurement | The total number of times drift conditions have triggered against incoming data since this RHQ Server instance was started | DriftCacheElementMatches |
| Total Processing Time | measurement | The total amount of time spent by the alerts cache processing ALL types of data | TotalProcessingTime |
| Total Processing Time per Minute | measurement | The total amount of time spent by the alerts cache processing ALL types of data | TotalProcessingTime |
| Availability Processing Time | measurement | The total amount of time spent by the alerts cache processing availability data | AvailabilityProcessingTime |
| Availability Processing Time per Minute | measurement | The total amount of time spent by the alerts cache processing availability data | AvailabilityProcessingTime |
| Measurement Processing Time | measurement | The total amount of time spent by the alerts cache processing measurement numeric or trait data | MeasurementProcessingTime |
| Measurement Processing Time per Minute | measurement | The total amount of time spent by the alerts cache processing measurement numeric or trait data | MeasurementProcessingTime |
| Event Processing Time | measurement | The total amount of time spent by the alerts cache processing event history data | EventProcessingTime |
| Event Processing Time per Minute | measurement | The total amount of time spent by the alerts cache processing event history data | EventProcessingTime |
| Resource Configuration Processing Time | measurement | The total amount of time spent by the alerts cache processing resource configuration data | ResourceConfigurationProcessingTime |
| Resource Configuration Processing Time per Minute | measurement | The total amount of time spent by the alerts cache processing resource configuration data | ResourceConfigurationProcessingTime |
| Operation Processing Time | measurement | The total amount of time spent by the alerts cache processing operation history data | OperationProcessingTime |
| Operation Processing Time per Minute | measurement | The total amount of time spent by the alerts cache processing operation history data | OperationProcessingTime |
| Call Time Processing Time | measurement | The total amount of time spent by the alerts cache processing calltime measurement data | CallTimeProcessingTime |
| Call Time Processing Time per Minute | measurement | The total amount of time spent by the alerts cache processing calltime measurement data | CallTimeProcessingTime |
| Drift Processing Time | measurement | The total amount of time spent by the alerts cache processing drift data | DriftProcessingTime |
| Drift Processing Time per Minute | measurement | The total amount of time spent by the alerts cache processing drift data | DriftProcessingTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 5.26. Metrics
| Name | Description |
|---|---|
| Reload Caches | Unloads then reloads all caches managed by the containing RHQ Server |
Package Types
none
5.3. RHQServer - RHQ Server Communications Subsystem Service
Overview
Table 5.27. Overview
| Description: | Details on communications with agents |
| Singleton: | yes |
| Plugin: | RHQServer |
Child Resource Types
none
Connection Properties
Table 5.28.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 5.29. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number Failed Commands Received | measurement | Total number of commands that were received but failed to be processed successfully | NumberFailedCommandsReceived |
| Number Failed Commands Received per Minute | measurement | Total number of commands that were received but failed to be processed successfully | NumberFailedCommandsReceived |
| Number Successful Commands Received | measurement | Total number of commands that were received and successfully processed | NumberSuccessfulCommandsReceived |
| Number Successful Commands Received per Minute | measurement | Total number of commands that were received and successfully processed | NumberSuccessfulCommandsReceived |
| Number Total Commands Received | measurement | Total number of commands that were received regardless of their success or failure | NumberTotalCommandsReceived |
| Number Total Commands Received per Minute | measurement | Total number of commands that were received regardless of their success or failure | NumberTotalCommandsReceived |
| Number Dropped Commands Received | measurement | Total number of commands that were received but were dropped, usually due to a limit reached in the server that prohibits more commands from being processed until commands currently being processed are finished. | NumberDroppedCommandsReceived |
| Number Dropped Commands Received per Minute | measurement | Total number of commands that were received but were dropped, usually due to a limit reached in the server that prohibits more commands from being processed until commands currently being processed are finished. | NumberDroppedCommandsReceived |
| Number Not Processed Commands Received | measurement | Total number of commands that were received but were not processed usually due to the suspension of global command processing. | NumberNotProcessedCommandsReceived |
| Number Not Processed Commands Received per Minute | measurement | Total number of commands that were received but were not processed usually due to the suspension of global command processing. | NumberNotProcessedCommandsReceived |
| Average Execution Time Received | measurement | Average time it took to process incoming commands that were ultimately successful | AverageExecutionTimeReceived |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
Table 5.30.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Global Concurrency Limit | Number of incoming commands from agents that can be processed concurrently; if zero or less, there is no limit | yes | GlobalConcurrencyLimit |
| Inventory Report Limit | Number of inventory reports that can be processed concurrently; if zero or less, there is no limit | yes | InventoryReportConcurrencyLimit |
| Availability Report Limit | Number of availability reports that can be processed concurrently; if zero or less, there is no limit | yes | AvailabilityReportConcurrencyLimit |
| Inventory Synchronization Limit | Number of inventory synchronizations that can be processed concurrently; if zero or less, there is no limit | yes | InventorySyncConcurrencyLimit |
| Content Report Limit | Number of content reports that can be processed concurrently; if zero or less, there is no limit | yes | ContentReportConcurrencyLimit |
| Content Download Limit | Number of package version downloads that can be processed concurrently; if zero or less, there is no limit | yes | ContentDownloadConcurrencyLimit |
| Measurement Report Concurrency Limit | Number of measurement reports that can be processed concurrently; if zero or less, there is no limit | yes | MeasurementReportConcurrencyLimit |
| Measurement Schedule Request Concurrency Limit | Number of measurement schedule requests that can be processed concurrently; if zero or less, there is no limit | yes | MeasurementScheduleRequestConcurrencyLimit |
| Maintenance Mode At Startup | If true, the server will start in Maintenance Mode, regardless of the state it was in when it was shutdown. Therefore, if true, no agents will be allowed to talk to this server when it starts up. | yes | MaintenanceModeAtStartup |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations
Table 5.31. Metrics
| Name | Description |
|---|---|
| Clear Metrics | Clear the collected metric data and start collecting anew |
| View Received Call Time Data | View statistical information about each subsystem call into the server |
Package Types
none
5.4. RHQServer - RHQ Server Group Definition / DynaGroups Subsystem Service
Overview
Table 5.32. Overview
| Description: | Statistics for the RHQ Server Group Definition / DynaGroups Subsystem |
| Singleton: | yes |
| Plugin: | RHQServer |
Child Resource Types
none
Connection Properties
Table 5.33.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 5.34. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Group Definition Count | measurement | Total number of group definitions in the system | GroupDefinitionCount |
| Auto Recalculating Group Definition Count | measurement | The number of auto-recalculating group definitions in the system | AutoRecalculatingGroupDefinitionCount |
| Dyna Group Count | measurement | Total number of resource groups managed by some group definition | DynaGroupCount |
| Auto Recalculation Thread Time | measurement | Average time it took to recalculate DynaGroup members for those GroupDefinition's whose timeout expired | AutoRecalculationThreadTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 5.35. Metrics
| Name | Description |
|---|---|
| Clear Statistics | Clear the collected statistics, and start collecting anew |
| Retrieve Statistics | View a snapshot of statistical information about the recalculation cost of each GroupDefinition in the system |
Package Types
none
5.5. RHQServer - RHQ Server Measurement Subsystem Service
Overview
Table 5.36. Overview
| Description: | RHQ Server Measurement Subsystem |
| Singleton: | yes |
| Plugin: | RHQServer |
Child Resource Types
none
Connection Properties
Table 5.37.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 5.38. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Calltime Values Inserted | measurement | The total number of call time data records inserted into the database by this RHQ Server instance since it was started | CalltimeValuesInserted |
| Calltime Values Inserted per Minute | measurement | The total number of call time data records inserted into the database by this RHQ Server instance since it was started | CalltimeValuesInserted |
| Call Time Insert Time | measurement | The total amount of time taken to insert call time data into the database by this RHQ Server instance since it was started | CallTimeInsertTime |
| Call Time Insert Time per Minute | measurement | The total amount of time taken to insert call time data into the database by this RHQ Server instance since it was started | CallTimeInsertTime |
| Measurements Inserted | measurement | The total number of measurement records (incl. Calltime data) inserted into the database by this RHQ Server instance since it was started | MeasurementsInserted |
| Measurements Inserted per Minute | measurement | The total number of measurement records (incl. Calltime data) inserted into the database by this RHQ Server instance since it was started | MeasurementsInserted |
| Scheduled Measurements Per Minute | measurement | The average number of measurements expected to be collected per minute | ScheduledMeasurementsPerMinute |
| Measurement Insert Time | measurement | The total amount of time taken to insert measurement data into the database by this RHQ Server instance since it was started | MeasurementInsertTime |
| Measurement Insert Time per Minute | measurement | The total amount of time taken to insert measurement data into the database by this RHQ Server instance since it was started | MeasurementInsertTime |
| Baseline Calculation Time | measurement | The total amount of time taken to calculate and insert measurement baseline data into the database by this RHQ Server instance since it was started | BaselineCalculationTime |
| Baseline Calculation Time per Minute | measurement | The total amount of time taken to calculate and insert measurement baseline data into the database by this RHQ Server instance since it was started | BaselineCalculationTime |
| Measurement Compression Time | measurement | The total amount of time taken by this RHQ Server instance to compress measurement data since it was started | MeasurementCompressionTime |
| Measurement Compression Time per Minute | measurement | The total amount of time taken by this RHQ Server instance to compress measurement data since it was started | MeasurementCompressionTime |
| Purge Time | measurement | The total amount of time taken by this RHQ Server instance to purge old data (including measurement, availability, event, etc) since it was started | PurgeTime |
| Purge Time per Minute | measurement | The total amount of time taken by this RHQ Server instance to purge old data (including measurement, availability, event, etc) since it was started | PurgeTime |
| Availability Insert Time | measurement | The total amount of time taken to insert availability data into the database by this RHQ Server instance since it was started | AvailabilityInsertTime |
| Availability Insert Time per Minute | measurement | The total amount of time taken to insert availability data into the database by this RHQ Server instance since it was started | AvailabilityInsertTime |
| Availabilities Inserted | measurement | The total number of availability records inserted into the database by this RHQ Server instance since it was started | AvailabilitiesInserted |
| Availabilities Inserted per Minute | measurement | The total number of availability records inserted into the database by this RHQ Server instance since it was started | AvailabilitiesInserted |
| Total Availability Reports | measurement | The total number of availability reports received and processed by this RHQ Server since it was started | TotalAvailabilityReports |
| Total Availability Reports per Minute | measurement | The total number of availability reports received and processed by this RHQ Server since it was started | TotalAvailabilityReports |
| Changes Only Availability Reports | measurement | The number of changes-only availability reports received and processed by this RHQ Server since it was started | ChangesOnlyAvailabilityReports |
| Changes Only Availability Reports per Minute | measurement | The number of changes-only availability reports received and processed by this RHQ Server since it was started | ChangesOnlyAvailabilityReports |
| Full Availability Reports | measurement | The number of full availability reports received and processed by this RHQ Server since it was started | FullAvailabilityReports |
| Full Availability Reports per Minute | measurement | The number of full availability reports received and processed by this RHQ Server since it was started | FullAvailabilityReports |
| Purged Alerts | measurement | Number of alerts purged by the last purge job | PurgedAlerts |
| Purged Alert Conditions | measurement | Number of alert conditions purged by the last purge job | PurgedAlertConditions |
| Purged Alert Notifications | measurement | Number of alert notifications purged by the last purge job | PurgedAlertNotifications |
| Purged Availabilities | measurement | Number of availabilities purged by the last purge job | PurgedAvailabilities |
| Purged Call Time Data | measurement | Number of call time data purged by the last purge job | PurgedCallTimeData |
| Purged Events | measurement | Number of events purged by the last purge job | PurgedEvents |
| Purged Measurement Traits | measurement | Number of traits purged by the last purge job | PurgedMeasurementTraits |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
5.6. RHQServer - RHQ Server Plugin Subsystem Service
Overview
Table 5.39. Overview
| Description: | Details on the server-side plugin container subsystem |
| Singleton: | yes |
| Plugin: | RHQServer |
Child Resource Types
none
Connection Properties
Table 5.40.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 5.41. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Plugin Directory | trait | The location where this plugin container expects to find all of its plugins. | {masterPluginContainer.configuration.pluginDirectory} |
| Temporary Directory | trait | The location that the plugin uses to store transient files. Dependency jars found in plugins will be stored here to help build plugin classloaders. | {masterPluginContainer.configuration.temporaryDirectory} |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 5.42. Metrics
| Name | Description |
|---|---|
| Start Master Plugin Container | Starts the master plugin container which will load and initialize all server-side plugins. |
| Stop Master Plugin Container | Stops the master plugin container which will shutdown all server-side plugins. |
| Restart Master Plugin Container | Convienence operation that first stops and then immediately restarts the master plugin container. |
Package Types
none
5.7. RHQServer - RHQ Server Remote API Subsystem Service
Overview
Table 5.43. Overview
| Description: | Details on remote API communications with external clients, including the CLI |
| Singleton: | yes |
| Plugin: | RHQServer |
Child Resource Types
none
Connection Properties
Table 5.44.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 5.45. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number Failed Invocations | measurement | Total number of remote API requests that were received but failed to be processed successfully | NumberFailedInvocations |
| Number Failed Invocations per Minute | measurement | Total number of remote API requests that were received but failed to be processed successfully | NumberFailedInvocations |
| Number Successful Invocations | measurement | Total number of remote API requests that were received and successfully processed | NumberSuccessfulInvocations |
| Number Successful Invocations per Minute | measurement | Total number of remote API requests that were received and successfully processed | NumberSuccessfulInvocations |
| Number Total Invocations | measurement | Total number of remote API requests that were received regardless of their success or failure | NumberTotalInvocations |
| Number Total Invocations per Minute | measurement | Total number of remote API requests that were received regardless of their success or failure | NumberTotalInvocations |
| Average Execution Time | measurement | Average time it took to process incoming remote API requests that were ultimately successful | AverageExecutionTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 5.46. Metrics
| Name | Description |
|---|---|
| Clear Metrics | Clear the collected metric data and start collecting anew |
| View Received Call Time Data | View statistical information about each subsystem call into the server |
Package Types
none
5.8. AntBundlePlugin - Ant Bundle Handler Service
Overview
Table 5.47. Overview
| Description: | This plugin is used to process Ant bundles |
| Singleton: | yes |
| Plugin: | AntBundlePlugin |
Child Resource Types
none
Connection Properties
none
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
Legal Notice
Copyright © 2012 Red Hat, Inc..
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
