Red Hat JBoss Operations
Network 3.3
Development - Complete
Resource Reference
A complete reference for monitoring metrics, operations, and
configuration options
Edition 3.3
Jared Morgan
Zach Rhoads
Ella Deon Ballard
Red Hat JBoss Operations Network 3.3 Development - Complete
Resource Reference
A complete reference for monitoring metrics, operations, and
configuration options
Edition 3.3
Jared Morgan
jmorgan@redhat.com
Zach Rhoads
zach@redhat.com
Ella Deon Ballard
dlackey@redhat.com
Legal No tice
Copyright © 2012 Red Hat, Inc..
This document is licensed by Red Hat under the Creative Commons AttributionShareAlike 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, MetaMatrix, 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.
Abstract
This is a reference for all monitoring checks available for the default resources
handled in Red Hat JBoss Operations Network, as well as available resource
operations, configuration properties, and plug-in properties.
T able o f Co nt e nt s
T able o f Co ntents
. .hapt
⁠C
. . . .e.r. 1.
. . Manage
. . . . . . .d. .Plat
. . . f.o. r.ms
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . .
⁠1 .1. P latform s - AIX P latform
2
⁠1 .2. P latform s - FreeBSD P latform
14
⁠1 .3. P latform s - HP -UX P latform
25
⁠1 .4. P latform s - Java P latform
37
⁠1 .5. P latform s - Linux P latform
38
⁠1 .6. P latform s - Mac O S X P latform
51
⁠1 .7. P latform s - Solaris P latform
63
⁠1 .8. P latform s - Windows P latform
75
. .hapt
⁠C
. . . .e.r. 2.
. . Co
. . r. e
. .Manage
. . . . . . .d. Re
. . .s.o.ur
. .c.e.s. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8.7. . . . . . . . .
⁠2.1. Apache - HTTP Server
87
⁠2.2. IIS - Server
126
⁠2.3. P ostgres - Server
⁠2.4. Abstract Database P lugin
⁠2.5. Script - Server
153
178
178
. .hapt
⁠C
. . . .e.r. 3.
. . Ent
. . . e. r. pr
. . is
. .e. Applic
. . . . . .at
. .io
.n
. .Plat
. . . .f o
. .r m
. . Re
. . .s.o.ur
. .c.e.s. . . . . . . . . . . . . . . . . . . . . . .18
. .5. . . . . . . . .
⁠3 .1. JBossAS - Server
185
⁠3 .2. JBossAS5 - JBossAS Server
257
⁠3 .3. JBoss AS 7 and EAP 6 - Standalone Server
382
⁠3 .4. JBoss AS 7 and EAP 6 - Host C ontroller Server
808
⁠3 .5. m od_cluster - Service
1473
⁠3 .6. Hibernate - Statistics Service
1492
⁠3 .7. JBossC ache - Subsystem Server
1500
⁠3 .8. JBossC ache3 - JBoss C ache Service
1506
⁠3 .9. JMX - Server
1519
⁠3 .10. HornetQ - JMS Manager Service
1535
. .hapt
⁠C
. . . .e.r. 4. .. Re
. . .s.o.ur
. .c.e.s. f. o. r. .JBo
..s
.s
. .O. N
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1550
............
⁠4 .1. RHQ Agent - RHQ Agent Server
1550
⁠4 .2. RHQ Server - RHQ Server Subsystem Services Service
1574
⁠4 .3. RHQ Storage - RHQ Storage Node Server
1599
⁠4 .4. AntBundleP lugin - Ant Bundle Handler Service
1604
. .ppe
⁠A
. . .ndix
. . . . A.
. . Do
. . .c.ume
. . . nt
. . .His
. . .t.o.r.y. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
. .0.6. . . . . . . . .
1
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Chapt er 1. Managed Plat forms
JBos s Ope rations Ne twork 3.3 s upports s e ve ral major type s of platforms and ope rating
s ys te ms , including Java, Linux, Unix dis tributions , and Windows . Platform s upport is
imple me nte d through a s ingle age nt re s ource plug-in that de fine s the individual
configuration, me trics , and ope rations for all s upporte d platform type s .
1.1. Plat forms - AIX Plat form
Overview
T able 1.1. Overview
De s cription:
Single ton:
Plugin:
IBM AIX Ope rating Sys te m
no
Platforms
Child Resource T ypes
Se ction 1.1.1, “Platforms - Proce s s Se rvice ”
Se ction 1.1.2, “Platforms - File Sys te m Se rvice ”
Se ction 1.1.3, “Platforms - Dire ctory Se rvice ”
Se ction 1.1.4, “Platforms - Ne twork Adapte r Se rvice ”
Se ction 1.1.5, “Platforms - CPU Se rvice ”
Connect ion Propert ies
none
Met rics
T able 1.2. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Me mory
me as ure me nt
Native .Me moryInfo.fr
ee
Actual Fre e Me mory
me as ure me nt
The total fre e
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total fre e
s ys te m me mory
(include s unallocate d
me mory as we ll as
available buffe r and
cache me mory)
2
Native .Me moryInfo.a
ctualFre e
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Us e d Me mory
me as ure me nt
Native .Me moryInfo.u
sed
Actual Us e d Me mory
me as ure me nt
Total Me mory
me as ure me nt
Fre e Swap Space
me as ure me nt
Us e d Swap Space
me as ure me nt
Total Swap Space
me as ure me nt
Idle
me as ure me nt
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Hos tname
trait
OS Name
trait
OS Ve rs ion
trait
Archite cture
trait
The total us e d
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total us e d
s ys te m me mory
(include s buffe r and
cache me mory)
The total s ys te m
me mory
The total fre e
s ys te m s wap
The total us e d
s ys te m s wap
The total s ys te m
s wap
Idle pe rce ntage of
all CPUs
Pe rce ntage of all
CPUs running in
s ys te m mode
Pe rce ntage of all
CPUs running in us e r
mode
Pe rce ntage of all
CPUs waiting on I/O
Name that this
platform is known as
Name that the
ope rating s ys te m is
known as
Ve rs ion of the
ope rating s ys te m
Hardware
archite cture of the
platform
Native .Me moryInfo.a
ctualUs e d
Native .Me moryInfo.to
tal
Native .SwapInfo.fre e
Native .SwapInfo.us e
d
Native .SwapInfo.total
CpuPe rc.idle
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
Trait.hos tname
Trait.os name
Trait.os ve rs ion
Trait.s ys arch
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 1.3. Met rics
3
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 1.3. Met rics
Name
Descript io n
Run Autodis cove ry
Run an imme diate dis cove ry to s e arch for
ne w re s ource s
Vie w running proce s s e s on this s ys te m
Vie w Proce s s Lis t
Package T ypes
none
1.1.1. Plat f orms - Process Service
Overview
T able 1.4. Overview
De s cription:
A ge ne ric proce s s monitoring s e rvice to
track native proce s s information bas e d on
a pid file or proce s s que ry
no
Platforms
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 1.5.
Name
Descript io n
Required
Int ernal Name
Type
Choice of us ing a pid
file or a PIQL que ry
to find the proce s s
to monitor
Fully qualifie d path
to the pid file for the
proce s s to monitor
Proce s s Information
Que ry Language for
proce s s to monitor
If true , the e ntire
proce s s tre e will be
monitore d
ye s
type
no
pidFile
no
piql
ye s
fullProce s s Tre e
Pid File
Piql
Full Proce s s Tre e
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
4
⁠C hapt e r 1. Manage d Plat f o r ms
Met rics
T able 1.6. Met rics
Name
T ype
Descript io n
Int ernal Name
Us e r Time
me as ure me nt
Proce s s .cpu.us e r
Us e r Time pe r
Minute
me as ure me nt
Ke rne l Time
me as ure me nt
Ke rne l Time pe r
Minute
me as ure me nt
CPU Pe rce ntage
me as ure me nt
Phys ical Me mory
me as ure me nt
Virtual Me mory
me as ure me nt
Ope n File
De s criptors
me as ure me nt
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The pe rce ntage of
CPU curre ntly be ing
us e d by all
proce s s e s
The aggre gate
amount of re s ide nt
me mory us e d by all
proce s s e s
The aggre gate
amount of virtual
me mory us e d by all
proce s s e s
The aggre gate
numbe r of file
de s criptors ope n by
all proce s s e s
Proce s s .cpu.us e r
Proce s s .cpu.s ys
Proce s s .cpu.s ys
Proce s s .cpu.pe rce nt
Proce s s .me mory.re s
ide nt
Proce s s .me mory.s iz
e
Proce s s .file De s cript
or.total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
5
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Package T ypes
none
1.1.2. Plat f orms - File Syst em Service
Overview
T able 1.7. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.8. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Space
me as ure me nt
Us e d Pe rce ntage
me as ure me nt
Capacity
trait
Volume Type
trait
Drive Type
trait
file Sys te mUs age .fre
e
file Sys te mUs age .us
e Pe rce nt
file Sys te mUs age .tot
al
file Sys te m.type Nam
e
file Sys te m.s ys Type
Name
name
trait
Fre e File s
me as ure me nt
Flags
trait
Us e d
me as ure me nt
Dis k Re ads
me as ure me nt
Dis k Re ads pe r
Minute
me as ure me nt
The total fre e byte s
on file s ys te m
The pe rce ntage of
dis k us e d
The total s iz e of the
file s ys te m
The file s ys te m's
ge ne ric type name
The file s ys te m's
ope rating s ys te ms pe cific type name
The name of this
de vice
The numbe r of fre e
file node s on the
file s ys te m
The file s ys te m's
flags
The total byte s us e d
on the file s ys te m
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k re ads
6
file Sys te m.de vName
file Sys te mUs age .fre
e File s
file Sys te m.flags
file Sys te mUs age .us
ed
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kRe ads
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Dis k Write s
me as ure me nt
Dis k Write s pe r
Minute
Dis k Re ad Byte s
me as ure me nt
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kRe adByte s
Dis k Re ad Byte s pe r
Minute
me as ure me nt
Dis k Write Byte s
me as ure me nt
Dis k Write Byte s
pe r Minute
me as ure me nt
Dis k Que ue
me as ure me nt
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
writte n
The numbe r of
phys ical dis k byte s
writte n
The numbe r of I/Os
curre ntly in progre s s
me as ure me nt
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kQue ue
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.1.3. Plat f orms - Direct ory Service
Overview
T able 1.9. Overview
De s cription:
Single ton:
Plugin:
Monitor a ge ne ric dire ctory. This can be
he avy for a dire ctory with many s ubdire ctorie s , s o monitoring / is not allowe d.
no
Platforms
Child Resource T ypes
7
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Connect ion Propert ies
T able 1.10 .
Name
Descript io n
Required
Int ernal Name
Path
Dire ctory to monitor.
/ is not allowe d.
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.11. Met rics
Name
T ype
Descript io n
Int ernal Name
Dire ctory us age
me as ure me nt
us age
Numbe r of file s
me as ure me nt
Numbe r of ite ms
me as ure me nt
Dis k us age of this
dire ctory
Numbe r of file s in
the dire ctory
Numbe r of ite ms in
the dire ctory (file s ,
s ubdirs , s ymlinks )
file s
total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.1.4. Plat f orms - Net work Adapt er Service
Overview
8
⁠C hapt e r 1. Manage d Plat f o r ms
T able 1.12. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.13. Met rics
Name
T ype
Descript io n
Int ernal Name
Ine t4Addre s s
trait
Trait.ne t4.addre s s
Inte rface Flags
trait
Byte s Re ce ive d
me as ure me nt
Byte s Re ce ive d pe r
Minute
me as ure me nt
Packe ts Re ce ive d
me as ure me nt
Packe ts Re ce ive d
pe r Minute
me as ure me nt
Byte s Trans mitte d
me as ure me nt
Byte s Trans mitte d
pe r Minute
me as ure me nt
IP addre s s of the
ne twork adapte r
Flag cons tants for
ne twork re late d
ope rations
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
Trait.inte rface Flags
rxByte s
rxByte s
rxPacke ts
rxPacke ts
txByte s
txByte s
9
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Packe ts Trans mitte d
me as ure me nt
txPacke ts
Packe ts Trans mitte d
pe r Minute
me as ure me nt
Re ce ive Errors
me as ure me nt
Re ce ive Errors pe r
Minute
me as ure me nt
Re ce ive Packe ts
Droppe d
me as ure me nt
Re ce ive Packe ts
Droppe d pe r Minute
me as ure me nt
Re ce ive Ove rrurns
me as ure me nt
Re ce ive Ove rrurns
pe r Minute
me as ure me nt
Re ce ive Frame
me as ure me nt
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
10
txPacke ts
rxErrors
rxErrors
rxDroppe d
rxDroppe d
rxOve rruns
rxOve rruns
rxFrame
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Re ce ive Frame pe r
Minute
me as ure me nt
rxFrame
Trans mit Errors
me as ure me nt
Trans mit Errors pe r
Minute
me as ure me nt
Trans mit Packe ts
Droppe d
me as ure me nt
Trans mit Packe ts
Droppe d pe r Minute
me as ure me nt
Trans mit Ove rruns
me as ure me nt
Trans mit Ove rruns
pe r Minute
me as ure me nt
Trans mit Collis ions
me as ure me nt
Trans mit Collis ions
pe r Minute
me as ure me nt
Trans mit Carrie r
me as ure me nt
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
txErrors
txErrors
txDroppe d
txDroppe d
txOve rruns
txOve rruns
txCollis ions
txCollis ions
txCarrie r
11
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Trans mit Carrie r pe r
Minute
me as ure me nt
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
txCarrie r
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.1.5. Plat f orms - CPU Service
Overview
T able 1.14. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.15. Met rics
Name
T ype
Descript io n
Int ernal Name
Idle
me as ure me nt
Idle pe rce ntage of
this CPU
CpuPe rc.idle
12
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Sys te m Load
me as ure me nt
CpuPe rc.s ys
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Us e r Time
me as ure me nt
Us e r Time pe r
Minute
Nice Time
me as ure me nt
Nice Time pe r
Minute
Sys te m Time
me as ure me nt
Sys te m Time pe r
Minute
Idle Time
me as ure me nt
Idle Time pe r Minute
me as ure me nt
Wait Time
me as ure me nt
Wait Time pe r
Minute
Ve ndor
CPU Mode l
CPU Spe e d
me as ure me nt
Cache s iz e
trait
Pe rce ntage of this
CPU running in
s ys te m mode
Pe rce ntage of this
CPU running in us e r
mode
Pe rce ntage of this
CPU waiting on I/O
The total s ys te m
CPU us e r time
The total s ys te m
CPU us e r time
The total s ys te m
CPU nice time
The total s ys te m
CPU nice time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU idle time
The total s ys te m
CPU idle time
The total s ys te m
CPU I/O wait time
The total s ys te m
CPU I/O wait time
Ve ndor of this CPU
Mode l of this CPU
Spe e d of this CPU in
Mhz
Cache Siz e of this
CPU
me as ure me nt
me as ure me nt
me as ure me nt
trait
trait
trait
CpuPe rc.us e r
CpuPe rc.wait
Cpu.us e r
Cpu.us e r
Cpu.nice
Cpu.nice
Cpu.s ys
Cpu.s ys
Cpu.idle
Cpu.idle
Cpu.wait
Cpu.wait
CpuTrait.ve ndor
CpuTrait.mode l
CpuTrait.mhz
CpuTrait.cache Siz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
13
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
1.2. Plat forms - FreeBSD Plat form
Overview
T able 1.16. Overview
De s cription:
Single ton:
Plugin:
Fre e BSD Ope rating Sys te m
no
Platforms
Child Resource T ypes
Se ction 1.2.1, “Platforms - Proce s s Se rvice ”
Se ction 1.2.2, “Platforms - File Sys te m Se rvice ”
Se ction 1.2.3, “Platforms - Dire ctory Se rvice ”
Se ction 1.2.4, “Platforms - Ne twork Adapte r Se rvice ”
Se ction 1.2.5, “Platforms - CPU Se rvice ”
Connect ion Propert ies
none
Met rics
T able 1.17. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Me mory
me as ure me nt
Native .Me moryInfo.fr
ee
Actual Fre e Me mory
me as ure me nt
Us e d Me mory
me as ure me nt
Actual Us e d Me mory
me as ure me nt
The total fre e
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total fre e
s ys te m me mory
(include s unallocate d
me mory as we ll as
available buffe r and
cache me mory)
The total us e d
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total us e d
s ys te m me mory
(include s buffe r and
cache me mory)
14
Native .Me moryInfo.a
ctualFre e
Native .Me moryInfo.u
sed
Native .Me moryInfo.a
ctualUs e d
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Total Me mory
me as ure me nt
Fre e Swap Space
me as ure me nt
Native .Me moryInfo.to
tal
Native .SwapInfo.fre e
Us e d Swap Space
me as ure me nt
Total Swap Space
me as ure me nt
Idle
me as ure me nt
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Hos tname
trait
OS Name
trait
OS Ve rs ion
trait
Archite cture
trait
The total s ys te m
me mory
The total fre e
s ys te m s wap
The total us e d
s ys te m s wap
The total s ys te m
s wap
Idle pe rce ntage of
all CPUs
Pe rce ntage of all
CPUs running in
s ys te m mode
Pe rce ntage of all
CPUs running in us e r
mode
Pe rce ntage of all
CPUs waiting on I/O
Name that this
platform is known as
Name that the
ope rating s ys te m is
known as
Ve rs ion of the
ope rating s ys te m
Hardware
archite cture of the
platform
Native .SwapInfo.us e
d
Native .SwapInfo.total
CpuPe rc.idle
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
Trait.hos tname
Trait.os name
Trait.os ve rs ion
Trait.s ys arch
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 1.18. Met rics
Name
Descript io n
Run Autodis cove ry
Run an imme diate dis cove ry to s e arch for
ne w re s ource s
Vie w running proce s s e s on this s ys te m
Vie w Proce s s Lis t
Package T ypes
15
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
1.2.1. Plat f orms - Process Service
Overview
T able 1.19. Overview
De s cription:
A ge ne ric proce s s monitoring s e rvice to
track native proce s s information bas e d on
a pid file or proce s s que ry
no
Platforms
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 1.20 .
Name
Descript io n
Required
Int ernal Name
Type
Choice of us ing a pid
file or a PIQL que ry
to find the proce s s
to monitor
Fully qualifie d path
to the pid file for the
proce s s to monitor
Proce s s Information
Que ry Language for
proce s s to monitor
If true , the e ntire
proce s s tre e will be
monitore d
ye s
type
no
pidFile
no
piql
ye s
fullProce s s Tre e
Pid File
Piql
Full Proce s s Tre e
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.21. Met rics
Name
16
T ype
Descript io n
Int ernal Name
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Us e r Time
me as ure me nt
Proce s s .cpu.us e r
Us e r Time pe r
Minute
me as ure me nt
Ke rne l Time
me as ure me nt
Ke rne l Time pe r
Minute
me as ure me nt
CPU Pe rce ntage
me as ure me nt
Phys ical Me mory
me as ure me nt
Virtual Me mory
me as ure me nt
Ope n File
De s criptors
me as ure me nt
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The pe rce ntage of
CPU curre ntly be ing
us e d by all
proce s s e s
The aggre gate
amount of re s ide nt
me mory us e d by all
proce s s e s
The aggre gate
amount of virtual
me mory us e d by all
proce s s e s
The aggre gate
numbe r of file
de s criptors ope n by
all proce s s e s
Proce s s .cpu.us e r
Proce s s .cpu.s ys
Proce s s .cpu.s ys
Proce s s .cpu.pe rce nt
Proce s s .me mory.re s
ide nt
Proce s s .me mory.s iz
e
Proce s s .file De s cript
or.total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.2.2. Plat f orms - File Syst em Service
17
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
1.2.2. Plat f orms - File Syst em Service
Overview
T able 1.22. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.23. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Space
me as ure me nt
Us e d Pe rce ntage
me as ure me nt
Capacity
trait
Volume Type
trait
Drive Type
trait
file Sys te mUs age .fre
e
file Sys te mUs age .us
e Pe rce nt
file Sys te mUs age .tot
al
file Sys te m.type Nam
e
file Sys te m.s ys Type
Name
name
trait
Fre e File s
me as ure me nt
Flags
trait
Us e d
me as ure me nt
Dis k Re ads
me as ure me nt
Dis k Re ads pe r
Minute
Dis k Write s
me as ure me nt
Dis k Write s pe r
Minute
me as ure me nt
The total fre e byte s
on file s ys te m
The pe rce ntage of
dis k us e d
The total s iz e of the
file s ys te m
The file s ys te m's
ge ne ric type name
The file s ys te m's
ope rating s ys te ms pe cific type name
The name of this
de vice
The numbe r of fre e
file node s on the
file s ys te m
The file s ys te m's
flags
The total byte s us e d
on the file s ys te m
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k write s
18
me as ure me nt
file Sys te m.de vName
file Sys te mUs age .fre
e File s
file Sys te m.flags
file Sys te mUs age .us
ed
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kWrite s
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Dis k Re ad Byte s
me as ure me nt
file Sys te mUs age .dis
kRe adByte s
Dis k Re ad Byte s pe r
Minute
me as ure me nt
Dis k Write Byte s
me as ure me nt
Dis k Write Byte s
pe r Minute
me as ure me nt
Dis k Que ue
me as ure me nt
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
writte n
The numbe r of
phys ical dis k byte s
writte n
The numbe r of I/Os
curre ntly in progre s s
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kQue ue
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.2.3. Plat f orms - Direct ory Service
Overview
T able 1.24. Overview
De s cription:
Single ton:
Plugin:
Monitor a ge ne ric dire ctory. This can be
he avy for a dire ctory with many s ubdire ctorie s , s o monitoring / is not allowe d.
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
19
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 1.25.
Name
Descript io n
Required
Int ernal Name
Path
Dire ctory to monitor.
/ is not allowe d.
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.26. Met rics
Name
T ype
Descript io n
Int ernal Name
Dire ctory us age
me as ure me nt
us age
Numbe r of file s
me as ure me nt
Numbe r of ite ms
me as ure me nt
Dis k us age of this
dire ctory
Numbe r of file s in
the dire ctory
Numbe r of ite ms in
the dire ctory (file s ,
s ubdirs , s ymlinks )
file s
total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.2.4. Plat f orms - Net work Adapt er Service
Overview
T able 1.27. Overview
De s cription:
20
⁠C hapt e r 1. Manage d Plat f o r ms
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.28. Met rics
Name
T ype
Descript io n
Int ernal Name
Ine t4Addre s s
trait
Trait.ne t4.addre s s
Inte rface Flags
trait
Byte s Re ce ive d
me as ure me nt
Byte s Re ce ive d pe r
Minute
me as ure me nt
Packe ts Re ce ive d
me as ure me nt
Packe ts Re ce ive d
pe r Minute
me as ure me nt
Byte s Trans mitte d
me as ure me nt
Byte s Trans mitte d
pe r Minute
me as ure me nt
IP addre s s of the
ne twork adapte r
Flag cons tants for
ne twork re late d
ope rations
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
Trait.inte rface Flags
rxByte s
rxByte s
rxPacke ts
rxPacke ts
txByte s
txByte s
21
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Packe ts Trans mitte d
me as ure me nt
txPacke ts
Packe ts Trans mitte d
pe r Minute
me as ure me nt
Re ce ive Errors
me as ure me nt
Re ce ive Errors pe r
Minute
me as ure me nt
Re ce ive Packe ts
Droppe d
me as ure me nt
Re ce ive Packe ts
Droppe d pe r Minute
me as ure me nt
Re ce ive Ove rrurns
me as ure me nt
Re ce ive Ove rrurns
pe r Minute
me as ure me nt
Re ce ive Frame
me as ure me nt
Re ce ive Frame pe r
Minute
me as ure me nt
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
22
txPacke ts
rxErrors
rxErrors
rxDroppe d
rxDroppe d
rxOve rruns
rxOve rruns
rxFrame
rxFrame
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Trans mit Errors
me as ure me nt
txErrors
Trans mit Errors pe r
Minute
me as ure me nt
Trans mit Packe ts
Droppe d
me as ure me nt
Trans mit Packe ts
Droppe d pe r Minute
me as ure me nt
Trans mit Ove rruns
me as ure me nt
Trans mit Ove rruns
pe r Minute
me as ure me nt
Trans mit Collis ions
me as ure me nt
Trans mit Collis ions
pe r Minute
me as ure me nt
Trans mit Carrie r
me as ure me nt
Trans mit Carrie r pe r
Minute
me as ure me nt
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
txErrors
txDroppe d
txDroppe d
txOve rruns
txOve rruns
txCollis ions
txCollis ions
txCarrie r
txCarrie r
23
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.2.5. Plat f orms - CPU Service
Overview
T able 1.29. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.30 . Met rics
Name
T ype
Descript io n
Int ernal Name
Idle
me as ure me nt
CpuPe rc.idle
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Idle pe rce ntage of
this CPU
Pe rce ntage of this
CPU running in
s ys te m mode
Pe rce ntage of this
CPU running in us e r
mode
Pe rce ntage of this
CPU waiting on I/O
24
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Us e r Time
me as ure me nt
Cpu.us e r
Us e r Time pe r
Minute
Nice Time
me as ure me nt
Nice Time pe r
Minute
Sys te m Time
me as ure me nt
Sys te m Time pe r
Minute
Idle Time
me as ure me nt
Idle Time pe r Minute
me as ure me nt
Wait Time
me as ure me nt
Wait Time pe r
Minute
Ve ndor
CPU Mode l
CPU Spe e d
me as ure me nt
Cache s iz e
trait
The total s ys te m
CPU us e r time
The total s ys te m
CPU us e r time
The total s ys te m
CPU nice time
The total s ys te m
CPU nice time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU idle time
The total s ys te m
CPU idle time
The total s ys te m
CPU I/O wait time
The total s ys te m
CPU I/O wait time
Ve ndor of this CPU
Mode l of this CPU
Spe e d of this CPU in
Mhz
Cache Siz e of this
CPU
me as ure me nt
me as ure me nt
me as ure me nt
trait
trait
trait
Cpu.us e r
Cpu.nice
Cpu.nice
Cpu.s ys
Cpu.s ys
Cpu.idle
Cpu.idle
Cpu.wait
Cpu.wait
CpuTrait.ve ndor
CpuTrait.mode l
CpuTrait.mhz
CpuTrait.cache Siz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.3. Plat forms - HP-UX Plat form
Overview
25
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 1.31. Overview
De s cription:
Single ton:
Plugin:
He wle tt-Packard HP-UX Ope rating Sys te m
no
Platforms
Child Resource T ypes
Se ction 1.3.1, “Platforms - Proce s s Se rvice ”
Se ction 1.3.2, “Platforms - File Sys te m Se rvice ”
Se ction 1.3.3, “Platforms - Dire ctory Se rvice ”
Se ction 1.3.4, “Platforms - Ne twork Adapte r Se rvice ”
Se ction 1.3.5, “Platforms - CPU Se rvice ”
Connect ion Propert ies
none
Met rics
T able 1.32. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Me mory
me as ure me nt
Native .Me moryInfo.fr
ee
Actual Fre e Me mory
me as ure me nt
Us e d Me mory
me as ure me nt
Actual Us e d Me mory
me as ure me nt
Total Me mory
me as ure me nt
Fre e Swap Space
me as ure me nt
Us e d Swap Space
me as ure me nt
The total fre e
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total fre e
s ys te m me mory
(include s unallocate d
me mory as we ll as
available buffe r and
cache me mory)
The total us e d
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total us e d
s ys te m me mory
(include s buffe r and
cache me mory)
The total s ys te m
me mory
The total fre e
s ys te m s wap
The total us e d
s ys te m s wap
26
Native .Me moryInfo.a
ctualFre e
Native .Me moryInfo.u
sed
Native .Me moryInfo.a
ctualUs e d
Native .Me moryInfo.to
tal
Native .SwapInfo.fre e
Native .SwapInfo.us e
d
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Total Swap Space
me as ure me nt
Native .SwapInfo.total
Idle
me as ure me nt
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Hos tname
trait
OS Name
trait
OS Ve rs ion
trait
Archite cture
trait
The total s ys te m
s wap
Idle pe rce ntage of
all CPUs
Pe rce ntage of all
CPUs running in
s ys te m mode
Pe rce ntage of all
CPUs running in us e r
mode
Pe rce ntage of all
CPUs waiting on I/O
Name that this
platform is known as
Name that the
ope rating s ys te m is
known as
Ve rs ion of the
ope rating s ys te m
Hardware
archite cture of the
platform
CpuPe rc.idle
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
Trait.hos tname
Trait.os name
Trait.os ve rs ion
Trait.s ys arch
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 1.33. Met rics
Name
Descript io n
Run Autodis cove ry
Run an imme diate dis cove ry to s e arch for
ne w re s ource s
Vie w running proce s s e s on this s ys te m
Vie w Proce s s Lis t
Package T ypes
none
1.3.1. Plat f orms - Process Service
Overview
27
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 1.34. Overview
De s cription:
A ge ne ric proce s s monitoring s e rvice to
track native proce s s information bas e d on
a pid file or proce s s que ry
no
Platforms
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 1.35.
Name
Descript io n
Required
Int ernal Name
Type
Choice of us ing a pid
file or a PIQL que ry
to find the proce s s
to monitor
Fully qualifie d path
to the pid file for the
proce s s to monitor
Proce s s Information
Que ry Language for
proce s s to monitor
If true , the e ntire
proce s s tre e will be
monitore d
ye s
type
no
pidFile
no
piql
ye s
fullProce s s Tre e
Pid File
Piql
Full Proce s s Tre e
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.36. Met rics
Name
T ype
Descript io n
Int ernal Name
Us e r Time
me as ure me nt
Proce s s .cpu.us e r
Us e r Time pe r
Minute
me as ure me nt
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
28
Proce s s .cpu.us e r
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Ke rne l Time
me as ure me nt
Proce s s .cpu.s ys
Ke rne l Time pe r
Minute
me as ure me nt
CPU Pe rce ntage
me as ure me nt
Phys ical Me mory
me as ure me nt
Virtual Me mory
me as ure me nt
Ope n File
De s criptors
me as ure me nt
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The pe rce ntage of
CPU curre ntly be ing
us e d by all
proce s s e s
The aggre gate
amount of re s ide nt
me mory us e d by all
proce s s e s
The aggre gate
amount of virtual
me mory us e d by all
proce s s e s
The aggre gate
numbe r of file
de s criptors ope n by
all proce s s e s
Proce s s .cpu.s ys
Proce s s .cpu.pe rce nt
Proce s s .me mory.re s
ide nt
Proce s s .me mory.s iz
e
Proce s s .file De s cript
or.total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.3.2. Plat f orms - File Syst em Service
Overview
T able 1.37. Overview
De s cription:
Single ton:
no
29
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Plugin:
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.38. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Space
me as ure me nt
Us e d Pe rce ntage
me as ure me nt
Capacity
trait
Volume Type
trait
Drive Type
trait
file Sys te mUs age .fre
e
file Sys te mUs age .us
e Pe rce nt
file Sys te mUs age .tot
al
file Sys te m.type Nam
e
file Sys te m.s ys Type
Name
name
trait
Fre e File s
me as ure me nt
Flags
trait
Us e d
me as ure me nt
Dis k Re ads
me as ure me nt
Dis k Re ads pe r
Minute
Dis k Write s
me as ure me nt
Dis k Write s pe r
Minute
Dis k Re ad Byte s
me as ure me nt
Dis k Re ad Byte s pe r
Minute
me as ure me nt
Dis k Write Byte s
me as ure me nt
The total fre e byte s
on file s ys te m
The pe rce ntage of
dis k us e d
The total s iz e of the
file s ys te m
The file s ys te m's
ge ne ric type name
The file s ys te m's
ope rating s ys te ms pe cific type name
The name of this
de vice
The numbe r of fre e
file node s on the
file s ys te m
The file s ys te m's
flags
The total byte s us e d
on the file s ys te m
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
writte n
30
me as ure me nt
me as ure me nt
file Sys te m.de vName
file Sys te mUs age .fre
e File s
file Sys te m.flags
file Sys te mUs age .us
ed
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kWrite Byte s
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Dis k Write Byte s
pe r Minute
me as ure me nt
file Sys te mUs age .dis
kWrite Byte s
Dis k Que ue
me as ure me nt
The numbe r of
phys ical dis k byte s
writte n
The numbe r of I/Os
curre ntly in progre s s
file Sys te mUs age .dis
kQue ue
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.3.3. Plat f orms - Direct ory Service
Overview
T able 1.39. Overview
De s cription:
Monitor a ge ne ric dire ctory. This can be
he avy for a dire ctory with many s ubdire ctorie s , s o monitoring / is not allowe d.
no
Platforms
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 1.40 .
Name
Descript io n
Required
Int ernal Name
Path
Dire ctory to monitor.
/ is not allowe d.
ye s
path
31
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.41. Met rics
Name
T ype
Descript io n
Int ernal Name
Dire ctory us age
me as ure me nt
us age
Numbe r of file s
me as ure me nt
Numbe r of ite ms
me as ure me nt
Dis k us age of this
dire ctory
Numbe r of file s in
the dire ctory
Numbe r of ite ms in
the dire ctory (file s ,
s ubdirs , s ymlinks )
file s
total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.3.4. Plat f orms - Net work Adapt er Service
Overview
T able 1.42. Overview
De s cription:
Single ton:
Plugin:
Child Resource T ypes
none
32
no
Platforms
⁠C hapt e r 1. Manage d Plat f o r ms
Connect ion Propert ies
none
Met rics
T able 1.43. Met rics
Name
T ype
Descript io n
Int ernal Name
Ine t4Addre s s
trait
Trait.ne t4.addre s s
Inte rface Flags
trait
Byte s Re ce ive d
me as ure me nt
Byte s Re ce ive d pe r
Minute
me as ure me nt
Packe ts Re ce ive d
me as ure me nt
Packe ts Re ce ive d
pe r Minute
me as ure me nt
Byte s Trans mitte d
me as ure me nt
Byte s Trans mitte d
pe r Minute
me as ure me nt
Packe ts Trans mitte d
me as ure me nt
Packe ts Trans mitte d
pe r Minute
me as ure me nt
IP addre s s of the
ne twork adapte r
Flag cons tants for
ne twork re late d
ope rations
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
Trait.inte rface Flags
rxByte s
rxByte s
rxPacke ts
rxPacke ts
txByte s
txByte s
txPacke ts
txPacke ts
33
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Re ce ive Errors
me as ure me nt
rxErrors
Re ce ive Errors pe r
Minute
me as ure me nt
Re ce ive Packe ts
Droppe d
me as ure me nt
Re ce ive Packe ts
Droppe d pe r Minute
me as ure me nt
Re ce ive Ove rrurns
me as ure me nt
Re ce ive Ove rrurns
pe r Minute
me as ure me nt
Re ce ive Frame
me as ure me nt
Re ce ive Frame pe r
Minute
me as ure me nt
Trans mit Errors
me as ure me nt
Trans mit Errors pe r
Minute
me as ure me nt
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
34
rxErrors
rxDroppe d
rxDroppe d
rxOve rruns
rxOve rruns
rxFrame
rxFrame
txErrors
txErrors
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Trans mit Packe ts
Droppe d
me as ure me nt
txDroppe d
Trans mit Packe ts
Droppe d pe r Minute
me as ure me nt
Trans mit Ove rruns
me as ure me nt
Trans mit Ove rruns
pe r Minute
me as ure me nt
Trans mit Collis ions
me as ure me nt
Trans mit Collis ions
pe r Minute
me as ure me nt
Trans mit Carrie r
me as ure me nt
Trans mit Carrie r pe r
Minute
me as ure me nt
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
txDroppe d
txOve rruns
txOve rruns
txCollis ions
txCollis ions
txCarrie r
txCarrie r
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
35
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Package T ypes
none
1.3.5. Plat f orms - CPU Service
Overview
T able 1.44. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.45. Met rics
Name
T ype
Descript io n
Int ernal Name
Idle
me as ure me nt
CpuPe rc.idle
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Us e r Time
me as ure me nt
Us e r Time pe r
Minute
Nice Time
me as ure me nt
Nice Time pe r
Minute
Sys te m Time
me as ure me nt
Sys te m Time pe r
Minute
me as ure me nt
Idle pe rce ntage of
this CPU
Pe rce ntage of this
CPU running in
s ys te m mode
Pe rce ntage of this
CPU running in us e r
mode
Pe rce ntage of this
CPU waiting on I/O
The total s ys te m
CPU us e r time
The total s ys te m
CPU us e r time
The total s ys te m
CPU nice time
The total s ys te m
CPU nice time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU ke rne l time
36
me as ure me nt
me as ure me nt
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
Cpu.us e r
Cpu.us e r
Cpu.nice
Cpu.nice
Cpu.s ys
Cpu.s ys
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Idle Time
me as ure me nt
Cpu.idle
Idle Time pe r Minute
me as ure me nt
Wait Time
me as ure me nt
Wait Time pe r
Minute
Ve ndor
CPU Mode l
CPU Spe e d
me as ure me nt
Cache s iz e
trait
The total s ys te m
CPU idle time
The total s ys te m
CPU idle time
The total s ys te m
CPU I/O wait time
The total s ys te m
CPU I/O wait time
Ve ndor of this CPU
Mode l of this CPU
Spe e d of this CPU in
Mhz
Cache Siz e of this
CPU
trait
trait
trait
Cpu.idle
Cpu.wait
Cpu.wait
CpuTrait.ve ndor
CpuTrait.mode l
CpuTrait.mhz
CpuTrait.cache Siz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.4. Plat forms - Java Plat form
Overview
T able 1.46. Overview
De s cription:
Single ton:
Plugin:
Platform with 100% Java capability but not
native ly s upporte d
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
37
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Met rics
T able 1.47. Met rics
Name
T ype
Descript io n
Int ernal Name
Hos tname
trait
Trait.hos tname
OS Name
trait
OS Ve rs ion
trait
Archite cture
trait
Name that this
platform is known as
Name that the
ope rating s ys te m is
known as
Ve rs ion of the
ope rating s ys te m
Hardware
archite cture of the
platform
Trait.os name
Trait.os ve rs ion
Trait.s ys arch
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 1.48. Met rics
Name
Descript io n
Run Autodis cove ry
Run an imme diate dis cove ry to s e arch for
ne w re s ource s
Vie w running proce s s e s on this s ys te m
Vie w Proce s s Lis t
Package T ypes
none
1.5. Plat forms - Linux Plat form
Overview
T able 1.49. Overview
De s cription:
Single ton:
38
Linux Ope rating Sys te m
no
⁠C hapt e r 1. Manage d Plat f o r ms
Plugin:
Platforms
Child Resource T ypes
Se ction 1.5.1, “Platforms - Proce s s Se rvice ”
Se ction 1.5.2, “Platforms - File Sys te m Se rvice ”
Se ction 1.5.3, “Platforms - Dire ctory Se rvice ”
Se ction 1.5.4, “Platforms - Ne twork Adapte r Se rvice ”
Se ction 1.5.5, “Platforms - CPU Se rvice ”
Connect ion Propert ies
T able 1.50 .
Name
Descript io n
Required
Int ernal Name
Enable Conte nt
Dis cove ry
If true , atte mpts will
be made to dis cove r
ins talle d package s
on this platform
If true , an inte rnal
yum s e rve r will be
s tarte d in orde r to
proce s s yum
conte nt re que s ts
made on the local
machine .
The port the plugin
will lis te n on in orde r
to proce s s yum
re que s ts . This is
ignore d if the
inte rnal yum s e rve r
is not e nable d.
The time , in
s e conds , that the
package me tadata
will always be
cons ide re d valid.
Afte r the cache has
live d this long or
longe r, the cache
will be che cke d to
s e e if it is s tale , and
if s o, will be
re fre s he d.
ye s
e nable Conte ntDis co
ve ry
ye s
e nable Inte rnalYumS
e rve r
ye s
yumPort
no
me tadataCache Time
out
ye s
logs
Enable Inte rnal Yum
Se rve r
Yum s e rve r port
Me tadata Cache
Time out
Logs
39
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.51. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Me mory
me as ure me nt
Native .Me moryInfo.fr
ee
Actual Fre e Me mory
me as ure me nt
Us e d Me mory
me as ure me nt
Actual Us e d Me mory
me as ure me nt
Total Me mory
me as ure me nt
Fre e Swap Space
me as ure me nt
Us e d Swap Space
me as ure me nt
Total Swap Space
me as ure me nt
Idle
me as ure me nt
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Hos tname
trait
The total fre e
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total fre e
s ys te m me mory
(include s unallocate d
me mory as we ll as
available buffe r and
cache me mory)
The total us e d
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total us e d
s ys te m me mory
(include s buffe r and
cache me mory)
The total s ys te m
me mory
The total fre e
s ys te m s wap
The total us e d
s ys te m s wap
The total s ys te m
s wap
Idle pe rce ntage of
all CPUs
Pe rce ntage of all
CPUs running in
s ys te m mode
Pe rce ntage of all
CPUs running in us e r
mode
Pe rce ntage of all
CPUs waiting on I/O
Name that this
platform is known as
40
Native .Me moryInfo.a
ctualFre e
Native .Me moryInfo.u
sed
Native .Me moryInfo.a
ctualUs e d
Native .Me moryInfo.to
tal
Native .SwapInfo.fre e
Native .SwapInfo.us e
d
Native .SwapInfo.total
CpuPe rc.idle
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
Trait.hos tname
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
OS Name
trait
Trait.os name
OS Ve rs ion
trait
Archite cture
trait
Dis tribution Name
trait
Dis tribution Ve rs ion
trait
Name that the
ope rating s ys te m is
known as
Ve rs ion of the
ope rating s ys te m
Hardware
archite cture of the
platform
name of the Linux
dis tribution
ve rs ion of the Linux
dis tribution
Trait.os ve rs ion
Trait.s ys arch
dis tro.name
dis tro.ve rs ion
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 1.52. Met rics
Name
Descript io n
Run Autodis cove ry
Run an imme diate dis cove ry to s e arch for
ne w re s ource s
Vie w running proce s s e s on this s ys te m
De le te s all cache d package me tadata
Vie w Proce s s Lis t
Cle an Yum Me tadata Cache
Package T ypes
T able 1.53. Package T ypes
Name
Cat ego ry
Descript io n
RPM File
De ployable
Re d Hat ins tallable package
1.5.1. Plat f orms - Process Service
Overview
T able 1.54. Overview
De s cription:
A ge ne ric proce s s monitoring s e rvice to
track native proce s s information bas e d on
a pid file or proce s s que ry
41
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
T able 1.55.
Name
Descript io n
Required
Int ernal Name
Type
Choice of us ing a pid
file or a PIQL que ry
to find the proce s s
to monitor
Fully qualifie d path
to the pid file for the
proce s s to monitor
Proce s s Information
Que ry Language for
proce s s to monitor
If true , the e ntire
proce s s tre e will be
monitore d
ye s
type
no
pidFile
no
piql
ye s
fullProce s s Tre e
Pid File
Piql
Full Proce s s Tre e
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.56. Met rics
Name
T ype
Descript io n
Int ernal Name
Us e r Time
me as ure me nt
Proce s s .cpu.us e r
Us e r Time pe r
Minute
me as ure me nt
Ke rne l Time
me as ure me nt
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
42
Proce s s .cpu.us e r
Proce s s .cpu.s ys
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Ke rne l Time pe r
Minute
me as ure me nt
Proce s s .cpu.s ys
CPU Pe rce ntage
me as ure me nt
Phys ical Me mory
me as ure me nt
Virtual Me mory
me as ure me nt
Ope n File
De s criptors
me as ure me nt
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The pe rce ntage of
CPU curre ntly be ing
us e d by all
proce s s e s
The aggre gate
amount of re s ide nt
me mory us e d by all
proce s s e s
The aggre gate
amount of virtual
me mory us e d by all
proce s s e s
The aggre gate
numbe r of file
de s criptors ope n by
all proce s s e s
Proce s s .cpu.pe rce nt
Proce s s .me mory.re s
ide nt
Proce s s .me mory.s iz
e
Proce s s .file De s cript
or.total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.5.2. Plat f orms - File Syst em Service
Overview
T able 1.57. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
43
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Connect ion Propert ies
none
Met rics
T able 1.58. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Space
me as ure me nt
Us e d Pe rce ntage
me as ure me nt
Capacity
trait
Volume Type
trait
Drive Type
trait
file Sys te mUs age .fre
e
file Sys te mUs age .us
e Pe rce nt
file Sys te mUs age .tot
al
file Sys te m.type Nam
e
file Sys te m.s ys Type
Name
name
trait
Fre e File s
me as ure me nt
Flags
trait
Us e d
me as ure me nt
Dis k Re ads
me as ure me nt
Dis k Re ads pe r
Minute
Dis k Write s
me as ure me nt
Dis k Write s pe r
Minute
Dis k Re ad Byte s
me as ure me nt
Dis k Re ad Byte s pe r
Minute
me as ure me nt
Dis k Write Byte s
me as ure me nt
Dis k Write Byte s
pe r Minute
me as ure me nt
Dis k Que ue
me as ure me nt
The total fre e byte s
on file s ys te m
The pe rce ntage of
dis k us e d
The total s iz e of the
file s ys te m
The file s ys te m's
ge ne ric type name
The file s ys te m's
ope rating s ys te ms pe cific type name
The name of this
de vice
The numbe r of fre e
file node s on the
file s ys te m
The file s ys te m's
flags
The total byte s us e d
on the file s ys te m
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
writte n
The numbe r of
phys ical dis k byte s
writte n
The numbe r of I/Os
curre ntly in progre s s
44
me as ure me nt
me as ure me nt
file Sys te m.de vName
file Sys te mUs age .fre
e File s
file Sys te m.flags
file Sys te mUs age .us
ed
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kQue ue
⁠C hapt e r 1. Manage d Plat f o r ms
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.5.3. Plat f orms - Direct ory Service
Overview
T able 1.59. Overview
De s cription:
Monitor a ge ne ric dire ctory. This can be
he avy for a dire ctory with many s ubdire ctorie s , s o monitoring / is not allowe d.
no
Platforms
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 1.60 .
Name
Descript io n
Required
Int ernal Name
Path
Dire ctory to monitor.
/ is not allowe d.
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
45
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 1.61. Met rics
Name
T ype
Descript io n
Int ernal Name
Dire ctory us age
me as ure me nt
us age
Numbe r of file s
me as ure me nt
Numbe r of ite ms
me as ure me nt
Dis k us age of this
dire ctory
Numbe r of file s in
the dire ctory
Numbe r of ite ms in
the dire ctory (file s ,
s ubdirs , s ymlinks )
file s
total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.5.4. Plat f orms - Net work Adapt er Service
Overview
T able 1.62. Overview
De s cription:
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.63. Met rics
46
no
Platforms
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Ine t4Addre s s
trait
Trait.ne t4.addre s s
Inte rface Flags
trait
Byte s Re ce ive d
me as ure me nt
Byte s Re ce ive d pe r
Minute
me as ure me nt
Packe ts Re ce ive d
me as ure me nt
Packe ts Re ce ive d
pe r Minute
me as ure me nt
Byte s Trans mitte d
me as ure me nt
Byte s Trans mitte d
pe r Minute
me as ure me nt
Packe ts Trans mitte d
me as ure me nt
Packe ts Trans mitte d
pe r Minute
me as ure me nt
Re ce ive Errors
me as ure me nt
IP addre s s of the
ne twork adapte r
Flag cons tants for
ne twork re late d
ope rations
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
Trait.inte rface Flags
rxByte s
rxByte s
rxPacke ts
rxPacke ts
txByte s
txByte s
txPacke ts
txPacke ts
rxErrors
47
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Re ce ive Errors pe r
Minute
me as ure me nt
rxErrors
Re ce ive Packe ts
Droppe d
me as ure me nt
Re ce ive Packe ts
Droppe d pe r Minute
me as ure me nt
Re ce ive Ove rrurns
me as ure me nt
Re ce ive Ove rrurns
pe r Minute
me as ure me nt
Re ce ive Frame
me as ure me nt
Re ce ive Frame pe r
Minute
me as ure me nt
Trans mit Errors
me as ure me nt
Trans mit Errors pe r
Minute
me as ure me nt
Trans mit Packe ts
Droppe d
me as ure me nt
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
48
rxDroppe d
rxDroppe d
rxOve rruns
rxOve rruns
rxFrame
rxFrame
txErrors
txErrors
txDroppe d
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Trans mit Packe ts
Droppe d pe r Minute
me as ure me nt
txDroppe d
Trans mit Ove rruns
me as ure me nt
Trans mit Ove rruns
pe r Minute
me as ure me nt
Trans mit Collis ions
me as ure me nt
Trans mit Collis ions
pe r Minute
me as ure me nt
Trans mit Carrie r
me as ure me nt
Trans mit Carrie r pe r
Minute
me as ure me nt
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
txOve rruns
txOve rruns
txCollis ions
txCollis ions
txCarrie r
txCarrie r
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
49
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
1.5.5. Plat f orms - CPU Service
Overview
T able 1.64. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.65. Met rics
Name
T ype
Descript io n
Int ernal Name
Idle
me as ure me nt
CpuPe rc.idle
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Us e r Time
me as ure me nt
Us e r Time pe r
Minute
Nice Time
me as ure me nt
Nice Time pe r
Minute
Sys te m Time
me as ure me nt
Sys te m Time pe r
Minute
Idle Time
me as ure me nt
Idle Time pe r Minute
me as ure me nt
Idle pe rce ntage of
this CPU
Pe rce ntage of this
CPU running in
s ys te m mode
Pe rce ntage of this
CPU running in us e r
mode
Pe rce ntage of this
CPU waiting on I/O
The total s ys te m
CPU us e r time
The total s ys te m
CPU us e r time
The total s ys te m
CPU nice time
The total s ys te m
CPU nice time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU idle time
The total s ys te m
CPU idle time
50
me as ure me nt
me as ure me nt
me as ure me nt
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
Cpu.us e r
Cpu.us e r
Cpu.nice
Cpu.nice
Cpu.s ys
Cpu.s ys
Cpu.idle
Cpu.idle
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Wait Time
me as ure me nt
Cpu.wait
Wait Time pe r
Minute
Ve ndor
CPU Mode l
CPU Spe e d
me as ure me nt
Cache s iz e
trait
The total s ys te m
CPU I/O wait time
The total s ys te m
CPU I/O wait time
Ve ndor of this CPU
Mode l of this CPU
Spe e d of this CPU in
Mhz
Cache Siz e of this
CPU
trait
trait
trait
Cpu.wait
CpuTrait.ve ndor
CpuTrait.mode l
CpuTrait.mhz
CpuTrait.cache Siz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.6. Plat forms - Mac OS X Plat form
Overview
T able 1.66. Overview
De s cription:
Single ton:
Plugin:
Mac OS X Ope rating Sys te m
no
Platforms
Child Resource T ypes
Se ction 1.6.1, “Platforms - Proce s s Se rvice ”
Se ction 1.6.2, “Platforms - File Sys te m Se rvice ”
Se ction 1.6.3, “Platforms - Dire ctory Se rvice ”
Se ction 1.6.4, “Platforms - Ne twork Adapte r Se rvice ”
Se ction 1.6.5, “Platforms - CPU Se rvice ”
51
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Connect ion Propert ies
T able 1.67.
Name
Descript io n
Logs
Required
Int ernal Name
ye s
logs
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.68. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Me mory
me as ure me nt
Native .Me moryInfo.fr
ee
Actual Fre e Me mory
me as ure me nt
Us e d Me mory
me as ure me nt
Actual Us e d Me mory
me as ure me nt
Total Me mory
me as ure me nt
Fre e Swap Space
me as ure me nt
Us e d Swap Space
me as ure me nt
Total Swap Space
me as ure me nt
Idle
me as ure me nt
Sys te m Load
me as ure me nt
The total fre e
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total fre e
s ys te m me mory
(include s unallocate d
me mory as we ll as
available buffe r and
cache me mory)
The total us e d
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total us e d
s ys te m me mory
(include s buffe r and
cache me mory)
The total s ys te m
me mory
The total fre e
s ys te m s wap
The total us e d
s ys te m s wap
The total s ys te m
s wap
Idle pe rce ntage of
all CPUs
Pe rce ntage of all
CPUs running in
s ys te m mode
52
Native .Me moryInfo.a
ctualFre e
Native .Me moryInfo.u
sed
Native .Me moryInfo.a
ctualUs e d
Native .Me moryInfo.to
tal
Native .SwapInfo.fre e
Native .SwapInfo.us e
d
Native .SwapInfo.total
CpuPe rc.idle
CpuPe rc.s ys
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Us e r Load
me as ure me nt
CpuPe rc.us e r
Wait Load
me as ure me nt
Hos tname
trait
OS Name
trait
OS Ve rs ion
trait
Archite cture
trait
Pe rce ntage of all
CPUs running in us e r
mode
Pe rce ntage of all
CPUs waiting on I/O
Name that this
platform is known as
Name that the
ope rating s ys te m is
known as
Ve rs ion of the
ope rating s ys te m
Hardware
archite cture of the
platform
CpuPe rc.wait
Trait.hos tname
Trait.os name
Trait.os ve rs ion
Trait.s ys arch
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 1.69. Met rics
Name
Descript io n
Run Autodis cove ry
Run an imme diate dis cove ry to s e arch for
ne w re s ource s
Vie w running proce s s e s on this s ys te m
Vie w Proce s s Lis t
Package T ypes
none
1.6.1. Plat f orms - Process Service
Overview
T able 1.70 . Overview
De s cription:
Single ton:
A ge ne ric proce s s monitoring s e rvice to
track native proce s s information bas e d on
a pid file or proce s s que ry
no
53
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Plugin:
Platforms
Child Resource T ypes
none
Connect ion Propert ies
T able 1.71.
Name
Descript io n
Required
Int ernal Name
Type
Choice of us ing a pid
file or a PIQL que ry
to find the proce s s
to monitor
Fully qualifie d path
to the pid file for the
proce s s to monitor
Proce s s Information
Que ry Language for
proce s s to monitor
If true , the e ntire
proce s s tre e will be
monitore d
ye s
type
no
pidFile
no
piql
ye s
fullProce s s Tre e
Pid File
Piql
Full Proce s s Tre e
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.72. Met rics
Name
T ype
Descript io n
Int ernal Name
Us e r Time
me as ure me nt
Proce s s .cpu.us e r
Us e r Time pe r
Minute
me as ure me nt
Ke rne l Time
me as ure me nt
Ke rne l Time pe r
Minute
me as ure me nt
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
54
Proce s s .cpu.us e r
Proce s s .cpu.s ys
Proce s s .cpu.s ys
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
CPU Pe rce ntage
me as ure me nt
Proce s s .cpu.pe rce nt
Phys ical Me mory
me as ure me nt
Virtual Me mory
me as ure me nt
Ope n File
De s criptors
me as ure me nt
The pe rce ntage of
CPU curre ntly be ing
us e d by all
proce s s e s
The aggre gate
amount of re s ide nt
me mory us e d by all
proce s s e s
The aggre gate
amount of virtual
me mory us e d by all
proce s s e s
The aggre gate
numbe r of file
de s criptors ope n by
all proce s s e s
Proce s s .me mory.re s
ide nt
Proce s s .me mory.s iz
e
Proce s s .file De s cript
or.total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.6.2. Plat f orms - File Syst em Service
Overview
T able 1.73. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
55
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Met rics
T able 1.74. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Space
me as ure me nt
Us e d Pe rce ntage
me as ure me nt
Capacity
trait
Volume Type
trait
Drive Type
trait
file Sys te mUs age .fre
e
file Sys te mUs age .us
e Pe rce nt
file Sys te mUs age .tot
al
file Sys te m.type Nam
e
file Sys te m.s ys Type
Name
name
trait
Fre e File s
me as ure me nt
Flags
trait
Us e d
me as ure me nt
Dis k Re ads
me as ure me nt
Dis k Re ads pe r
Minute
Dis k Write s
me as ure me nt
Dis k Write s pe r
Minute
Dis k Re ad Byte s
me as ure me nt
Dis k Re ad Byte s pe r
Minute
me as ure me nt
Dis k Write Byte s
me as ure me nt
Dis k Write Byte s
pe r Minute
me as ure me nt
Dis k Que ue
me as ure me nt
The total fre e byte s
on file s ys te m
The pe rce ntage of
dis k us e d
The total s iz e of the
file s ys te m
The file s ys te m's
ge ne ric type name
The file s ys te m's
ope rating s ys te ms pe cific type name
The name of this
de vice
The numbe r of fre e
file node s on the
file s ys te m
The file s ys te m's
flags
The total byte s us e d
on the file s ys te m
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
writte n
The numbe r of
phys ical dis k byte s
writte n
The numbe r of I/Os
curre ntly in progre s s
56
me as ure me nt
me as ure me nt
file Sys te m.de vName
file Sys te mUs age .fre
e File s
file Sys te m.flags
file Sys te mUs age .us
ed
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kQue ue
⁠C hapt e r 1. Manage d Plat f o r ms
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.6.3. Plat f orms - Direct ory Service
Overview
T able 1.75. Overview
De s cription:
Monitor a ge ne ric dire ctory. This can be
he avy for a dire ctory with many s ubdire ctorie s , s o monitoring / is not allowe d.
no
Platforms
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 1.76.
Name
Descript io n
Required
Int ernal Name
Path
Dire ctory to monitor.
/ is not allowe d.
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
57
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 1.77. Met rics
Name
T ype
Descript io n
Int ernal Name
Dire ctory us age
me as ure me nt
us age
Numbe r of file s
me as ure me nt
Numbe r of ite ms
me as ure me nt
Dis k us age of this
dire ctory
Numbe r of file s in
the dire ctory
Numbe r of ite ms in
the dire ctory (file s ,
s ubdirs , s ymlinks )
file s
total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.6.4. Plat f orms - Net work Adapt er Service
Overview
T able 1.78. Overview
De s cription:
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.79. Met rics
58
no
Platforms
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Ine t4Addre s s
trait
Trait.ne t4.addre s s
Inte rface Flags
trait
Byte s Re ce ive d
me as ure me nt
Byte s Re ce ive d pe r
Minute
me as ure me nt
Packe ts Re ce ive d
me as ure me nt
Packe ts Re ce ive d
pe r Minute
me as ure me nt
Byte s Trans mitte d
me as ure me nt
Byte s Trans mitte d
pe r Minute
me as ure me nt
Packe ts Trans mitte d
me as ure me nt
Packe ts Trans mitte d
pe r Minute
me as ure me nt
Re ce ive Errors
me as ure me nt
IP addre s s of the
ne twork adapte r
Flag cons tants for
ne twork re late d
ope rations
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
Trait.inte rface Flags
rxByte s
rxByte s
rxPacke ts
rxPacke ts
txByte s
txByte s
txPacke ts
txPacke ts
rxErrors
59
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Re ce ive Errors pe r
Minute
me as ure me nt
rxErrors
Re ce ive Packe ts
Droppe d
me as ure me nt
Re ce ive Packe ts
Droppe d pe r Minute
me as ure me nt
Re ce ive Ove rrurns
me as ure me nt
Re ce ive Ove rrurns
pe r Minute
me as ure me nt
Re ce ive Frame
me as ure me nt
Re ce ive Frame pe r
Minute
me as ure me nt
Trans mit Errors
me as ure me nt
Trans mit Errors pe r
Minute
me as ure me nt
Trans mit Packe ts
Droppe d
me as ure me nt
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
60
rxDroppe d
rxDroppe d
rxOve rruns
rxOve rruns
rxFrame
rxFrame
txErrors
txErrors
txDroppe d
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Trans mit Packe ts
Droppe d pe r Minute
me as ure me nt
txDroppe d
Trans mit Ove rruns
me as ure me nt
Trans mit Ove rruns
pe r Minute
me as ure me nt
Trans mit Collis ions
me as ure me nt
Trans mit Collis ions
pe r Minute
me as ure me nt
Trans mit Carrie r
me as ure me nt
Trans mit Carrie r pe r
Minute
me as ure me nt
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
txOve rruns
txOve rruns
txCollis ions
txCollis ions
txCarrie r
txCarrie r
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
61
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
1.6.5. Plat f orms - CPU Service
Overview
T able 1.80 . Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.81. Met rics
Name
T ype
Descript io n
Int ernal Name
Idle
me as ure me nt
CpuPe rc.idle
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Us e r Time
me as ure me nt
Us e r Time pe r
Minute
Nice Time
me as ure me nt
Nice Time pe r
Minute
Sys te m Time
me as ure me nt
Sys te m Time pe r
Minute
Idle Time
me as ure me nt
Idle Time pe r Minute
me as ure me nt
Idle pe rce ntage of
this CPU
Pe rce ntage of this
CPU running in
s ys te m mode
Pe rce ntage of this
CPU running in us e r
mode
Pe rce ntage of this
CPU waiting on I/O
The total s ys te m
CPU us e r time
The total s ys te m
CPU us e r time
The total s ys te m
CPU nice time
The total s ys te m
CPU nice time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU idle time
The total s ys te m
CPU idle time
62
me as ure me nt
me as ure me nt
me as ure me nt
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
Cpu.us e r
Cpu.us e r
Cpu.nice
Cpu.nice
Cpu.s ys
Cpu.s ys
Cpu.idle
Cpu.idle
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Wait Time
me as ure me nt
Cpu.wait
Wait Time pe r
Minute
Ve ndor
CPU Mode l
CPU Spe e d
me as ure me nt
Cache s iz e
trait
The total s ys te m
CPU I/O wait time
The total s ys te m
CPU I/O wait time
Ve ndor of this CPU
Mode l of this CPU
Spe e d of this CPU in
Mhz
Cache Siz e of this
CPU
trait
trait
trait
Cpu.wait
CpuTrait.ve ndor
CpuTrait.mode l
CpuTrait.mhz
CpuTrait.cache Siz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.7. Plat forms - Solaris Plat form
Overview
T able 1.82. Overview
De s cription:
Single ton:
Plugin:
SUN Solaris Ope rating Sys te m
no
Platforms
Child Resource T ypes
Se ction 1.7.1, “Platforms - Proce s s Se rvice ”
Se ction 1.7.2, “Platforms - File Sys te m Se rvice ”
Se ction 1.7.3, “Platforms - Dire ctory Se rvice ”
Se ction 1.7.4, “Platforms - Ne twork Adapte r Se rvice ”
Se ction 1.7.5, “Platforms - CPU Se rvice ”
63
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Connect ion Propert ies
T able 1.83.
Name
Descript io n
Logs
Required
Int ernal Name
ye s
logs
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.84. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Me mory
me as ure me nt
Native .Me moryInfo.fr
ee
Actual Fre e Me mory
me as ure me nt
Us e d Me mory
me as ure me nt
Actual Us e d Me mory
me as ure me nt
Total Me mory
me as ure me nt
Fre e Swap Space
me as ure me nt
Us e d Swap Space
me as ure me nt
Total Swap Space
me as ure me nt
Idle
me as ure me nt
Sys te m Load
me as ure me nt
The total fre e
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total fre e
s ys te m me mory
(include s unallocate d
me mory as we ll as
available buffe r and
cache me mory)
The total us e d
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total us e d
s ys te m me mory
(include s buffe r and
cache me mory)
The total s ys te m
me mory
The total fre e
s ys te m s wap
The total us e d
s ys te m s wap
The total s ys te m
s wap
Idle pe rce ntage of
all CPUs
Pe rce ntage of all
CPUs running in
s ys te m mode
64
Native .Me moryInfo.a
ctualFre e
Native .Me moryInfo.u
sed
Native .Me moryInfo.a
ctualUs e d
Native .Me moryInfo.to
tal
Native .SwapInfo.fre e
Native .SwapInfo.us e
d
Native .SwapInfo.total
CpuPe rc.idle
CpuPe rc.s ys
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Us e r Load
me as ure me nt
CpuPe rc.us e r
Wait Load
me as ure me nt
Hos tname
trait
OS Name
trait
OS Ve rs ion
trait
Archite cture
trait
Pe rce ntage of all
CPUs running in us e r
mode
Pe rce ntage of all
CPUs waiting on I/O
Name that this
platform is known as
Name that the
ope rating s ys te m is
known as
Ve rs ion of the
ope rating s ys te m
Hardware
archite cture of the
platform
CpuPe rc.wait
Trait.hos tname
Trait.os name
Trait.os ve rs ion
Trait.s ys arch
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 1.85. Met rics
Name
Descript io n
Run Autodis cove ry
Run an imme diate dis cove ry to s e arch for
ne w re s ource s
Vie w running proce s s e s on this s ys te m
Vie w Proce s s Lis t
Package T ypes
none
1.7.1. Plat f orms - Process Service
Overview
T able 1.86. Overview
De s cription:
Single ton:
A ge ne ric proce s s monitoring s e rvice to
track native proce s s information bas e d on
a pid file or proce s s que ry
no
65
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Plugin:
Platforms
Child Resource T ypes
none
Connect ion Propert ies
T able 1.87.
Name
Descript io n
Required
Int ernal Name
Type
Choice of us ing a pid
file or a PIQL que ry
to find the proce s s
to monitor
Fully qualifie d path
to the pid file for the
proce s s to monitor
Proce s s Information
Que ry Language for
proce s s to monitor
If true , the e ntire
proce s s tre e will be
monitore d
ye s
type
no
pidFile
no
piql
ye s
fullProce s s Tre e
Pid File
Piql
Full Proce s s Tre e
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.88. Met rics
Name
T ype
Descript io n
Int ernal Name
Us e r Time
me as ure me nt
Proce s s .cpu.us e r
Us e r Time pe r
Minute
me as ure me nt
Ke rne l Time
me as ure me nt
Ke rne l Time pe r
Minute
me as ure me nt
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
66
Proce s s .cpu.us e r
Proce s s .cpu.s ys
Proce s s .cpu.s ys
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
CPU Pe rce ntage
me as ure me nt
Proce s s .cpu.pe rce nt
Phys ical Me mory
me as ure me nt
Virtual Me mory
me as ure me nt
Ope n File
De s criptors
me as ure me nt
The pe rce ntage of
CPU curre ntly be ing
us e d by all
proce s s e s
The aggre gate
amount of re s ide nt
me mory us e d by all
proce s s e s
The aggre gate
amount of virtual
me mory us e d by all
proce s s e s
The aggre gate
numbe r of file
de s criptors ope n by
all proce s s e s
Proce s s .me mory.re s
ide nt
Proce s s .me mory.s iz
e
Proce s s .file De s cript
or.total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.7.2. Plat f orms - File Syst em Service
Overview
T able 1.89. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
67
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Met rics
T able 1.90 . Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Space
me as ure me nt
Us e d Pe rce ntage
me as ure me nt
Capacity
trait
Volume Type
trait
Drive Type
trait
file Sys te mUs age .fre
e
file Sys te mUs age .us
e Pe rce nt
file Sys te mUs age .tot
al
file Sys te m.type Nam
e
file Sys te m.s ys Type
Name
name
trait
Fre e File s
me as ure me nt
Flags
trait
Us e d
me as ure me nt
Dis k Re ads
me as ure me nt
Dis k Re ads pe r
Minute
Dis k Write s
me as ure me nt
Dis k Write s pe r
Minute
Dis k Re ad Byte s
me as ure me nt
Dis k Re ad Byte s pe r
Minute
me as ure me nt
Dis k Write Byte s
me as ure me nt
Dis k Write Byte s
pe r Minute
me as ure me nt
Dis k Que ue
me as ure me nt
The total fre e byte s
on file s ys te m
The pe rce ntage of
dis k us e d
The total s iz e of the
file s ys te m
The file s ys te m's
ge ne ric type name
The file s ys te m's
ope rating s ys te ms pe cific type name
The name of this
de vice
The numbe r of fre e
file node s on the
file s ys te m
The file s ys te m's
flags
The total byte s us e d
on the file s ys te m
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
writte n
The numbe r of
phys ical dis k byte s
writte n
The numbe r of I/Os
curre ntly in progre s s
68
me as ure me nt
me as ure me nt
file Sys te m.de vName
file Sys te mUs age .fre
e File s
file Sys te m.flags
file Sys te mUs age .us
ed
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kQue ue
⁠C hapt e r 1. Manage d Plat f o r ms
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.7.3. Plat f orms - Direct ory Service
Overview
T able 1.91. Overview
De s cription:
Monitor a ge ne ric dire ctory. This can be
he avy for a dire ctory with many s ubdire ctorie s , s o monitoring / is not allowe d.
no
Platforms
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 1.92.
Name
Descript io n
Required
Int ernal Name
Path
Dire ctory to monitor.
/ is not allowe d.
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
69
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 1.93. Met rics
Name
T ype
Descript io n
Int ernal Name
Dire ctory us age
me as ure me nt
us age
Numbe r of file s
me as ure me nt
Numbe r of ite ms
me as ure me nt
Dis k us age of this
dire ctory
Numbe r of file s in
the dire ctory
Numbe r of ite ms in
the dire ctory (file s ,
s ubdirs , s ymlinks )
file s
total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.7.4. Plat f orms - Net work Adapt er Service
Overview
T able 1.94. Overview
De s cription:
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.95. Met rics
70
no
Platforms
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Ine t4Addre s s
trait
Trait.ne t4.addre s s
Inte rface Flags
trait
Byte s Re ce ive d
me as ure me nt
Byte s Re ce ive d pe r
Minute
me as ure me nt
Packe ts Re ce ive d
me as ure me nt
Packe ts Re ce ive d
pe r Minute
me as ure me nt
Byte s Trans mitte d
me as ure me nt
Byte s Trans mitte d
pe r Minute
me as ure me nt
Packe ts Trans mitte d
me as ure me nt
Packe ts Trans mitte d
pe r Minute
me as ure me nt
Re ce ive Errors
me as ure me nt
IP addre s s of the
ne twork adapte r
Flag cons tants for
ne twork re late d
ope rations
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
Trait.inte rface Flags
rxByte s
rxByte s
rxPacke ts
rxPacke ts
txByte s
txByte s
txPacke ts
txPacke ts
rxErrors
71
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Re ce ive Errors pe r
Minute
me as ure me nt
rxErrors
Re ce ive Packe ts
Droppe d
me as ure me nt
Re ce ive Packe ts
Droppe d pe r Minute
me as ure me nt
Re ce ive Ove rrurns
me as ure me nt
Re ce ive Ove rrurns
pe r Minute
me as ure me nt
Re ce ive Frame
me as ure me nt
Re ce ive Frame pe r
Minute
me as ure me nt
Trans mit Errors
me as ure me nt
Trans mit Errors pe r
Minute
me as ure me nt
Trans mit Packe ts
Droppe d
me as ure me nt
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
72
rxDroppe d
rxDroppe d
rxOve rruns
rxOve rruns
rxFrame
rxFrame
txErrors
txErrors
txDroppe d
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Trans mit Packe ts
Droppe d pe r Minute
me as ure me nt
txDroppe d
Trans mit Ove rruns
me as ure me nt
Trans mit Ove rruns
pe r Minute
me as ure me nt
Trans mit Collis ions
me as ure me nt
Trans mit Collis ions
pe r Minute
me as ure me nt
Trans mit Carrie r
me as ure me nt
Trans mit Carrie r pe r
Minute
me as ure me nt
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
txOve rruns
txOve rruns
txCollis ions
txCollis ions
txCarrie r
txCarrie r
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
73
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
1.7.5. Plat f orms - CPU Service
Overview
T able 1.96. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.97. Met rics
Name
T ype
Descript io n
Int ernal Name
Idle
me as ure me nt
CpuPe rc.idle
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Us e r Time
me as ure me nt
Us e r Time pe r
Minute
Nice Time
me as ure me nt
Nice Time pe r
Minute
Sys te m Time
me as ure me nt
Sys te m Time pe r
Minute
Idle Time
me as ure me nt
Idle Time pe r Minute
me as ure me nt
Idle pe rce ntage of
this CPU
Pe rce ntage of this
CPU running in
s ys te m mode
Pe rce ntage of this
CPU running in us e r
mode
Pe rce ntage of this
CPU waiting on I/O
The total s ys te m
CPU us e r time
The total s ys te m
CPU us e r time
The total s ys te m
CPU nice time
The total s ys te m
CPU nice time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU idle time
The total s ys te m
CPU idle time
74
me as ure me nt
me as ure me nt
me as ure me nt
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
Cpu.us e r
Cpu.us e r
Cpu.nice
Cpu.nice
Cpu.s ys
Cpu.s ys
Cpu.idle
Cpu.idle
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Wait Time
me as ure me nt
Cpu.wait
Wait Time pe r
Minute
Ve ndor
CPU Mode l
CPU Spe e d
me as ure me nt
Cache s iz e
trait
The total s ys te m
CPU I/O wait time
The total s ys te m
CPU I/O wait time
Ve ndor of this CPU
Mode l of this CPU
Spe e d of this CPU in
Mhz
Cache Siz e of this
CPU
trait
trait
trait
Cpu.wait
CpuTrait.ve ndor
CpuTrait.mode l
CpuTrait.mhz
CpuTrait.cache Siz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.8. Plat forms - Windows Plat form
Overview
T able 1.98. Overview
De s cription:
Single ton:
Plugin:
Micros oft Windows Ope rating Sys te m
no
Platforms
Child Resource T ypes
Se ction 1.8.1, “Platforms - Proce s s Se rvice ”
Se ction 1.8.2, “Platforms - File Sys te m Se rvice ”
Se ction 1.8.3, “Platforms - Ne twork Adapte r Se rvice ”
Se ction 1.8.4, “Platforms - CPU Se rvice ”
Connect ion Propert ies
75
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 1.99.
Name
Descript io n
Required
Int ernal Name
Enable Conte nt
Dis cove ry
If true , atte mpts will
be made to dis cove r
ins talle d package s
on this platform
Enable s the
colle ction of
Windows e ve nts into
the e ve nt
s ubs ys te m
A re gular
e xpre s s ion that if
not-null mus t be
matche d by the
e ve nt de tail for the
me s s age to be
acce pte d
The minimum
s e ve rity e ve nt that
will be colle cte d
ye s
e nable Conte ntDis co
ve ry
ye s
e ve ntTrackingEnable
d
no
re gularExpre s s ion
ye s
minimumSe ve rity
Eve nt Tracking
Enable d
Re gular Expre s s ion
Minimum Se ve rity
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 1.10 0 . Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Me mory
me as ure me nt
Native .Me moryInfo.fr
ee
Actual Fre e Me mory
me as ure me nt
Us e d Me mory
me as ure me nt
The total fre e
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
The actual total fre e
s ys te m me mory
(include s unallocate d
me mory as we ll as
available buffe r and
cache me mory)
The total us e d
s ys te m me mory
(doe s not include
buffe r or cache
me mory)
76
Native .Me moryInfo.a
ctualFre e
Native .Me moryInfo.u
sed
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Actual Us e d Me mory
me as ure me nt
Native .Me moryInfo.a
ctualUs e d
Total Me mory
me as ure me nt
Fre e Swap Space
me as ure me nt
Us e d Swap Space
me as ure me nt
Total Swap Space
me as ure me nt
Idle
me as ure me nt
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Hos tname
trait
OS Name
trait
OS Ve rs ion
trait
Archite cture
trait
The actual total us e d
s ys te m me mory
(include s buffe r and
cache me mory)
The total s ys te m
me mory
The total fre e
s ys te m s wap
The total us e d
s ys te m s wap
The total s ys te m
s wap
Idle pe rce ntage of
all CPUs
Pe rce ntage of all
CPUs running in
s ys te m mode
Pe rce ntage of all
CPUs running in us e r
mode
Pe rce ntage of all
CPUs waiting on I/O
Name that this
platform is known as
Name that the
ope rating s ys te m is
known as
Ve rs ion of the
ope rating s ys te m
Hardware
archite cture of the
platform
Native .Me moryInfo.to
tal
Native .SwapInfo.fre e
Native .SwapInfo.us e
d
Native .SwapInfo.total
CpuPe rc.idle
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
Trait.hos tname
Trait.os name
Trait.os ve rs ion
Trait.s ys arch
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 1.10 1. Met rics
Name
Descript io n
Run Autodis cove ry
Run an imme diate dis cove ry to s e arch for
ne w re s ource s
77
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Vie w Proce s s Lis t
Vie w running proce s s e s on this s ys te m
Package T ypes
T able 1.10 2. Package T ypes
Name
Cat ego ry
Descript io n
Ins talle d Software
De ployable
Ins talle d Windows Software
1.8.1. Plat f orms - Process Service
Overview
T able 1.10 3. Overview
De s cription:
A ge ne ric proce s s monitoring s e rvice to
track native proce s s information bas e d on
a pid file or proce s s que ry
no
Platforms
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 1.10 4.
Name
Descript io n
Required
Int ernal Name
Type
Choice of us ing a pid
file or a PIQL que ry
to find the proce s s
to monitor
Fully qualifie d path
to the pid file for the
proce s s to monitor
Proce s s Information
Que ry Language for
proce s s to monitor
If true , the e ntire
proce s s tre e will be
monitore d
ye s
type
no
pidFile
no
piql
ye s
fullProce s s Tre e
Pid File
Piql
Full Proce s s Tre e
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
78
⁠C hapt e r 1. Manage d Plat f o r ms
Met rics
T able 1.10 5. Met rics
Name
T ype
Descript io n
Int ernal Name
Us e r Time
me as ure me nt
Proce s s .cpu.us e r
Us e r Time pe r
Minute
me as ure me nt
Ke rne l Time
me as ure me nt
Ke rne l Time pe r
Minute
me as ure me nt
CPU Pe rce ntage
me as ure me nt
Phys ical Me mory
me as ure me nt
Virtual Me mory
me as ure me nt
Ope n File
De s criptors
me as ure me nt
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU us e r
time s pe nt by all
proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all proce s s e s
The pe rce ntage of
CPU curre ntly be ing
us e d by all
proce s s e s
The aggre gate
amount of re s ide nt
me mory us e d by all
proce s s e s
The aggre gate
amount of virtual
me mory us e d by all
proce s s e s
The aggre gate
numbe r of file
de s criptors ope n by
all proce s s e s
Proce s s .cpu.us e r
Proce s s .cpu.s ys
Proce s s .cpu.s ys
Proce s s .cpu.pe rce nt
Proce s s .me mory.re s
ide nt
Proce s s .me mory.s iz
e
Proce s s .file De s cript
or.total
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
79
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Package T ypes
none
1.8.2. Plat f orms - File Syst em Service
Overview
T able 1.10 6. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.10 7. Met rics
Name
T ype
Descript io n
Int ernal Name
Fre e Space
me as ure me nt
Us e d Pe rce ntage
me as ure me nt
Capacity
trait
Volume Type
trait
Drive Type
trait
file Sys te mUs age .fre
e
file Sys te mUs age .us
e Pe rce nt
file Sys te mUs age .tot
al
file Sys te m.type Nam
e
file Sys te m.s ys Type
Name
name
trait
Fre e File s
me as ure me nt
Flags
trait
Us e d
me as ure me nt
Dis k Re ads
me as ure me nt
Dis k Re ads pe r
Minute
me as ure me nt
The total fre e byte s
on file s ys te m
The pe rce ntage of
dis k us e d
The total s iz e of the
file s ys te m
The file s ys te m's
ge ne ric type name
The file s ys te m's
ope rating s ys te ms pe cific type name
The name of this
de vice
The numbe r of fre e
file node s on the
file s ys te m
The file s ys te m's
flags
The total byte s us e d
on the file s ys te m
The numbe r of
phys ical dis k re ads
The numbe r of
phys ical dis k re ads
80
file Sys te m.de vName
file Sys te mUs age .fre
e File s
file Sys te m.flags
file Sys te mUs age .us
ed
file Sys te mUs age .dis
kRe ads
file Sys te mUs age .dis
kRe ads
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Dis k Write s
me as ure me nt
Dis k Write s pe r
Minute
Dis k Re ad Byte s
me as ure me nt
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kWrite s
file Sys te mUs age .dis
kRe adByte s
Dis k Re ad Byte s pe r
Minute
me as ure me nt
Dis k Write Byte s
me as ure me nt
Dis k Write Byte s
pe r Minute
me as ure me nt
Dis k Que ue
me as ure me nt
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k write s
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
re ad
The numbe r of
phys ical dis k byte s
writte n
The numbe r of
phys ical dis k byte s
writte n
The numbe r of I/Os
curre ntly in progre s s
me as ure me nt
file Sys te mUs age .dis
kRe adByte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kWrite Byte s
file Sys te mUs age .dis
kQue ue
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
1.8.3. Plat f orms - Net work Adapt er Service
Overview
T able 1.10 8. Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
81
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Connect ion Propert ies
none
Met rics
T able 1.10 9. Met rics
Name
T ype
Descript io n
Int ernal Name
Ine t4Addre s s
trait
Trait.ne t4.addre s s
Inte rface Flags
trait
Byte s Re ce ive d
me as ure me nt
Byte s Re ce ive d pe r
Minute
me as ure me nt
Packe ts Re ce ive d
me as ure me nt
Packe ts Re ce ive d
pe r Minute
me as ure me nt
Byte s Trans mitte d
me as ure me nt
Byte s Trans mitte d
pe r Minute
me as ure me nt
Packe ts Trans mitte d
me as ure me nt
Packe ts Trans mitte d
pe r Minute
me as ure me nt
IP addre s s of the
ne twork adapte r
Flag cons tants for
ne twork re late d
ope rations
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts re ce ive d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
byte s trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
The total numbe r of
packe ts trans mitte d
acros s this ne twork
inte rface s ince it
s tarte d
82
Trait.inte rface Flags
rxByte s
rxByte s
rxPacke ts
rxPacke ts
txByte s
txByte s
txPacke ts
txPacke ts
⁠C hapt e r 1. Manage d Plat f o r ms
Name
T ype
Descript io n
Int ernal Name
Re ce ive Errors
me as ure me nt
rxErrors
Re ce ive Errors pe r
Minute
me as ure me nt
Re ce ive Packe ts
Droppe d
me as ure me nt
Re ce ive Packe ts
Droppe d pe r Minute
me as ure me nt
Re ce ive Ove rrurns
me as ure me nt
Re ce ive Ove rrurns
pe r Minute
me as ure me nt
Re ce ive Frame
me as ure me nt
Re ce ive Frame pe r
Minute
me as ure me nt
Trans mit Errors
me as ure me nt
Trans mit Errors pe r
Minute
me as ure me nt
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'frame ' s tatis tic for
re ce ive d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'e rrors ' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
rxErrors
rxDroppe d
rxDroppe d
rxOve rruns
rxOve rruns
rxFrame
rxFrame
txErrors
txErrors
83
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Trans mit Packe ts
Droppe d
me as ure me nt
txDroppe d
Trans mit Packe ts
Droppe d pe r Minute
me as ure me nt
Trans mit Ove rruns
me as ure me nt
Trans mit Ove rruns
pe r Minute
me as ure me nt
Trans mit Collis ions
me as ure me nt
Trans mit Collis ions
pe r Minute
me as ure me nt
Trans mit Carrie r
me as ure me nt
Trans mit Carrie r pe r
Minute
me as ure me nt
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'droppe d' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'ove rruns ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'collis ions ' s tatis tic
for trans mitte d
packe ts acros s this
ne twork inte rface
s ince it s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
'carrie r' s tatis tic for
trans mitte d packe ts
acros s this ne twork
inte rface s ince it
s tarte d
txDroppe d
txOve rruns
txOve rruns
txCollis ions
txCollis ions
txCarrie r
txCarrie r
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
84
⁠C hapt e r 1. Manage d Plat f o r ms
none
Package T ypes
none
1.8.4. Plat f orms - CPU Service
Overview
T able 1.110 . Overview
De s cription:
Single ton:
Plugin:
no
Platforms
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 1.111. Met rics
Name
T ype
Descript io n
Int ernal Name
Idle
me as ure me nt
CpuPe rc.idle
Sys te m Load
me as ure me nt
Us e r Load
me as ure me nt
Wait Load
me as ure me nt
Us e r Time
me as ure me nt
Us e r Time pe r
Minute
Nice Time
me as ure me nt
Nice Time pe r
Minute
Sys te m Time
me as ure me nt
Sys te m Time pe r
Minute
me as ure me nt
Idle pe rce ntage of
this CPU
Pe rce ntage of this
CPU running in
s ys te m mode
Pe rce ntage of this
CPU running in us e r
mode
Pe rce ntage of this
CPU waiting on I/O
The total s ys te m
CPU us e r time
The total s ys te m
CPU us e r time
The total s ys te m
CPU nice time
The total s ys te m
CPU nice time
The total s ys te m
CPU ke rne l time
The total s ys te m
CPU ke rne l time
me as ure me nt
me as ure me nt
CpuPe rc.s ys
CpuPe rc.us e r
CpuPe rc.wait
Cpu.us e r
Cpu.us e r
Cpu.nice
Cpu.nice
Cpu.s ys
Cpu.s ys
85
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Idle Time
me as ure me nt
Cpu.idle
Idle Time pe r Minute
me as ure me nt
Wait Time
me as ure me nt
Wait Time pe r
Minute
Ve ndor
CPU Mode l
CPU Spe e d
me as ure me nt
Cache s iz e
trait
The total s ys te m
CPU idle time
The total s ys te m
CPU idle time
The total s ys te m
CPU I/O wait time
The total s ys te m
CPU I/O wait time
Ve ndor of this CPU
Mode l of this CPU
Spe e d of this CPU in
Mhz
Cache Siz e of this
CPU
trait
trait
trait
Cpu.idle
Cpu.wait
Cpu.wait
CpuTrait.ve ndor
CpuTrait.mode l
CpuTrait.mhz
CpuTrait.cache Siz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
86
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Chapt er 2. Core Managed Resources
The re are ce rtain s e rve r type s that are s upporte d by de fault in JBos s Ope rations Ne twork,
both for JBos s and non-JBos s re s ource type s .
2.1. Apache - HT T P Server
Overview
T able 2.1. Overview
De s cription:
Single ton:
Plugin:
an Apache HTTP Se rve r ins tance
no
Apache
Child Resource T ypes
Se ction 2.1.1, “Apache - Virtual Hos t Se rvice ”
Se ction 2.1.2, “Apache - Mod JK Se rvice ”
Aut odiscovery Process Scans
T able 2.2. Met rics
Name
Query
HttpdOnWindows
proce s s |bas e name |match=(?
i)httpd.e xe ,proce s s |bas e name |match|pare n
t=(?i)httpd.e xe
proce s s |bas e name |match=(?
i)Apache .e xe ,proce s s |bas e name |match|par
e nt=(?i)Apache .e xe
proce s s |bas e name |match=httpd.*,proce s s |
bas e name |nomatch|pare nt=httpd.*
proce s s |bas e name |match=apache 2,proce s
s |bas e name |nomatch|pare nt=apache 2
Apache OnWindows
HttpdOnUnix
Apache 2OnUnix
Connect ion Propert ies
T able 2.3.
Name
Descript io n
Required
Int ernal Name
Enable auge as
s upport
Auge as Module
Name
Enable auge as
s upport
the name of the
Auge as module /le ns
to us e for loading
and updating this
re s ource 's
configuration
ye s
auge as Enable d
ye s
auge as Module Name
87
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Httpd config file
Location of the
Apache main
configuration file .
How s hould the ne w
virtual hos t
de finitions be put in
the configuration
If the ne w virtual
hos ts s hould be
cre ate d in
s tandalone file s , this
mas k de te rmine s
whe re to cre ate
thos e file s . The '*' in
the path is re place d
by the name of the
virtual hos t. If the
path is re lative , it is
cons ide re d re lative
to s e rve r root.
The abs olute path to
the e rror log file - if
the path is not
abs olute , it will be
re s olve d re lative to
the s e rve r root
dire ctory; if uns e t,
de fault will be
'logs /e rror_log' on
UNIX or
'logs \e rror.log' on
Windows .
A flag indicating
whe the r or not
ge ne ration of Eve nts
for ne w e rror log
e ntrie s is e nable d.
The minimum
s e ve rity of e rror log
e ntry Eve nts that
s hould be colle cte d.
If not s pe cifie d,
the re is no minimum
s e ve rity (i.e . all
e ve nts will be
colle cte d).
ye s
configurationFile s Incl
us ionPatte rns
ye s
vhos tCre ationPolicy
ye s
vhos tFile s Mas k
no
e rrorLogFile Path
ye s
e rrorLogEve nts Enabl
ed
no
e rrorLogMinimumSe
ve rity
Virtual Hos ts
Configuration
Place me nt
Path To Contain
Virtual Hos ts File s
Error Log File Path
Error Log Eve nts
Enable d
Error Log Minimum
Se ve rity
88
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Error Log Include s
Patte rn
A re gular
no
e xpre s s ion agains t
which an e rror log
e ntry's de tail is
matche d to
de te rmine if an
Eve nt s hould be
fire d for that e ntry. If
not s pe cifie d, no
filte ring of log
e ntrie s will be done
bas e d on the ir
de tail.
Apache can us e 2
ye s
value s to ide ntify a
module . Eithe r its
module name that is
us e d in the
LoadModule
dire ctive or its
s ource file that can
be us e d in the
IfModule dire ctive
(as of Apache 2.1
the IfModule
dire ctive can but
doe s n't have to us e
the module name ,
too). The plugin
contains the
mappings of the
module name s to
module file s for all
the s tandard apache
module s me ntione d
on the
http://httpd.apache .or
g/docs /curre nt/mod/
plus the SNMP
module and mod_jk.
If you us e any nons tandard module s
and us e the ir s ource
file in the IfModule
dire ctive s , you have
to add the module name -to-module -file
mapping to this lis t
s o that the plugin
can de te rmine the
corre ct runtime
configuration of the
apache ins tance .
Cus tom Module
Name s
Required
Int ernal Name
e rrorLogInclude s Patt
e rn
cus tomModule Name
s
89
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se rve r Root
the abs olute path of
the Apache s e rve r
root dire ctory
the path to the
Apache e xe cutable if the path is not
abs olute , it will be
re s olve d re lative to
the s e rve r root
dire ctory; if uns e t,
de fault value is
'bin/httpd' on UNIX or
'bin\Apache .e xe ' on
Windows
the path to the
Apache control s cript
- if the path is not
abs olute , it will be
re s olve d re lative to
the s e rve r root
dire ctory; if uns e t,
de fault will be
'bin/apache ctl' on
UNIX or the Apache
e xe cutable on
Windows
the path to the
httpd.conf file - if the
path is not abs olute ,
it will be re s olve d
re lative to the
s e rve r root
dire ctory; if uns e t,
de fault will be
'conf/httpd.conf' on
UNIX
The http or https URL
that will be us e d to
che ck availability for
this Apache s e rve r;
if not s e t, availability
will be de te rmine d
bas e d on whe the r
plugin can conne ct to
the Apache s e rve r's
SNMP age nt. Note
that SSL ce rtificate
validation is dis able d
during availability
che cks if this is an
HTTPS URL.
ye s
s e rve rRoot
no
e xe cutable Path
no
controlScriptPath
ye s
configFile
no
url
Exe cutable Path
Control Script Path
Config File
URL
90
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
SNMP Age nt Hos t
the hos t name or IP
addre s s of the
Apache SNMP age nt
(typically '127.0.0.1')
the UDP port of the
Apache SNMP age nt
(typically '1610')
the SNMP community
of the Apache SNMP
age nt (typically
'public')
the time out, in
millis e conds , for
re que s ts to the
Apache SNMP age nt;
de faults to 2000
the numbe r of time s
a re que s t that has
time d out s hould be
re trie d; de faults to 1
If s e t to true , e ach
configuration update
of the s e rve r or any
unde rlying virtual
hos t or dire ctory is
followe d by the
re s tart of the
Apache ins tance s o
that the
configuration
change s are applie d
imme diate ly. If s e t
to fals e , you have to
manually re s tart the
s e rve r (for e xample
us ing the re s tart
ope ration in the
ope rations tab) once
all the configuration
update s are
finis he d.
If s e t to a valid URL
to mod_bmx handle r
allow to us e
mod_bmx ins te ad of
mod_s nmp.
no
s nmpAge ntHos t
no
s nmpAge ntPort
no
s nmpAge ntCommuni
ty
no
s nmpRe que s tTime ou
t
no
s nmpRe que s tRe trie s
ye s
re s tartAfte rConfigur
ationUpdate
no
bmxUrl
SNMP Age nt Port
SNMP Age nt
Community
SNMP Re que s t
Time out
SNMP Re que s t
Re trie s
Re s tart Afte r
Configuration Update
BMX Handle r
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
91
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Met rics
T able 2.4. Met rics
Name
T ype
Descript io n
Int ernal Name
Numbe r of
Concurre nt
Conne ctions
Se rve r Built
me as ure me nt
applInboundAs s ociati
ons
Start Time
trait
Time to ping the
s e rve r for
availability
me as ure me nt
Numbe r of
Concurre nt
Conne ctions
the date and time
this Apache s e rve r's
binary was compile d
the date and time
this Apache s e rve r
was las t s tarte d
Time it took to ping
the s e rve r for
availability ove r http;
this include s DNS
lookup time .
trait
s e rve rBuilt
wwwSe rvice StartTim
e
rhq_avail_ping_time
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 2.5.
Name
Lis te n
92
Descript io n
Required
Int ernal Name
ye s
Lis te n
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Name Virtual Hos t
A re quire d dire ctive
if you want to
configure name bas e d virtual hos ts .
Although the value
can be hos tname it
is re comme nde d
that you always us e
an IP addre s s . IPv6
addre s s e s mus t be
e nclos e d in s quare
bracke ts . To re ce ive
re que s ts on all
inte rface s , you can
s e t the value to *.
Note that the IP
addre s s of a name bas e d virtual hos t
mus t e xactly match
the value of this
prope rty. The
addre s s may be
optionally followe d
by the port
s pe cification to
furthe r limit the
dire ctive e ffe ct.
no
Name VirtualHos t
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
T able 2.6. Met rics
Name
Descript io n
Start
Starts this Apache s e rve r, or re turns an
e rror if it is alre ady running. The control
s cript us e d is s pe cifie d in the Conne ction
Prope rtie s .
Stops this Apache s e rve r, or re turns an
e rror if it is not running. The control s cript
us e d is s pe cifie d in the Conne ction
Prope rtie s .
Stop
93
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Re s tart
Re s tarts the Apache s e rve r by s e nding its
proce s s a SIGHUP. If the s e rve r is not
running, it is s tarte d. This command
automatically che cks the s e rve r's
configuration file s via configte s t be fore
initiating the re s tart to make s ure Apache
doe s n't die . The control s cript us e d is
s pe cifie d in the Conne ction Prope rtie s .
Only s upporte d on UNIX platforms .
Starts this Apache s e rve r with s upport for
SSL. The control s cript us e d is s pe cifie d in
the Conne ction Prope rtie s . Only s upporte d
on Apache 1.3.
Grace fully re s tarts the Apache s e rve r by
s e nding it a SIGUSR1. If the dae mon is not
running, it is s tarte d. This diffe rs from a
normal re s tart in that curre ntly ope n
conne ctions are not aborte d. A s ide e ffe ct
is that old log file s will not be clos e d
imme diate ly. This me ans that if us e d in a
log rotation s cript, a s ubs tantial de lay may
be ne ce s s ary to e ns ure that the old log
file s are clos e d be fore proce s s ing the m.
This command automatically che cks the
configuration file s via configte s t be fore
initiating the re s tart to make s ure Apache
doe s n't die . The control s cript us e d is
s pe cifie d in the Conne ction Prope rtie s .
Run a configuration file s yntax te s t. It
pars e s the configuration file s and e ithe r
re ports Syntax Ok or de taile d information
about the particular s yntax e rror. The
control s cript us e d is s pe cifie d in the
Conne ction Prope rtie s . Only s upporte d on
UNIX platforms .
Trie s to ins tall a mod_jk configuration in
httpd.conf if none is de te cte d. This include s
a worke rs .prope rtie s file and urimap file
Start with SSL Support
Re s tart Grace fully
Che ck Configuration File Syntax
Ins tall mod_jk configuration
Package T ypes
none
2.1.1. Apache - Virt ual Host Service
Overview
T able 2.7. Overview
De s cription:
Single ton:
Plugin:
94
no
Apache
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Child Resource T ypes
Se ction 2.1.1.1, “Apache - Dire ctory Se rvice ”
Se ction 2.1.1.2, “Apache - IfModule Se rvice ”
Connect ion Propert ies
T able 2.8.
Name
Descript io n
Required
Int ernal Name
Re s pons e Time Log
File
the full path to the
log file containing
re s pons e -time s tats
for this virtual hos t
a s pace -de limite d
lis t of re gular
e xpre s s ions
s pe cifying URLs that
s hould be e xclude d
from re s pons e -time
s tats colle ction
a s pace -de limite d
lis t of Pe rl-s tyle
s ubs titution
e xpre s s ions that
s hould be applie d to
all URLs for which
re s pons e -time s tats
are colle cte d (e .g.
|^/de pt/finance /.*|/de
pt/finance /*|)
The http or https URL
that will be us e d to
che ck availability for
this virtual hos t.
Note that SSL
ce rtificate validation
is dis able d during
availability che cks if
this is an HTTPS URL.
If the URL is not s e t,
the availability is
de te rmine d by
pinging the
configure d SNMP
location.
no
re s pons e Time LogFil
e
no
re s pons e Time UrlExc
lude s
no
re s pons e Time UrlTra
ns forms
no
url
Re s pons e Time Url
Exclude s
Re s pons e Time Url
Trans forms
URL
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
95
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Met rics
T able 2.9. Met rics
Name
T ype
Descript io n
Int ernal Name
Hos t
trait
wwwSe rvice Name
Port
trait
Adminis trator
trait
Total Numbe r of
Re que s ts
me as ure me nt
Total Numbe r of
Re que s ts pe r Minute
me as ure me nt
Total Numbe r of
Byte s Re ce ive d
me as ure me nt
Total Numbe r of
Byte s Re ce ive d pe r
Minute
Total Numbe r of
Re s pons e s
me as ure me nt
Total Numbe r of
Re s pons e s pe r
Minute
Total Numbe r of
Byte s Se nt
Total Numbe r of
Byte s Se nt pe r
Minute
Numbe r of GET
Re que s ts
me as ure me nt
the hos t name or IP
addre s s of this
virtual hos t
the TCP port of this
virtual hos t
the adminis trator of
this virtual hos t
The numbe r of
inbound re que s ts on
the s e rvice
The numbe r of
inbound re que s ts on
the s e rvice
The numbe r of byte s
re ce ive d by the
s e rvice
The numbe r of byte s
re ce ive d by the
s e rvice
The numbe r of
outbound re que s ts
on the s e rvice
The numbe r of
outbound re que s ts
on the s e rvice
The numbe r of byte s
s e nt by the s e rvice
The numbe r of byte s
s e nt by the s e rvice
wwwRe que s tInRe que
s ts .GET
Numbe r of GET
Re que s ts pe r Minute
me as ure me nt
Numbe r of HEAD
Re que s ts
me as ure me nt
Numbe r of HEAD
Re que s ts pe r Minute
me as ure me nt
The numbe r of
inbound GET
re que s ts on the
s e rvice
The numbe r of
inbound GET
re que s ts on the
s e rvice
The numbe r of
inbound HEAD
re que s ts on the
s e rvice
The numbe r of
inbound HEAD
re que s ts on the
s e rvice
96
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
wwwSe rvice Protocol
wwwSe rvice Contact
wwwSummaryInRe qu
e s ts
wwwSummaryInRe qu
e s ts
wwwSummaryInLowB
yte s
wwwSummaryInLowB
yte s
wwwSummaryOutRe
s pons e s
wwwSummaryOutRe
s pons e s
wwwSummaryOutLo
wByte s
wwwSummaryOutLo
wByte s
wwwRe que s tInRe que
s ts .GET
wwwRe que s tInRe que
s ts .HEAD
wwwRe que s tInRe que
s ts .HEAD
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Numbe r of POST
Re que s ts
me as ure me nt
wwwRe que s tInRe que
s ts .POST
Numbe r of POST
Re que s ts pe r Minute
me as ure me nt
Numbe r of PUT
Re que s ts
me as ure me nt
Numbe r of PUT
Re que s ts pe r Minute
me as ure me nt
Byte s Re ce ive d for
GET Re que s ts
me as ure me nt
Byte s Re ce ive d for
GET Re que s ts pe r
Minute
me as ure me nt
Byte s Re ce ive d for
HEAD Re que s ts
me as ure me nt
Byte s Re ce ive d for
HEAD Re que s ts pe r
Minute
me as ure me nt
Byte s Re ce ive d for
POST Re que s ts
me as ure me nt
Byte s Re ce ive d for
POST Re que s ts pe r
Minute
me as ure me nt
Byte s Re ce ive d for
PUT Re que s ts
me as ure me nt
Byte s Re ce ive d for
PUT Re que s ts pe r
Minute
me as ure me nt
Numbe r of 200
Re s pons e s
me as ure me nt
The numbe r of
inbound POST
re que s ts on the
s e rvice
The numbe r of
inbound POST
re que s ts on the
s e rvice
The numbe r of
inbound PUT
re que s ts on the
s e rvice
The numbe r of
inbound PUT
re que s ts on the
s e rvice
The numbe r of byte s
re ce ive d by GET
re que s ts on the
s e rvice
The numbe r of byte s
re ce ive d by GET
re que s ts on the
s e rvice
The numbe r of byte s
re ce ive d by HEAD
re que s ts on the
s e rvice
The numbe r of byte s
re ce ive d by HEAD
re que s ts on the
s e rvice
The numbe r of byte s
re ce ive d by POST
re que s ts on the
s e rvice
The numbe r of byte s
re ce ive d by POST
re que s ts on the
s e rvice
The numbe r of byte s
re ce ive d by PUT
re que s ts on the
s e rvice
The numbe r of byte s
re ce ive d by PUT
re que s ts on the
s e rvice
The numbe r of 200
re s pons e s
ge ne rate d by this
s e rvice
wwwRe que s tInRe que
s ts .POST
wwwRe que s tInRe que
s ts .PUT
wwwRe que s tInRe que
s ts .PUT
wwwRe que s tInByte s .
GET
wwwRe que s tInByte s .
GET
wwwRe que s tInByte s .
HEAD
wwwRe que s tInByte s .
HEAD
wwwRe que s tInByte s .
POST
wwwRe que s tInByte s .
POST
wwwRe que s tInByte s .
PUT
wwwRe que s tInByte s .
PUT
wwwRe s pons e OutRe
s pons e s .200
97
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Numbe r of 200
Re s pons e s pe r
Minute
me as ure me nt
wwwRe s pons e OutRe
s pons e s .200
Numbe r of 301
Re s pons e s
me as ure me nt
Numbe r of 301
Re s pons e s pe r
Minute
me as ure me nt
Numbe r of 302
Re s pons e s
me as ure me nt
Numbe r of 302
Re s pons e s pe r
Minute
me as ure me nt
Numbe r of 401
Re s pons e s
me as ure me nt
Numbe r of 401
Re s pons e s pe r
Minute
me as ure me nt
Numbe r of 403
Re s pons e s
me as ure me nt
Numbe r of 403
Re s pons e s pe r
Minute
me as ure me nt
Numbe r of 404
Re s pons e s
me as ure me nt
Numbe r of 404
Re s pons e s pe r
Minute
me as ure me nt
Numbe r of 500
Re s pons e s
me as ure me nt
Numbe r of 500
Re s pons e s pe r
Minute
me as ure me nt
The numbe r of 200
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 301
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 301
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 302
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 302
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 401
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 401
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 403
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 403
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 404
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 404
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 500
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of 500
re s pons e s
ge ne rate d by this
s e rvice
98
wwwRe s pons e OutRe
s pons e s .301
wwwRe s pons e OutRe
s pons e s .301
wwwRe s pons e OutRe
s pons e s .302
wwwRe s pons e OutRe
s pons e s .302
wwwRe s pons e OutRe
s pons e s .401
wwwRe s pons e OutRe
s pons e s .401
wwwRe s pons e OutRe
s pons e s .403
wwwRe s pons e OutRe
s pons e s .403
wwwRe s pons e OutRe
s pons e s .404
wwwRe s pons e OutRe
s pons e s .404
wwwRe s pons e OutRe
s pons e s .500
wwwRe s pons e OutRe
s pons e s .500
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Byte s Se nt for 200
Re s pons e s
me as ure me nt
wwwRe s pons e OutBy
te s .200
Byte s Se nt for 200
Re s pons e s pe r
Minute
me as ure me nt
Byte s Se nt for 301
Re s pons e s
me as ure me nt
Byte s Se nt for 301
Re s pons e s pe r
Minute
me as ure me nt
Byte s Se nt for 302
Re s pons e s
me as ure me nt
Byte s Se nt for 302
Re s pons e s pe r
Minute
me as ure me nt
Byte s Se nt for 401
Re s pons e s
me as ure me nt
Byte s Se nt for 401
Re s pons e s pe r
Minute
me as ure me nt
Byte s Se nt for 403
Re s pons e s
me as ure me nt
Byte s Se nt for 403
Re s pons e s pe r
Minute
me as ure me nt
The numbe r of byte s
s e nt for 200
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 200
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 301
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 301
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 302
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 302
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 401
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 401
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 403
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 403
re s pons e s
ge ne rate d by this
s e rvice
wwwRe s pons e OutBy
te s .200
wwwRe s pons e OutBy
te s .301
wwwRe s pons e OutBy
te s .301
wwwRe s pons e OutBy
te s .302
wwwRe s pons e OutBy
te s .302
wwwRe s pons e OutBy
te s .401
wwwRe s pons e OutBy
te s .401
wwwRe s pons e OutBy
te s .403
wwwRe s pons e OutBy
te s .403
99
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Byte s Se nt for 404
Re s pons e s
me as ure me nt
wwwRe s pons e OutBy
te s .404
Byte s Se nt for 404
Re s pons e s pe r
Minute
me as ure me nt
Byte s Se nt for 500
Re s pons e s
me as ure me nt
Byte s Se nt for 500
Re s pons e s pe r
Minute
me as ure me nt
HTTP Re s pons e
Time
calltime
The numbe r of byte s
s e nt for 404
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 404
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 500
re s pons e s
ge ne rate d by this
s e rvice
The numbe r of byte s
s e nt for 500
re s pons e s
ge ne rate d by this
s e rvice
The minimum,
maximum, and
ave rage re s pons e
time s for HTTP
re que s ts s e rvice d
by this virtual hos t
wwwRe s pons e OutBy
te s .404
wwwRe s pons e OutBy
te s .500
wwwRe s pons e OutBy
te s .500
Re s pons e Time
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 2.10 .
Name
100
Descript io n
Required
Int ernal Name
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Error Log
Se ts the name of
no
the file to which the
s e rve r will log any
e rrors it e ncounte rs .
If the file -path is not
abs olute the n it is
as s ume d to be
re lative to the
Se rve rRoot. If the
file -path be gins with
a pipe (|) the n it is
as s ume d to be a
command to s pawn
to handle the e rror
log. Us ing s ys log
ins te ad of a
file name e nable s
logging via
s ys logd(8) if the
s ys te m s upports it.
The de fault is to us e
s ys log facility local7,
but you can ove rride
this by us ing the
s ys log:facility s yntax
whe re facility can be
one of the name s
us ually docume nte d
in s ys log(1).
Configure the
ye s
logging of re que s ts
to the s e rve r.
Re que s t logs
Required
Int ernal Name
ErrorLog
Cus tomLog
101
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Se rve r Name
Se ts the re que s t
no
s che me , hos tname
and port that the
s e rve r us e s to
ide ntify its e lf. This is
us e d whe n cre ating
re dire ction URLs . If
no Se rve rName is
s pe cifie d, the n the
s e rve r atte mpts to
de duce the
hos tname by
pe rforming a
re ve rs e lookup on
the IP addre s s . If no
port is s pe cifie d in
the Se rve rName ,
the n the s e rve r will
us e the port from
the incoming
re que s t. For optimal
re liability and
pre dictability, you
s hould s pe cify an
e xplicit hos tname
and port us ing the
Se rve rName
dire ctive . If you are
us ing name -bas e d
virtual hos ts , the
Se rve rName ins ide
a <VirtualHos t>
s e ction s pe cifie s
what hos tname mus t
appe ar in the
re que s t's Hos t:
he ade r to match this
virtual hos t.
ye s
The e mail addre s s
no
or URL to contact the
s e rve r adminis trator
in cas e of e rrors .
This addre s s is
us e d in various
Apache ge ne rate d
e rror me s s age s .
Se rve r Alias
Se rve r Admin
102
Required
Int ernal Name
Se rve rName
Se rve rAlias
Se rve rAdmin
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Docume nt Root
This dire ctive s e ts
ye s
the dire ctory from
which httpd will
s e rve file s . Unle s s
matche d by a
dire ctive like Alias ,
the s e rve r appe nds
the path from the
re que s te d URL to
the docume nt root to
make the path to the
docume nt. If the
dire ctory-path is not
abs olute the n it is
as s ume d to be
re lative to the
Se rve rRoot. The
Docume ntRoot
s hould be s pe cifie d
without a trailing
s las h.
This dire ctive
no
s pe cifie s a de fault
value for the me dia
type chars e t
parame te r (the
name of a characte r
e ncoding) to be
adde d to a re s pons e
if and only if the
re s pons e 's conte nttype is e ithe r
te xt/plain or
te xt/html. Value
"Off" dis able s this
functionality. "On"
e nable s a de fault
chars e t of is o-88591. Any othe r value is
as s ume d to be the
chars e t to be us e d,
which s hould be one
of the IANA
re gis te re d chars e t
value s for us e in
MIME me dia type s .
Add De fault Chars e t
Required
Int ernal Name
Docume ntRoot
AddDe faultChars e t
103
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Alias
The Alias dire ctive
ye s
allows docume nts to
be s tore d in the
local file s ys te m
othe r than unde r the
Docume ntRoot. With
" Alias /image
/ftp/pub/image ", a
re que s t for
http://mys e rve r/ima
ge /foo.gif would
caus e the s e rve r to
re turn the file
/ftp/pub/image /foo.gi
f. Only comple te
path s e gme nts are
matche d, s o the
above alias would
not match a re que s t
for
http://mys e rve r/ima
ge foo.gif. Note that
you may ne e d to
s pe cify additional
<Dire ctory>
s e ctions which cove r
the de s tination of
alias e s . In particular,
if you are cre ating
an Alias to a
dire ctory outs ide of
your Docume ntRoot,
you may ne e d to
e xplicitly pe rmit
acce s s to the targe t
dire ctory.
The re will be time s
no
whe n the s e rve r is
as ke d to provide a
docume nt whos e
type cannot be
de te rmine d by its
MIME type s
mappings . The
s e rve r SHOULD
inform the clie nt of
the conte nt-type of
the docume nt. If the
s e rve r is unable to
de te rmine this by
normal me ans , it will
s e t it to the
configure d
De faultType .
De fault Type
104
Required
Int ernal Name
Alias
De faultType
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Dire ctory Inde x
Se ts the lis t of
no
re s ource s to look
for, whe n the clie nt
re que s ts an inde x of
the dire ctory by
s pe cifying a / at the
e nd of the dire ctory
name . Note that the
docume nts do not
ne e d to be re lative
to the dire ctory.
In the e ve nt of a
ye s
proble m or e rror,
Apache can be
configure d to do one
of four things , 1.
output a s imple
hardcode d e rror
me s s age , 2. output
a cus tomiz e d
me s s age , 3. re dire ct
to a local URL-path to
handle the
proble m/e rror, 4.
re dire ct to an
e xte rnal URL to
handle the
proble m/e rror. The
firs t option is the
de fault, while
options 2-4 are
configure d us ing the
ErrorDocume nt
dire ctive , which is
followe d by the HTTP
re s pons e code and
a URL or a me s s age .
Apache will
s ome time s offe r
additional
information
re garding the
proble m/e rror.
The Time Out
no
dire ctive de fine s the
le ngth of time
Apache will wait for
I/O in various
circums tance s .
Error Docume nt
Time out
Required
Int ernal Name
Dire ctoryInde x
ErrorDocume nt
Time out
105
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Options
The Options
no
dire ctive controls
which s e rve r
fe ature s are
available in a
particular dire ctory.
With
no
Us e CanonicalName
On Apache will us e
the hos tname and
port s pe cifie d in the
Se rve rName
dire ctive to
cons truct the
canonical name for
the s e rve r. This
name is us e d in all
s e lf-re fe re ntial
URLs , and for the
value s of
SERVER_NAME and
SERVER_PORT in
CGIs . With
Us e CanonicalName
Off Apache will form
s e lf-re fe re ntial URLs
us ing the hos tname
and port s upplie d by
the clie nt if any are
s upplie d (othe rwis e
it will us e the
canonical name , as
de fine d above ).
Us e CanonicalName
DNS is inte nde d for
us e with mas s IPbas e d virtual hos ting
to s upport ancie nt
clie nts that do not
provide a Hos t:
he ade r. With this
option Apache doe s
a re ve rs e DNS
lookup on the s e rve r
IP addre s s that the
clie nt conne cte d to
in orde r to work out
s e lf-re fe re ntial
URLs .
Us e Canonical Name
106
Required
Int ernal Name
Options
Us e CanonicalName
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Required
Us e Canonical
Phys ical Port
In many s ituations
no
Apache mus t
cons truct a s e lfre fe re ntial URL -that is , a URL that
re fe rs back to the
s ame s e rve r. With
Us e CanonicalPhys ica
lPort On Apache will,
whe n cons tructing
the canonical port
for the s e rve r to
honor the
Us e CanonicalName
dire ctive , provide
the actual phys ical
port numbe r be ing
us e d by this re que s t
as a pote ntial port.
With
Us e CanonicalPhys ica
lPort Off Apache will
not e ve r us e the
actual phys ical port
numbe r, ins te ad
re lying on all
configure d
information to
cons truct a valid port
numbe r.
Int ernal Name
Us e CanonicalPhys ica
lPort
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
2.1.1.1. Apache - Direct ory Service
Overview
T able 2.11. Overview
De s cription:
107
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Single ton:
Plugin:
no
Apache
Child Reso urce T ypes
Se ction 2.1.1.1.1, “Apache - IfModule Parame te rs Se rvice ”
Co nnect io n Pro pert ies
T able 2.12.
Name
Descript io n
Required
Int ernal Name
Re gular Expre s s ion
Doe s the name of
this dire ctory de note
a re gular
e xpre s s ion?
ye s
re ge xp
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 2.13.
Name
Descript io n
Required
Int ernal Name
IfModule Conditions
Lis t of module s
which mus t be
loade d to us e
dire ctive
configuration.
ye s
IfModule s
108
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Orde r
The Orde r dire ctive , no
along with the Allow
and De ny dire ctive s ,
controls a thre e pas s acce s s control
s ys te m. The firs t
pas s proce s s e s
e ithe r all Allow or all
De ny dire ctive s , as
s pe cifie d by the
Orde r dire ctive . The
s e cond pas s pars e s
the re s t of the
dire ctive s (De ny or
Allow). The third
pas s applie s to all
re que s ts which do
not match e ithe r of
the firs t two.
The Allow dire ctive
no
affe cts which hos ts
can acce s s an are a
of the s e rve r.
Acce s s can be
controlle d by
hos tname , IP
addre s s , IP addre s s
range . The
e nvironme nt
variable s s e ttings
are not s upporte d in
the us e r inte rface .
The argume nts for
no
the De ny dire ctive
are ide ntical to the
argume nts for the
Allow dire ctive .
no
Allow
De ny
Allow Ove rride
Required
Int ernal Name
Orde r
Allow
De ny
AllowOve rride
109
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Add De fault Chars e t
This dire ctive
no
s pe cifie s a de fault
value for the me dia
type chars e t
parame te r (the
name of a characte r
e ncoding) to be
adde d to a re s pons e
if and only if the
re s pons e 's conte nttype is e ithe r
te xt/plain or
te xt/html. Value
"Off" dis able s this
functionality. "On"
e nable s a de fault
chars e t of is o-88591. Any othe r value is
as s ume d to be the
chars e t to be us e d,
which s hould be one
of the IANA
re gis te re d chars e t
value s for us e in
MIME me dia type s .
The re will be time s
no
whe n the s e rve r is
as ke d to provide a
docume nt whos e
type cannot be
de te rmine d by its
MIME type s
mappings . The
s e rve r SHOULD
inform the clie nt of
the conte nt-type of
the docume nt. If the
s e rve r is unable to
de te rmine this by
normal me ans , it will
s e t it to the
configure d
De faultType .
Se ts the lis t of
no
re s ource s to look
for, whe n the clie nt
re que s ts an inde x of
the dire ctory by
s pe cifying a / at the
e nd of the dire ctory
name . Note that the
docume nts do not
ne e d to be re lative
to the dire ctory.
De fault Type
Dire ctory Inde x
110
Required
Int ernal Name
AddDe faultChars e t
De faultType
Dire ctoryInde x
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Error Docume nt
In the e ve nt of a
ye s
proble m or e rror,
Apache can be
configure d to do one
of four things , 1.
output a s imple
hardcode d e rror
me s s age , 2. output
a cus tomiz e d
me s s age , 3. re dire ct
to a local URL-path to
handle the
proble m/e rror, 4.
re dire ct to an
e xte rnal URL to
handle the
proble m/e rror. The
firs t option is the
de fault, while
options 2-4 are
configure d us ing the
ErrorDocume nt
dire ctive , which is
followe d by the HTTP
re s pons e code and
a URL or a me s s age .
Apache will
s ome time s offe r
additional
information
re garding the
proble m/e rror.
The Options
no
dire ctive controls
which s e rve r
fe ature s are
available in a
particular dire ctory.
Options
Required
Int ernal Name
ErrorDocume nt
Options
111
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Us e Canonical Name
With
no
Us e CanonicalName
On Apache will us e
the hos tname and
port s pe cifie d in the
Se rve rName
dire ctive to
cons truct the
canonical name for
the s e rve r. This
name is us e d in all
s e lf-re fe re ntial
URLs , and for the
value s of
SERVER_NAME and
SERVER_PORT in
CGIs . With
Us e CanonicalName
Off Apache will form
s e lf-re fe re ntial URLs
us ing the hos tname
and port s upplie d by
the clie nt if any are
s upplie d (othe rwis e
it will us e the
canonical name , as
de fine d above ).
Us e CanonicalName
DNS is inte nde d for
us e with mas s IPbas e d virtual hos ting
to s upport ancie nt
clie nts that do not
provide a Hos t:
he ade r. With this
option Apache doe s
a re ve rs e DNS
lookup on the s e rve r
IP addre s s that the
clie nt conne cte d to
in orde r to work out
s e lf-re fe re ntial
URLs .
112
Required
Int ernal Name
Us e CanonicalName
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Required
Us e Canonical
Phys ical Port
In many s ituations
no
Apache mus t
cons truct a s e lfre fe re ntial URL -that is , a URL that
re fe rs back to the
s ame s e rve r. With
Us e CanonicalPhys ica
lPort On Apache will,
whe n cons tructing
the canonical port
for the s e rve r to
honor the
Us e CanonicalName
dire ctive , provide
the actual phys ical
port numbe r be ing
us e d by this re que s t
as a pote ntial port.
With
Us e CanonicalPhys ica
lPort Off Apache will
not e ve r us e the
actual phys ical port
numbe r, ins te ad
re lying on all
configure d
information to
cons truct a valid port
numbe r.
Int ernal Name
Us e CanonicalPhys ica
lPort
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
2.1.1.1.1. Apache - If Mo dule Paramet ers Service
Overview
T able 2.14. Overview
De s cription:
Single ton:
no
113
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Plugin:
Apache
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
none
Met rics
none
Co nf igurat io n Pro pert ies
T able 2.15.
Name
Descript io n
IfModule Conditions
Lis t of module s
ye s
which mus t be
loade d to us e
dire ctive
configuration.
The Orde r dire ctive , no
along with the Allow
and De ny dire ctive s ,
controls a thre e pas s acce s s control
s ys te m. The firs t
pas s proce s s e s
e ithe r all Allow or all
De ny dire ctive s , as
s pe cifie d by the
Orde r dire ctive . The
s e cond pas s pars e s
the re s t of the
dire ctive s (De ny or
Allow). The third
pas s applie s to all
re que s ts which do
not match e ithe r of
the firs t two.
Orde r
114
Required
Int ernal Name
IfModule s
Orde r
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Allow
The Allow dire ctive
affe cts which hos ts
can acce s s an are a
of the s e rve r.
Acce s s can be
controlle d by
hos tname , IP
addre s s , IP addre s s
range . The
e nvironme nt
variable s s e ttings
are not s upporte d in
the us e r inte rface .
The argume nts for
the De ny dire ctive
are ide ntical to the
argume nts for the
Allow dire ctive .
no
Allow
no
De ny
no
no
AllowOve rride
AddDe faultChars e t
De ny
Allow Ove rride
Add De fault Chars e t
This dire ctive
s pe cifie s a de fault
value for the me dia
type chars e t
parame te r (the
name of a characte r
e ncoding) to be
adde d to a re s pons e
if and only if the
re s pons e 's conte nttype is e ithe r
te xt/plain or
te xt/html. Value
"Off" dis able s this
functionality. "On"
e nable s a de fault
chars e t of is o-88591. Any othe r value is
as s ume d to be the
chars e t to be us e d,
which s hould be one
of the IANA
re gis te re d chars e t
value s for us e in
MIME me dia type s .
115
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
De fault Type
The re will be time s
no
whe n the s e rve r is
as ke d to provide a
docume nt whos e
type cannot be
de te rmine d by its
MIME type s
mappings . The
s e rve r SHOULD
inform the clie nt of
the conte nt-type of
the docume nt. If the
s e rve r is unable to
de te rmine this by
normal me ans , it will
s e t it to the
configure d
De faultType .
Se ts the lis t of
no
re s ource s to look
for, whe n the clie nt
re que s ts an inde x of
the dire ctory by
s pe cifying a / at the
e nd of the dire ctory
name . Note that the
docume nts do not
ne e d to be re lative
to the dire ctory.
Dire ctory Inde x
116
Required
Int ernal Name
De faultType
Dire ctoryInde x
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Error Docume nt
In the e ve nt of a
ye s
proble m or e rror,
Apache can be
configure d to do one
of four things , 1.
output a s imple
hardcode d e rror
me s s age , 2. output
a cus tomiz e d
me s s age , 3. re dire ct
to a local URL-path to
handle the
proble m/e rror, 4.
re dire ct to an
e xte rnal URL to
handle the
proble m/e rror. The
firs t option is the
de fault, while
options 2-4 are
configure d us ing the
ErrorDocume nt
dire ctive , which is
followe d by the HTTP
re s pons e code and
a URL or a me s s age .
Apache will
s ome time s offe r
additional
information
re garding the
proble m/e rror.
The Options
no
dire ctive controls
which s e rve r
fe ature s are
available in a
particular dire ctory.
Options
Required
Int ernal Name
ErrorDocume nt
Options
117
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Us e Canonical Name
With
no
Us e CanonicalName
On Apache will us e
the hos tname and
port s pe cifie d in the
Se rve rName
dire ctive to
cons truct the
canonical name for
the s e rve r. This
name is us e d in all
s e lf-re fe re ntial
URLs , and for the
value s of
SERVER_NAME and
SERVER_PORT in
CGIs . With
Us e CanonicalName
Off Apache will form
s e lf-re fe re ntial URLs
us ing the hos tname
and port s upplie d by
the clie nt if any are
s upplie d (othe rwis e
it will us e the
canonical name , as
de fine d above ).
Us e CanonicalName
DNS is inte nde d for
us e with mas s IPbas e d virtual hos ting
to s upport ancie nt
clie nts that do not
provide a Hos t:
he ade r. With this
option Apache doe s
a re ve rs e DNS
lookup on the s e rve r
IP addre s s that the
clie nt conne cte d to
in orde r to work out
s e lf-re fe re ntial
URLs .
118
Required
Int ernal Name
Us e CanonicalName
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Required
Us e Canonical
Phys ical Port
In many s ituations
no
Apache mus t
cons truct a s e lfre fe re ntial URL -that is , a URL that
re fe rs back to the
s ame s e rve r. With
Us e CanonicalPhys ica
lPort On Apache will,
whe n cons tructing
the canonical port
for the s e rve r to
honor the
Us e CanonicalName
dire ctive , provide
the actual phys ical
port numbe r be ing
us e d by this re que s t
as a pote ntial port.
With
Us e CanonicalPhys ica
lPort Off Apache will
not e ve r us e the
actual phys ical port
numbe r, ins te ad
re lying on all
configure d
information to
cons truct a valid port
numbe r.
Int ernal Name
Us e CanonicalPhys ica
lPort
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
2.1.1.2. Apache - If Module Service
Overview
T able 2.16. Overview
De s cription:
Single ton:
no
119
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Plugin:
Apache
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
none
Met rics
none
Co nf igurat io n Pro pert ies
T able 2.17.
Name
Descript io n
IfModule Conditions
Lis t of module s
ye s
which mus t be
loade d to us e
dire ctive
configuration.
The Orde r dire ctive , no
along with the Allow
and De ny dire ctive s ,
controls a thre e pas s acce s s control
s ys te m. The firs t
pas s proce s s e s
e ithe r all Allow or all
De ny dire ctive s , as
s pe cifie d by the
Orde r dire ctive . The
s e cond pas s pars e s
the re s t of the
dire ctive s (De ny or
Allow). The third
pas s applie s to all
re que s ts which do
not match e ithe r of
the firs t two.
Orde r
120
Required
Int ernal Name
IfModule s
Orde r
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Allow
The Allow dire ctive
affe cts which hos ts
can acce s s an are a
of the s e rve r.
Acce s s can be
controlle d by
hos tname , IP
addre s s , IP addre s s
range . The
e nvironme nt
variable s s e ttings
are not s upporte d in
the us e r inte rface .
The argume nts for
the De ny dire ctive
are ide ntical to the
argume nts for the
Allow dire ctive .
no
Allow
no
De ny
no
no
AllowOve rride
AddDe faultChars e t
De ny
Allow Ove rride
Add De fault Chars e t
This dire ctive
s pe cifie s a de fault
value for the me dia
type chars e t
parame te r (the
name of a characte r
e ncoding) to be
adde d to a re s pons e
if and only if the
re s pons e 's conte nttype is e ithe r
te xt/plain or
te xt/html. Value
"Off" dis able s this
functionality. "On"
e nable s a de fault
chars e t of is o-88591. Any othe r value is
as s ume d to be the
chars e t to be us e d,
which s hould be one
of the IANA
re gis te re d chars e t
value s for us e in
MIME me dia type s .
121
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
De fault Type
The re will be time s
no
whe n the s e rve r is
as ke d to provide a
docume nt whos e
type cannot be
de te rmine d by its
MIME type s
mappings . The
s e rve r SHOULD
inform the clie nt of
the conte nt-type of
the docume nt. If the
s e rve r is unable to
de te rmine this by
normal me ans , it will
s e t it to the
configure d
De faultType .
Se ts the lis t of
no
re s ource s to look
for, whe n the clie nt
re que s ts an inde x of
the dire ctory by
s pe cifying a / at the
e nd of the dire ctory
name . Note that the
docume nts do not
ne e d to be re lative
to the dire ctory.
Dire ctory Inde x
122
Required
Int ernal Name
De faultType
Dire ctoryInde x
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Error Docume nt
In the e ve nt of a
ye s
proble m or e rror,
Apache can be
configure d to do one
of four things , 1.
output a s imple
hardcode d e rror
me s s age , 2. output
a cus tomiz e d
me s s age , 3. re dire ct
to a local URL-path to
handle the
proble m/e rror, 4.
re dire ct to an
e xte rnal URL to
handle the
proble m/e rror. The
firs t option is the
de fault, while
options 2-4 are
configure d us ing the
ErrorDocume nt
dire ctive , which is
followe d by the HTTP
re s pons e code and
a URL or a me s s age .
Apache will
s ome time s offe r
additional
information
re garding the
proble m/e rror.
The Options
no
dire ctive controls
which s e rve r
fe ature s are
available in a
particular dire ctory.
Options
Required
Int ernal Name
ErrorDocume nt
Options
123
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Us e Canonical Name
With
no
Us e CanonicalName
On Apache will us e
the hos tname and
port s pe cifie d in the
Se rve rName
dire ctive to
cons truct the
canonical name for
the s e rve r. This
name is us e d in all
s e lf-re fe re ntial
URLs , and for the
value s of
SERVER_NAME and
SERVER_PORT in
CGIs . With
Us e CanonicalName
Off Apache will form
s e lf-re fe re ntial URLs
us ing the hos tname
and port s upplie d by
the clie nt if any are
s upplie d (othe rwis e
it will us e the
canonical name , as
de fine d above ).
Us e CanonicalName
DNS is inte nde d for
us e with mas s IPbas e d virtual hos ting
to s upport ancie nt
clie nts that do not
provide a Hos t:
he ade r. With this
option Apache doe s
a re ve rs e DNS
lookup on the s e rve r
IP addre s s that the
clie nt conne cte d to
in orde r to work out
s e lf-re fe re ntial
URLs .
124
Required
Int ernal Name
Us e CanonicalName
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Required
Us e Canonical
Phys ical Port
In many s ituations
no
Apache mus t
cons truct a s e lfre fe re ntial URL -that is , a URL that
re fe rs back to the
s ame s e rve r. With
Us e CanonicalPhys ica
lPort On Apache will,
whe n cons tructing
the canonical port
for the s e rve r to
honor the
Us e CanonicalName
dire ctive , provide
the actual phys ical
port numbe r be ing
us e d by this re que s t
as a pote ntial port.
With
Us e CanonicalPhys ica
lPort Off Apache will
not e ve r us e the
actual phys ical port
numbe r, ins te ad
re lying on all
configure d
information to
cons truct a valid port
numbe r.
Int ernal Name
Us e CanonicalPhys ica
lPort
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
2.1.2. Apache - Mod JK Service
Overview
T able 2.18. Overview
De s cription:
Manage me nt of mod_jk
125
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Single ton:
Plugin:
ye s
Apache
Child Resource T ypes
none
Connect ion Propert ies
T able 2.19.
Name
Descript io n
Path to
worke rs .prope rtie s
The path to the file
no
containing worke r
prope rtie s . If this is
a re lative path, it will
be looke d up in the
s e rve r root of the
pare nt Apache
s e rve r
The path to the file
no
containing uri to
worke r mappings . If
this is a re lative
path, it will be looke d
up in the s e rve r root
of the pare nt
Apache s e rve r
Path to the
uriworke rs file
Required
Int ernal Name
worke rFile
uriWorke rFile
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
2.2. IIS - Server
126
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Overview
T able 2.20 . Overview
De s cription:
Single ton:
Plugin:
IIS We b Se rve r
no
IIS
Child Resource T ypes
Se ction 2.2.1, “IIS - VHos t Se rvice ”
Aut odiscovery Process Scans
none
Connect ion Propert ies
none
Met rics
T able 2.21. Met rics
Name
T ype
Descript io n
Int ernal Name
Byte s Se nt
me as ure me nt
Byte s Se nt/s e c
Byte s Se nt pe r
Minute
me as ure me nt
Byte s Re ce ive d
me as ure me nt
Byte s Re ce ive d pe r
Minute
me as ure me nt
Total File s Se nt
me as ure me nt
Total File s Se nt pe r
Minute
me as ure me nt
Shows the rate that
data byte s are s e nt
by the We b s e rvice .
Shows the rate that
data byte s are s e nt
by the We b s e rvice .
Shows the rate that
data byte s are
re ce ive d by the We b
s e rvice .
Shows the rate that
data byte s are
re ce ive d by the We b
s e rvice .
Shows the total
numbe r of file s s e nt
by the We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the total
numbe r of file s s e nt
by the We b s e rvice
(counte d s ince
s e rvice s tartup).
Byte s Se nt/s e c
Byte s Re ce ive d/s e c
Byte s Re ce ive d/s e c
Total File s Se nt
Total File s Se nt
127
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total File s Re ce ive d
me as ure me nt
Total File s Re ce ive d
Total File s Re ce ive d
pe r Minute
me as ure me nt
Total File s
Trans fe rre d
me as ure me nt
Total File s
Trans fe rre d pe r
Minute
me as ure me nt
Curre nt Anonymous
Us e rs
me as ure me nt
Curre nt
NonAnonymous
Us e rs
me as ure me nt
Total Anonymous
Us e rs
me as ure me nt
Shows the total
numbe r of file s
re ce ive d by the We b
s e rvice (counte d
s ince s e rvice
s tartup).
Shows the total
numbe r of file s
re ce ive d by the We b
s e rvice (counte d
s ince s e rvice
s tartup).
Shows the s um of
File s Se nt and File s
Re ce ive d. This is the
total numbe r of file s
trans fe rre d by the
We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the s um of
File s Se nt and File s
Re ce ive d. This is the
total numbe r of file s
trans fe rre d by the
We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the numbe r
of us e rs who
curre ntly have an
anonymous
conne ction us ing the
We b s e rvice .
Shows the numbe r
of us e rs who
curre ntly have a
non-anonymous
conne ction us ing the
We b s e rvice .
Shows the total
numbe r of us e rs
who e s tablis he d an
anonymous
conne ction with the
We b s e rvice
(counte d s ince
s e rvice s tartup).
128
Total File s Re ce ive d
Total File s
Trans fe rre d
Total File s
Trans fe rre d
Curre nt Anonymous
Us e rs
Curre nt
NonAnonymous
Us e rs
Total Anonymous
Us e rs
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total Anonymous
Us e rs pe r Minute
me as ure me nt
Total Anonymous
Us e rs
Total Non
Anonymous Us e rs
me as ure me nt
Total Non
Anonymous Us e rs
pe r Minute
me as ure me nt
Maximum
Anonymous Us e rs
me as ure me nt
Maximum Non
Anonymous Us e rs
me as ure me nt
Curre nt Conne ctions
me as ure me nt
Maximum
Conne ctions
me as ure me nt
Shows the total
numbe r of us e rs
who e s tablis he d an
anonymous
conne ction with the
We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the total
numbe r of us e rs
who e s tablis he d a
non-anonymous
conne ction with the
We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the total
numbe r of us e rs
who e s tablis he d a
non-anonymous
conne ction with the
We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the maximum
numbe r of us e rs
who e s tablis he d
concurre nt
anonymous
conne ctions us ing
the We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the maximum
numbe r of us e rs
who e s tablis he d
concurre nt nonanonymous
conne ctions us ing
the We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the curre nt
numbe r of
conne ctions
e s tablis he d with the
We b s e rvice .
Shows the maximum
numbe r of
s imultane ous
conne ctions
e s tablis he d with the
We b s e rvice .
Total NonAnonymous
Us e rs
Total NonAnonymous
Us e rs
Maximum
Anonymous Us e rs
Maximum
NonAnonymous
Us e rs
Curre nt Conne ctions
Maximum
Conne ctions
129
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total Logon
Atte mpts
me as ure me nt
Total Logon Atte mpts
Total Logon
Atte mpts pe r Minute
me as ure me nt
Total GET Re que s ts
me as ure me nt
Total GET Re que s ts
pe r Minute
me as ure me nt
Total POST
Re que s ts
me as ure me nt
Shows the numbe r
of logons that have
be e n atte mpte d
us ing the We b
s e rvice (counte d
s ince s e rvice
s tartup).
Shows the numbe r
of logons that have
be e n atte mpte d
us ing the We b
s e rvice (counte d
s ince s e rvice
s tartup).
Shows the numbe r
of HTTP re que s ts
us ing the GET
me thod (counte d
s ince s e rvice
s tartup). GET
re que s ts are
ge ne rally us e d for
bas ic file re trie vals
or image maps ,
though the y can be
us e d with forms .
Shows the numbe r
of HTTP re que s ts
us ing the GET
me thod (counte d
s ince s e rvice
s tartup). GET
re que s ts are
ge ne rally us e d for
bas ic file re trie vals
or image maps ,
though the y can be
us e d with forms .
Shows the numbe r
of HTTP re que s ts
us ing the POST
me thod (counte d
s ince s e rvice
s tartup). POST
re que s ts are
ge ne rally us e d for
forms or gate way
re que s ts .
130
Total Logon Atte mpts
Total Ge t Re que s ts
Total Ge t Re que s ts
Total Pos t Re que s ts
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total POST
Re que s ts pe r Minute
me as ure me nt
Total Pos t Re que s ts
Total HEAD
Re que s ts
me as ure me nt
Total HEAD
Re que s ts pe r Minute
me as ure me nt
Total PUT Re que s ts
me as ure me nt
Total PUT Re que s ts
pe r Minute
me as ure me nt
Shows the numbe r
of HTTP re que s ts
us ing the POST
me thod (counte d
s ince s e rvice
s tartup). POST
re que s ts are
ge ne rally us e d for
forms or gate way
re que s ts .
Shows the numbe r
of HTTP re que s ts
us ing the HEAD
me thod (counte d
s ince s e rvice
s tartup). He ad
re que s ts ge ne rally
indicate a clie nt is
que rying the s tate of
a docume nt the y
alre ady have to s e e
if it ne e ds to be
re fre s he d.
Shows the numbe r
of HTTP re que s ts
us ing the HEAD
me thod (counte d
s ince s e rvice
s tartup). He ad
re que s ts ge ne rally
indicate a clie nt is
que rying the s tate of
a docume nt the y
alre ady have to s e e
if it ne e ds to be
re fre s he d.
Shows the numbe r
of HTTP re que s ts
us ing the PUT
me thod (counte d
s ince s e rvice
s tartup).
Shows the numbe r
of HTTP re que s ts
us ing the PUT
me thod (counte d
s ince s e rvice
s tartup).
Total He ad Re que s ts
Total He ad Re que s ts
Total Put Re que s ts
Total Put Re que s ts
131
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total DELETE
Re que s ts
me as ure me nt
Total De le te
Re que s ts
Total DELETE
Re que s ts pe r Minute
me as ure me nt
Total TRACE
Re que s ts
me as ure me nt
Total TRACE
Re que s ts pe r Minute
me as ure me nt
Shows the numbe r
of HTTP re que s ts
us ing the DELETE
me thod (counte d
s ince s e rvice
s tartup). De le te
re que s ts are
ge ne rally us e d for
file re movals .
Shows the numbe r
of HTTP re que s ts
us ing the DELETE
me thod (counte d
s ince s e rvice
s tartup). De le te
re que s ts are
ge ne rally us e d for
file re movals .
Shows the numbe r
of HTTP re que s ts
us ing the TRACE
me thod (counte d
s ince s e rvice
s tartup). TRACE
re que s ts allow the
clie nt to s e e what is
be ing re ce ive d at
the e nd of the
re que s t chain and
us e the information
for diagnos tic
purpos e s .
Shows the numbe r
of HTTP re que s ts
us ing the TRACE
me thod (counte d
s ince s e rvice
s tartup). TRACE
re que s ts allow the
clie nt to s e e what is
be ing re ce ive d at
the e nd of the
re que s t chain and
us e the information
for diagnos tic
purpos e s .
132
Total De le te
Re que s ts
Total Trace
Re que s ts
Total Trace
Re que s ts
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total Othe r Re que s t
Me thods
me as ure me nt
Total Othe r Re que s t
Me thods
Total Othe r Re que s t
Me thods pe r Minute
me as ure me nt
Total Me thod
Re que s ts
me as ure me nt
Total Me thod
Re que s ts pe r Minute
me as ure me nt
Shows the numbe r
of HTTP re que s ts
that are not
OPTIONS, GET, HEAD,
POST, PUT, DELETE,
TRACE, MOVE, COPY,
MKCOL, PROPFIND,
PROPPATCH, MSSEARCH, LOCK or
UNLOCK me thods
(counte d s ince
s e rvice s tartup).
The s e may include
LINK or othe r
me thods s upporte d
by gate way
applications .
Shows the numbe r
of HTTP re que s ts
that are not
OPTIONS, GET, HEAD,
POST, PUT, DELETE,
TRACE, MOVE, COPY,
MKCOL, PROPFIND,
PROPPATCH, MSSEARCH, LOCK or
UNLOCK me thods
(counte d s ince
s e rvice s tartup).
The s e may include
LINK or othe r
me thods s upporte d
by gate way
applications .
Shows the numbe r
of all HTTP re que s ts
(counte d s ince
s e rvice s tartup).
Shows the numbe r
of all HTTP re que s ts
(counte d s ince
s e rvice s tartup).
Total Othe r Re que s t
Me thods
Total Me thod
Re que s ts
Total Me thod
Re que s ts
133
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Total CGI Re que s ts
me as ure me nt
Total CGI Re que s ts
pe r Minute
me as ure me nt
Shows the total
Total CGI Re que s ts
numbe r of CGI
re que s ts . CGI
re que s ts are cus tom
gate way
e xe cutable s (.e xe )
the adminis trator
can ins tall to add
forms proce s s ing or
othe r dynamic data
s ource s . CGI
re que s ts initiate a
proce s s on the
s e rve r which can be
a large drain on
s e rve r re s ource s .
The count is the total
s ince s e rvice
s tartup.
Shows the total
Total CGI Re que s ts
numbe r of CGI
re que s ts . CGI
re que s ts are cus tom
gate way
e xe cutable s (.e xe )
the adminis trator
can ins tall to add
forms proce s s ing or
othe r dynamic data
s ource s . CGI
re que s ts initiate a
proce s s on the
s e rve r which can be
a large drain on
s e rve r re s ource s .
The count is the total
s ince s e rvice
s tartup.
134
Int ernal Name
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total ISAPI
Exte ns ion Re que s ts
me as ure me nt
Total ISAPI Exte ns ion
Re que s ts
Total ISAPI
Exte ns ion Re que s ts
pe r Minute
me as ure me nt
Shows the total
numbe r of ISAPI
Exte ns ion Re que s ts .
ISAPI Exte ns ion
Re que s ts are
cus tom gate way
Dynamic Link
Librarie s (.dll) the
adminis trator can
ins tall to add forms
proce s s ing or othe r
dynamic data
s ource s . Unlike CGI
re que s ts , ISAPI
re que s ts are s imple
calls to a DLL library
routine , thus the y
are be tte r s uite d to
high pe rformance
gate way
applications . The
count is the total
s ince s e rvice
s tartup.
Shows the total
numbe r of ISAPI
Exte ns ion Re que s ts .
ISAPI Exte ns ion
Re que s ts are
cus tom gate way
Dynamic Link
Librarie s (.dll) the
adminis trator can
ins tall to add forms
proce s s ing or othe r
dynamic data
s ource s . Unlike CGI
re que s ts , ISAPI
re que s ts are s imple
calls to a DLL library
routine , thus the y
are be tte r s uite d to
high pe rformance
gate way
applications . The
count is the total
s ince s e rvice
s tartup.
Total ISAPI Exte ns ion
Re que s ts
135
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total Not Found
Errors
me as ure me nt
Total Not Found
Errors
Total Not Found
Errors pe r Minute
me as ure me nt
Total Locke d Errors
me as ure me nt
Total Locke d Errors
pe r Minute
me as ure me nt
Shows the numbe r
of re que s ts that
could not be
s atis fie d by the
s e rve r be caus e the
re que s te d docume nt
could not be found.
The s e are ge ne rally
re porte d as an HTTP
404 e rror code to
the clie nt. The count
is the total s ince
s e rvice s tartup.
Shows the numbe r
of re que s ts that
could not be
s atis fie d by the
s e rve r be caus e the
re que s te d docume nt
could not be found.
The s e are ge ne rally
re porte d as an HTTP
404 e rror code to
the clie nt. The count
is the total s ince
s e rvice s tartup.
Shows the numbe r
of re que s ts that
could not be
s atis fie d by the
s e rve r be caus e the
re que s te d was
locke d. The s e are
ge ne rally re porte d
as an HTTP 423
e rror code to the
clie nt. The count is
the total s ince
s e rvice s tartup.
Shows the numbe r
of re que s ts that
could not be
s atis fie d by the
s e rve r be caus e the
re que s te d was
locke d. The s e are
ge ne rally re porte d
as an HTTP 423
e rror code to the
clie nt. The count is
the total s ince
s e rvice s tartup.
136
Total Not Found
Errors
Total Locke d Errors
Total Locke d Errors
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Curre nt CGI
Re que s ts
me as ure me nt
Curre nt CGI
Re que s ts
Curre nt CGI
Re que s ts pe r Minute
me as ure me nt
Curre nt ISAPI
Exte ns ion Re que s ts
me as ure me nt
Maximum CGI
Re que s ts
me as ure me nt
Maximum ISAPI
Exte ns ion Re que s ts
me as ure me nt
Total Blocke d As ync
I/O Re que s ts
me as ure me nt
Total Blocke d As ync
I/O Re que s ts pe r
Minute
me as ure me nt
Shows the curre nt
numbe r of CGI
re que s ts that are
s imultane ous ly
be ing proce s s e d by
the We b s e rvice .
Shows the curre nt
numbe r of CGI
re que s ts that are
s imultane ous ly
be ing proce s s e d by
the We b s e rvice .
Shows the curre nt
numbe r of Exte ns ion
re que s ts that are
s imultane ous ly
be ing proce s s e d by
the We b s e rvice .
Shows the maximum
numbe r of CGI
re que s ts
s imultane ous ly
proce s s e d by the
We b s e rvice .
Shows the maximum
numbe r of Exte ns ion
re que s ts
s imultane ous ly
proce s s e d by the
We b s e rvice .
Shows the numbe r
of total re que s ts
te mporarily blocke d
due to bandwidth
throttling s e ttings
(counte d s ince
s e rvice s tartup).
Shows the numbe r
of total re que s ts
te mporarily blocke d
due to bandwidth
throttling s e ttings
(counte d s ince
s e rvice s tartup).
Curre nt CGI
Re que s ts
Curre nt ISAPI
Exte ns ion Re que s ts
Maximum CGI
Re que s ts
Maximum ISAPI
Exte ns ion Re que s ts
Total Blocke d As ync
I/O Re que s ts
Total Blocke d As ync
I/O Re que s ts
137
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total Allowe d As ync
I/O Re que s ts
me as ure me nt
Total Allowe d As ync
I/O Re que s ts
Total Allowe d As ync
I/O Re que s ts pe r
Minute
me as ure me nt
Total Re je cte d
As ync I/O Re que s ts
me as ure me nt
Total Re je cte d
As ync I/O Re que s ts
pe r Minute
me as ure me nt
Curre nt Blocke d
As ync I/O Re que s ts
me as ure me nt
Me as ure d As ync I/O
Bandwidth Us age
me as ure me nt
Shows the total
numbe r of re que s ts
allowe d by
bandwidth throttling
s e ttings (counte d
s ince s e rvice
s tartup). Whe n
bandwidth throttling
is de fine d, the
numbe r of allowe d
us e r re que s ts is
re s tricte d.
Shows the total
numbe r of re que s ts
allowe d by
bandwidth throttling
s e ttings (counte d
s ince s e rvice
s tartup). Whe n
bandwidth throttling
is de fine d, the
numbe r of allowe d
us e r re que s ts is
re s tricte d.
Shows the total
numbe r of re que s ts
re je cte d due to
bandwidth throttling
s e ttings (counte d
s ince s e rvice
s tartup).
Shows the total
numbe r of re que s ts
re je cte d due to
bandwidth throttling
s e ttings (counte d
s ince s e rvice
s tartup).
Shows curre nt
re que s ts that are
te mporarily blocke d
due to bandwidth
throttling s e ttings .
Shows the
me as ure d bandwidth
of as ynchronous I/O
ave rage d ove r a
minute .
138
Total Allowe d As ync
I/O Re que s ts
Total Re je cte d As ync
I/O Re que s ts
Total Re je cte d As ync
I/O Re que s ts
Curre nt Blocke d
As ync I/O Re que s ts
Me as ure d As ync I/O
Bandwidth Us age
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total Conne ction
Atte mpts (all
Ins tance s )
me as ure me nt
Total Conne ction
Atte mpts (all
ins tance s )
Total Conne ction
Atte mpts (all
Ins tance s ) pe r
Minute
me as ure me nt
Se rvice Uptime
me as ure me nt
Shows the numbe r
of conne ctions that
have be e n
atte mpte d us ing the
We b s e rvice
(counte d s ince
s e rvice s tartup).
This counte r is for all
ins tance s lis te d.
Shows the numbe r
of conne ctions that
have be e n
atte mpte d us ing the
We b s e rvice
(counte d s ince
s e rvice s tartup).
This counte r is for all
ins tance s lis te d.
The amount of time
this s e rvice has
be e n up for
Total Conne ction
Atte mpts (all
ins tance s )
Se rvice Uptime
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 2.22. Met rics
Name
Descript io n
Start
Starts IIS and, if ne ce s s ary, de pe nde nt
s e rvice s
Shuts down IIS
Stop
Package T ypes
none
2.2.1. IIS - VHost Service
Overview
T able 2.23. Overview
139
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
De s cription:
Single ton:
Plugin:
IIS VHos t
no
IIS
Child Resource T ypes
none
Connect ion Propert ies
T able 2.24.
Name
Site Name
Hos tname
Port
Ip Addre s s
Doc Root
Ss l
Log Dire ctory
Log Format
Re s pons e Time Url
Exclude s
140
Descript io n
The format log
e ntrie s are writte n
in. This is a pe r-s ite ,
ge ne ral option of the
W3C Exte nde d Log
File Format. Format
mus t contain the
following toke ns 'date ' ,'time ' , 'c-ip',
'cs -uri-s te m', 's cs tatus ', and 'time take n' - but can
include othe rs .
Toke ns mus t *not*
have quote s around
the m, and s hould be
s pace -de limite d.
a s pace -de limite d
lis t of re gular
e xpre s s ions
s pe cifying URLs that
s hould be e xclude d
from re s pons e -time
s tats colle ction
Required
Int ernal Name
ye s
ye s
ye s
ye s
ye s
ye s
ye s
ye s
s ite Name
hos tname
port
ipAddre s s
docRoot
ssl
logDire ctory
re s pons e Time LogFor
mat
no
re s pons e Time UrlExc
lude s
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Re s pons e Time Url
Trans forms
a s pace -de limite d
lis t of Pe rl-s tyle
s ubs titution
e xpre s s ions that
s hould be applie d to
all URLs for which
re s pons e -time s tats
are colle cte d (e .g.
|^/de pt/finance /.*|/de
pt/finance /*|)
no
re s pons e Time UrlTra
ns forms
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 2.25. Met rics
Name
T ype
Descript io n
Int ernal Name
Byte s Se nt
me as ure me nt
Byte s Se nt/s e c
Byte s Se nt pe r
Minute
me as ure me nt
Byte s Re ce ive d
me as ure me nt
Byte s Re ce ive d pe r
Minute
me as ure me nt
Total File s Se nt
me as ure me nt
Total File s Se nt pe r
Minute
me as ure me nt
Shows the rate that
data byte s are s e nt
by the We b s e rvice .
Shows the rate that
data byte s are s e nt
by the We b s e rvice .
Shows the rate that
data byte s are
re ce ive d by the We b
s e rvice .
Shows the rate that
data byte s are
re ce ive d by the We b
s e rvice .
Shows the total
numbe r of file s s e nt
by the We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the total
numbe r of file s s e nt
by the We b s e rvice
(counte d s ince
s e rvice s tartup).
Byte s Se nt/s e c
Byte s Re ce ive d/s e c
Byte s Re ce ive d/s e c
Total File s Se nt
Total File s Se nt
141
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total File s Re ce ive d
me as ure me nt
Total File s Re ce ive d
Total File s Re ce ive d
pe r Minute
me as ure me nt
Total File s
Trans fe rre d
me as ure me nt
Total File s
Trans fe rre d pe r
Minute
me as ure me nt
Curre nt Anonymous
Us e rs
me as ure me nt
Curre nt
NonAnonymous
Us e rs
me as ure me nt
Total Anonymous
Us e rs
me as ure me nt
Shows the total
numbe r of file s
re ce ive d by the We b
s e rvice (counte d
s ince s e rvice
s tartup).
Shows the total
numbe r of file s
re ce ive d by the We b
s e rvice (counte d
s ince s e rvice
s tartup).
Shows the s um of
File s Se nt and File s
Re ce ive d. This is the
total numbe r of file s
trans fe rre d by the
We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the s um of
File s Se nt and File s
Re ce ive d. This is the
total numbe r of file s
trans fe rre d by the
We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the numbe r
of us e rs who
curre ntly have an
anonymous
conne ction us ing the
We b s e rvice .
Shows the numbe r
of us e rs who
curre ntly have a
non-anonymous
conne ction us ing the
We b s e rvice .
Shows the total
numbe r of us e rs
who e s tablis he d an
anonymous
conne ction with the
We b s e rvice
(counte d s ince
s e rvice s tartup).
142
Total File s Re ce ive d
Total File s
Trans fe rre d
Total File s
Trans fe rre d
Curre nt Anonymous
Us e rs
Curre nt
NonAnonymous
Us e rs
Total Anonymous
Us e rs
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total Anonymous
Us e rs pe r Minute
me as ure me nt
Total Anonymous
Us e rs
Total Non
Anonymous Us e rs
me as ure me nt
Total Non
Anonymous Us e rs
pe r Minute
me as ure me nt
Maximum
Anonymous Us e rs
me as ure me nt
Maximum Non
Anonymous Us e rs
me as ure me nt
Curre nt Conne ctions
me as ure me nt
Maximum
Conne ctions
me as ure me nt
Shows the total
numbe r of us e rs
who e s tablis he d an
anonymous
conne ction with the
We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the total
numbe r of us e rs
who e s tablis he d a
non-anonymous
conne ction with the
We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the total
numbe r of us e rs
who e s tablis he d a
non-anonymous
conne ction with the
We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the maximum
numbe r of us e rs
who e s tablis he d
concurre nt
anonymous
conne ctions us ing
the We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the maximum
numbe r of us e rs
who e s tablis he d
concurre nt nonanonymous
conne ctions us ing
the We b s e rvice
(counte d s ince
s e rvice s tartup).
Shows the curre nt
numbe r of
conne ctions
e s tablis he d with the
We b s e rvice .
Shows the maximum
numbe r of
s imultane ous
conne ctions
e s tablis he d with the
We b s e rvice .
Total NonAnonymous
Us e rs
Total NonAnonymous
Us e rs
Maximum
Anonymous Us e rs
Maximum
NonAnonymous
Us e rs
Curre nt Conne ctions
Maximum
Conne ctions
143
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total Logon
Atte mpts
me as ure me nt
Total Logon Atte mpts
Total Logon
Atte mpts pe r Minute
me as ure me nt
Total GET Re que s ts
me as ure me nt
Total GET Re que s ts
pe r Minute
me as ure me nt
Total POST
Re que s ts
me as ure me nt
Shows the numbe r
of logons that have
be e n atte mpte d
us ing the We b
s e rvice (counte d
s ince s e rvice
s tartup).
Shows the numbe r
of logons that have
be e n atte mpte d
us ing the We b
s e rvice (counte d
s ince s e rvice
s tartup).
Shows the numbe r
of HTTP re que s ts
us ing the GET
me thod (counte d
s ince s e rvice
s tartup). GET
re que s ts are
ge ne rally us e d for
bas ic file re trie vals
or image maps ,
though the y can be
us e d with forms .
Shows the numbe r
of HTTP re que s ts
us ing the GET
me thod (counte d
s ince s e rvice
s tartup). GET
re que s ts are
ge ne rally us e d for
bas ic file re trie vals
or image maps ,
though the y can be
us e d with forms .
Shows the numbe r
of HTTP re que s ts
us ing the POST
me thod (counte d
s ince s e rvice
s tartup). POST
re que s ts are
ge ne rally us e d for
forms or gate way
re que s ts .
144
Total Logon Atte mpts
Total Ge t Re que s ts
Total Ge t Re que s ts
Total Pos t Re que s ts
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total POST
Re que s ts pe r Minute
me as ure me nt
Total Pos t Re que s ts
Total HEAD
Re que s ts
me as ure me nt
Total HEAD
Re que s ts pe r Minute
me as ure me nt
Total PUT Re que s ts
me as ure me nt
Total PUT Re que s ts
pe r Minute
me as ure me nt
Shows the numbe r
of HTTP re que s ts
us ing the POST
me thod (counte d
s ince s e rvice
s tartup). POST
re que s ts are
ge ne rally us e d for
forms or gate way
re que s ts .
Shows the numbe r
of HTTP re que s ts
us ing the HEAD
me thod (counte d
s ince s e rvice
s tartup). He ad
re que s ts ge ne rally
indicate a clie nt is
que rying the s tate of
a docume nt the y
alre ady have to s e e
if it ne e ds to be
re fre s he d.
Shows the numbe r
of HTTP re que s ts
us ing the HEAD
me thod (counte d
s ince s e rvice
s tartup). He ad
re que s ts ge ne rally
indicate a clie nt is
que rying the s tate of
a docume nt the y
alre ady have to s e e
if it ne e ds to be
re fre s he d.
Shows the numbe r
of HTTP re que s ts
us ing the PUT
me thod (counte d
s ince s e rvice
s tartup).
Shows the numbe r
of HTTP re que s ts
us ing the PUT
me thod (counte d
s ince s e rvice
s tartup).
Total He ad Re que s ts
Total He ad Re que s ts
Total Put Re que s ts
Total Put Re que s ts
145
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total DELETE
Re que s ts
me as ure me nt
Total De le te
Re que s ts
Total DELETE
Re que s ts pe r Minute
me as ure me nt
Total TRACE
Re que s ts
me as ure me nt
Total TRACE
Re que s ts pe r Minute
me as ure me nt
Shows the numbe r
of HTTP re que s ts
us ing the DELETE
me thod (counte d
s ince s e rvice
s tartup). De le te
re que s ts are
ge ne rally us e d for
file re movals .
Shows the numbe r
of HTTP re que s ts
us ing the DELETE
me thod (counte d
s ince s e rvice
s tartup). De le te
re que s ts are
ge ne rally us e d for
file re movals .
Shows the numbe r
of HTTP re que s ts
us ing the TRACE
me thod (counte d
s ince s e rvice
s tartup). TRACE
re que s ts allow the
clie nt to s e e what is
be ing re ce ive d at
the e nd of the
re que s t chain and
us e the information
for diagnos tic
purpos e s .
Shows the numbe r
of HTTP re que s ts
us ing the TRACE
me thod (counte d
s ince s e rvice
s tartup). TRACE
re que s ts allow the
clie nt to s e e what is
be ing re ce ive d at
the e nd of the
re que s t chain and
us e the information
for diagnos tic
purpos e s .
146
Total De le te
Re que s ts
Total Trace
Re que s ts
Total Trace
Re que s ts
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total Othe r Re que s t
Me thods
me as ure me nt
Total Othe r Re que s t
Me thods
Total Othe r Re que s t
Me thods pe r Minute
me as ure me nt
Total Me thod
Re que s ts
me as ure me nt
Total Me thod
Re que s ts pe r Minute
me as ure me nt
Shows the numbe r
of HTTP re que s ts
that are not
OPTIONS, GET, HEAD,
POST, PUT, DELETE,
TRACE, MOVE, COPY,
MKCOL, PROPFIND,
PROPPATCH, MSSEARCH, LOCK or
UNLOCK me thods
(counte d s ince
s e rvice s tartup).
The s e may include
LINK or othe r
me thods s upporte d
by gate way
applications .
Shows the numbe r
of HTTP re que s ts
that are not
OPTIONS, GET, HEAD,
POST, PUT, DELETE,
TRACE, MOVE, COPY,
MKCOL, PROPFIND,
PROPPATCH, MSSEARCH, LOCK or
UNLOCK me thods
(counte d s ince
s e rvice s tartup).
The s e may include
LINK or othe r
me thods s upporte d
by gate way
applications .
Shows the numbe r
of all HTTP re que s ts
(counte d s ince
s e rvice s tartup).
Shows the numbe r
of all HTTP re que s ts
(counte d s ince
s e rvice s tartup).
Total Othe r Re que s t
Me thods
Total Me thod
Re que s ts
Total Me thod
Re que s ts
147
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Total CGI Re que s ts
me as ure me nt
Total CGI Re que s ts
pe r Minute
me as ure me nt
Shows the total
Total CGI Re que s ts
numbe r of CGI
re que s ts . CGI
re que s ts are cus tom
gate way
e xe cutable s (.e xe )
the adminis trator
can ins tall to add
forms proce s s ing or
othe r dynamic data
s ource s . CGI
re que s ts initiate a
proce s s on the
s e rve r which can be
a large drain on
s e rve r re s ource s .
The count is the total
s ince s e rvice
s tartup.
Shows the total
Total CGI Re que s ts
numbe r of CGI
re que s ts . CGI
re que s ts are cus tom
gate way
e xe cutable s (.e xe )
the adminis trator
can ins tall to add
forms proce s s ing or
othe r dynamic data
s ource s . CGI
re que s ts initiate a
proce s s on the
s e rve r which can be
a large drain on
s e rve r re s ource s .
The count is the total
s ince s e rvice
s tartup.
148
Int ernal Name
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total ISAPI
Exte ns ion Re que s ts
me as ure me nt
Total ISAPI Exte ns ion
Re que s ts
Total ISAPI
Exte ns ion Re que s ts
pe r Minute
me as ure me nt
Shows the total
numbe r of ISAPI
Exte ns ion Re que s ts .
ISAPI Exte ns ion
Re que s ts are
cus tom gate way
Dynamic Link
Librarie s (.dll) the
adminis trator can
ins tall to add forms
proce s s ing or othe r
dynamic data
s ource s . Unlike CGI
re que s ts , ISAPI
re que s ts are s imple
calls to a DLL library
routine , thus the y
are be tte r s uite d to
high pe rformance
gate way
applications . The
count is the total
s ince s e rvice
s tartup.
Shows the total
numbe r of ISAPI
Exte ns ion Re que s ts .
ISAPI Exte ns ion
Re que s ts are
cus tom gate way
Dynamic Link
Librarie s (.dll) the
adminis trator can
ins tall to add forms
proce s s ing or othe r
dynamic data
s ource s . Unlike CGI
re que s ts , ISAPI
re que s ts are s imple
calls to a DLL library
routine , thus the y
are be tte r s uite d to
high pe rformance
gate way
applications . The
count is the total
s ince s e rvice
s tartup.
Total ISAPI Exte ns ion
Re que s ts
149
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total Not Found
Errors
me as ure me nt
Total Not Found
Errors
Total Not Found
Errors pe r Minute
me as ure me nt
Total Locke d Errors
me as ure me nt
Total Locke d Errors
pe r Minute
me as ure me nt
Shows the numbe r
of re que s ts that
could not be
s atis fie d by the
s e rve r be caus e the
re que s te d docume nt
could not be found.
The s e are ge ne rally
re porte d as an HTTP
404 e rror code to
the clie nt. The count
is the total s ince
s e rvice s tartup.
Shows the numbe r
of re que s ts that
could not be
s atis fie d by the
s e rve r be caus e the
re que s te d docume nt
could not be found.
The s e are ge ne rally
re porte d as an HTTP
404 e rror code to
the clie nt. The count
is the total s ince
s e rvice s tartup.
Shows the numbe r
of re que s ts that
could not be
s atis fie d by the
s e rve r be caus e the
re que s te d was
locke d. The s e are
ge ne rally re porte d
as an HTTP 423
e rror code to the
clie nt. The count is
the total s ince
s e rvice s tartup.
Shows the numbe r
of re que s ts that
could not be
s atis fie d by the
s e rve r be caus e the
re que s te d was
locke d. The s e are
ge ne rally re porte d
as an HTTP 423
e rror code to the
clie nt. The count is
the total s ince
s e rvice s tartup.
150
Total Not Found
Errors
Total Locke d Errors
Total Locke d Errors
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Curre nt CGI
Re que s ts
me as ure me nt
Curre nt CGI
Re que s ts
Curre nt CGI
Re que s ts pe r Minute
me as ure me nt
Curre nt ISAPI
Exte ns ion Re que s ts
me as ure me nt
Maximum CGI
Re que s ts
me as ure me nt
Maximum ISAPI
Exte ns ion Re que s ts
me as ure me nt
Total Blocke d As ync
I/O Re que s ts
me as ure me nt
Total Blocke d As ync
I/O Re que s ts pe r
Minute
me as ure me nt
Shows the curre nt
numbe r of CGI
re que s ts that are
s imultane ous ly
be ing proce s s e d by
the We b s e rvice .
Shows the curre nt
numbe r of CGI
re que s ts that are
s imultane ous ly
be ing proce s s e d by
the We b s e rvice .
Shows the curre nt
numbe r of Exte ns ion
re que s ts that are
s imultane ous ly
be ing proce s s e d by
the We b s e rvice .
Shows the maximum
numbe r of CGI
re que s ts
s imultane ous ly
proce s s e d by the
We b s e rvice .
Shows the maximum
numbe r of Exte ns ion
re que s ts
s imultane ous ly
proce s s e d by the
We b s e rvice .
Shows the numbe r
of total re que s ts
te mporarily blocke d
due to bandwidth
throttling s e ttings
(counte d s ince
s e rvice s tartup).
Shows the numbe r
of total re que s ts
te mporarily blocke d
due to bandwidth
throttling s e ttings
(counte d s ince
s e rvice s tartup).
Curre nt CGI
Re que s ts
Curre nt ISAPI
Exte ns ion Re que s ts
Maximum CGI
Re que s ts
Maximum ISAPI
Exte ns ion Re que s ts
Total Blocke d As ync
I/O Re que s ts
Total Blocke d As ync
I/O Re que s ts
151
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total Allowe d As ync
I/O Re que s ts
me as ure me nt
Total Allowe d As ync
I/O Re que s ts
Total Allowe d As ync
I/O Re que s ts pe r
Minute
me as ure me nt
Total Re je cte d
As ync I/O Re que s ts
me as ure me nt
Total Re je cte d
As ync I/O Re que s ts
pe r Minute
me as ure me nt
Curre nt Blocke d
As ync I/O Re que s ts
me as ure me nt
Me as ure d As ync I/O
Bandwidth Us age
me as ure me nt
HTTP Re s pons e
Time
calltime
Shows the total
numbe r of re que s ts
allowe d by
bandwidth throttling
s e ttings (counte d
s ince s e rvice
s tartup). Whe n
bandwidth throttling
is de fine d, the
numbe r of allowe d
us e r re que s ts is
re s tricte d.
Shows the total
numbe r of re que s ts
allowe d by
bandwidth throttling
s e ttings (counte d
s ince s e rvice
s tartup). Whe n
bandwidth throttling
is de fine d, the
numbe r of allowe d
us e r re que s ts is
re s tricte d.
Shows the total
numbe r of re que s ts
re je cte d due to
bandwidth throttling
s e ttings (counte d
s ince s e rvice
s tartup).
Shows the total
numbe r of re que s ts
re je cte d due to
bandwidth throttling
s e ttings (counte d
s ince s e rvice
s tartup).
Shows curre nt
re que s ts that are
te mporarily blocke d
due to bandwidth
throttling s e ttings .
Shows the
me as ure d bandwidth
of as ynchronous I/O
ave rage d ove r a
minute .
the minimum,
maximum, and
ave rage re s pons e
time s for HTTP
re que s ts s e rvice d
by this virtual hos t
152
Total Allowe d As ync
I/O Re que s ts
Total Re je cte d As ync
I/O Re que s ts
Total Re je cte d As ync
I/O Re que s ts
Curre nt Blocke d
As ync I/O Re que s ts
Me as ure d As ync I/O
Bandwidth Us age
Re s pons e Time
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
2.3. Post gres - Server
Overview
T able 2.26. Overview
De s cription:
Single ton:
Plugin:
Pos tgre SQL Se rve r
no
Pos tgre s
Child Resource T ypes
Se ction 2.3.1, “Pos tgre s - Databas e Se rvice ”
Se ction 2.3.2, “Pos tgre s - Us e r Se rvice ”
Aut odiscovery Process Scans
T able 2.27. Met rics
Name
Query
unix
proce s s |bas e name |match=^(pos tgre s |pos t
mas te r)$,proce s s |bas e name |nomatch|pare
nt=^(pos tgre s |pos tmas te r)$
proce s s |bas e name |match=^(?i)
(pos tgre s |pos tmas te r)\.e xe $,proce s s |bas e
name |nomatch|pare nt=^(?i)
(pos tgre s |pos tmas te r)\.e xe $
windows
Connect ion Propert ies
T able 2.28.
153
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
lis te n hos t
the hos tname or IP
addre s s that the
databas e is lis te ning
on
the TCP port that the
databas e is lis te ning
on
the name of the
databas e to conne ct
to
the fully-qualifie d
clas s name of the
JDBC drive r clas s
the databas e role to
conne ct as
the pas s word for the
databas e role be ing
us e d to conne ct
the abs olute path to
the dire ctory
containing the
clus te r configuration
file s pos tgre s ql.conf,
pg_hba.conf, and
pg_ide nt.conf
the abs olute path to
the main clus te r
configuration file ;
de fault value is
'{pgDataDir}/pos tgr
e s ql.conf', whe re
[pgDataDir] is the
value of the
pgDataDir
conne ction prope rty
ye s
hos t
ye s
port
ye s
db
no
drive rClas s
ye s
principal
ye s
cre de ntials
ye s
pgdataDir
no
configFile
lis te n port
databas e name
JDBC drive r clas s
role name
role pas s word
PGDATA dire ctory
configuration file
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 2.29. Met rics
Name
T ype
Descript io n
Int ernal Name
Us e r Time
me as ure me nt
The aggre gate
amount of CPU us e r
time s pe nt by all
pos tgre s proce s s e s
Proce s s .aggre gate C
pu.us e r
154
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Us e r Time pe r
Minute
me as ure me nt
Proce s s .aggre gate C
pu.us e r
Ke rne l Time
me as ure me nt
Ke rne l Time pe r
Minute
me as ure me nt
CPU Pe rce ntage
me as ure me nt
Phys ical Me mory
me as ure me nt
Virtual Me mory
me as ure me nt
Ope n File
De s criptors
me as ure me nt
Active Backe nds
me as ure me nt
Start time
trait
Add Mis s ing From
trait
Allow Sys te m Table
Mods
trait
Archive Command
trait
Archive Time out
trait
The aggre gate
amount of CPU us e r
time s pe nt by all
pos tgre s proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all pos tgre s
proce s s e s
The aggre gate
amount of CPU
ke rne l time s pe nt by
all pos tgre s
proce s s e s
The pe rce ntage of
CPU curre ntly be ing
us e d by all pos tgre s
proce s s e s
The aggre gate
amount of re s ide nt
me mory us e d by all
pos tgre s proce s s e s
The aggre gate
amount of virtual
me mory us e d by all
pos tgre s proce s s e s
The aggre gate
numbe r of file
de s criptors ope n by
all pos tgre s
proce s s e s
Numbe r of curre ntly
active backe nds
(us e r conne ctions )
Start time of the
Pos tgre SQL
databas e s e rve r
Automatically adds
mis s ing table
re fe re nce s to FROM
claus e s
Allows modifications
of the s tructure of
s ys te m table s
WAL archiving
command
Force s a s witch to
the ne xt xlog file if a
ne w file has not
be e n s tarte d within
the s pe cifie d amount
of time
Proce s s .aggre gate C
pu.s ys
Proce s s .aggre gate C
pu.s ys
Proce s s .aggre gate C
pu.pe rce nt
Proce s s .aggre gate M
e mory.re s ide nt
Proce s s .aggre gate M
e mory.s iz e
Proce s s .aggre gate Fil
e De s criptor.total
Databas e .backe nds
Databas e .s tartTime
Runtime .add_mis s ing
_from
Runtime .allow_s ys te
m_table _mods
Runtime .archive _com
mand
Runtime .archive _tim
e out
155
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Array Nulls
trait
Runtime .array_nulls
Authe ntication
Time out
trait
Autovacuum
trait
Autovacuum
Analyz e Scale
Factor
trait
Autovacuum
Analyz e Thre s hold
trait
Autovacuum Fre e z e
Max Age
trait
Autovacuum
Naptime
trait
Enable input of NULL
e le me nts in arrays .
The maximum
allowe d time to
comple te clie nt
authe ntication
Starts the
autovacuum
s ubproce s s .
Numbe r of tuple
ins e rts , update s or
de le te s prior to
analyz e as a fraction
of re ltuple s .
Minimum numbe r of
tuple ins e rts ,
update s or de le te s
prior to analyz e .
Age (in trans actions )
at which to
autovacuum a table
to pre ve nt
trans action ID
wraparound.
Amount of time to
s le e p be twe e n
autovacuum runs
Vacuum cos t de lay
for autovacuum
Vacuum cos t amount
available be fore
napping, for
autovacuum.
Numbe r of tuple
update s or de le te s
prior to vacuum as a
fraction of re ltuple s .
Minimum numbe r of
tuple update s or
de le te s prior to
vacuum.
Whe the r quote s are
allowe d in s tring
lite rals
Background write r
maximum numbe r of
all page s to flus h
pe r round
Background write r
pe rce ntage of all
buffe rs to flus h pe r
round
Autovacuum Vacuum trait
Cos t De lay
Autovacuum Vacuum trait
Cos t Limit
Autovacuum Vacuum trait
Scale Factor
Autovacuum Vacuum trait
Thre s hold
Backs las h Quote
trait
Bgwrite r All
Maxpage s
trait
Bgwrite r All Pe rce nt
trait
156
Runtime .authe nticati
on_time out
Runtime .autovacuum
Runtime .autovacuum
_analyz e _s cale _facto
r
Runtime .autovacuum
_analyz e _thre s hold
Runtime .autovacuum
_fre e z e _max_age
Runtime .autovacuum
_naptime
Runtime .autovacuum
_vacuum_cos t_de lay
Runtime .autovacuum
_vacuum_cos t_limit
Runtime .autovacuum
_vacuum_s cale _facto
r
Runtime .autovacuum
_vacuum_thre s hold
Runtime .backs las h_q
uote
Runtime .bgwrite r_all_
maxpage s
Runtime .bgwrite r_all_
pe rce nt
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Bgwrite r De lay
trait
Runtime .bgwrite r_de l
ay
Bgwrite r Lru
Maxpage s
trait
Background write r
s le e p time be twe e n
rounds ; de fault unit
is millis e conds
Background write r
maximum numbe r of
LRU page s to flus h
pe r round
Background write r
pe rce ntage of LRU
buffe rs to flus h pe r
round
Shows s iz e of a dis k
block; de te rmine d by
the value of BLCKSZ
whe n building the
s e rve r; de fault unit
is byte s
The Bonjour
broadcas t s e rvice
name
Che ck function
bodie s during
CREATE FUNCTION.
The maximum
dis tance (in log
s e gme nts ) be twe e n
automatic WAL
che ckpoints .
The maximum
amount of time
be twe e n automatic
WAL che ckpoints ;
de fault unit is
s e conds
Logs if filling of
che ckpoint
s e gme nts happe ns
more fre que ntly
than this amount of
time ; de fault unit is
s e conds
The clie nt's
characte r s e t
e ncoding.
The me s s age le ve ls
that are s e nt to the
clie nt.
The de lay in
be twe e n trans action
commit and flus hing
WAL to dis k; de fault
unit is micros e conds
Bgwrite r Lru Pe rce nt trait
Block Siz e
trait
Bonjour Name
trait
Che ck Function
Bodie s
trait
Che ckpoint
Se gme nts
trait
Che ckpoint Time out
trait
Che ckpoint Warning
trait
Clie nt Encoding
trait
Clie nt Min Me s s age s
trait
Commit De lay
trait
Runtime .bgwrite r_lru
_maxpage s
Runtime .bgwrite r_lru
_pe rce nt
Runtime .block_s iz e
Runtime .bonjour_na
me
Runtime .che ck_functi
on_bodie s
Runtime .che ckpoint_
s e gme nts
Runtime .che ckpoint_t
ime out
Runtime .che ckpoint_
warning
Runtime .clie nt_e ncod
ing
Runtime .clie nt_min_
me s s age s
Runtime .commit_de la
y
157
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Commit Siblings
trait
Runtime .commit_s ibli
ngs
Config File
trait
Cons traint Exclus ion
trait
Cpu Inde x Tuple
Cos t
trait
Cpu Ope rator Cos t
trait
Cpu Tuple Cos t
trait
Cus tom Variable
Clas s e s
trait
Data Dire ctory
trait
Date Style
trait
Db Us e r Name s pace
trait
The minimum
concurre nt ope n
trans actions be fore
pe rforming
commit_de lay.
The s e rve r's main
configuration file .
Enable s the planne r
to us e cons traints to
optimiz e que rie s .
The planne r's
e s timate of the cos t
of proce s s ing e ach
inde x e ntry during
an inde x s can;
me as ure d on the
s ame s cale as the
s e q_page _cos t
configuration
parame te r
The planne r's
e s timate of the cos t
of proce s s ing e ach
ope rator or function
call; me as ure d on
the s ame s cale as
the s e q_page _cos t
configuration
parame te r
The planne r's
e s timate of the cos t
of proce s s ing e ach
tuple (row);
me as ure d on the
s ame s cale as the
s e q_page _cos t
configuration
parame te r
The lis t of known
cus tom variable
clas s e s
The s e rve r's data
dire ctory.
The dis play format
for date and time
value s .
Enable s pe rdatabas e us e r
name s .
158
Runtime .config_file
Runtime .cons traint_e
xclus ion
Runtime .cpu_inde x_t
uple _cos t
Runtime .cpu_ope rato
r_cos t
Runtime .cpu_tuple _c
os t
Runtime .cus tom_vari
able _clas s e s
Runtime .data_dire cto
ry
Runtime .Date Style
Runtime .db_us e r_na
me s pace
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
De adlock Time out
trait
Runtime .de adlock_ti
me out
De bug As s e rtions
trait
De bug Pre tty Print
trait
De bug Print Pars e
trait
De bug Print Plan
trait
De bug Print
Re writte n
trait
De fault Statis tics
Targe t
trait
De fault Table s pace
trait
De fault Trans action
Is olation
trait
De fault Trans action
Re ad Only
trait
De fault With Oids
trait
Dynamic Library
Path
trait
Effe ctive Cache Siz e
trait
Enable Bitmaps can
trait
Enable Has hagg
trait
Enable Has hjoin
trait
The amount of time
to wait on lock
be fore che cking for
a de adlock; de fault
unit is millis e conds
Turns on various
as s e rtion che cks .
Inde nts pars e and
plan tre e dis plays .
Prints the pars e tre e
to the s e rve r log.
Prints the e xe cution
plan to s e rve r log.
Prints the pars e tre e
afte r re writing to
s e rve r log.
The de fault s tatis tics
targe t; range 11000.
The de fault
table s pace to cre ate
table s and inde xe s
in.
The trans action
is olation le ve l of
e ach ne w
trans action.
The de fault re adonly s tatus of ne w
trans actions .
Cre ate ne w table s
with OIDs by de fault.
The path for
dynamically loadable
module s .
The planne r's
as s umption about
s iz e of the dis k
cache ; the unit is
dis k page s , which
are normally 8KB
e ach
Enable s the
planne r's us e of
bitmap-s can plans .
Enable s the
planne r's us e of
has he d aggre gation
plans .
Enable s the
planne r's us e of
has h join plans .
Runtime .de bug_as s e
rtions
Runtime .de bug_pre tt
y_print
Runtime .de bug_print
_pars e
Runtime .de bug_print
_plan
Runtime .de bug_print
_re writte n
Runtime .de fault_s tati
s tics _targe t
Runtime .de fault_tabl
e s pace
Runtime .de fault_tran
s action_is olation
Runtime .de fault_tran
s action_re ad_only
Runtime .de fault_with
_oids
Runtime .dynamic_libr
ary_path
Runtime .e ffe ctive _ca
che _s iz e
Runtime .e nable _bitm
aps can
Runtime .e nable _has
hagg
Runtime .e nable _has
hjoin
159
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Enable Inde xs can
trait
Runtime .e nable _inde
xs can
Enable Me rge join
trait
Enable Ne s tloop
trait
Enable Se qs can
trait
Enable Sort
trait
Enable Tids can
trait
Es cape String
Warning
trait
Explain Pre tty Print
trait
Exte rnal Pid File
trait
Extra Float Digits
trait
From Collaps e Limit
trait
Fs ync
trait
Full Page Write s
trait
Ge qo
trait
Ge qo Effort
trait
Enable s the
planne r's us e of
inde x-s can plans .
Enable s the
planne r's us e of
me rge join plans .
Enable s the
planne r's us e of
ne s te d-loop join
plans .
Enable s the
planne r's us e of
s e que ntial-s can
plans .
Enable s the
planne r's us e of
e xplicit s ort s te ps .
Enable s the
planne r's us e of TID
s can plans .
Warn about
backs las h e s cape s
in ordinary s tring
lite rals .
Us e s the inde nte d
output format for
EXPLAIN VERBOSE.
Write s the
pos tmas te r PID to
the s pe cifie d file .
The numbe r of e xtra
digits dis playe d for
floating-point value s .
The FROM-lis t s iz e
be yond which
s ubque rie s are not
collaps e d
Force s
s ynchroniz ation of
update s to dis k.
Write s full page s to
WAL whe n firs t
modifie d afte r a
che ckpoint.
Enable s ge ne tic
que ry optimiz ation
GEQO: e ffort is us e d
to s e t the de fault for
othe r GEQO
parame te rs ; range
1-10
160
Runtime .e nable _me r
ge join
Runtime .e nable _ne s t
loop
Runtime .e nable _s e q
s can
Runtime .e nable _s ort
Runtime .e nable _tids c
an
Runtime .e s cape _s tri
ng_warning
Runtime .e xplain_pre t
ty_print
Runtime .e xte rnal_pid
_file
Runtime .e xtra_float_
digits
Runtime .from_collaps
e _limit
Runtime .fs ync
Runtime .full_page _wr
ite s
Runtime .ge qo
Runtime .ge qo_e ffort
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Ge qo Ge ne rations
trait
Runtime .ge qo_ge ne r
ations
Ge qo Pool Siz e
trait
Ge qo Se le ction Bias
trait
Ge qo Thre s hold
trait
Gin Fuz z y Se arch
Limit
trait
Hba File
trait
Ide nt File
trait
Ignore Sys te m
Inde xe s
trait
Inte ge r Date time s
trait
Join Collaps e Limit
trait
Krb Cas e ins Us e rs
trait
Krb Se rve r
Hos tname
Krb Se rve r Ke yfile
trait
Krb Srvname
trait
Lc Collate
trait
Lc Ctype
trait
Lc Me s s age s
trait
GEQO: numbe r of
ite rations of the
algorithm; de fault
s e le cte d bas e d on
e ffort.
GEQO: numbe r of
individuals in the
population; de fault
s e le cte d bas e d on
e ffort.
GEQO: s e le ctive
pre s s ure within the
population.
The thre s hold of
FROM ite ms be yond
which GEQO is us e d.
The maximum
allowe d re s ult for
e xact s e arch by GIN.
The s e rve r's hba
[configuration file ]
The s e rve r's ide nt
[configuration file ]
Dis able s re ading
from s ys te m
inde xe s .
Date time s are
inte ge r bas e d.
The FROM-lis t s iz e
be yond which JOIN
cons tructs are not
flatte ne d
Whe the r Ke rbe ros
us e r name s s hould
be tre ate d as cas e ins e ns itive .
The hos tname of the
Ke rbe ros s e rve r.
The location of the
Ke rbe ros s e rve r ke y
file .
The name of the
Ke rbe ros s e rvice .
Shows the collation
orde r locale .
Shows the characte r
clas s ification and
cas e conve rs ion
locale .
The language in
which me s s age s are
dis playe d.
trait
Runtime .ge qo_pool_s
iz e
Runtime .ge qo_s e le ct
ion_bias
Runtime .ge qo_thre s h
old
Runtime .gin_fuz z y_s
e arch_limit
Runtime .hba_file
Runtime .ide nt_file
Runtime .ignore _s ys t
e m_inde xe s
Runtime .inte ge r_dat
e time s
Runtime .join_collaps
e _limit
Runtime .krb_cas e ins
_us e rs
Runtime .krb_s e rve r_
hos tname
Runtime .krb_s e rve r_
ke yfile
Runtime .krb_s rvnam
e
Runtime .lc_collate
Runtime .lc_ctype
Runtime .lc_me s s age
s
161
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Lc Mone tary
trait
Runtime .lc_mone tary
Lc Nume ric
trait
Lc Time
trait
Lis te n Addre s s e s
trait
Local Pre load
Librarie s
trait
Log Conne ctions
trait
Log De s tination
trait
Log Dire ctory
trait
Log Dis conne ctions
trait
Log Duration
trait
Log Error Ve rbos ity
trait
Log Exe cutor Stats
trait
Log File name
trait
Log Hos tname
trait
Log Line Pre fix
trait
Log Min Duration
State me nt
trait
Log Min Error
State me nt
trait
The locale for
formatting mone tary
amounts .
The locale for
formatting numbe rs .
The locale for
formatting date and
time value s .
The hos t name or IP
addre s s (e s ) to lis te n
to.
Lis ts s hare d
librarie s to pre load
into e ach backe nd.
Logs e ach
s ucce s s ful
conne ction.
The de s tination for
s e rve r log output.
The de s tination
dire ctory for log
file s .
Logs e nd of a
s e s s ion, including
duration.
Logs the duration of
e ach comple te d SQL
s tate me nt.
The ve rbos ity of
logge d me s s age s .
Write s e xe cutor
pe rformance
s tatis tics to the
s e rve r log.
The file name
patte rn for log file s .
Logs the hos t name
in the conne ction
logs .
Controls information
pre fixe d to e ach log
line
The minimum
e xe cution time (in
millis e conds ) above
which s tate me nts
will be logge d.
Caus e s all
s tate me nts
ge ne rating e rror at
or above this le ve l
to be logge d.
162
Runtime .lc_nume ric
Runtime .lc_time
Runtime .lis te n_addre
sses
Runtime .local_pre loa
d_librarie s
Runtime .log_conne cti
ons
Runtime .log_de s tinati
on
Runtime .log_dire ctor
y
Runtime .log_dis conn
e ctions
Runtime .log_duration
Runtime .log_e rror_v
e rbos ity
Runtime .log_e xe cuto
r_s tats
Runtime .log_file nam
e
Runtime .log_hos tnam
e
Runtime .log_line _pre
fix
Runtime .log_min_dur
ation_s tate me nt
Runtime .log_min_e rr
or_s tate me nt
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Log Min Me s s age s
trait
Log Pars e r Stats
trait
Runtime .log_min_me
s s age s
Runtime .log_pars e r_
s tats
Log Planne r Stats
trait
Log Rotation Age
trait
Log Rotation Siz e
trait
Log State me nt
trait
Log State me nt Stats
trait
Log Truncate On
Rotation
trait
Mainte nance Work
Me m
trait
Max Conne ctions
trait
Max File s Pe r
Proce s s
trait
Max Fs m Page s
trait
Max Fs m Re lations
trait
The me s s age le ve ls
that are logge d.
Write s pars e r
pe rformance
s tatis tics to the
s e rve r log.
Write s planne r
pe rformance
s tatis tics to the
s e rve r log.
Automatic log file
rotation will occur
afte r this amount of
time ; de fault unit is
minute s
Automatic log file
rotation will occur
whe n the file
re ache s this s iz e ;
de fault unit is
kilobyte s
The type of
s tate me nts logge d.
Write s cumulative
pe rformance
s tatis tics to the
s e rve r log.
Truncate e xis ting log
file s of s ame name
during log rotation.
The maximum
me mory to be us e d
for mainte nance
ope rations .
The maximum
numbe r of
concurre nt
conne ctions .
The maximum
numbe r of
s imultane ous ly ope n
file s for e ach s e rve r
proce s s .
The maximum
numbe r of dis k
page s for which fre e
s pace is tracke d.
The maximum
numbe r of table s
and inde xe s for
which fre e s pace is
tracke d.
Runtime .log_planne r_
s tats
Runtime .log_rotation_
age
Runtime .log_rotation_
s iz e
Runtime .log_s tate me
nt
Runtime .log_s tate me
nt_s tats
Runtime .log_truncate
_on_rotation
Runtime .mainte nanc
e _work_me m
Runtime .max_conne c
tions
Runtime .max_file s _p
e r_proce s s
Runtime .max_fs m_pa
ge s
Runtime .max_fs m_re
lations
163
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Max Function Args
trait
Runtime .max_functio
n_args
Max Ide ntifie r
Le ngth
Max Inde x Ke ys
trait
Max Locks Pe r
Trans action
trait
Max Pre pare d
Trans actions
trait
Max Stack De pth
trait
Pas s word Encryption
trait
Shows the maximum
numbe r of function
argume nts .
Shows the maximum
ide ntifie r le ngth
Shows the maximum
numbe r of inde x
ke ys .
The maximum
numbe r of locks pe r
trans action.
The maximum
numbe r of
s imultane ous ly
pre pare d
trans actions .
The maximum s iz e
of the s e rve r's
e xe cution s tack;
de fault unit is
kilobyte s
Encrypt pas s words .
Port
trait
Pos t Auth De lay
trait
Pre Auth De lay
trait
Random Page Cos t
trait
Re dire ct Stde rr
trait
Re ge x Flavor
trait
164
trait
The TCP port the
s e rve r lis te ns on
Waits the s pe cifie d
amount of time on
conne ction s tartup
afte r authe ntication;
de fault unit is
s e conds
Waits the s pe cifie d
amount of time on
conne ction s tartup
be fore
authe ntication;
de fault unit is
s e conds
The planne r's
e s timate of the cos t
of a nons e que ntially
fe tche d dis k page ;
me as ure d on the
s ame s cale as the
s e q_page _cos t
configuration
parame te r
Start a s ubproce s s
to capture s tde rr
output into log file s
The re gular
e xpre s s ion flavor.
Runtime .max_ide ntifi
e r_le ngth
Runtime .max_inde x_
ke ys
Runtime .max_locks _p
e r_trans action
Runtime .max_pre par
e d_trans actions
Runtime .max_s tack_
de pth
Runtime .pas s word_e
ncryption
Runtime .port
Runtime .pos t_auth_d
e lay
Runtime .pre _auth_de
lay
Runtime .random_pag
e _cos t
Runtime .re dire ct_s td
e rr
Runtime .re ge x_flavo
r
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Se arch Path
trait
Runtime .s e arch_path
Se q Page Cos t
trait
Se rve r Encoding
trait
Se rve r Ve rs ion
trait
Se rve r Ve rs ion Num
trait
Share d Buffe rs
trait
Share d Pre load
Librarie s
trait
Sile nt Mode
trait
Sql Inhe ritance
trait
Ss l
trait
Standard
Conforming Strings
State me nt Time out
trait
Stats Block Le ve l
trait
Stats Command
String
trait
Stats Re s e t On
Se rve r Start
trait
The s che ma s e arch
orde r for name s that
are not s che maqualifie d.
The planne r's
e s timate of the cos t
of a s e que ntially
fe tche d dis k page ;
me as ure d on an
arbitrary s cale .
The s e rve r
(databas e ) characte r
s e t e ncoding.
Shows the
Pos tgre SQL ve rs ion.
Shows the
Pos tgre SQL ve rs ion
as an inte ge r (e .g.
80204 trans late s to
8.2.4).
The amount of
me mory for the
s hare d me mory
buffe rs us e d by the
s e rve r
Lis ts s hare d
librarie s to pre load
into s e rve r.
Runs the s e rve r
s ile ntly.
Caus e s s ubtable s to
be include d by
de fault in various
commands .
Enable s SSL
conne ctions .
'...' s trings tre at
backs las he s lite rally.
The maximum
allowe d duration of
any s tate me nt;
de fault unit is
millis e conds
Colle cts block-le ve l
s tatis tics on
databas e activity.
Colle cts information
about e xe cuting
commands .
Ze roe s colle cte d
s tatis tics on s e rve r
re s tart.
trait
Runtime .s e q_page _c
os t
Runtime .s e rve r_e nc
oding
Runtime .s e rve r_ve rs
ion
Runtime .s e rve r_ve rs
ion_num
Runtime .s hare d_buff
e rs
Runtime .s hare d_pre l
oad_librarie s
Runtime .s ile nt_mode
Runtime .s ql_inhe rita
nce
Runtime .s s l
Runtime .s tandard_co
nforming_s trings
Runtime .s tate me nt_ti
me out
Runtime .s tats _block_l
e ve l
Runtime .s tats _comm
and_s tring
Runtime .s tats _re s e t_
on_s e rve r_s tart
165
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Stats Row Le ve l
trait
Runtime .s tats _row_le
ve l
Stats Start Colle ctor
trait
Supe rus e r
Re s e rve d
Conne ctions
trait
Tcp Ke e palive s
Count
trait
Tcp Ke e palive s Idle
trait
Tcp Ke e palive s
Inte rval
trait
Te mp Buffe rs
trait
Time Zone
trait
Time z one
Abbre viations
Trace Notify
trait
Trace Sort
trait
Trans action Is olation
trait
Trans action Re ad
Only
trait
Trans form Null
Equals
trait
Colle cts row-le ve l
s tatis tics on
databas e activity.
Starts the s e rve r
s tatis tics -colle ction
s ubproce s s .
The numbe r of
conne ction s lots
re s e rve d for
s upe rus e rs
Maximum numbe r of
TCP ke e palive
re trans mits ; '0'
s e le cts the s ys te m
de fault
Amount of time
be twe e n is s uing TCP
ke e palive s ; '0'
s e le cts the s ys te m
de fault; de fault unit
is s e conds
Amount of time
be twe e n TCP
ke e palive
re trans mits ; '0'
s e le cts the s ys te m
de fault; de fault unit
is s e conds
The maximum
numbe r of
te mporary buffe rs
us e d by e ach
s e s s ion.
The time z one for
dis playing and
inte rpre ting time
s tamps .
Se le cts a file of time
z one abbre viations
Ge ne rate s
de bugging output for
LISTEN and NOTIFY.
Emit information
about re s ource
us age in s orting.
The curre nt
trans action's
is olation le ve l.
The curre nt
trans action's re adonly s tatus .
Tre ats e xpr=NULL
as e xpr IS NULL
166
trait
Runtime .s tats _s tart_
colle ctor
Runtime .s upe rus e r_r
e s e rve d_conne ction
s
Runtime .tcp_ke e paliv
e s _count
Runtime .tcp_ke e paliv
e s _idle
Runtime .tcp_ke e paliv
e s _inte rval
Runtime .te mp_buffe r
s
Runtime .Time Zone
Runtime .time z one _a
bbre viations
Runtime .trace _notify
Runtime .trace _s ort
Runtime .trans action_i
s olation
Runtime .trans action_
re ad_only
Runtime .trans form_n
ull_e quals
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Unix Socke t
Dire ctory
trait
Runtime .unix_s ocke t
_dire ctory
Unix Socke t Group
trait
Unix Socke t
Pe rmis s ions
trait
Update Proce s s Title
trait
Vacuum Cos t De lay
trait
Vacuum Cos t Limit
trait
Vacuum Cos t Page
Dirty
trait
Vacuum Cos t Page
Hit
trait
Vacuum Cos t Page
Mis s
trait
Vacuum Fre e z e Min
Age
trait
Wal Buffe rs
trait
Wal Sync Me thod
trait
Work Me m
trait
The dire ctory whe re
the Unix-domain
s ocke t will be
cre ate d
The owning group of
the Unix-domain
s ocke t
The acce s s
pe rmis s ions of the
Unix-domain s ocke t
Update s the proce s s
title to s how the
active SQL
command.
Vacuum cos t de lay;
de fault unit is
millis e conds ; range
0-1000
Vacuum cos t (in
cre dits ) amount
available be fore
napping.
Vacuum cos t (in
cre dits ) for a page
dirtie d by vacuum;
range 0-10000
Vacuum cos t (in
cre dits ) for a page
found in the buffe r
cache ; range 010000
Vacuum cos t (in
cre dits ) for a page
not found in the
buffe r cache ; range
0-10000
Minimum age (in
trans actions ) at
which VACUUM
s hould fre e z e a
table row.
The numbe r of dis kpage buffe rs in
s hare d me mory for
WAL
Se le cts the me thod
us e d for forcing WAL
update s out to dis k.
The maximum
me mory to be us e d
for que ry
works pace s ; de fault
unit is kilobyte s
Runtime .unix_s ocke t
_group
Runtime .unix_s ocke t
_pe rmis s ions
Runtime .update _proc
e s s _title
Runtime .vacuum_cos
t_de lay
Runtime .vacuum_cos
t_limit
Runtime .vacuum_cos
t_page _dirty
Runtime .vacuum_cos
t_page _hit
Runtime .vacuum_cos
t_page _mis s
Runtime .vacuum_fre
e z e _min_age
Runtime .wal_buffe rs
Runtime .wal_s ync_m
e thod
Runtime .work_me m
167
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Ze ro Damage d
Page s
trait
Continue s
proce s s ing pas t
damage d page
he ade rs .
Runtime .z e ro_damag
e d_page s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 2.30 .
Name
Descript io n
Required
Int ernal Name
Port
Se ts the TCP port
the s e rve r lis te ns
on; de fault value is
'5432'.
Se ts the maximum
numbe r of
concurre nt
conne ctions ; de fault
value is '100'.
Se ts the numbe r of
the s hare d me mory
buffe rs us e d by the
s e rve r; de fault
value is typically
'1000'.
Maximum FSM
Page s , mus t be a
minimum of
max_fs m_re lations *1
6, 6 byte s e ach)
Available options
de pe nd on ope rating
s ys te m; de fault
value is 's tde rr'
Enable capturing of
s tde rr into log file s ;
e nable d by de fault
ne e de d for block or
row s tats ; e nable d
by de fault
no
port
no
max_conne ctions
no
s hare d_buffe rs
no
max_fs m_page s
no
log_de s tination
no
re dire ct_s tde rr
no
s tats _s tart_colle ctor
Max_conne ctions
Share d_buffe rs
Max_fs m_page s
Log_de s tination
Re dire ct_s tde rr
Stats _s tart_colle ctor
168
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Stats _block_le ve l
Enable s the
colle ction of blockle ve l s tatis tics on
databas e activity; if
this option is
e nable d, the data
that is produce d can
be acce s s e d via the
pg_s tat and
pg_s tatio family of
s ys te m vie ws ;
dis able d by de fault
Enable s the
colle ction of rowle ve l s tatis tics on
databas e activity; if
this option is
e nable d, the data
that is produce d can
be acce s s e d via the
pg_s tat and
pg_s tatio family of
s ys te m vie ws ;
dis able d by de fault
Enable autovacuum
s ubproce s s ?
(re quire s
s tats _s tart_colle ctor
and s tats _row_le ve l
to als o be on);
e nable d by de fault
no
s tats _block_le ve l
no
s tats _row_le ve l
no
autovacuum
Stats _row_le ve l
Autovacuum
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
T able 2.31. Met rics
Name
Descript io n
Lis t Proce s s Statis tics
Lis t s tatis tics about the curre ntly e xe cuting
pos tgre s backe nds . state column re s ult is
only available with Pos tgre s 9.2+
Package T ypes
none
169
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
2.3.1. Post gres - Dat abase Service
Overview
T able 2.32. Overview
De s cription:
Single ton:
Plugin:
no
Pos tgre s
Child Resource T ypes
Se ction 2.3.1.1, “Pos tgre s - Table Se rvice ”
Se ction 2.3.1.2, “Pos tgre s - Que ry Se rvice ”
Connect ion Propert ies
T able 2.33.
Name
Descript io n
Databas e Name
Required
Int ernal Name
ye s
databas e Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 2.34. Met rics
Name
T ype
Descript io n
Int ernal Name
Backe nds
me as ure me nt
numbacke nds
Trans actions
Committe d
me as ure me nt
Trans actions
Committe d pe r
Minute
Trans actions Rolle d
Back
Trans actions Rolle d
Back pe r Minute
Blocks Re ad
me as ure me nt
Numbe r of active
s e rve r proce s s e s
for databas e
Trans actions
committe d in
databas e
Trans actions
committe d in
databas e
Trans actions rolle d
back in databas e
Trans actions rolle d
back in databas e
Numbe r of dis k block
fe tch re que s ts for
databas e
170
me as ure me nt
me as ure me nt
me as ure me nt
xact_commit
xact_commit
xact_rollback
xact_rollback
blks _re ad
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Blocks Re ad pe r
Minute
me as ure me nt
blks _re ad
Blocks Hit
me as ure me nt
Blocks Hit pe r
Minute
me as ure me nt
Siz e
me as ure me nt
Numbe r of dis k block
fe tch re que s ts for
databas e
Numbe r of dis k block
fe tch re que s ts found
in cache for
databas e
Numbe r of dis k block
fe tch re que s ts found
in cache for
databas e
Dis k s pace us e d by
the databas e
blks _hit
blks _hit
s iz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 2.35. Met rics
Name
Descript io n
Re s e t Statis tics
Invoke Sql
Re s e ts the s tatis tics in this databas e
Exe cute arbitrary SQL
Package T ypes
none
2.3.1.1. Post gres - T able Service
Overview
T able 2.36. Overview
De s cription:
Single ton:
Plugin:
Databas e table
no
Pos tgre s
Child Reso urce T ypes
none
171
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Co nnect io n Pro pert ies
T able 2.37.
Name
Descript io n
Sche ma Name
Table Name
Required
Int ernal Name
ye s
ye s
s che maName
table Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 2.38. Met rics
Name
T ype
Descript io n
Int ernal Name
Se que ntial Scans
me as ure me nt
s e q_s can
Se que ntial Scans
pe r Minute
me as ure me nt
Se que ntial Rows
Re ad
me as ure me nt
Se que ntial Rows
Re ad pe r Minute
me as ure me nt
Inde x Scans
me as ure me nt
Inde x Scans pe r
Minute
me as ure me nt
Inde x Scan Rows
Re ad
me as ure me nt
Inde x Scan Rows
Re ad pe r Minute
me as ure me nt
Numbe r of
s e que ntial s cans
done agains t this
table (whe n an inde x
s can was not
pos s ible )
Numbe r of
s e que ntial s cans
done agains t this
table (whe n an inde x
s can was not
pos s ible )
Numbe r of rows
re ad by s e que ntial
s cans
Numbe r of rows
re ad by s e que ntial
s cans
Numbe r of inde x
s cans done agains t
this table
Numbe r of inde x
s cans done agains t
this table
Numbe r of inde x
e ntrie s re turne d by
inde x s cans
Numbe r of inde x
e ntrie s re turne d by
inde x s cans
172
s e q_s can
s e q_tup_re ad
s e q_tup_re ad
idx_s can
idx_s can
idx_tup_fe tch
idx_tup_fe tch
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
He ap Blocks Re ad
me as ure me nt
he ap_blks _re ad
He ap Blocks Re ad
pe r Minute
me as ure me nt
He ap Blocks Hit
me as ure me nt
He ap Blocks Hit pe r
Minute
me as ure me nt
Inde x Blocks Re ad
me as ure me nt
Inde x Blocks Re ad
pe r Minute
me as ure me nt
Inde x Blocks Hit
me as ure me nt
Inde x Blocks Hit pe r
Minute
me as ure me nt
Toas t Blocks Re ads
me as ure me nt
Toas t Blocks Re ads
pe r Minute
me as ure me nt
Toas t Blocks Hit
me as ure me nt
Toas t Blocks Hit pe r
Minute
me as ure me nt
Toas t Inde x Blocks
Re ad
me as ure me nt
The numbe r of he ap
blocks re ad that
we re not a buffe r
cache hit
The numbe r of he ap
blocks re ad that
we re not a buffe r
cache hit
The numbe r of he ap
block re que s ts that
we re found in the
buffe r cache
The numbe r of he ap
block re que s ts that
we re found in the
buffe r cache
The numbe r of inde x
blocks fe tche d that
we re not a buffe r
cache hit
The numbe r of inde x
blocks fe tche d that
we re not a buffe r
cache hit
The numbe r of inde x
block re que s ts that
we re found in the
buffe r cache
The numbe r of inde x
block re que s ts that
we re found in the
buffe r cache
The numbe r of toas t
blocks fe tche d that
we re not a buffe r
cache hit
The numbe r of toas t
blocks fe tche d that
we re not a buffe r
cache hit
The numbe r of toas t
block re que s ts that
we re found in the
buffe r cache
The numbe r of toas t
block re que s ts that
we re found in the
buffe r cache
The numbe r of toas t
inde x blocks fe tche d
that we re not a
buffe r cache hit
he ap_blks _re ad
he ap_blks _hit
he ap_blks _hit
idx_blks _re ad
idx_blks _re ad
idx_blks _hit
idx_blks _hit
toas t_blks _re ad
toas t_blks _re ad
toas t_blks _hit
toas t_blks _hit
tidx_blks _re ad
173
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Toas t Inde x Blocks
Re ad pe r Minute
me as ure me nt
tidx_blks _re ad
Toas t Inde x Blocks
Hit
me as ure me nt
Toas t Inde x Blocks
Hit pe r Minute
me as ure me nt
Row Ins e rts
me as ure me nt
Row Ins e rts pe r
Minute
me as ure me nt
Row Update s
me as ure me nt
Row Update s pe r
Minute
me as ure me nt
Row De le te s
me as ure me nt
Row De le te s pe r
Minute
me as ure me nt
Table Siz e
me as ure me nt
Total Siz e
me as ure me nt
Rows
me as ure me nt
Approximate rows
me as ure me nt
The numbe r of toas t
inde x blocks fe tche d
that we re not a
buffe r cache hit
The numbe r of toas t
inde x block re que s ts
that we re found in
the buffe r cache
The numbe r of toas t
inde x block re que s ts
that we re found in
the buffe r cache
The numbe r of rows
e ve r ins e rte d into
this table
The numbe r of rows
e ve r ins e rte d into
this table
The numbe r of rows
e ve r update d on this
table
The numbe r of rows
e ve r update d on this
table
The numbe r of rows
e ve r de le te d from
this table
The numbe r of rows
e ve r de le te d from
this table
The s iz e in byte s of
the data in the table
The s iz e in byte s of
the data and all
as s ociate d inde xe s
and toas t table s
The count of rows in
the table . Warning:
This may be an
e xpe ns ive ope ration
The approximate
count of rows in the
table . This is
bas ically the numbe r
of rows of the las t
ANALYZE of the
table . This me tric is
not e xpe ns ive .
174
tidx_blks _hit
tidx_blks _hit
n_tup_ins
n_tup_ins
n_tup_upd
n_tup_upd
n_tup_de l
n_tup_de l
table _s iz e
total_s iz e
rows
rows _approx
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 2.39.
Name
Descript io n
Sche ma Name
Table Name
Columns
Required
Int ernal Name
ye s
ye s
ye s
s che maName
table Name
columns
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 2.40 . Met rics
Name
Descript io n
Vacuum
Vacuum the table
Package T ypes
none
2.3.1.2. Post gres - Query Service
Overview
T able 2.41. Overview
De s cription:
Single ton:
Plugin:
no
Pos tgre s
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 2.42.
175
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Table
The table to
dis cove r and to be
que rie d on for
me tric data
Initial name of the
re s ource whe n
manually adde d.
This is als o part of
the re s ource ke y make this unique if
you want two Que ry
re s ource s bas e d on
the s ame table .
Initial de s cription of
re s ource whe n
manually adde d
The que ry that will
gathe r me tric data.
This mus t re turn two
columns , a s tring
column whos e value
is 'me tricColumn'
and the n a nume ric
column whos e value
is the me tric to be
colle cte d.
ye s
table
no
name
no
de s cription
no
me tricQue ry
Name
De s cription
Me tric Que ry
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 2.43. Met rics
Name
T ype
Descript io n
Int ernal Name
Me tric Value
me as ure me nt
The me tric value for
this Que ry. If Me tric
Que ry is not
s pe cifie d, this is not
colle cte d.
me tricColumn
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
176
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
none
Operat io ns
none
Package T ypes
none
2.3.2. Post gres - User Service
Overview
T able 2.44. Overview
De s cription:
Single ton:
Plugin:
A Us e r in the Pos tgre s Sys te m
no
Pos tgre s
Child Resource T ypes
none
Connect ion Propert ies
none
Met rics
T able 2.45. Met rics
Name
T ype
Descript io n
Int ernal Name
Total Us e r
Conne ctions
me as ure me nt
total
Active Us e r
Conne ctions
me as ure me nt
The total numbe r of
us e r conne ctions in
the s ys te m, whe the r
active ly que rying or
idle
The numbe r of us e r
conne ctions in the
s ys te m active ly
que rying
active
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 2.46.
177
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Inhe rit Rights
Inhe rit rights from
pare nt role s .
Is a s upe r us e r.
Implie d for a s upe r
us e r.
Implie d for a s upe r
us e r.
Eve n a s upe rus e r
cannot update
s ys te m catalogs
unle s s this prope rty
is true . Fals e is
implie d for a non
s upe r us e r.
ye s
inhe ritRights
ye s
ye s
s upe rus e r
canCre ate Databas e
Obje cts
canCre ate Role s
Supe r Us e r
Can Cre ate
Databas e Type s
Can Cre ate Role s
Can Update Sys te m
Catalogs Dire ctly
Us e r conne ction
limit
Us e r
Can Login
Pas s word
ye s
ye s
canModifyCatalogDir
e ctly
ye s
conne ctionLimit
ye s
ye s
ye s
us e r
canLogin
pas s word
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
2.4. Abst ract Dat abase Plugin
T able 2.47. Basic Det ails
Inte rnal Name :
De s cription:
Ve rs ion:
Databas e
Abs tract plugin s upporting concre te
databas e plugins
4.4.0
T op-Level Resource T ypes
This plugin doe s not de fine any Re s ource type s . It it probably an "abs tract plugin", that is ,
one that provide s Re s ource compone nts and/or dis cove ry compone nts that can be us e d
by othe r plugins .
2.5. Script - Server
178
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
2.5. Script - Server
Overview
T able 2.48. Overview
De s cription:
A re s ource with a command line
e xe cutable or s cript as its manage me nt
inte rface
no
Script
Single ton:
Plugin:
Child Resource T ypes
none
Aut odiscovery Process Scans
none
Connect ion Propert ies
T able 2.49.
Name
Descript io n
Exe cutable
The full path to the
ye s
command line
e xe cutable or s cript
Whe n the
no
e xe cutable is
invoke d, this will be
its working dire ctory.
Environme nt
no
variable s that are
s e t whe n e xe cuting
the e xe cutable
Working Dire ctory
Environme nt
Variable s
Required
Int ernal Name
e xe cutable
workingDire ctory
e nvironme ntVariable
s
179
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Availability Exe cute
Che ck
If s pe cifie d and true ,
the ability to
s ucce s s fully
e xe cute the
e xe cutable can
de te rmine whe the r
or not the manage d
re s ource is
cons ide re d up and
available . If you s e t
this to true , you
normally do not s e t
the availability
re ge x s e ttings in
orde r to allow
availability to be
de te rmine d bas e d
s ole ly on the
s ucce s s ful
e xe cution,
re gardle s s of the
e xit code or output.
If this is fals e ,
s e tting one of the
avail re ge x s e ttings
will ove rride it as if
it we re true .
If s pe cifie d, the
e xe cutable mus t
re turn an e xit code
that matche s this
re gular e xpre s s ion
if the manage d
re s ource is to be
cons ide re d up and
available
no
availabilityExe cute Ch
e ck
no
availabilityExitCode R
e ge x
Availability Exit Code
Re ge x
180
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Availability Output
Re ge x
If s pe cifie d, the
no
e xe cutable mus t
output te xt that
matche s this re gular
e xpre s s ion if the
manage d re s ource
is to be cons ide re d
up and available .
Expre s s ion is
e valuate d by
Patte rn.find() s o
match actually
me ans firs t match
found in te xt. Patte rn
`OK` matche s
multiline te xt
`Se rvice s tatus \n is
OK`. By de fault ^$
re pre s e nt s tart/e nd
of output te xt. To
match s tart/e nd of
line add (?m). e g. `(?
m)^ is OK$`. To
match whole multiline output us e (?s ),
e g. `(?
s )Se rvice .*OK`.
If the e xe cutable
no
ne e ds to be
e xe cute d in orde r to
de te rmine
availability, the s e
are the argume nts
that will be pas s e d
to the e xe cutable . If
you do not s pe cify
the re ge x s e ttings
and you s e t the
e xe cute che ck
s e tting to fals e , the
e xe cutable will not
be e xe cute d and
the s e argume nts
will not be us e d - in
this cas e , availability
will be de te rmine d
by the me re
e xis te nce of the
e xe cutable file .
Availability
Argume nts
Required
Int ernal Name
availabilityOutputRe g
ex
availabilityArgume nt
s
181
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Ve rs ion Argume nts
The argume nts to
pas s to the
e xe cutable that will
he lp de te rmine the
ve rs ion of the
manage d re s ource
The re ge x that can
pick out the ve rs ion
from the e xe cutable
output. If the re ge x
has a capture d
group, its matche d
conte nt will be us e d
as the ve rs ion. If
the re is no capture d
group, the e ntire
output will be us e d
as the ve rs ion.
If s pe cifie d, this will
be the ve rs ion of
the manage d
re s ource - the
e xe cutable will not
be invoke d to
de te rmine it.
The argume nts to
pas s to the
e xe cutable that will
he lp de te rmine the
manage d re s ource
de s cription. This can
be argume nts to
e nable ve rbos e
ve rs ion output.
The re ge x that can
pick out the
de s cription from the
e xe cutable output. If
the re ge x has a
capture d group, its
matche d conte nt will
be us e d as the
de s cription. If the re
is no capture d
group, the e ntire
output will be us e d
as the de s cription.
If s pe cifie d, this will
be the de s cription of
the manage d
re s ource - the
e xe cutable will not
be invoke d to
de te rmine it.
no
ve rs ionArgume nts
no
ve rs ionRe ge x
no
fixe dVe rs ion
no
de s criptionArgume nt
s
no
de s criptionRe ge x
no
fixe dDe s cription
Ve rs ion Re ge x
Fixe d Ve rs ion
De s cription
Argume nts
De s cription Re ge x
Fixe d De s cription
182
⁠C hapt e r 2. Co r e Manage d Re s o ur c e s
Name
Descript io n
Enable Quoting of
Argume nts
Es cape Characte r
1. In unquote d
te xt: the
e s cape
characte r
pre s e rve s
the value of
any following
characte r
2. In double quote d te xt:
the e s cape
characte r
e s cape s "
and its e lf
othe rwis e is
both the
e s cape
characte r and
the following
characte r are
le ft intact
3. In s ingle quote d te xt:
no e s caping
can occur
Required
Int ernal Name
ye s
quotingEnable d
The e s cape
ye s
characte r to be us e d
whe n pars ing
argume nts . By
de fault the e s cape
characte r is
backs las h.
e s cape Characte r
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
T able 2.50 . Met rics
183
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Exe cute
Exe cute s the e xe cutable with a s e t of
argume nts and re turns the output and e xit
code .
Package T ypes
none
184
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Chapt er 3. Ent erprise Applicat ion Plat form Resources
The re are ce rtain s e rve r type s that are s upporte d by de fault in JBos s Ope rations Ne twork,
both for JBos s and non-JBos s re s ource type s .
The JBos s re s ource s he re are include d with JBos s ON by de fault through the EAP plug-in
pack. Additional JBos s re s ource s can be manage d by JBos s ON by ins talling additional plugin packs.
3.1. JBossAS - Server
Overview
T able 3.1. Overview
De s cription:
Single ton:
Plugin:
JBos s Application Se rve r
no
JBos s AS
185
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
h3. Binding to IP addre s s e s Whe n s tarting JBos s AS ins tance s that ne e d to be
monitore d us ing re mote JMX (i.e . JNP), it is ne ce s s ary for the
{{java.rmi.s e rve r.hos tname }} Sys te m prope rty to be s e t to the s ame value as the
s e rve r's JNP addre s s (which is s e t to the {{jbos s .bind.addre s s }} Sys te m prope rty
by de fault). Due to bugs in JBos s AS (for more information ple as e s e e [JBAS4736|http://jira.jbos s .com/jira/brows e /JBAS-4736] and [JBAS4955|http://jira.jbos s .com/jira/brows e /JBAS-4955]), {{java.rmi.s e rve r.hos tname }} will
de fault to {{127.0.0.1}}, unle s s JBos s AS is s tarte d us ing {{-b}}, in which cas e
{{java.rmi.s e rve r.hos tname }} will de fault to the bind addre s s s pe cifie d as the
argume nt to {{-b}}. The re fore , you mus t s tart your JBos s AS ins tance s by us ing
e ithe r {{-b}}: {code } run -b 12.34.56.78 ... {code } or by e xplicitly s pe cifying a value
for {{java.rmi.s e rve r.hos tname }} via {{-D}} or {{-P}}, e .g.: {code } run Djbos s .bind.addre s s =12.34.56.78 -Djava.rmi.s e rve r.hos tname =12.34.56.78 ... {code }
Othe rwis e , you will not be able to manage the ins tance via JON. {note } Us ing {{-b}}
is the re comme nde d way to s pe cify the bind addre s s , s ince , in addition to s e tting
{{jbos s .bind.addre s s }} and {{java.rmi.s e rve r.hos tname }}, it will als o s e t othe r
JGroups -re late d Sys te m prope rtie s to the s pe cifie d addre s s . {note } h3. Monitoring
of EJB 2.x EJBs The is s ue he re is that JBos s AS change d the way it cre ate s the
MBe an name s of the de ploye d EJBs from the JNDI name s / EJB name s (this
happe ne d around ve rs ion 4.0.3.s p1). Bas ically the <jndi-name >, or <local-jndiname > if <jndi-name > is not pre s e nt, from jbos s .xml is us e d. So the workaround is
to s e t the <jndi-name > to the e jb-name in your application. As this probably bre aks
clie nt code , you will want to s e tup a naming re fe re nce that re s tore s the original
hie rarchy. For e xample , if you have in jbos s .xml: {code } <s e s s ion> <e jbname >Ability</e jb-name > <local-jndi-name >flowe r.AbilityLocal</local-jndi-name >
{code } You might change this to: {code } <s e s s ion> <e jb-name >Ability</e jb-name >
<local-jndi-name >Ability</local-jndi-name > {code } And the n add an MBe an flows ys naming-alias -s e rvice .xml: {code } <mbe an code ="org.jbos s .naming.NamingAlias "
name =":s e rvice =naming-alias "> <attribute
name ="ToName ">flowe r.AbilityLocal</attribute > <attribute
name ="FromName ">Ability</attribute > </mbe an> {code } Afte r you have done this ,
go into the inve ntory of the re s pe ctive be ans , e dit the configuration and the n click
OK. The naming alias e ns ure s that clie nts of the Ability EJB can s till find the be an in
JNDI at the original location. Naming alias e s appe ar in JNDIVie w (within JMX-Cons ole )
as LinkRe f.
Child Resource T ypes
Se ction 3.1.1, “JBos s AS - Embe dde d Tomcat Se rve r”
Se ction 3.1.2, “JBos s AS - Datas ource Se rvice ”
Se ction 3.1.3, “JBos s AS - Conne ctionFactory Se rvice ”
Se ction 3.1.4, “JBos s AS - JBos s MQ Se rvice ”
Se ction 3.1.5, “JBos s AS - JBos s Me s s aging Se rvice ”
Se ction 3.1.6, “JBos s AS - EJB3 Se s s ion Be an Se rvice ”
Se ction 3.1.7, “JBos s AS - State le s s Se s s ion EJB Se rvice ”
Se ction 3.1.8, “JBos s AS - State ful Se s s ion EJB Se rvice ”
186
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Se ction 3.1.9, “JBos s AS - Entity EJB Se rvice ”
Se ction 3.1.10, “JBos s AS - Me s s age Drive n EJB Se rvice ”
Se ction 3.1.11, “JBos s AS - Ente rpris e Application (EAR) Se rvice ”
Se ction 3.1.12, “JBos s AS - We b Application (WAR) Se rvice ”
Se ction 3.1.13, “JBos s AS - EJB3 Entity Tre e Cache Se rvice ”
Se ction 3.1.14, “JBos s AS - Script Se rvice ”
Aut odiscovery Process Scans
T able 3.2. Met rics
Name
Query
JBos s 4
proce s s |bas e name |match=^java.*,arg|org.j
bos s .Main|match=.*
Connect ion Propert ies
T able 3.3.
Name
Descript io n
Naming Provide r URL The JNP URL with
which to conne ct to
the JBos s Application
Se rve r ins tance
(e .g.
jnp://127.0.0.1:1099).
Principal
The name of the
principal (i.e . us e r)
to authe nticate .
Cre de ntials
The cre de ntials (i.e .
pas s word) that
s hould be us e d to
authe nticate the
principal.
JBos s Home
The abs olute path to
Dire ctory
the dire ctory whe re
JBos s AS is ins talle d
(e .g. /opt/jbos s 4.2.2.GA).
Configuration Path
The path to the
configuration
dire ctory unde r
which this ins tance
ope rate s (e .g.
/opt/jbos s 4.2.2.GA/s e rve r/de fa
ult); if the path is not
abs olute , the n it will
be re s olve d re lative
to {jbos s Home Dir}.
Required
Int ernal Name
ye s
namingURL
no
principal
no
cre de ntials
ye s
jbos s Home Dir
ye s
configurationPath
187
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Configuration Se t
The name of the
s e rve r configuration
(e .g. minimal,
de fault, or all); if not
s pe cifie d, it will
de fault to the las t
path compone nt of
{configurationPath}.
A pre fix applie d to
s cript e xe cution
commands ; this
pre fix is applie d
ve rbatim. The full
path of the
e xe cutable is
re quire d (e .g.
/us r/bin/s udo). For
applicable platforms ,
this is typically a
s udo command, s o a
s udo us e r mus t be
configure d
appropriate ly for the
s pe cifie d command.
Ignore d if not s e t.
The path to the
s cript us e d by the
'Start' ope ration to
s tart this JBos s AS
s e rve r (e .g.
/opt/jbos s 4.2.2.GA/bin/run.s h);
if the path is not
abs olute , the n it will
be re s olve d re lative
to {jbos s Home Dir};
de faults to
'bin/run.s h' on UNIX
or 'bin\run.bat' on
Windows .
no
configurationSe t
no
s criptPre fix
no
s tartScript
Script Pre fix
Start Script
188
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Shutdown Script
The path to the
s cript us e d by the
'Shutdown' ope ration
to s hutdown this
JBos s AS s e rve r (e .g.
/opt/jbos s 4.2.2.GA/bin/s hutdow
n.s h); if the path is
not abs olute , the n it
will be re s olve d
re lative to
{jbos s Home Dir};
de faults to
'bin/s hutdown.s h' on
UNIX or
'bin\s hutdown.bat' on
Windows .
The me thod us e d to
e xe cute the
Shutdown ope ration;
de faults to 'JMX
MBe an'.
The hos t or IP
addre s s us e d by all
JBos s s e rvice s as
the binding addre s s
(e .g. 10.11.14.233);
s pe cify 0.0.0.0 to
te ll JBos s AS to bind
to all available
ne twork inte rface s ;
de faults to
'127.0.0.1'.
The abs olute path to
a JRE or JDK
ins tallation dire ctory
containing the JVM
that s hould be us e d
to s tart and
s hutdown the
JBos s AS ins tance ;
de faults to the home
dire ctory of the RHQ
age nt JRE.
The time , in
minute s ,(e .g. 1 or 8)
that mus t e laps e
be fore the s e rve r is
cons ide re d to have
faile d to s tart up.
The de fault is 5
minute s .
no
s hutdownScript
no
s hutdownMe thod
no
bindingAddre s s
no
javaHome Path
no
s tartWaitMax
Shutdown Me thod
Binding Addre s s
JAVA_HOME Path
Start Wait Max
189
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Stop Wait Max
The time , in
minute s ,(e .g. 1 or 8)
that mus t e laps e
be fore the s e rve r is
cons ide re d to have
faile d to s top. The
de fault is 2.5
minute s .
no
s topWaitMax
ye s
ye s
logEve ntSource s
s naps hotConfigEnabl
ed
ye s
s naps hotConfigDire c
tory
no
s naps hotConfigRe ge
x
ye s
s naps hotConfigRe cur
s ive
ye s
s naps hotLogEnable d
ye s
s naps hotLogDire ctor
y
Log Eve nt Source s
Snaps hot Config
Enable d
Snaps hot Config
Dire ctory
Snaps hot Config
Re ge x
Snaps hot Config
Re curs ive
Snaps hot Log
Enable d
Snaps hot Log
Dire ctory
190
If true , take a
s naps hot of the
configuration
The dire ctory
containing the
configuration file s
that will be capture d
in the s naps hot. This
is us ually re lative to
the configurationPath
but can be a full
abs olute path.
If de fine d, this
re gular e xpre s s ion
mus t match a
configuration file
name if that file is to
be capture d in the
s naps hot. If not
de fine d, all
configuration file s
will be capture d.
If true , the s naps hot
will include file s
locate d in
s ubdire ctorie s unde r
the config dire ctory.
If true , take a
s naps hot of the log
file s
The dire ctory
containing the log
file s that will be
capture d in the
s naps hot. This is
us ually re lative to
the configurationPath
but can be a full
abs olute path.
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Snaps hot Log Re ge x
If de fine d, this
re gular e xpre s s ion
mus t match a log file
name if that file is to
be capture d in the
s naps hot. If not
de fine d, all log file s
will be capture d.
If true , the s naps hot
will include file s
locate d in
s ubdire ctorie s unde r
the log dire ctory.
If true , take a
s naps hot of the data
file s
The dire ctory
containing the data
file s that will be
capture d in the
s naps hot. This is
us ually re lative to
the configurationPath
but can be a full
abs olute path.
If de fine d, this
re gular e xpre s s ion
mus t match a data
file name if that file
is to be capture d in
the s naps hot. If not
de fine d, all data file s
will be capture d.
If true , the s naps hot
will include file s
locate d in
s ubdire ctorie s unde r
the data dire ctory.
Additional file s to be
include d in the
s naps hot re port
The type of the
conne ction.
Name of the MBe an
to us e whe n s hutting
down this s e rve r
through JMX.
no
s naps hotLogRe ge x
ye s
s naps hotLogRe curs iv
e
ye s
s naps hotDataEnable
d
ye s
s naps hotDataDire cto
ry
no
s naps hotDataRe ge x
ye s
s naps hotDataRe curs i
ve
ye s
s naps hotAdditionalFil
e s Lis t
ye s
type
ye s
s hutdownMbe anNam
e
Snaps hot Log
Re curs ive
Snaps hot Data
Enable d
Snaps hot Data
Dire ctory
Snaps hot Data
Re ge x
Snaps hot Data
Re curs ive
Snaps hot Additional
File s Lis t
Type
Shutdown MBe an
Name
191
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Shutdown MBe an
Ope ration
Name of the
ope ration to invoke
whe n s hutting down
this s e rve r through
JMX. Note that only
ope rations with no
parame te r or with
one int parame te r
are s upporte d. If the
ope ration re quire s
an int parame te r, '0'
will be s upplie d.
The name of the
JBos s AS JVM
re s ource .
ye s
s hutdownMbe anOpe r
ation
no
childJmxSe rve rName
JBos s AS JVM Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.4. Met rics
Name
T ype
Descript io n
Int ernal Name
Partition Name
trait
partitionName
Ve rs ion Name
trait
Build Date
trait
Start Date
trait
Active Thre ad Count
me as ure me nt
the name of the
clus te r partition this
app s e rve r ins tance
be longs to
the code name for
the this app s e rve r
ins tance 's major
ve rs ion (AS 3.2 =
Wonde rLand, AS 4.0
= Zion, AS 4.2 =
Trinity, EAP 4.x =
EAP, SOA 4.x = SOA)
the date this app
s e rve r was built
the date and time
this app s e rve r
ins tance was s tarte d
The curre nt numbe r
of active thre ads for
this app s e rve r
ins tance
192
jbos s .s ys te m:type =
Se rve r:Ve rs ionName
jbos s .s ys te m:type =
Se rve r:BuildDate
jbos s .s ys te m:type =
Se rve r:StartDate
jbos s .s ys te m:type =
Se rve rInfo:Active Thr
e adCount
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Active Thre ad Group
Count
me as ure me nt
jbos s .s ys te m:type =
Se rve rInfo:Active Thr
e adGroupCount
JVM Fre e Me mory
me as ure me nt
JVM Max Me mory
me as ure me nt
JVM Total Me mory
me as ure me nt
Total Trans actions
me as ure me nt
Total Trans actions
pe r Minute
me as ure me nt
Trans actions
Committe d
me as ure me nt
Trans actions
Committe d pe r
Minute
me as ure me nt
Trans actions
Rolle dback
me as ure me nt
Trans actions
Rolle dback pe r
Minute
me as ure me nt
The curre nt numbe r
of active thre ad
groups for this app
s e rve r ins tance
An approximation of
the total amount of
me mory curre ntly
available in the app
s e rve r JVM for future
allocate d obje cts ,
me as ure d in byte s
The maximum
amount of me mory
that the app s e rve r
JVM will atte mpt to
us e , me as ure d in
byte s ; if the re is no
inhe re nt limit the n
the value
Long.MAX_VALUE will
be re turne d
The total amount of
me mory curre ntly
available in the app
s e rve r JVM for
curre nt and future
obje cts , me as ure d in
byte s
Total numbe r of
trans actions s ince
las t re s tart
Total numbe r of
trans actions s ince
las t re s tart
Numbe r of
trans actions
commite d s ince las t
re s tart
Numbe r of
trans actions
commite d s ince las t
re s tart
Numbe r of
trans actions
commite d s ince las t
re s tart
Numbe r of
trans actions
commite d s ince las t
re s tart
jbos s .s ys te m:type =
Se rve rInfo:Fre e Me m
ory
jbos s .s ys te m:type =
Se rve rInfo:MaxMe mo
ry
jbos s .s ys te m:type =
Se rve rInfo:TotalMe m
ory
jbos s :s e rvice =Trans
actionManage r:Trans
actionCount
jbos s :s e rvice =Trans
actionManage r:Trans
actionCount
jbos s :s e rvice =Trans
actionManage r:Com
mitCount
jbos s :s e rvice =Trans
actionManage r:Com
mitCount
jbos s :s e rvice =Trans
actionManage r:Rollba
ckCount
jbos s :s e rvice =Trans
actionManage r:Rollba
ckCount
193
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 3.5. Met rics
Name
Descript io n
Start
Start this application s e rve r. The s cript
us e d is s pe cifie d in the Ope rations group
of conne ction prope rtie s .
Shutdown this application s e rve r via s cript
or JMX de pe nding on the s e ttings in the
Ope rations and Advance d groups of
conne ction prope rtie s .
Shutdown and the n s tart this application
s e rve r.
Shutdown
Re s tart
Package T ypes
T able 3.6. Package T ypes
Name
Cat ego ry
Descript io n
Cumulative Patch
De ployable
Jar Library
De ployable
Automatically ins tallable
application s e rve r patche s
Library Jar file s de ploye d in
JBos s AS
3.1.1. JBossAS - Embedded T omcat Server
Overview
T able 3.7. Overview
De s cription:
Single ton:
Plugin:
Tomcat We b Application Containe r
e mbe dde d in a JBos s AS Se rve r
ye s
JBos s AS
Child Resource T ypes
Se ction 3.1.1.1, “JBos s AS - Conne ctor Se rvice ”
Se ction 3.1.1.2, “JBos s AS - VHos t Se rvice ”
194
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Aut odiscovery Process Scans
none
Connect ion Propert ies
none
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.1.1.1. JBossAS - Connect or Service
Overview
T able 3.8. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.9.
Name
Obje ct Name
Port
Addre s s
Sche me
Name Te mplate
Descript io n
Required
Int ernal Name
ye s
ye s
obje ctName
port
Port this conne ctor
lis te ns on.
Addre s s this
ye s
conne ctor lis te ns on.
The s che me of the
ye s
protocol us e d by this
conne ctor (e .g. jk,
ajp, http, https ).
ye s
addre s s
s che ma
name Te mplate
195
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
De s cription
Te mplate
Required
Int ernal Name
ye s
de s criptionTe mplate
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.10 . Met rics
Name
T ype
Descript io n
Int ernal Name
Maximum Re que s t
Time
me as ure me nt
Maximum time it
took to proce s s a
re que s t
Re que s t count
me as ure me nt
Total numbe r of
re que s ts proce s s e d
s ince las t re s tart.
Re que s t count pe r
Minute
me as ure me nt
Total numbe r of
re que s ts proce s s e d
s ince las t re s tart.
Error count
me as ure me nt
Numbe r of e rrors
while proce s s ing
s ince las t re s tart.
Error count pe r
Minute
me as ure me nt
Numbe r of e rrors
while proce s s ing
s ince las t re s tart.
Thre ads Active
me as ure me nt
Thre ads Active
jbos s .we b:name =%s
che ma%%das h%%a
ddre s s %%port%,type =Global
Re que s tProce s s or:m
axTime
jbos s .we b:name =%s
che ma%%das h%%a
ddre s s %%port%,type =Global
Re que s tProce s s or:re
que s tCount
jbos s .we b:name =%s
che ma%%das h%%a
ddre s s %%port%,type =Global
Re que s tProce s s or:re
que s tCount
jbos s .we b:name =%s
che ma%%das h%%a
ddre s s %%port%,type =Global
Re que s tProce s s or:e r
rorCount
jbos s .we b:name =%s
che ma%%das h%%a
ddre s s %%port%,type =Global
Re que s tProce s s or:e r
rorCount
jbos s .we b:name =%s
che ma%%das h%%a
ddre s s %%port%,type =Thre a
dPool:curre ntThre ad
s Bus y
196
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Thre ads Allocate d
me as ure me nt
Thre ads Allocate d
Maximum Thre ads
trait
Maximum numbe r of
thre ads that can be
allocate d for the
thre ad pool of this
conne ctor
jbos s .we b:name =%s
che ma%%das h%%a
ddre s s %%port%,type =Thre a
dPool:curre ntThre ad
Count
jbos s .we b:name =%s
che ma%%das h%%a
ddre s s %%port%,type =Thre a
dPool:maxThre ads
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.1.1.2. JBossAS - VHost Service
Overview
T able 3.11. Overview
De s cription:
Single ton:
Plugin:
A virtual hos t in the we b containe r
no
JBos s AS
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.12.
Name
Obje ct Name
Descript io n
Required
Int ernal Name
ye s
obje ctName
197
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.13. Met rics
Name
T ype
Descript io n
Int ernal Name
Alias e s
trait
The alias e s for this
virtual hos t
jbos s .we b:type =Hos t
,hos t=%name %:alias
es
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.1.2. JBossAS - Dat asource Service
Overview
T able 3.14. Overview
De s cription:
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 3.15.
198
no
JBos s AS
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Obje ct Name
Name Te mplate
De s cription
Te mplate
Name
The name of this
datas ource
Required
Int ernal Name
ye s
ye s
ye s
obje ctName
name Te mplate
de s criptionTe mplate
ye s
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.16. Met rics
Name
T ype
Descript io n
Int ernal Name
Total Conne ctions
me as ure me nt
Conne ctionCount
Available
Conne ctions
me as ure me nt
Active Conne ctions
me as ure me nt
Conne ctions
Cre ate d
me as ure me nt
Conne ctions
Cre ate d pe r Minute
me as ure me nt
Conne ctions
De s troye d
me as ure me nt
Conne ctions
De s troye d pe r
Minute
me as ure me nt
Total Numbe r of
Conne ctions for the
Conne ction Pool,
both active and inactive .
Numbe r of available
conne ctions in the
conne ction pool inactive and waiting.
Numbe r of
Conne ctions
curre ntly s upporting
clie nts .
Numbe r of
Conne ctions cre ate d
s ince the Conne ction
Pool was cre ate d.
Numbe r of
Conne ctions cre ate d
s ince the Conne ction
Pool was cre ate d.
Numbe r of
Conne ctions
de s troye d s ince the
Conne ction Pool was
cre ate d.
Numbe r of
Conne ctions
de s troye d s ince the
Conne ction Pool was
cre ate d.
Available Conne ction
Count
InUs e Conne ctionCou
nt
Conne ctionCre ate dC
ount
Conne ctionCre ate dC
ount
Conne ctionDe s troye
dCount
Conne ctionDe s troye
dCount
199
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.17.
Name
Type
JNDI Name
Drive r Clas s
Conne ction Url
Us e r Name
Pas s word
Min Pool Siz e
Max Pool Siz e
Trans action Is olation
200
Descript io n
The JNDI name
unde r which the
DataSource wrappe r
will be bound.
The fully qualifie d
name of the JDBC
drive r or datas ource
clas s . Not us e d for
XA-Datas ource s
The JDBC drive r
conne ction URL
s tring. Ne e de d for
Tx and Non-Tx
datas ource s
The Trans action
Is olation le ve l. The
de fault s e tting is to
us e whiche ve r
is olation le ve l is
provide d by de fault
by the databas e .
Required
Int ernal Name
ye s
ye s
type
jndi-name
no
drive r-clas s
no
conne ction-url
no
no
no
no
no
us e r-name
pas s word
min-pool-s iz e
max-pool-s iz e
trans action-is olation
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Blocking Time out
Millis
Indicate s the
no
maximum time in
millis e conds to block
while waiting for a
conne ction be fore
throwing an
e xce ption. Note that
this blocks only
while waiting for a
pe rmit for a
conne ction, and will
ne ve r throw an
e xce ption if cre ating
a ne w conne ction
take s an inordinate ly
long time . If nothing
is s pe cifie d the
de fault of 30000
millis e conds is us e d.
Indicate s the
no
maximum time in
minute s a
conne ction may be
idle be fore be ing
clos e d. The actual
maximum time
de pe nds als o on the
Idle Re move r s can
time , which is 1/2
the s malle s t idle time out-minute s of
any pool. If nothing
is s pe cifie d the
de fault of 15
minute s is us e d.
The numbe r of
no
pre pare d
s tate me nts pe r
conne ction in an LRU
cache .
Idle Time out Minute s
Pre pare d State me nt
Cache Siz e
Required
Int ernal Name
blocking-time outmillis
idle -time out-minute s
pre pare d-s tate me ntcache -s iz e
201
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Valid Conne ction
Che cke r Clas s
Name
An
org.jbos s .re s ource .a
dapte r.jdbc.ValidCon
ne ctionChe cke r that
provide s a
SQLExce ption
is ValidConne ction(Co
nne ction e ) me thod
to validate is a
conne ction is valid.
An e xce ption me ans
the conne ction is
de s troye d. This
ove rride s the che ckvalid-conne ction-s ql
whe n pre s e nt.
Indicate s if the JNDI
name s hould be
pre fixe d with java:
which caus e s the
DataSource to only
be acce s s ible from
within the JBos s
s e rve r vm. The
de fault is Ye s .
Indicate s Subje cts
(from s e curity
domain) are us e d to
dis tinguis h
conne ctions in the
pool. The conte nt of
the s e curity domain
is the name of the
JAAS s e curity
manage r that will
handle
authe ntication. This
name corre late s to
the JAAS loginconfig.xml de s criptor
applicationpolicy/name
attribute . Mus t be
s pe cifie d if e ithe r
Containe r Bas e d or
Containe r and
Application Bas e d
authe ntication type s
are s pe cifie d.
no
valid-conne ctionche cke r-clas s -name
no
us e -java-conte xt
no
s e curity-domain
Us e Java Conte xt
Se curity Domain
202
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Ne w Conne ction Sql
Spe cify an SQL
s tate me nt to
e xe cute whe ne ve r a
conne ction is adde d
to the conne ction
pool.
An
org.jbos s .re s ource .a
dapte r.jdbc.Exce ptio
nSorte r that
provide s a boole an
is Exce ptionFatal(SQL
Exce ption e ) me thod
to validate is an
e xce ption s hould be
broadcas t to all
javax.re s ource .s pi.C
onne ctionEve ntLis te
ne r as a
conne ctionErrorOccu
rre d me s s age .
Spe cify an SQL
s tate me nt to che ck
validity of a pool
conne ction. This may
be calle d whe n
manage d conne ction
is take n from pool
for us e .
Whe the r to che ck for
unclos e d
s tate me nts whe n a
conne ction is
re turne d to the pool
and re s ult s e ts are
clos e d whe n a
s tate me nt is
clos e d/re turne d to
the pre pare d
s tate me nt cache .
The de fault is Ye s ,
but no warnings .
The datas ource
clas s for XA
conne ctions .
no
ne w-conne ction-s ql
no
e xce ption-s orte rclas s -name
no
che ck-validconne ction-s ql
no
track-s tate me nts
no
xa-datas ource -clas s
no
conne ction-prope rty
Exce ption Sorte r
Clas s Name
Che ck Valid
Conne ction Sql
Track State me nts
Xa Datas ource
Clas s
Conne ction Prope rty
203
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
No Tx Se parate
Pools
Whe the r to us e
s e parate pools for
conne ctions
re trie ve d in a
trans action and
thos e re trie ve d
outs ide a
trans action. The
de fault is Ye s .
no
no-tx-s e parate -pools
no
application-manage ds e curity
s e curity-domain-andapplication
track-conne ction-bytx
Application Manage d
Se curity
Se curity Domain and
Application
Track Conne ction By Whe the r the
Tx
conne ction s hould
be "locke d" to the
trans action,
re turning it to the
pool at the e nd of
the trans action. The
de fault is No.
Is Same RM
Allows one to
Ove rride Value
unconditionally s e t
whe the r the
javax.trans action.xa.
XARe s ource .is Same
RM(XARe s ource )
re turns true or
fals e . The de fault is
not to ove rride the
re turn value .
no
no
no
is Same RM-ove rride value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
T able 3.18. Met rics
Name
Descript io n
Flus h
Re s e ts the conne ction pool for this
datas ource . Pe rforms the following s te ps :
1) all idle conne ctions are imme diate ly
clos e d, 2) any in us e conne ctions are
clos e d whe n the application finis he s with
the m, and 3) ne w conne ctions are cre ate d.
Package T ypes
204
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
3.1.3. JBossAS - Connect ionFact ory Service
Overview
T able 3.19. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS
Child Resource T ypes
none
Connect ion Propert ies
T able 3.20 .
Name
Descript io n
Obje ct Name
Name Te mplate
De s cription
Te mplate
Name
The name of this
Conne ction Factory
Required
Int ernal Name
ye s
ye s
ye s
obje ctName
name Te mplate
de s criptionTe mplate
ye s
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.21. Met rics
Name
T ype
Descript io n
Int ernal Name
Available Conne ction
Count
Conne ction Count
Conne ction Cre ate d
Count
Conne ction
De s troye d Count
In Us e Conne ction
Count
me as ure me nt
Numbe r of available
conne ctions .
Conne ction Count
Conne ction Cre ate d
Count
Conne ction
De s troye d Count
Mumbe r of
conne ctions
curre ntly in us e .
Available Conne ction
Count
Conne ctionCount
Conne ctionCre ate dC
ount
Conne ctionDe s troye
dCount
InUs e Conne ctionCou
nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
205
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Max Conne ctions In
Us e Count
me as ure me nt
MaxConne ctions InUs
e Count
Max Siz e
Min Siz e
me as ure me nt
me as ure me nt
Maximum numbe r of
maximum
conne ctions that
have be e n in us e .
Max Siz e
Min Siz e
MaxSiz e
MinSiz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.22.
Name
Descript io n
Required
Int ernal Name
Conne ction Factory
Type
JNDI Name
Conne ction Factory
Type (Tx or no Tx)
The JNDI Name
unde r which the
DataSource wrappe r
will be bound.
This e le me nt
s pe cifie s the de fault
us e rname us e d
whe n cre ating a ne w
conne ction. The
actual us e rname
may be ove rridde n
by the application
code ge tConne ction
parame te rs or the
conne ction cre ation
conte xt JAAS
Subje ct.
This e le me nt
s pe cifie s the de fault
pas s word us e d
whe n cre ating a ne w
conne ction. The
actual pas s word
may be ove rridde n
by the application
code ge tConne ction
parame te rs or the
conne ction cre ation
conte xt JAAS
Subje ct.
ye s
type
ye s
jndi-name
no
us e r-name
no
pas s word
Us e r Name
Pas s word
206
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Minimum Pool Siz e
Indicate s the
minimum numbe r of
conne ctions the pool
s hould hold.
Indicate s the
maximum numbe r of
conne ctions the pool
s hould hold.
Spe cifying this
e le me nt indicate s
that conne ctions in
the pool s hould be
dis tinguis he d by
application code
s upplie d
parame te rs , s uch as
from
ge tConne ction(us e r,
pw). This re quire s
that you s e t a
s e curity domain
which will populate a
s e curity-domain-andapplication tag. If it is
mis s ing this
re s ource will not be
cre ate d or s ave d.
Indicate s Subje cts
from s e curity
domain are us e d to
dis tinguis h
conne ctions in this
pool. If Application
Manage d Se curity is
s e t to true , the n this
will cre ate a
s e curity-domain tag.
If it is s e t to fals e or
uns e t, the n this
prope rty will
populate a s e curitydomain-andapplication tag.
us e d to ide ntify the
RAR de ployme nt
matching the
dis play-name in the
ra.xml
no
min-pool-s iz e
no
max-pool-s iz e
no
application-manage ds e curity
no
s e curity-domain
no
adapte r-dis playname
Maximum Pool Siz e
Application Manage d
Se curity
Se curity
Domain/Se curity
Domain and
Application
Adapte r Dis play
Name
207
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
De pe nds
The de pe nds
e le me nt s pe cifie s
the JMX Obje ctName
s tring of a s e rvice
that the conne ction
manage r s e rvice s
de pe nd on. The
conne ction manage r
s e rvice will not be
s tarte d until the
de pe nde nt s e rvice s
have be e n s tarte d.
This is the name of
the RAR file that
contains the
de finition for the
re s ource we want to
provide . For ne s te d
RAR file s , the name
would look like
myapplication.e ar#m
y.rar.
This is the
conne ction factory
inte rface clas s . It
s hould match the
conne ctionfactoryinte rface in the
ra.xml file .
This e le me nt
de clare s a de fault
type mapping for
this datas ource . The
type mapping s hould
match a type mapping/name
e le me nt from
s tandardjbos s cmpjdbc.xml.
Indicate s if the JNDI
name s hould be
pre fixe d with java:.
Whe the r to us e local
or xa trans actions . If
nothing is s pe cifie d,
the de fault of local
will be us e d.
no
de pe nds
ye s
rar-name
ye s
conne ction-de finition
no
type -mapping
no
us e -java-conte xt
no
trans action-type
Rar Name
Conne ction
De finition
Type Mappings
Us e Java Conte xt
Trans action Type
208
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
No Tx Se parate
Pools
The pre s e nce of this
e le me nt indicate s
that two conne ction
pools are re quire d
to is olate
conne ctions us e d
with JTA trans action
from thos e us e d
without a JTA
trans action. The
pools are laz ily
cons tructe d on firs t
us e . Its us e cas e is
for Oracle (and
pos s ibly othe r
ve ndors ) XA
imple me ntations
that don't like us ing
an XA conne ction
with and without a
JTA trans action.
Whe the r the
conne ction s hould
be locke d into the
trans action.
Allows one to
unconditionally s e t
whe the r the
javax.trans action.xa.
XARe s ource .is Same
RMXARe s ource
re turns true or
fals e . The de fault is
not to ove rride the
re turn value .
Whe the r on not to
us e s trict minumum.
Pre fill the Pool with
Conne ction obje cts ,
or laz y load obje cts
in the pool
no
no-tx-s e parate -pools
no
track-conne ction-bytx
no
is Same RM-ove rride value
no
us e -s trict-min
no
pre fill
Track Conne ction By
Trans action
is Same RM Ove rride
Value
Us e Strict Minimum
Pre fill
209
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Blocking Time out in
Millis e conds
Indicate s the
maximum time in
millis e conds to block
while waiting for a
conne ction be fore
throwing an
e xce ption. Note that
this blocks only
while waiting for a
pe rmit for a
conne ction, and will
ne ve r throw an
e xce ption if cre ating
a ne w conne ction
take s an inordinate ly
long time . If nothing
is s pe cifie d the
de fault of 30000
millis e conds is us e d.
Idle Time out
Maximum time in
minute s a
conne ction can be
idle be fore it is
clos e d.
XA Re s ource
Maximum time in
Time out
minute s an XA
Re s ource can be
idle be fore it is
re move d.
Ne w Conne ction SQL Spe cify an SQL
s tate me nt to
e xe cute whe ne ve r a
conne ction is adde d
to the conne ction
pool.
Che ck Valid
Spe cify an SQL
Conne ction SQL
s tate me nt to che ck
validity of a pool
conne ction. This may
be calle d whe n
manage d conne ction
is take n from pool
for us e .
Config Prope rty
Configuration
Prope rtie s
Required
Int ernal Name
no
blocking-time outmillis
no
idle -time out-minute s
no
xa-re s ource -time out
no
ne w-conne ction-s ql
no
che ck-validconne ction-s ql
no
config-prope rty
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
210
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Operat ions
none
Package T ypes
none
3.1.4. JBossAS - JBossMQ Service
Overview
T able 3.23. Overview
De s cription:
Single ton:
Plugin:
The JBos s MQ s ubs ys te m
ye s
JBos s AS
Child Resource T ypes
Se ction 3.1.4.1, “JBos s AS - JMQ JMS Que ue Se rvice ”
Se ction 3.1.4.2, “JBos s AS - JMQ JMS Topic Se rvice ”
Connect ion Propert ies
T able 3.24.
Name
Descript io n
Obje ct Name
Name
Required
Int ernal Name
ye s
ye s
obje ctName
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.25. Met rics
Name
T ype
Descript io n
Int ernal Name
JMS Me s s age Cache
Hits
me as ure me nt
JMS Me s s age Cache
Hits pe r Minute
me as ure me nt
The numbe r of
cache hits to the JMS
Me s s age Cache
The numbe r of
cache hits to the JMS
Me s s age Cache
jbos s .mq:s e rvice =M
e s s age Cache :Cache
Hits
jbos s .mq:s e rvice =M
e s s age Cache :Cache
Hits
211
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
JMS Me s s age Cache
Mis s e s
me as ure me nt
JMS Me s s age Cache
Mis s e s pe r Minute
me as ure me nt
JMS Me s s age Cache
Curre nt Me mory
Us age
me as ure me nt
jbos s .mq:s e rvice =M
e s s age Cache :Cache
Mis s e s
jbos s .mq:s e rvice =M
e s s age Cache :Cache
Mis s e s
jbos s .mq:s e rvice =M
e s s age Cache :Curre n
tMe moryUs age
JMS Me s s age Cache
High Me mory Mark
me as ure me nt
JMS Me s s age Cache
Max Me mory Mark
me as ure me nt
JMS Me s s age Cache
Siz e
me as ure me nt
The numbe r of
cache mis s e s to the
JMS Me s s age Cache
The numbe r of
cache mis s e s to the
JMS Me s s age Cache
The total me mory
curre ntly in us e by
the JMS Me s s age
Cache
The pe ak amount of
me mory the JMS
Me s s age Cache has
active ly us e d s ince
s e rve r s tart
The maximum
amount of me mory
the JMS Me s s age
Cache is allowe d to
us e
The numbe r of
me s s age s curre ntly
in the JMS Me s s age
Cache
jbos s .mq:s e rvice =M
e s s age Cache :HighM
e moryMark
jbos s .mq:s e rvice =M
e s s age Cache :MaxMe
moryMark
jbos s .mq:s e rvice =M
e s s age Cache :TotalC
ache Siz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.1.4.1. JBossAS - JMQ JMS Queue Service
Overview
T able 3.26. Overview
De s cription:
Single ton:
212
no
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Plugin:
JBos s AS
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.27.
Name
Descript io n
Obje ct Name
Name Te mplate
De s cription
Te mplate
Name
The name of this
que ue
Required
Int ernal Name
ye s
ye s
ye s
obje ctName
name Te mplate
de s criptionTe mplate
ye s
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.28. Met rics
Name
T ype
Descript io n
Int ernal Name
Me s s age s in Que ue
me as ure me nt
Que ue De pth
Re ce ive rs Count
me as ure me nt
Sche dule d Me s s age
Count
me as ure me nt
In Proce s s Me s s age
Count
me as ure me nt
The numbe r of
unde live re d
me s s age s in the
que ue .
The numbe r of
Clie ntCons ume rs
waiting for a
me s s age .
The numbe r of
me s s age s waiting to
be s che dule d
The numbe r of
me s s age s re ce ive d
by clie nts but not
acknowle dge d (from
AS 4.0.5)
Re ce ive rs Count
Sche dule dMe s s age C
ount
InProce s s Me s s age C
ount
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
213
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Co nf igurat io n Pro pert ies
T able 3.29.
Name
Descript io n
Required
Int ernal Name
De s tination Manage r
The JMX obje ct name
of the de s tination
manage r configure d
for the s e rve r.
The JMX obje ct name
of the s e curity
manage r that is
be ing us e d to
validate clie nt
re que s ts .
By de fault, JBos s MQ
s ile ntly re move s
e xpire d JMS
me s s age from its
de s tination. As of
JBos s 4.0.4, e xpire d
me s s age s can now
be move d into a
s e parate
de s tination.
ExpiryDe s tination
indicate s the
javax.manage me nt.
Obje ctName of the
e xpiry de s tination.
This de s tination
mus t be locate d on
the s ame s e rve r
and be a JBos s MQ
de s tination.
The location in JNDI
to which the que ue
obje ct will be bound.
If this is not s e t it
will be bound unde r
the que ue conte xt
us ing the name of
the que ue . This
prope rty is optional,
in mos t cas e s the
mbe an name is
us e d for binding
purpos e . Se e
{s e rve rconfig}/de ploy/jms /j
bos s mqde s tinations s e rvice .xml for
e xample s .
ye s
De s tinationManage r
no
Se curityManage r
no
ExpiryDe s tination
no
JNDIName
Se curity Manage r
Expiry De s tination
JNDI Name
214
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
In Me mory
Don't pe rs is t
me s s age s and avoid
me s s age s ofte ning
whe n us ing the
NullPe rs is te nce Mana
ge r
The maximum time s
a me s s age is
nacke d be fore a
me s s age is s e nt to
the De ad Le tte r
Que ue (0 - don't
re de live r, n re de live r n time s , -1
- continue
re de live ring
inde finite ly)
The le ngth of time in
millis e conds to wait
be fore a me s s age
is re de live re d afte r
a nack
Se ts the de s tination
me s s age counte r
his tory day limit with
a value le s s than 0
indicating unlimite d
his tory, a 0 value
dis abling his tory and
a value gre ate r than
0 giving the his tory
days count.
no
InMe mory
no
Re de live ryLimit
no
Re de live ryDe lay
no
Me s s age Counte rHis t
oryDayLimit
Re de live ry Limit
Re de live ry De lay
Me s s age Counte r
His tory Day Limit
215
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Maximum De pth
The MaxDe pth is an no
uppe r limit to the
backlog of
me s s age s that can
e xis t for a
de s tination. If
e xce e de d, atte mpts
to add ne w
me s s age s will re s ult
in a
org.jbos s .mq.De s tina
tionFullExce ption.
The MaxDe pth can
s till be e xce e de d in
a numbe r of
s ituations , e .g. whe n
a me s s age is place d
back into the que ue .
Als o trans actions
pe rforming re ad
committe d
proce s s ing, look at
the curre nt s iz e of
que ue , ignoring any
me s s age s that may
be adde d as a re s ult
of the curre nt
trans action or othe r
trans actions . This is
be caus e we don't
want the trans action
to fail during the
commit phas e whe n
the me s s age is
phys ically adde d to
the que ue .
Spe cifie s the
no
numbe r of time s
uncommitte d
trans actions are to
be re s olve d be fore
failing. De fault 0 z e ro (from JBos s 4.0.3).
Re cove ry Re trie s
216
Required
Int ernal Name
MaxDe pth
Re cove ryRe trie s
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Se curity
Configurations
This e le me nt
s pe cifie s a XML
fragme nt which
de s cribe s the
acce s s control lis t to
be us e d by the
Se curityManage r to
authoriz e clie nt
ope rations agains t
the de s tination. The
conte nt mode l is the
s ame as for the
Se curityManage r
Se curityConf
attribute .
Name of the que ue
to be us e d in the
JMX obje ct name .
Binding path of this
Que ue in JNDI.
ye s
Se curityConf
ye s
MBe anName
ye s
JNDIBinding
Que ue Name
JNDI Binding
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.30 . Met rics
Name
Descript io n
Re move All Me s s age s
Re s e t Me s s age Counte r
Cle ars all Me s s age s in the Que ue
Cle ars the Me s s age Counte r data for this
Que ue
Cle ars the Me s s age Counte r his tory data
for this Que ue
Lis ts the Me s s age s in the Que ue by
Se le ctor (if provide d). Se le ctor is not
re quire d.
Lis ts the Sche dule d Me s s age s by Se le ctor
(if provide d). Se le ctor is not re quire d.
Lis ts the Me s s age s in proce s s by Se le ctor
(if provide d). Se le ctor is not re quire d.
Re s e t Me s s age Counte r His tory
Lis t Me s s age s by Se le ctor
Lis t Sche dule d Me s s age s
Lis t In Proce s s Me s s age s
Package T ypes
none
3.1.4.2. JBossAS - JMQ JMS T opic Service
217
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Overview
T able 3.31. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.32.
Name
Descript io n
Obje ct Name
Name Te mplate
De s cription
Te mplate
Name
The name of this
topic
Required
Int ernal Name
ye s
ye s
ye s
obje ctName
name Te mplate
de s criptionTe mplate
ye s
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.33. Met rics
Name
T ype
All Me s s age Counte r me as ure me nt
Durable Me s s age
Count
me as ure me nt
Non-durable
Me s s age Count
me as ure me nt
All Subs cription
Count
me as ure me nt
Durable Subs cription me as ure me nt
Count
218
Descript io n
Int ernal Name
Re turns the total
me s s age count for
all s ubs criptions .
Total numbe r of
me s s age s for all
durable
s ubs criptions .
Total numbe r of
me s s age s for all
non-durable
s ubs criptions .
Numbe r of
s ubs criptions waiting
for a me s s age .
Numbe r of durable
s ubs criptions waiting
for a me s s age .
AllMe s s age Count
Durable Me s s age Cou
nt
NonDurable Me s s age
Count
AllSubs criptions Coun
t
Durable Subs cription
s Count
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Non-durable
Subs cription Count
me as ure me nt
Numbe r of nondurable
s ubs criptions waiting
for a me s s age .
NonDurable Subs cript
ions Count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.34.
Name
Descript io n
Required
Int ernal Name
De s tination Manage r
The JMX obje ct name
of the de s tination
manage r configure d
for the s e rve r.
The JMX obje ct name
of the s e curity
manage r that is
be ing us e d to
validate clie nt
re que s ts .
By de fault, JBos s MQ
s ile ntly re move s
e xpire d JMS
me s s age from its
de s tination. As of
JBos s 4.0.4, e xpire d
me s s age s can now
be move d into a
s e parate
de s tination.
ExpiryDe s tination
indicate s the
javax.manage me nt.
Obje ctName of the
e xpiry de s tination.
This de s tination
mus t be locate d on
the s ame s e rve r
and be a JBos s MQ
de s tination.
ye s
De s tinationManage r
no
Se curityManage r
no
ExpiryDe s tination
Se curity Manage r
Expiry De s tination
219
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
JNDI Name
The location in JNDI
to which the topic
will be bound. If this
is not s e t it will be
bound unde r the
topic conte xt us ing
the mbe an name of
the topic. This
prope rty is optional,
in mos t cas e s the
mbe an name is
us e d for binding
purpos e . Se e
{s e rve rconfig}/de ploy/jms /j
bos s mqde s tinations s e rvice .xml for
e xample s .
Don't pe rs is t
me s s age s and avoid
me s s age s ofte ning
whe n us ing the
NullPe rs is te nce Mana
ge r.
The maximum time s
a me s s age is
nacke d be fore a
me s s age is s e nt to
the De ad Le tte r
Que ue (0 - don't
re de live r, n re de live r n time s , -1
- continue
re de live ring
inde finite ly).
The le ngth of time in
millis e conds to wait
be fore a me s s age
is re de live re d afte r
a nack.
Se ts the de s tination
me s s age counte r
his tory day limit with
a value le s s than 0
indicating unlimite d
his tory, a 0 value
dis abling his tory and
a value gre ate r than
0 giving the his tory
days count.
no
JNDIName
no
InMe mory
no
Re de live ryLimit
no
Re de live ryDe lay
no
Me s s age Counte rHis t
oryDayLimit
In Me mory
Re de live ry Limit
Re de live ry De lay
Me s s age Counte r
His tory Day Limit
220
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Maximum De pth
The MaxDe pth is an no
uppe r limit to the
backlog of
me s s age s that can
e xis t for a
de s tination. If
e xce e de d, atte mpts
to add ne w
me s s age s will re s ult
in a
org.jbos s .mq.De s tina
tionFullExce ption.
The MaxDe pth can
s till be e xce e de d in
a numbe r of
s ituations , e .g. whe n
a me s s age is place d
back into the que ue .
Als o trans actions
pe rforming re ad
committe d
proce s s ing, look at
the curre nt s iz e of
que ue , ignoring any
me s s age s that may
be adde d as a re s ult
of the curre nt
trans action or othe r
trans actions . This is
be caus e we don't
want the trans action
to fail during the
commit phas e whe n
the me s s age is
phys ically adde d to
the que ue .
Spe cifie s the
no
numbe r of time s
uncommitte d
trans actions are to
be re s olve d be fore
failing. De fault 0 z e ro (from JBos s 4.0.3).
Re cove ry Re trie s
Required
Int ernal Name
MaxDe pth
Re cove ryRe trie s
221
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se curity
Configurations
This e le me nt
s pe cifie s a XML
fragme nt which
de s cribe s the
acce s s control lis t to
be us e d by the
Se curityManage r to
authoriz e clie nt
ope rations agains t
the de s tination. The
conte nt mode l is the
s ame as for the
Se curityManage r
Se curityConf
attribute .
Name of the que ue
to be us e d as the
JMX obje ct name .
Binding path of this
Topic in JNDI.
ye s
Se curityConf
ye s
MBe anName
ye s
JNDIBinding
Topic Name
JNDI Binding
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.35. Met rics
Name
Descript io n
Re move All Me s s age s
Lis t All Subs criptions
Lis t Durable Subs criptions
Lis t Non-durable Subs criptions
Re s e t Me s s age Counte r
Cle ars all Subs criptions
Lis ts all the Subs criptions .
Lis ts all the durable s ubs criptions .
Lis ts all the non-durable s ubs criptions .
Cle ars the me s s age counte r data for all
topic s ubs criptions .
Cle ars the me s s age counte r his tory data
for this topic.
Lis t the me s s age s for a s ubs cription by ID
and with an optional s e le ctor.
Ge ts the me s s age count for non-durable
me s s age s by clie nt ID and s ubs cription ID.
Lis ts the non-durable me s s age s by clie nt
ID, s ubs cription ID, and an optional s e le ctor.
Ge ts the me s s age count for durable
me s s age s by clie nt ID and s ubs cription ID.
Lis ts the durable me s s age s by clie nt ID,
s ubs cription ID, and an optional s e le ctor.
Re s e t Me s s age Counte r His tory
Lis t Me s s age s by ID and Se le ctor
Ge t Non-durable Me s s age Count
Lis t Non-durable Me s s age s
Ge t Durable Me s s age Count
Lis t Durable Me s s age s
222
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Ge t Non-durable Sche dule d Me s s age Count Ge ts the me s s age count for non-durable
s che dule d me s s age s by clie nt ID and
s ubs cription ID.
Lis t Non-durable Sche dule d Me s s age s
Lis ts the non-durable s che dule d me s s age s
by clie nt ID, s ubs cription ID, and an optional
s e le ctor.
Ge t Durable Sche dule d Me s s age Count
Ge ts the me s s age count for durable
s che dule d me s s age s by clie nt ID and
s ubs cription ID.
Lis t Durable Sche dule d Me s s age s
Lis ts the durable s che dule d me s s age s by
clie nt ID, s ubs cription ID, and an optional
s e le ctor.
Ge t Non-durable In-proce s s Me s s age Count Ge ts the me s s age count for non-durable
in-proce s s me s s age s by clie nt Id and
s ubs cription Id
Lis t Non-durable In-proce s s Me s s age s
Lis ts the non-durable in-proce s s me s s age s
by clie nt ID, s ubs cription ID, and an optional
s e le ctor.
Ge t Durable In-proce s s Me s s age Count
Ge ts the me s s age count for durable inproce s s me s s age s by clie nt ID and
s ubs cription Id
Lis t Durable In-proce s s Me s s age s
Lis ts the durable in-proce s s me s s age s by
clie nt ID, s ubs cription ID, and an optional
s e le ctor.
Package T ypes
none
3.1.5. JBossAS - JBossMessaging Service
Overview
T able 3.36. Overview
De s cription:
Single ton:
Plugin:
The JBos s Me s s aging s ubs ys te m
ye s
JBos s AS
Child Resource T ypes
Se ction 3.1.5.1, “JBos s AS - JBM JMS Que ue Se rvice ”
Se ction 3.1.5.2, “JBos s AS - JBM JMS Topic Se rvice ”
Connect ion Propert ies
T able 3.37.
Name
Obje ct Name
Descript io n
Required
Int ernal Name
ye s
obje ctName
223
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Name
Required
Int ernal Name
ye s
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.38. Met rics
Name
T ype
Descript io n
Int ernal Name
Ve rs ion of the
Provide r
trait
The ve rs ion of JBos s
Me s s aging in us e
jbos s .me s s aging:s e r
vice =Se rve rPe e r:Pr
ovide rVe rs ion
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.1.5.1. JBossAS - JBM JMS Queue Service
Overview
T able 3.39. Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
none
224
no
JBos s AS
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Co nnect io n Pro pert ies
T able 3.40 .
Name
Descript io n
Obje ct Name
Name Te mplate
De s cription
Te mplate
Name
The name of this
que ue
Required
Int ernal Name
ye s
ye s
ye s
obje ctName
name Te mplate
de s criptionTe mplate
ye s
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.41. Met rics
Name
T ype
Descript io n
Int ernal Name
Me s s age s in Que ue
me as ure me nt
Me s s age Count
Cons ume r Count
me as ure me nt
Sche dule d Me s s age
Count
me as ure me nt
Cre ate d
programmatically
De live ring Count
trait
The numbe r of
me s s age s in the
que ue .
The numbe r of
Clie ntCons ume rs
waiting for a
me s s age .
The numbe r of
s che dule d
me s s age s in the
Que ue
Was this Que ue
cre ate d dynamically
The numbe r of
me s s age s curre ntly
be ing de live re d
me as ure me nt
Cons ume rCount
Sche dule dMe s s age C
ount
Cre ate dProgrammati
cally
De live ringCount
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.42.
225
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se rve r Pe e r
The Obje ctName of
the s e rve r pe e r this
de s tination was
de ploye d on.
The DLQ for this
que ue , ove rride s
the de fault DLQ on
the s e rve r pe e r.
By de fault, JBos s
Me s s aging s ile ntly
re move s e xpire d
JMS me s s age from
its de s tination.
ExpiryDe s tination
indicate s the
javax.manage me nt.
Obje ctName of the
e xpiry de s tination.
This de s tination
mus t be locate d on
the s ame s e rve r
and be a
JBos s Me s s aging
de s tination.
The location in JNDI
to which the que ue
obje ct will be bound.
If this is not s e t it
will be bound unde r
the que ue conte xt
us ing the name of
the que ue . This
prope rty is optional,
in mos t cas e s the
mbe an name is
us e d for binding
purpos e . Se e
{s e rve rconfig}/de ploy/jms /j
bos s mqde s tinations s e rvice .xml for
e xample s .
Is this a clus te re d
de s tination?
ye s
Se rve rPe e r
no
DLQ
no
ExpiryQue ue
no
JNDIName
no
Clus te re d
De ad Le tte r Que ue
Expiry Que ue
JNDI Name
Clus te re d
226
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Max De live ry
Atte mpts
The maximum time s
a me s s age is
nacke d be fore a
me s s age is s e nt to
the De ad Le tte r
Que ue (0 - don't
re de live r, n re de live r n time s , -1
- continue
re de live ring
inde finite ly)
The le ngth of time in
millis e conds to wait
be fore a me s s age
is re de live re d afte r
a nack
Se ts the de s tination
me s s age counte r
his tory day limit with
a value le s s than 0
indicating unlimite d
his tory, a 0 value
dis abling his tory and
a value gre ate r than
0 giving the his tory
days count.
The maximum
numbe r of
me s s age s this
que ue can hold
be fore the y are
droppe d (-1 =
infinite )
The in-me mory
me s s age limit, can
only be s e t whe n
que ue is s toppe d
The paging s iz e , can
only be s e t whe n
que ue is s toppe d
The write -cache
s iz e , can only be s e t
whe n que ue is
s toppe d
no
MaxDe live ryAtte mpt
s
no
Re de live ryDe lay
no
Me s s age Counte rHis t
oryDayLimit
no
MaxSiz e
no
FullSiz e
no
Page Siz e
no
DownCache Siz e
Re de live ry De lay
Me s s age Counte r
His tory Day Limit
Maximum Que ue
Siz e
Full Siz e
Page Siz e
Down Cache Siz e
227
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se curity
Configurations
This e le me nt
s pe cifie s a XML
fragme nt which
de s cribe s the
acce s s control lis t to
be us e d by the
Se curityManage r to
authoriz e clie nt
ope rations agains t
the de s tination. The
conte nt mode l is the
s ame as for the
Se curityManage r
Se curityConf
attribute .
Name of the que ue
to be us e d in the
JMX obje ct name .
Binding path of this
Que ue in JNDI.
ye s
Se curityConfig
ye s
MBe anName
ye s
JNDIBinding
Que ue Name
JNDI Binding
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.43. Met rics
Name
Descript io n
Re move All Me s s age s
Re s e t Me s s age Counte r
Cle ars all Me s s age s in the Que ue
Cle ars the Me s s age Counte r data for this
Que ue
Cle ars the Me s s age Counte r his tory data
for this Que ue
Lis ts the Me s s age s in the Que ue by
Se le ctor (if provide d). Se le ctor is not
re quire d.
Lis ts All Me s s age s by Se le ctor (if
provide d). Se le ctor is not re quire d.
Lis ts Durable Me s s age s by Se le ctor (if
provide d). Se le ctor is not re quire d.
Lis ts Non-Durable Me s s age s by Se le ctor (if
provide d). Se le ctor is not re quire d.
Re s e t Me s s age Counte r His tory
Lis t Me s s age s by Se le ctor
Lis t All Me s s age s
Lis t Durable Me s s age s
Lis t Non-Durable Me s s age s
Package T ypes
none
3.1.5.2. JBossAS - JBM JMS T opic Service
228
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
3.1.5.2. JBossAS - JBM JMS T opic Service
Overview
T able 3.44. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.45.
Name
Descript io n
Obje ct Name
Name Te mplate
De s cription
Te mplate
Name
The name of this
topic
Required
Int ernal Name
ye s
ye s
ye s
obje ctName
name Te mplate
de s criptionTe mplate
ye s
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.46. Met rics
Name
T ype
All Me s s age Counte r me as ure me nt
Durable Me s s age
Count
me as ure me nt
Non-durable
Me s s age Count
me as ure me nt
All Subs cription
Count
me as ure me nt
Descript io n
Int ernal Name
Re turns the total
me s s age count for
all s ubs criptions .
Total numbe r of
me s s age s for all
durable
s ubs criptions .
Total numbe r of
me s s age s for all
non-durable
s ubs criptions .
Numbe r of
s ubs criptions waiting
for a me s s age .
AllMe s s age Count
Durable Me s s age Cou
nt
NonDurable Me s s age
Count
AllSubs criptions Coun
t
229
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Durable Subs cription me as ure me nt
Count
Non-durable
Subs cription Count
me as ure me nt
Cre ate d
programmatically
trait
Descript io n
Int ernal Name
Numbe r of durable
s ubs criptions waiting
for a me s s age .
Numbe r of nondurable
s ubs criptions waiting
for a me s s age .
Was this Topic
cre ate d dynamically
Durable Subs cription
s Count
NonDurable Subs cript
ions Count
Cre ate dProgrammati
cally
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.47.
Name
Descript io n
Required
Int ernal Name
Se rve r Pe e r
The Obje ctName of
the s e rve r pe e r this
de s tination was
de ploye d on.
The DLQ for this
que ue , ove rride s
the de fault DLQ on
the s e rve r pe e r.
By de fault, JBos s
Me s s aging s ile ntly
re move s e xpire d
JMS me s s age from
its de s tination.
ExpiryDe s tination
indicate s the
javax.manage me nt.
Obje ctName of the
e xpiry de s tination.
This de s tination
mus t be locate d on
the s ame s e rve r
and be a
JBos s Me s s aging
de s tination.
ye s
Se rve rPe e r
no
DLQ
no
ExpiryQue ue
De ad Le tte r Que ue
Expiry Que ue
230
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
JNDI Name
The location in JNDI
to which the topic
will be bound. If this
is not s e t it will be
bound unde r the
topic conte xt us ing
the mbe an name of
the topic. This
prope rty is optional,
in mos t cas e s the
mbe an name is
us e d for binding
purpos e . Se e
{s e rve rconfig}/de ploy/jms /j
bos s mqde s tinations s e rvice .xml for
e xample s .
Is this a clus te re d
de s tination?
The maximum time s
a me s s age is
nacke d be fore a
me s s age is s e nt to
the De ad Le tte r
Que ue (0 - don't
re de live r, n re de live r n time s , -1
- continue
re de live ring
inde finite ly)
The le ngth of time in
millis e conds to wait
be fore a me s s age
is re de live re d afte r
a NACK
Se ts the de s tination
me s s age counte r
his tory day limit with
a value le s s than 0
indicating unlimite d
his tory, a 0 value
dis abling his tory and
a value gre ate r than
0 giving the his tory
days count.
The maximum
numbe r of
me s s age s this
que ue can hold
be fore the y are
droppe d (-1 =
infinite )
no
JNDIName
no
Clus te re d
no
MaxDe live ryAtte mpt
s
no
Re de live ryDe lay
no
Me s s age Counte rHis t
oryDayLimit
no
MaxSiz e
Clus te re d
Max De live ry
Atte mpts
Re de live ry De lay
Me s s age Counte r
His tory Day Limit
Maximum Que ue
Siz e
231
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Full Siz e
The in-me mory
me s s age limit, can
only be s e t whe n
que ue is s toppe d
The paging s iz e , can
only be s e t whe n
que ue is s toppe d
The write -cache
s iz e , can only be s e t
whe n que ue is
s toppe d
This e le me nt
s pe cifie s a XML
fragme nt which
de s cribe s the
acce s s control lis t to
be us e d by the
Se curityManage r to
authoriz e clie nt
ope rations agains t
the de s tination. The
conte nt mode l is the
s ame as for the
Se curityManage r
Se curityConf
attribute .
Name of the que ue
to be us e d in the
JMX obje ct name .
Binding path of this
Topic in JNDI.
no
FullSiz e
no
Page Siz e
no
DownCache Siz e
ye s
Se curityConfig
ye s
MBe anName
ye s
JNDIBinding
Page Siz e
Down Cache Siz e
Se curity
Configurations
Topic Name
JNDI Binding
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.48. Met rics
Name
Descript io n
Re move All Me s s age s
Lis t All Subs criptions
Lis t Durable Subs criptions
Lis t Non-durable Subs criptions
Lis t Me s s age s by ID and Se le ctor
Cle ars all Subs criptions
Lis ts all the Subs criptions .
Lis ts all the durable s ubs criptions .
Lis ts all the non-durable s ubs criptions .
Lis t the me s s age s for a s ubs cription by ID
and with an optional s e le ctor.
Lis ts the non-durable me s s age s by
s ubs cription ID and an optional s e le ctor.
Lis t Non-durable Me s s age s
232
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Lis t Durable Me s s age s
Lis ts the durable me s s age s by
s ubs cription ID and an optional s e le ctor.
Package T ypes
none
3.1.6. JBossAS - EJB3 Session Bean Service
Overview
T able 3.49. Overview
De s cription:
Single ton:
Plugin:
An EJB3 State le s s or State ful Se s s ion Be an
no
JBos s AS
Child Resource T ypes
none
Connect ion Propert ies
T able 3.50 .
Name
Descript io n
Obje ct Name
Name Te mplate
De s cription
Te mplate
Name
The name of this
be an
Ear
Jar
Required
Int ernal Name
ye s
ye s
ye s
obje ctName
name Te mplate
de s criptionTe mplate
ye s
name
ye s
ye s
e ar
jar
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.51. Met rics
Name
T ype
Descript io n
Int ernal Name
233
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Curre nt Count
me as ure me nt
Curre ntSiz e
Cre ate Count
me as ure me nt
Cre ate Count pe r
Minute
me as ure me nt
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
Available Count
me as ure me nt
Max Siz e
me as ure me nt
Me thod Invocation
Time
calltime
The total numbe r of
curre ntly poole d
ins tance s of this
EJB3 Se s s ion Be an
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart
The numbe r of
poole d ins tance s of
this EJB3 Se s s ion
Be an in the me thodre ady s tate
The maximum
numbe r of ins tance s
that are allowe d to
be poole d
The minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB; NOTE:
this me tric is only
available if JBos s
EJB3 RC9 Patch 1 or
late r is be ing us e d
(a capable ve rs ion of
EJB3 is include d with
JBos s AS 4.2.0.GA or
late r)
234
Cre ate Count
Cre ate Count
Re move Count
Re move Count
Available Count
MaxSiz e
Me thodInvocationTim
e
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 3.52. Met rics
Name
Descript io n
Vie w Me thod Stats
Vie w me thod e xe cution s tatis tics for the
EJB; NOTE: this ope ration is only available if
JBos s EJB3 RC9 Patch 1 or late r is be ing
us e d (a capable ve rs ion of EJB3 is include d
with JBos s AS 4.2.0.GA or late r)
Package T ypes
none
3.1.7. JBossAS - St at eless Session EJB Service
Overview
T able 3.53. Overview
De s cription:
Single ton:
Plugin:
An EJB 1.x or 2.x State le s s Se s s ion Be an
no
JBos s AS
Child Resource T ypes
none
Connect ion Propert ies
T able 3.54.
Name
Obje ct Name
Name Te mplate
De s cription
Te mplate
Name
J 2e e Application
Descript io n
The name of this e jb
Required
Int ernal Name
ye s
ye s
ye s
obje ctName
name Te mplate
de s criptionTe mplate
ye s
ye s
name
j2e e Application
235
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Ejb Jar
Required
Int ernal Name
ye s
e jbJar
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.55. Met rics
Name
T ype
Descript io n
Int ernal Name
Cre ate Calls
me as ure me nt
{s tats .cre ate Count.c
ount}
Cre ate Calls pe r
Minute
me as ure me nt
Re move Calls
me as ure me nt
Re move Calls pe r
Minute
me as ure me nt
Me thod-Re ady
Be ans
me as ure me nt
Pool Siz e
me as ure me nt
The numbe r of
ins tance s of this EJB
1.x or 2.x State le s s
Se s s ion Be an that
have be e n cre ate d
s ince s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x State le s s
Se s s ion Be an that
have be e n cre ate d
s ince s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x State le s s
Se s s ion Be an that
have be e n re move d
s ince s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x State le s s
Se s s ion Be an that
have be e n re move d
s ince s e rve r s tart
The numbe r of
poole d ins tance s of
this EJB 1.x or 2.x
State le s s Se s s ion
Be an in the me thodre ady s tate
The total numbe r of
curre ntly poole d
ins tance s of this EJB
1.x or 2.x State le s s
Se s s ion Be an
236
{s tats .cre ate Count.c
ount}
{s tats .re move Count.
count}
{s tats .re move Count.
count}
{s tats .me thodRe ady
Count.curre nt}
{{jbos s .j2e e :jndiNam
e =%name %,plugin=
pool,s e rvice =EJB}Cu
rre ntSiz e }
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Max Pool Siz e
me as ure me nt
Me thod Invocation
Time
calltime
The maximum
numbe r of ins tance s
that are allowe d to
be poole d
the minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB
{{jbos s .j2e e :jndiNam
e =%name %,plugin=
pool,s e rvice =EJB}Ma
xSiz e }
Me thodInvocationTim
e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.1.8. JBossAS - St at ef ul Session EJB Service
Overview
T able 3.56. Overview
De s cription:
Single ton:
Plugin:
An EJB 1.x or 2.x State ful Se s s ion Be an
no
JBos s AS
Child Resource T ypes
none
Connect ion Propert ies
T able 3.57.
Name
Obje ct Name
Name Te mplate
Descript io n
Required
Int ernal Name
ye s
ye s
obje ctName
name Te mplate
237
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
De s cription
Te mplate
Name
J 2e e Application
Ejb Jar
The name of this EJB
Required
Int ernal Name
ye s
de s criptionTe mplate
ye s
ye s
ye s
name
j2e e Application
e jbJar
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.58. Met rics
Name
T ype
Descript io n
Int ernal Name
Cre ate Calls
me as ure me nt
{s tats .cre ate Count.c
ount}
Cre ate Calls pe r
Minute
me as ure me nt
Re move Calls
me as ure me nt
Re move Calls pe r
Minute
me as ure me nt
Me thod-Re ady
Be ans
me as ure me nt
The numbe r of
ins tance s of this EJB
1.x or 2.x State ful
Se s s ion Be an that
have be e n cre ate d
s ince s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x State ful
Se s s ion Be an that
have be e n cre ate d
s ince s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x State ful
Se s s ion Be an that
have be e n re move d
s ince s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x State ful
Se s s ion Be an that
have be e n re move d
s ince s e rve r s tart
The numbe r of
poole d ins tance s of
this EJB 1.x or 2.x
State ful Se s s ion
Be an in the me thodre ady s tate
238
{s tats .cre ate Count.c
ount}
{s tats .re move Count.
count}
{s tats .re move Count.
count}
{s tats .me thodRe ady
Count.curre nt}
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Pas s ive Be ans
me as ure me nt
{s tats .pas s ive Count.
curre nt}
Me thod Invocation
Time
calltime
The numbe r of
poole d ins tance s of
this EJB 1.x or 2.x
State ful Se s s ion
Be an in the
pas s ivate d s tate
the minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB
Me thodInvocationTim
e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.1.9. JBossAS - Ent it y EJB Service
Overview
T able 3.59. Overview
De s cription:
Single ton:
Plugin:
An EJB 1.x or 2.x Entity Be an
no
JBos s AS
Child Resource T ypes
none
Connect ion Propert ies
T able 3.60 .
239
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Obje ct Name
Name Te mplate
De s cription
Te mplate
Name
J 2e e Application
Ejb Jar
The name of this e jb
Required
Int ernal Name
ye s
ye s
ye s
obje ctName
name Te mplate
de s criptionTe mplate
ye s
ye s
ye s
name
j2e e Application
e jbJar
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.61. Met rics
Name
T ype
Descript io n
Int ernal Name
Cre ate Calls
me as ure me nt
{s tats .cre ate Count.c
ount}
Cre ate Calls pe r
Minute
me as ure me nt
Re move Calls
me as ure me nt
Re move Calls pe r
Minute
me as ure me nt
Me thod-Re ady
Be ans
me as ure me nt
The numbe r of
ins tance s of this EJB
1.x or 2.x Entity
Be an that have be e n
cre ate d s ince
s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x Entity
Be an that have be e n
cre ate d s ince
s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x Entity
Be an that have be e n
re move d s ince
s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x Entity
Be an that have be e n
re move d s ince
s e rve r s tart
The numbe r of
poole d ins tance s of
this EJB 1.x or 2.x
Entity Be an in the
me thod-re ady s tate
240
{s tats .cre ate Count.c
ount}
{s tats .re move Count.
count}
{s tats .re move Count.
count}
{s tats .me thodRe ady
Count.curre nt}
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Poole d Be ans
me as ure me nt
{s tats .poole dCount.c
urre nt}
Cache Siz e
me as ure me nt
Pas s ivate d Count
me as ure me nt
Pas s ivate d Count
pe r Minute
me as ure me nt
Curre nt Siz e
me as ure me nt
Max Siz e
me as ure me nt
The total numbe r of
curre ntly poole d
ins tance s of this EJB
1.x or 2.x Entity
Be an
The total numbe r of
curre ntly cache d
ins tance s of this EJB
1.x or 2.x Entity
Be an
The numbe r of
poole d ins tance s of
this EJB 1.x or 2.x
Entity Be an in the
pas s ivate d s tate
The numbe r of
poole d ins tance s of
this EJB 1.x or 2.x
Entity Be an in the
pas s ivate d s tate
The total numbe r of
curre ntly poole d
ins tance s of this EJB
1.x or 2.x Entity
Be an
The maximum
numbe r of ins tance s
that are allowe d to
be poole d
{{jbos s .j2e e :jndiNam
e =%name %,plugin=
cache ,s e rvice =EJB}C
ache Siz e }
{{jbos s .j2e e :jndiNam
e =%name %,plugin=
cache ,s e rvice =EJB}P
as s ivate dCount}
{{jbos s .j2e e :jndiNam
e =%name %,plugin=
cache ,s e rvice =EJB}P
as s ivate dCount}
{{jbos s .j2e e :jndiNam
e =%name %,plugin=
pool,s e rvice =EJB}Po
olSiz e }
{{jbos s .j2e e :jndiNam
e =%name %,plugin=
pool,s e rvice =EJB}Ma
xPoolSiz e }
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.1.10. JBossAS - Message Driven EJB Service
Overview
241
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.62. Overview
De s cription:
Single ton:
Plugin:
An EJB 1.x or 2.x Me s s age Drive n Be an
no
JBos s AS
Child Resource T ypes
none
Connect ion Propert ies
T able 3.63.
Name
Descript io n
Obje ct Name
Name Te mplate
De s cription
Te mplate
Name
J 2e e Application
Ejb Jar
The name of this e jb
Required
Int ernal Name
ye s
ye s
ye s
obje ctName
name Te mplate
de s criptionTe mplate
ye s
ye s
ye s
name
j2e e Application
e jbJar
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.64. Met rics
Name
T ype
Descript io n
Int ernal Name
Cre ate Calls
me as ure me nt
{s tats .cre ate Count.c
ount}
Cre ate Calls pe r
Minute
me as ure me nt
The numbe r of
ins tance s of this EJB
1.x or 2.x Me s s age
Drive n Be an that
have be e n cre ate d
s ince s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x Me s s age
Drive n Be an that
have be e n cre ate d
s ince s e rve r s tart
242
{s tats .cre ate Count.c
ount}
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Re move Calls
me as ure me nt
{s tats .re move Count.
count}
Re move Calls pe r
Minute
me as ure me nt
Me thod-Re ady
Be ans
me as ure me nt
Me thod-Re ady
Be ans pe r Minute
me as ure me nt
The numbe r of
ins tance s of this EJB
1.x or 2.x Me s s age
Drive n Be an that
have be e n re move d
s ince s e rve r s tart
The numbe r of
ins tance s of this EJB
1.x or 2.x Me s s age
Drive n Be an that
have be e n re move d
s ince s e rve r s tart
The numbe r of
poole d ins tance s of
this EJB 1.x or 2.x
Me s s age Drive n
Be an in the me thodre ady s tate
The numbe r of
poole d ins tance s of
this EJB 1.x or 2.x
Me s s age Drive n
Be an in the me thodre ady s tate
{s tats .re move Count.
count}
{s tats .me s s age Coun
t.count}
{s tats .me s s age Coun
t.count}
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.1.11. JBossAS - Ent erprise Applicat ion (EAR) Service
Overview
T able 3.65. Overview
De s cription:
Single ton:
Ente rpris e Application
no
243
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Plugin:
JBos s AS
Child Resource T ypes
Se ction 3.1.11.1, “JBos s AS - Embe dde d We b Application (WAR) Se rvice ”
Connect ion Propert ies
T able 3.66.
Name
Descript io n
Required
Int ernal Name
Name
The name of this
EAR
ye s
name
ye s
ye s
ye s
ye s
ye s
file name
obje ctName
name Te mplate
e xte ns ion
de s criptionTe mplate
File name
Obje ct Name
Name Te mplate
Exte ns ion
De s cription
Te mplate
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.67. Met rics
Name
T ype
Descript io n
Int ernal Name
Path
trait
Application.path
Explode d?
trait
The abs olute path of
this EAR file or
dire ctory
Whe the r this EAR is
de ploye d e xplode d
(i.e . as a dire ctory)
Application.e xplode d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
244
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.68. Met rics
Name
Descript io n
Re ve rt
Trie s to re ve rt this e nte rpris e application
from a s ave d backup in the s ame dire ctory
and with a name e nding in .bak
Package T ypes
T able 3.69. Package T ypes
Name
Cat ego ry
EAR File
De ployable
Descript io n
3.1.11.1. JBossAS - Embedded Web Applicat ion (WAR) Service
Overview
T able 3.70 . Overview
De s cription:
We b Application e mbe dde d ins ide of an
Ente rpris e Application
no
JBos s AS
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.71.
Name
Descript io n
Required
Int ernal Name
Name
The name of this
WAR
ye s
name
ye s
ye s
no
file name
obje ctName
conte xtRoot
no
vHos t
File name
Obje ct Name
Conte xt Root
Virtual Hos t
this WAR's conte xt
root - us e d as a
unique path pre fix
for URLs
corre s ponding to
this WAR
The (virtual) hos t
that this application
is running on. If no
virtual hos t is s e t,
this de faults to
'localhos t'
245
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Jbos s We b Name
the obje ctName for
the jbos s .we b
We bModule that will
be us e d to fire
ope rations
the full path to the
log file containing
re s pons e -time s tats
for this we bapp
a s pace -de limite d
lis t of re gular
e xpre s s ions
s pe cifying URLs that
s hould be e xclude d
from re s pons e -time
s tats colle ction
a s pace -de limite d
lis t of Pe rl-s tyle
s ubs titution
e xpre s s ions that
s hould be applie d to
all URLs for which
re s pons e -time s tats
are colle cte d (e .g.
|^/de pt/finance /.*|/de
pt/finance /*|)
no
jbos s We bName
no
re s pons e Time LogFil
e
no
re s pons e Time UrlExc
lude s
no
re s pons e Time UrlTra
ns forms
ye s
ye s
ye s
name Te mplate
e xte ns ion
de s criptionTe mplate
Re s pons e Time Log
File
Re s pons e Time Url
Exclude s
Re s pons e Time Url
Trans forms
Name Te mplate
Exte ns ion
De s cription
Te mplate
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.72. Met rics
Name
T ype
Descript io n
Int ernal Name
Path
trait
Application.path
Explode d?
trait
the abs olute path of
this WAR file or
dire ctory
whe the r this WAR is
de ploye d e xplode d
(i.e . as a dire ctory)
246
Application.e xplode d
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Conte xt Root
trait
Conte xtRoot
HTTP Re s pons e
Time
calltime
Min. Se rvle t Re s p.
Time
Avg. Se rvle t Re s p.
Time
Max. Se rvle t Re s p.
Time
Total proce s s ing
time
Total proce s s ing
time pe r Minute
Re que s ts s e rve d
me as ure me nt
Re que s ts s e rve d
pe r Minute
Errors while
proce s s ing
Errors while
proce s s ing pe r
Minute
Curre ntly Active
Se s s ions
me as ure me nt
this WAR's conte xt
root - us e d as a
unique path pre fix
for URLs
corre s ponding to this
WAR
the minimum,
maximum, and
ave rage re s pons e
time s for HTTP
re que s ts s e rvice d
by this we bapp
Minimum re s pons e
time of a s e rvle t
Ave rage re s pons e
time of a s e rvle t
Maximum re s pons e
time of a s e rvle t
Total proce s s ing
time of the we bapp
Total proce s s ing
time of the we bapp
Numbe r of re que s ts
s e rve d by s e rvle ts
Numbe r of re que s ts
s e rve d by s e rvle ts
Numbe r of e rrors
while proce s s ing
Numbe r of e rrors
while proce s s ing
Se s s ion.active Se s s i
ons
Maximum numbe r of
Active Se s s ions
me as ure me nt
Se s s ions cre ate d
me as ure me nt
Se s s ions cre ate d
pe r Minute
me as ure me nt
Expire d Se s s ions
me as ure me nt
Expire d Se s s ions
pe r Minute
me as ure me nt
Re je cte d Se s s ions
me as ure me nt
Numbe r active
s e s s ions for the
we bapp right now
Maximum numbe r of
active s e s s ions for
the we bapp
Numbe r of s e s s ions
cre ate d for the
we bapp
Numbe r of s e s s ions
cre ate d for the
we bapp
Numbe r of e xpire d
s e s s ions for the
we bapp
Numbe r of e xpire d
s e s s ions for the
we bapp
Numbe r of s e s s ions
re je cte d for the
we bapp
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
Re s pons e Time
Se rvle t.MinRe s pons e
Time
Se rvle t.AvgRe s pons
e Time
Se rvle t.MaxRe s pons
e Time
Se rvle t.TotalTime
Se rvle t.TotalTime
Se rvle t.NumRe que s t
s
Se rvle t.NumRe que s t
s
Se rvle t.NumErrors
Se rvle t.NumErrors
Se s s ion.maxActive
Se s s ion.s e s s ionCou
nte r
Se s s ion.s e s s ionCou
nte r
Se s s ion.e xpire dSe s
s ions
Se s s ion.e xpire dSe s
s ions
Se s s ion.re je cte dSe s
s ions
247
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Re je cte d Se s s ions
pe r Minute
me as ure me nt
Se s s ion.re je cte dSe s
s ions
Se s s ion Ave rage
alive time
Max Se s s ion alive
time
Vhos t
me as ure me nt
Numbe r of s e s s ions
re je cte d for the
we bapp
Ave rage alive time
of a Se s s ions
Maximum alive time
of a Se s s ions
Virtual hos ts this app
runs on
me as ure me nt
trait
Se s s ion.s e s s ionAve
rage Alive Time
Se s s ion.s e s s ionMax
Alive Time
Vhos t.name
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.73. Met rics
Name
Descript io n
Start
s tarts this we bapp; NOTE: this ope ration is
*not* s upporte d for JBos s AS ve rs ions prior
to 4.0.4.GA (s e e
http://jira.jbos s .org/jira/brows e /JBAS-3006)
s tops this we bapp; NOTE: this ope ration is
*not* s upporte d for JBos s AS ve rs ions prior
to 4.0.4.GA (s e e
http://jira.jbos s .org/jira/brows e /JBAS-3006)
re loads this we bapp; NOTE: if the we bapp
is not in the s tarte d s tate , this ope ration
will fail
Stop
Re load
Package T ypes
none
3.1.12. JBossAS - Web Applicat ion (WAR) Service
Overview
T able 3.74. Overview
De s cription:
Single ton:
Plugin:
248
We b Application
no
JBos s AS
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Child Resource T ypes
none
Connect ion Propert ies
T able 3.75.
Name
Descript io n
Required
Int ernal Name
Name
The name of this
WAR
ye s
name
ye s
ye s
no
file name
obje ctName
conte xtRoot
no
vHos t
no
jbos s We bName
no
re s pons e Time LogFil
e
no
re s pons e Time UrlExc
lude s
File name
Obje ct Name
Conte xt Root
Virtual Hos t
Jbos s We b Name
Re s pons e Time Log
File
Re s pons e Time Url
Exclude s
this WAR's conte xt
root - us e d as a
unique path pre fix
for URLs
corre s ponding to
this WAR
The (virtual) hos t
that this application
is running on. If no
virtual hos t is s e t,
this de faults to
'localhos t'
the obje ctName for
the jbos s .we b
We bModule that will
be us e d to fire
ope rations
the full path to the
log file containing
re s pons e -time s tats
for this we bapp. The
location is
de te rmine d by the
RtFilte r and is
us ually s ome thing
like
...s e rve r/.../log/rt/app
name _rt.log
a s pace -de limite d
lis t of re gular
e xpre s s ions
s pe cifying URLs that
s hould be e xclude d
from re s pons e -time
s tats colle ction
249
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Re s pons e Time Url
Trans forms
a s pace -de limite d
lis t of Pe rl-s tyle
s ubs titution
e xpre s s ions that
s hould be applie d to
all URLs for which
re s pons e -time s tats
are colle cte d (e .g.
|^/de pt/finance /.*|/de
pt/finance /*|)
no
re s pons e Time UrlTra
ns forms
ye s
ye s
ye s
name Te mplate
e xte ns ion
de s criptionTe mplate
Name Te mplate
Exte ns ion
De s cription
Te mplate
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.76. Met rics
Name
T ype
Descript io n
Int ernal Name
Path
trait
Application.path
Explode d?
trait
Conte xt Root
trait
HTTP Re s pons e
Time
calltime
Min. Se rvle t Re s p.
Time
Avg. Se rvle t Re s p.
Time
Max. Se rvle t Re s p.
Time
me as ure me nt
the abs olute path of
this WAR file or
dire ctory
whe the r this WAR is
de ploye d e xplode d
(i.e . as a dire ctory)
this WAR's conte xt
root - us e d as a
unique path pre fix
for URLs
corre s ponding to this
WAR
the minimum,
maximum, and
ave rage re s pons e
time s for HTTP
re que s ts s e rvice d
by this we bapp
Minimum re s pons e
time of a s e rvle t
Ave rage re s pons e
time of a s e rvle t
Maximum re s pons e
time of a s e rvle t
250
me as ure me nt
me as ure me nt
Application.e xplode d
Conte xtRoot
Re s pons e Time
Se rvle t.MinRe s pons e
Time
Se rvle t.AvgRe s pons
e Time
Se rvle t.MaxRe s pons
e Time
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total proce s s ing
time
Total proce s s ing
time pe r Minute
Re que s ts s e rve d
me as ure me nt
Se rvle t.TotalTime
Re que s ts s e rve d
pe r Minute
Errors while
proce s s ing
Errors while
proce s s ing pe r
Minute
Curre ntly Active
Se s s ions
me as ure me nt
Total proce s s ing
time of the we bapp
Total proce s s ing
time of the we bapp
Numbe r of re que s ts
s e rve d by s e rvle ts
Numbe r of re que s ts
s e rve d by s e rvle ts
Numbe r of e rrors
while proce s s ing
Numbe r of e rrors
while proce s s ing
Se s s ion.active Se s s i
ons
Maximum numbe r of
Active Se s s ions
me as ure me nt
Se s s ions cre ate d
me as ure me nt
Se s s ions cre ate d
pe r Minute
me as ure me nt
Expire d Se s s ions
me as ure me nt
Expire d Se s s ions
pe r Minute
me as ure me nt
Re je cte d Se s s ions
me as ure me nt
Re je cte d Se s s ions
pe r Minute
me as ure me nt
Se s s ion Ave rage
alive time
Max Se s s ion alive
time
Vhos t
me as ure me nt
Numbe r active
s e s s ions for the
we bapp right now
Maximum numbe r of
active s e s s ions for
the we bapp
Numbe r of s e s s ions
cre ate d for the
we bapp
Numbe r of s e s s ions
cre ate d for the
we bapp
Numbe r of e xpire d
s e s s ions for the
we bapp
Numbe r of e xpire d
s e s s ions for the
we bapp
Numbe r of s e s s ions
re je cte d for the
we bapp
Numbe r of s e s s ions
re je cte d for the
we bapp
Ave rage alive time
of a Se s s ions
Maximum alive time
of a Se s s ions
Virtual hos ts this app
runs on
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
trait
Se rvle t.TotalTime
Se rvle t.NumRe que s t
s
Se rvle t.NumRe que s t
s
Se rvle t.NumErrors
Se rvle t.NumErrors
Se s s ion.maxActive
Se s s ion.s e s s ionCou
nte r
Se s s ion.s e s s ionCou
nte r
Se s s ion.e xpire dSe s
s ions
Se s s ion.e xpire dSe s
s ions
Se s s ion.re je cte dSe s
s ions
Se s s ion.re je cte dSe s
s ions
Se s s ion.s e s s ionAve
rage Alive Time
Se s s ion.s e s s ionMax
Alive Time
Vhos t.name
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
251
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Operat ions
T able 3.77. Met rics
Name
Descript io n
Start
s tarts this we bapp; NOTE: this ope ration is
*not* s upporte d for JBos s AS ve rs ions prior
to 4.0.4.GA (s e e
http://jira.jbos s .org/jira/brows e /JBAS-3006)
s tops this we bapp; NOTE: this ope ration is
*not* s upporte d for JBos s AS ve rs ions prior
to 4.0.4.GA (s e e
http://jira.jbos s .org/jira/brows e /JBAS-3006)
re loads this we bapp; NOTE: if the we bapp
is not in the s tarte d s tate , this ope ration
will fail
Trie s to re ve rt this we b application from a
s ave d backup in the s ame dire ctory and
with a name e nding in .bak
Stop
Re load
Re ve rt
Package T ypes
T able 3.78. Package T ypes
Name
Cat ego ry
WAR File
De ployable
Descript io n
3.1.13. JBossAS - EJB3 Ent it y T ree Cache Service
Overview
T able 3.79. Overview
De s cription:
Single ton:
Plugin:
The e ntity cache
no
JBos s AS
Child Resource T ypes
Se ction 3.1.13.1, “JBos s AS - EJB3 Entity Tre e Cache Inte rce ptor Se rvice ”
Connect ion Propert ies
T able 3.80 .
Name
Obje ct Name
Name Te mplate
252
Descript io n
Required
Int ernal Name
ye s
ye s
obje ctName
name Te mplate
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.81. Met rics
Name
T ype
Descript io n
Int ernal Name
Numbe r Of Locks
He ld
me as ure me nt
Numbe rOfLocks He ld
Numbe r Of Node s
me as ure me nt
The numbe r of
e ntitie s locke d for
update / re plication
acros s the
(clus te re d) tre e
cache
The total numbe r of
e ntitie s curre ntly
cache d acros s the
(clus te re d) tre e
cache
Numbe rOfNode s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.1.13.1. JBossAS - EJB3 Ent it y T ree Cache Int ercept or Service
Overview
T able 3.82. Overview
De s cription:
Single ton:
Plugin:
The e ntity cache inte rce ptor
no
JBos s AS
253
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.83.
Name
Descript io n
Obje ct Name
Name Te mplate
Required
Int ernal Name
ye s
ye s
obje ctName
name Te mplate
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.84. Met rics
Name
T ype
Descript io n
Int ernal Name
Hit Mis s Ratio
me as ure me nt
HitMis s Ratio
Re ad Write Ratio
me as ure me nt
Hits
me as ure me nt
Mis s e s
me as ure me nt
Evictions
me as ure me nt
Re turns the hit/mis s
ratio for the cache .
This ratio is de fine d
as hits /(hits +
mis s e s ).
Re turns the
re ad/write ratio for
the cache . This ratio
is de fine d as (hits +
mis s e s )/s tore s .
Re turns the numbe r
of re que s ts made to
this cache which it
could ans we r without
inte rrogating the
unde rlying data
s tore
Re turns the numbe r
of re que s ts made to
this cache which
re quire d
inte rrogating the
unde rlying data
s tore
Re turns the numbe r
of e le me nts purge d
from this cache in
accordance with its
s pe cific e viction
policy
254
Re adWrite Ratio
Hits
Mis s e s
Evictions
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Numbe r Of Locks
He ld
me as ure me nt
Numbe rOfLocks He ld
Numbe r Of Node s
me as ure me nt
Ave rage Write Time
me as ure me nt
Time Since Re s e t
me as ure me nt
Ave rage Re ad Time
me as ure me nt
Store s
me as ure me nt
Numbe r Of
Attribute s
me as ure me nt
Elaps e d Time
me as ure me nt
The numbe r of
e le me nts locke d by
this inte rce ptor for
update / re plication
acros s the
(clus te re d) tre e
cache
The total numbe r of
e ntitie s curre ntly
cache d acros s the
(clus te re d) tre e
cache
The ave rage time it
take s to ins e rt or
update e le me nts for
the cache
The amount of time
s ince this cache was
re s e t / cle are d
The ave rage time it
take s to re ad
e le me nts for the
cache , include s
Numbe r of s tore /
write s into this
cache made by this
inte rce ptor
The total numbe r of
attribute s
(prope rtie s of an
e ntity) curre ntly
cache d acros s the
(clus te re d) tre e
cache
The amount of time
s ince this cache was
cre ate d
Numbe rOfNode s
Ave rage Write Time
Time Since Re s e t
Ave rage Re adTime
Store s
Numbe rOfAttribute s
Elaps e dTime
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
255
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Package T ypes
none
3.1.14. JBossAS - Script Service
Overview
T able 3.85. Overview
De s cription:
provide s the ability to e xe cute a s cript that
pe rforms s ome tas k re late d to its pare nt
JBos s AS s e rve r
no
JBos s AS
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 3.86.
Name
Descript io n
Path
the abs olute path to ye s
the s cript file
the e nvironme nt
no
variable s that will be
pas s e d to the s cript;
e ach variable mus t
be on a ne w line and
have the s yntax
name =value ; the
variable 's value can
contain prope rtie s
with the s yntax
%prope rtyName %;
the s cript plugin will
inte rpolate the s e
with the curre nt
value s of the
corre s ponding
prope rtie s from the
s cript's pare nt
JBos s AS s e rve r's
conne ction
prope rtie s
Environme nt
Variable s
256
Required
Int ernal Name
path
e nvironme ntVariable
s
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
T able 3.87. Met rics
Name
Descript io n
Exe cute Script
e xe cute the s cript; NOTE: e nvironme nt
variable s to be pas s e d to the s cript can be
configure d via this Script s e rvice 's
conne ction prope rtie s (unde r its
Inve ntory>Conne ction tab)
Package T ypes
none
3.2. JBossAS5 - JBossAS Server
Overview
T able 3.88. Overview
De s cription:
Single ton:
Plugin:
JBos s Application Se rve r (AS), Ente rpris e
Application Platform (EAP), Ente rpris e SOA
Platform (SOA-P), or Ente rpris e We b
Platform (EWP) 5.x or 6.x ins tance
no
JBos s AS5
257
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
The s e rve r can be s tarte d, re s tarte d, or s toppe d via the Start, Re s tart, and
Shutdown ope rations . The Start and Re s tart ope rations s tart the s e rve r by
e xe cuting the s e rve r s tart s cript, typically run.s h on UNIX or run.bat on Windows . The
following conne ction s e ttings can be us e d to configure the s tart s cript e xe cution: *
Start Script - the abs olute path of the s tart s cript (e .g. "/opt/jbos s -e ap-5.0/jbos s as /bin/run.s h") * Script Pre fix - a pre fix command line to be pre pe nde d to the s tart
s cript command line (e .g. "nohup s udo -u jbos s -g jbos s ") the pre fix is als o
pre ps e nde d to the s top s cript command line if the Stop ope ration is configure d to
s top the app s e rve r via s cript. * Start Script Argume nts - argume nts to be pas s e d to
the s tart s cript (e .g. "--configuration=production") * Start Script Environme nt e nvironme nt variable s to be s e t in the s tart s cript's e nvironme nt (e .g.
"JAVA_HOME=/us r/java/jdk1.6.0_30") The s e s e ttings are automatically initializ e d by
the JBos s AS5 plugin dis cove ry code to match the curre ntly running s e rve r proce s s '
command line and e nvironme nt. For more de taile d de s criptions of the s e ttings , s e e
the Conne ction Se ttings s e ction be low.
Child Resource T ypes
Se ction 3.2.1, “JBos s AS5 - JBos s We b Se rvice ”
Se ction 3.2.2, “JBos s AS5 - No Tx Datas ource Se rvice ”
Se ction 3.2.3, “JBos s AS5 - Local Tx Datas ource Se rvice ”
Se ction 3.2.4, “JBos s AS5 - XA Datas ource Se rvice ”
Se ction 3.2.5, “JBos s AS5 - No Tx Conne ctionFactory Se rvice ”
Se ction 3.2.6, “JBos s AS5 - Tx Conne ctionFactory Se rvice ”
Se ction 3.2.7, “JBos s AS5 - JBos s Me s s aging Se rvice ”
Se ction 3.2.8, “JBos s AS5 - Ente rpris e Application (EAR) Se rvice ”
Se ction 3.2.9, “JBos s AS5 - We b Application (WAR) Se rvice ”
Se ction 3.2.10, “JBos s AS5 - Embe dde d We b Application (WAR) Se rvice ”
Se ction 3.2.11, “JBos s AS5 - EJB2 JAR Se rvice ”
Se ction 3.2.12, “JBos s AS5 - Embe dde d EJB2 JAR Se rvice ”
Se ction 3.2.13, “JBos s AS5 - EJB3 JAR Se rvice ”
Se ction 3.2.14, “JBos s AS5 - Embe dde d EJB3 JAR Se rvice ”
Se ction 3.2.15, “JBos s AS5 - Re s ource Adapte r Archive (RAR) Se rvice ”
Se ction 3.2.16, “JBos s AS5 - Embe dde d Re s ource Adapte r Archive (RAR) Se rvice ”
Se ction 3.2.17, “JBos s AS5 - Script Se rvice ”
Se ction 3.2.18, “JBos s AS5 - Se rvice Binding Manage r Se rvice ”
Aut odiscovery Process Scans
258
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.89. Met rics
Name
Query
jbos s as
proce s s |bas e name |match=^java.*,arg|org.j
bos s .Main|match=.*
Connect ion Propert ies
T able 3.90 .
Name
Descript io n
Naming Provide r URL The JBos s Naming
Provide r (JNP) URL
with which to
conne ct to the JBos s
AS or EAP ins tance
(e .g.
jnp://127.0.0.1:1099).
Principal
The name of the
principal (i.e . us e r)
to authe nticate .
Cre de ntials
The cre de ntials (i.e .
pas s word) that
s hould be us e d to
authe nticate the
principal.
JBos s Home
The abs olute path to
Dire ctory
the dire ctory whe re
JBos s AS or EAP is
ins talle d (e .g.
/opt/jbos s -5.1.0.GA).
Se rve r Home Dir
The path to the
configuration
dire ctory unde r
which this ins tance
ope rate s (e .g.
/opt/jbos s 5.2.0.GA/s e rve r/de fa
ult); if the path is not
abs olute , the n it will
be re s olve d re lative
to {home Dir}.
Required
Int ernal Name
ye s
namingURL
no
principal
no
cre de ntials
ye s
home Dir
ye s
s e rve rHome Dir
259
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se rve r Name
The name of the
s e rve r configuration
(e .g. minimal,
de fault, or all); if not
s pe cifie d, it will
de fault to the las t
path compone nt of
{s e rve rHome Dir}. If
the 's tartScriptArgs '
prope rty is not s e t,
this prope rty will be
us e d by the Start
and Re s tart
ope rations as the
value of the -c
option that is pas s e d
to the s tart s cript.
Howe ve r, this
prope rty is
de pre cate d for that
purpos e and
's tartScriptArgs '
s hould be us e d
ins te ad.
The URL of the
s e rve r's clie nt JAR
library dire ctory; if
not s pe cifie d, it will
de fault to
{home Dir}/clie nt.
The URL of the
s e rve r's main JAR
library dire ctory; if
not s pe cifie d, it will
de fault to
{home Dir}/lib.
The URL of the
s e rve r's common
JAR library dire ctory;
if not s pe cifie d, it will
de fault to
{home Dir}/common/
lib.
no
s e rve rName
no
clie ntUrl
no
libUrl
no
commonLibUrl
Clie nt Url
Lib Url
Common Lib Url
260
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Script Pre fix
A pre fix applie d to
s cript e xe cution
commands ; this
pre fix is applie d
ve rbatim. The full
path of the
e xe cutable is
re quire d (e .g.
/us r/bin/s udo). For
applicable platforms ,
this is typically a
s udo command, s o a
s udo us e r mus t be
configure d
appropriate ly for the
s pe cifie d command.
Ignore d if not s e t.
The path to the
s cript us e d by the
'Start' ope ration to
s tart this JBos s AS
s e rve r (e .g.
/opt/jbos s 5.2.0.GA/bin/run.s h);
if the path is not
abs olute , the n it will
be re s olve d re lative
to {jbos s Home Dir};
de faults to
'bin/run.s h' on UNIX
or 'bin\run.bat' on
Windows .
no
s criptPre fix
no
s tartScript
Start Script
261
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Start Script
Environme nt
Variable s
The variable s that
no
the Start and Re s tart
ope rations will add
to the e nvironme nt
of the s e rve r s tart
s cript. Each
name =value pair
s hould be on a ne w
line . Variable value s
s hould *not* be
e nclos e d in quote s
(e .g. JAVA_OPTS=Xms 512M Xmx1024M). On UNIX
s ys te ms , the typical
minimum s e t of
e nvironme nt
variable s is :
PATH=/us r/bin:/bin .
And on Windows the
typical minimum s e t
is :
PATH=C:\Windows \S
ys te m32;C:\Windows
, OS=Windows _NT ,
SYSTEMROOT=C:\Wi
ndows . In addition, it
is good practice to
s e t JAVA_HOME to
the abs olute path of
the ins tall dire ctory
of the JRE or JDK you
wis h to us e to run
the AS7 ins tance .
Howe ve r, if
JAVA_HOME is not
s pe cifie d, the s tart
s cript will atte mpt to
find java in the
PATH. The re is
curre ntly a 2000
characte r limit for
this value .
262
Required
Int ernal Name
s tartScriptEnv
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Start Script
Argume nts
The argume nts that
no
the Start and Re s tart
ope rations will pas s
to the s e rve r s tart
s cript. Each
argume nt s hould be
on a ne w line - for
e xample : --s e rve rconfig=s tandalone ha-full.xml. As an
e xce ption, the value
of a s pace -de limite d
option can optionally
be on the s ame line
as the option - for
e xample : -c de fault.
The re is curre ntly a
2000 characte r limit
for this value .
The path to the
no
s cript us e d by the
Shut Down ope ration
to s hut down this
JBos s AS s e rve r (e .g.
/opt/jbos s 5.2.0.GA/bin/s hutdow
n.s h); if the path is
not abs olute , the n it
will be re s olve d
re lative to
{jbos s Home Dir};
de faults to
'bin/s hutdown.s h' on
UNIX or
'bin\s hutdown.bat' on
Windows .
The me thod us e d to no
e xe cute the Shut
Down ope ration;
de faults to 'JMX
MBe an'. 'JMX MBe an'
is the pre fe rre d
s hutdown me thod
and s hould be us e d
unle s s the re is a
s pe cific us e cas e for
us ing a s cript.
Shutdown Script
Shutdown Me thod
Required
Int ernal Name
s tartScriptArgs
s hutdownScript
s hutdownMe thod
263
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Bind Addre s s
The hos t or IP
no
addre s s that all
application s e rve r
s e rvice s s hould
lis te n on (e .g.
10.11.14.233 or
foo.e xample .com);
s pe cify 0.0.0.0 to
te ll the application
s e rve r to bind to all
available ne twork
inte rface s ; de faults
to '127.0.0.1'. If the
's tartScriptArgs '
prope rty is not s e t,
this prope rty will be
us e d by the Start
and Re s tart
ope rations as the
value of the -b
option that is pas s e d
to the s tart s cript.
Howe ve r, this
prope rty is
de pre cate d for that
purpos e and
's tartScriptArgs '
s hould be us e d
ins te ad.
The abs olute path to no
a JRE or JDK
ins tallation dire ctory
containing the JVM
that s hould be us e d
by the ope rations
that s tart and/or
s hut down this JBos s
AS s e rve r; for the
Shutdown ope ration
to work whe n the
s hutdown me thod is
s e t to 's hutdown
s cript', the prope rty
mus t be s e t. For the
Start ope ration, this
prope rty is
de pre cate d and will
be ignore d if the
's tartScriptEnv'
prope rty is s e t.
Java Home
264
Required
Int ernal Name
bindAddre s s
javaHome
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Start Wait Max
The time , in
minute s ,(e .g. 1 or 8)
that mus t e laps e
be fore the s e rve r is
cons ide re d to have
faile d to s tart up.
The de fault is 5
minute s .
The time , in
minute s ,(e .g. 1 or 8)
that mus t e laps e
be fore the s e rve r is
cons ide re d to have
faile d to s top. The
de fault is 2.5
minute s .
Name of the MBe an
to us e whe n s hutting
down this s e rve r
through JMX.
Name of the
ope ration to invoke
whe n s hutting down
this s e rve r through
JMX. Note that only
ope rations with no
parame te r or with
one int parame te r
are s upporte d. If the
ope ration re quire s
an int parame te r, '0'
will be s upplie d.
no
s tartWaitMax
no
s topWaitMax
ye s
s hutdownMBe anNam
e
ye s
s hutdownMBe anOpe r
ation
Stop Wait Max
Shutdown MBe an
Name
Shutdown MBe an
Ope ration
265
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se rvice Availability
Re fre s h Inte rval
The amount of time ,
in minute s , that can
e laps e for s e rvice
re s ource (e .g., EJBs ,
data s ource s )
availability che cks
without having to
re fre s h the
manage d obje ct
from the JBos s
s e rve r. The
information us e d to
pe rform availability
che cks is cache d.
This prope rty
de te rmine s how
fre que ntly that data
ne e ds to be
re loade d from the
JBos s s e rve r. Any
time the manage d
obje ct is loade d
from the s e rve r, like
for colle cting
me trics , the
availability
information is
update d and the
inte rval is re s e t.
The name of the
JBos s AS JVM
re s ource .
no
s e rvice AvailabilityRe
fre s hInte rval
no
childJmxSe rve rName
ye s
logEve ntSource s
JBos s AS JVM Name
Log Eve nt Source s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.91. Met rics
Name
T ype
Descript io n
Int ernal Name
Clus te r Partition
Name
trait
MCBe an|Se rve rConfi
g|*|partitionName
Se rve r Name
trait
the name of the
clus te r partition this
s e rve r be longs to
the name of the
active profile (i.e .
configuration s e t)
this s e rve r is us ing
266
MCBe an|Se rve rConfi
g|*|s e rve rName
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Se rve r Home Dir
trait
MCBe an|Se rve rConfi
g|*|s e rve rHome Dir
Ve rs ion Name
trait
Build Date
trait
Start Date
trait
Active Thre ad Count
me as ure me nt
Active Thre ad Group
Count
me as ure me nt
JVM Fre e Me mory
me as ure me nt
JVM Max Me mory
me as ure me nt
JVM Total Me mory
me as ure me nt
Total Trans actions
me as ure me nt
the full path of the
configuration s e t
dire ctory this s e rve r
is us ing (e .g.
/opt/jbos s 5.1.0.CR1/s e rve r/de f
ault)
the code name for
this app s e rve r's
ve rs ion (AS 5.0 =
Morphe us , AS 5.1 =
The Oracle , AS 6.x =
Ne o)
the date this app
s e rve r was built
the date and time
this app s e rve r
ins tance was s tarte d
The curre nt numbe r
of active thre ads for
this app s e rve r
ins tance
The curre nt numbe r
of active thre ad
groups for this app
s e rve r ins tance
An approximation of
the total amount of
me mory curre ntly
available in the app
s e rve r JVM for future
allocate d obje cts ,
me as ure d in byte s
The maximum
amount of me mory
that the app s e rve r
JVM will atte mpt to
us e , me as ure d in
byte s ; if the re is no
inhe re nt limit the n
the value
Long.MAX_VALUE will
be re turne d
The total amount of
me mory curre ntly
available in the app
s e rve r JVM for
curre nt and future
obje cts , me as ure d in
byte s
Total numbe r of
trans actions s ince
las t re s tart
MCBe an|MCSe rve r|*|
ve rs ionName
MCBe an|MCSe rve r|*|
buildDate
MCBe an|MCSe rve r|*|
s tartDate
MCBe an|Se rve rInfo|*|
active Thre adCount
MCBe an|Se rve rInfo|*|
active Thre adGroupC
ount
MCBe an|Se rve rInfo|*|
fre e Me mory
MCBe an|Se rve rInfo|*|
maxMe mory
MCBe an|Se rve rInfo|*|
totalMe mory
MCBe an|JTA|*|trans ac
tionCount
267
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Total Trans actions
pe r Minute
me as ure me nt
MCBe an|JTA|*|trans ac
tionCount
Trans actions
Committe d
me as ure me nt
Trans actions
Committe d pe r
Minute
me as ure me nt
Trans actions Rolle d
Back
me as ure me nt
Trans actions Rolle d
Back pe r Minute
me as ure me nt
Total numbe r of
trans actions s ince
las t re s tart
Numbe r of
trans actions
committe d s ince las t
re s tart
Numbe r of
trans actions
committe d s ince las t
re s tart
Numbe r of
trans actions rolle d
back s ince las t
re s tart
Numbe r of
trans actions rolle d
back s ince las t
re s tart
MCBe an|JTA|*|commit
Count
MCBe an|JTA|*|commit
Count
MCBe an|JTA|*|rollback
Count
MCBe an|JTA|*|rollback
Count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 3.92. Met rics
Name
Descript io n
Start
Start this application s e rve r. The s cript
us e d is s pe cifie d in the Ope rations group
of conne ction prope rtie s . This ope ration will
fail if the s e rve r is alre ady s tarte d.
Shut down this application s e rve r via s cript
or JMX, de pe nding on the s e ttings in the
Ope rations and Advance d groups of
conne ction prope rtie s . This ope ration will
fail if the s e rve r is alre ady s hut down.
Shut down (if s tarte d) and the n s tart this
application s e rve r.
Shut Down
Re s tart
Package T ypes
T able 3.93. Package T ypes
268
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Cat ego ry
Descript io n
Cumulative Patch
De ployable
JAR Library
De ployable
Automatically ins tallable
application s e rve r patche s
Library Jar file s de ploye d in
JBos s AS
3.2.1. JBossAS5 - JBoss Web Service
Overview
T able 3.94. Overview
De s cription:
Single ton:
Plugin:
JBos s We b Se rvle t Containe r
ye s
JBos s AS5
Child Resource T ypes
Se ction 3.2.1.1, “JBos s AS5 - Conne ctor Se rvice ”
Se ction 3.2.1.2, “JBos s AS5 - Virtual Hos t Se rvice ”
Connect ion Propert ies
none
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.2.1.1. JBossAS5 - Connect or Service
Overview
T able 3.95. Overview
De s cription:
Single ton:
Plugin:
a JBos s We b Conne ctor
no
JBos s AS5
269
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.96.
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Protocol
Addre s s
Port
this conne ctor's
protocol (e .g. jk, ajp,
http)
the IP addre s s this
conne ctor lis te ns on
the port this
conne ctor lis te ns on
Required
Int ernal Name
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
protocol
ye s
addre s s
ye s
port
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.97. Met rics
Name
T ype
Descript io n
Int ernal Name
Maximum Re que s t
Time
me as ure me nt
maxTime
Re que s t Count
me as ure me nt
Re que s t Count pe r
Minute
me as ure me nt
Error Count
me as ure me nt
Error Count pe r
Minute
me as ure me nt
the maximum time it
took to proce s s a
re que s t s ince the
las t re s tart
the total numbe r of
re que s ts proce s s e d
s ince the las t re s tart
the total numbe r of
re que s ts proce s s e d
s ince the las t re s tart
the numbe r of
e rrors while
proce s s ing re que s ts
s ince the las t re s tart
the numbe r of
e rrors while
proce s s ing re que s ts
s ince the las t re s tart
270
re que s tCount
re que s tCount
e rrorCount
e rrorCount
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Curre nt Active
Thre ads
me as ure me nt
Thre adPool|curre ntT
hre ads Bus y
Curre nt Thre ad
Count
me as ure me nt
Maximum Thre ads
trait
the numbe r of
thre ads for this
conne ctor that are
curre ntly active
the numbe r of
thre ads for this
conne ctor that
curre ntly e xis t
Maximum numbe r of
thre ads that can be
allocate d for the
thre ad pool of this
conne ctor
Thre adPool|curre ntT
hre adCount
Thre adPool|maxThre
ads
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.2.1.2. JBossAS5 - Virt ual Host Service
Overview
T able 3.98. Overview
De s cription:
Single ton:
Plugin:
a JBos s We b virtual hos t
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.99.
Name
Compone nt Type
Descript io n
Required
Int ernal Name
ye s
compone ntType
271
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Compone nt Subtype
Compone nt Name
Name
the virtual hos t's
name (e .g. localhos t)
Required
Int ernal Name
ye s
ye s
ye s
compone ntSubtype
compone ntName
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.10 0 . Met rics
Name
T ype
Descript io n
Int ernal Name
Alias e s
trait
the alias e s for this
virtual hos t, if any
alias e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.2.2. JBossAS5 - No T x Dat asource Service
Overview
T able 3.10 1. Overview
De s cription:
Single ton:
Plugin:
272
No Trans action Datas ource s de ploye d in
the ins tance of JBos s AS
no
JBos s AS5
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Child Resource T ypes
none
Connect ion Propert ies
T able 3.10 2.
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Te mplate Name
Compone nt Name
Prope rty
The name of the
Re s ource
configuration
prope rty whos e
value s hould be
us e d as the
Manage dCompone nt
name whe n cre ating
a ne w Re s ource of
this type .
Required
Int ernal Name
ye s
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
te mplate Name
compone ntName Pro
pe rty
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.10 3. Met rics
Name
T ype
Descript io n
Int ernal Name
Run State
Conne ction
Available ?
trait
trait
runState
cus tom.conne ctionAv
ailable
Pool JNDI Name
trait
Run State
could a conne ction to
the unde rlying data
provide r be
obtaine d? Ple as e
s e e the
docume ntation
be fore e nabling this
me tric
the JNDI name of the
conne ction pool for
this datas ource
the maximum
numbe r of
conne ctions that are
available
Available Conne ction me as ure me nt
Count
poolJndiName
available Conne ction
Count
273
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Conne ction Count
me as ure me nt
conne ctionCount
Conne ction Cre ate d
Count
me as ure me nt
Conne ction
De s troye d Count
me as ure me nt
In Us e Conne ction
Count
me as ure me nt
Local Trans action
Max Conne ctions In
Us e Count
trait
me as ure me nt
Max Siz e
Min Siz e
me as ure me nt
me as ure me nt
the numbe r of
conne ctions that are
curre ntly in the pool
the numbe r of
conne ctions that
have be e n cre ate d
s ince the datas ource
was las t s tarte d
the numbe r of
conne ctions that
have be e n
de s troye d s ince the
datas ource was las t
s tarte d
the numbe r of
conne ctions that are
curre ntly in us e
Local Trans action
the mos t
conne ctions that
have be e n
s imultane ous ly in
us e s ince this
datas ource was
s tarte d
Max Siz e
Min Siz e
conne ctionCre ate dC
ount
conne ctionDe s troye
dCount
inUs e Conne ctionCou
nt
local-trans action
maxConne ctions InUs
e Count
maxSiz e
minSiz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.10 4.
Name
Descript io n
Required
Int ernal Name
JNDI Name
The global JNDI
Name unde r which
to bind the
datas ource
The de fault
us e rname whe n
cre ating a ne w
conne ction.
The de fault
pas s word whe n
cre ating a ne w
conne ction.
ye s
jndi-name
no
us e r-name
no
pas s word
Us e rname
Pas s word
274
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Minimum Pool Siz e
The minimum
numbe r of
conne ctions the pool
s hould hold. The
de fault is 0.
The maximum
numbe r of
conne ctions the pool
s hould hold. The
de fault is 10.
The fully qualifie d
name of the JDBC
drive r clas s (e .g.
"oracle .jdbc.drive r.Or
acle Drive r").
The JDBC URL for the
databas e (e .g.
"jdbc:oracle :thin:@ho
s t.e xample .com:152
1:db"). To de fine a
high availablity (HA)
datas ource , s pe cify
a lis t of URLs
s e parate d by URL
de limite rs (e .g.
"jdbc:oracle :thin:@ho
s t1.e xample .com:15
21:db1|jdbc:oracle :thi
n:@hos t2.e xample .c
om:1521:db2").
Arbitrary conne ction
prope rtie s that
s hould be pas s e d to
the
java.s ql.Drive r.conne
ct(url, props )
me thod.
The numbe r of
time s that allocating
a conne ction s hould
be trie d be fore
throwing an
e xce ption. The
de fault is 0.
The time in
millis e conds to wait
be twe e n re trying to
allocate a
conne ction. The
de fault is 5000 (5
s e conds ).
no
min-pool-s iz e
no
max-pool-s iz e
ye s
drive r-clas s
ye s
conne ction-url
no
conne ctionprope rtie s
no
allocation-re try
no
allocation-re try-waitmillis
Maximum Pool Siz e
JDBC Drive r Clas s
Conne ction URL
Conne ction
Prope rtie s
Allocation Re try
Allocation Re try Wait
Millis
275
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Background
Validation
Spe cify if
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Background
validation is me ant
to re duce the
ove rall load on the
RDBMS s ys te m
whe n validating a
conne ction. The
de fault is No.
The inte rval, in
millis e conds , at
which the
Conne ctionValidator
will run. Se t to 0 to
dis able background
validation. The
de fault is 0.
Indicate s the
maximum time in
millis e conds to block
while waiting for a
conne ction be fore
throwing an
e xce ption. Note that
this blocks only
while waiting for a
pe rmit for a
conne ction, and will
ne ve r throw an
e xce ption if cre ating
a ne w conne ction
take s an inordinate ly
long time . The
de fault is 30000 (30
s e conds ).
The maximum time ,
in minute s , a
conne ction may be
idle be fore be ing
clos e d. The de fault
is 30.
If s e t, unconditionally
s e ts the boole an
re turn value of
javax.trans action.xa.
XARe s ource .is Same
RM(XARe s ource ).
no
backgroundvalidation
no
backgroundvalidation-millis
no
blocking-time outmillis
no
idle -time out-minute s
no
is Same RM-ove rride value
Background
Validation Millis
Blocking Time out in
Millis e conds
Idle Time out
Is Same RM
Ove rride Value
276
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Jmx Invoke r Name
The Obje ctName of
the JMX Invoke r
MBe an as s ociate d
with this datas ource .
Me tadata prope rtie s .
If true , the
datas ource cannot
re us e a conne ction
outs ide a trans action
once e nlis te d in a
global trans action
and vice -ve rs a. The
de fault is Ye s .
Whe the r to atte mpt
to pre fill the
conne ction pool to
the minimum
numbe r of
conne ctions . NOTE:
Only s upporting
pools (One Pool)
s upport this fe ature .
A warning can be
found in the logs if
the pool doe s not
s upport this . The
de fault is No.
Se curity s e ttings for
conne ctions in the
pool.
The fully qualifie d
clas s name of the
clas s to us e for
formatting manage d
conne ction pool
s tatis tics for this
datas ource . The
clas s mus t
imple me nt the
org.jbos s .re s ource .s
tatis tic.formatte r.Stat
is tics Formatte r.
inte rface . The
de fault is
"org.jbos s .re s ource .
s tatis tic.pool.JBos s D
e faultSubPoolStatis ti
cFormatte r".
no
jmx-invoke r-name
no
no
me tadata
no-tx-s e parate -pools
no
pre fill
no
s e curity-domain
no
s tatis tics -formatte r
Me tadata
No Tx Se parate
Pools
Pre fill
Se curity Se ttings
Statis tics Formatte r
277
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Type Mapping
The name of the
corre s ponding type mapping in
conf/s tandardjbos s c
mp-jdbc.xml. The
type mappings
provide d by de fault:
DB2, InformixDB,
MaxDB, mySQL,
Oracle 9i, PointBas e ,
Inte rBas e , Mime r
SQL, McKoi, SapDB,
DB2/400, SOLID,
Hype rs onic SQL,
Firs tSQL/J, MS
SQLSERVER2000, MS
SQLSERVER,
Clouds cape , De rby,
Fire bird, Pos tgre SQL
8.0, Pos tgre SQL,
Sybas e , Ingre s .
Note , the re may be
cus tom type
mappings de fine d in
addition to the s e
pre de fine d
mappings .
Indicate s whe the r
the JNDI name
s hould be bound
unde r the "java"
conte xt, which
caus e s the
DataSource to only
be acce s s ible from
within the JBos s AS
VM. The de fault is
Ye s .
Whe the r idle
conne ctions be low
the min-pool-s iz e
s hould be clos e d.
The de fault is No.
no
type -mapping
no
us e -java-conte xt
no
us e -s trict-min
Us e Java Conte xt
Us e Strict Min
278
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Validate On Match
Descript io n
The validate -onmatch e le me nt
indicate s whe the r or
not conne ction le ve l
validation s hould be
done whe n a
conne ction factory
atte mpts to match a
manage d conne ction
for a give n s e t. This
is typically e xclus ive
to the us e of
background
validation. The
de fault is Ye s .
Che ck Valid
The SQL s tate me nt
Conne ction SQL
to us e to che ck the
validity of a pool
conne ction.
Conne ction
The conne ction
De finition
de finition ins ide the
RAR de ployme nt
unique ly ide ntifie d
by the conne ction
factory inte rface ,
e .g.
"javax.s ql.DataSourc
e ".
Exce ption Sorte r
The fully qualifie d
Clas s Name
name of a Java clas s
imple me nting the
org.jbos s .re s ource .a
dapte r.jdbc.Exce ptio
nSorte r inte rface
that s hould be us e d
to che ck if a JDBC
e xce ption s hould be
broadcas t.
Ne w Conne ction SQL An SQL s tate me nt to
e xe cute whe ne ve r a
ne w conne ction is
adde d to the pool;
this can be us e d to
s e t the conne ction
s che ma, e tc.
Required
Int ernal Name
no
validate -on-match
no
che ck-validconne ction-s ql
no
conne ction-de finition
no
e xce ption-s orte rclas s -name
no
ne w-conne ction-s ql
279
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Pre pare d State me nt
Cache Siz e
The numbe r of
pre pare d
s tate me nts pe r
conne ction to be
ke pt ope n and
re us e d in
s ubs e que nt
re que s ts . The y are
s tore d in an LRU
cache . Se t to 0 to
dis able the cache .
The de fault is 0.
Any configure d
que ry time out in
s e conds . A value of
0 me ans no time out.
The de fault is 0.
The RAR de ployme nt
to as s ociate with the
conne ction manage r
MBe an. e .g. jms ra.rar or
myapplication.e ar#m
y.rar for ne s te d
rars .
Whe the r to s e t the
que ry time out bas e d
on the time
re maining until
trans action time out;
any configure d
que ry time out will
be us e d if the re is
no trans action. The
de fault is No.
Should pre pare d
s tate me nts be
s hare d? The de fault
is No.
Fully qualifie d name
of the Java clas s
us e d to che ck if a
conne ction has
be come s tale .
Whe the r to che ck for
unclos e d
State me nts and
Re s ultSe ts whe n
conne ctions are
re turne d to the pool.
The de fault is "ye s no-warnings ".
no
pre pare d-s tate me ntcache -s iz e
no
que ry-time out
no
rar-name
no
s e t-tx-que ry-time out
no
s hare -pre pare ds tate me nts
no
s tale -conne ctionche cke r-clas s -name
no
track-s tate me nts
Que ry Time out
Rar Name
Se t Tx Que ry
Time out
Share Pre pare d
State me nts
Stale Conne ction
Che cke r Clas s
Name
Track State me nts
280
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Trans action Is olation
The Trans action
Is olation le ve l. The
de fault s e tting is to
us e whiche ve r
is olation le ve l is
provide d by de fault
by the databas e .
Spe cifie s the
de limite r for URLs in
the value of the
conne ction-url
prope rty for HA
datas ource s . The
de fault is "|".
The fully qualifie d
clas s name of a Java
clas s imple me nting
the
org.jbos s .re s ource .a
dapte r.jdbc.URLSe le c
torStrate gy
inte rface .
Any configure d
time out, in
millis e conds , for
inte rnal locks on the
re s ource adapte r
obje cts . A value of 0
me ans no time out.
The de fault is 0.
The fully qualifie d
name of a Java clas s
imple me nting the
org.jbos s .re s ource .a
dapte r.jdbc.ValidCon
ne ctionChe cke r
whos e pingDatabas e
me thod s hould be
us e d to che ck if a
conne ction is s till
valid be fore handing
it out from the pool.
no
trans action-is olation
no
url-de limite r
no
url-s e le ctors trate gy-clas s -name
no
us e -try-lock
no
valid-conne ctionche cke r-clas s -name
Url De limite r
Url Se le ctor
Strate gy Clas s
Name
Us e Try Lock
Valid Conne ction
Che cke r Clas s
Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
T able 3.10 5. Met rics
281
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Flus h
Lis t Formatte d Sub Pool Statis tics
Flus h the conne ctions in the pool
Obtain a formatte d s ub pool s tatis tics
re port
Obtain a s tatis tics re port
Te s t if a conne ction can be obtaine d re turns true if a conne ction was obtaine d,
or fals e if not; NOTE: this ope ration will
always re turn a s tatus of Succe s s ful - the
re s ults of the ope ration mus t be ins pe cte d
to s e e whe the r or not a conne ction was
obtaine d
Lis t Statis tics
Te s t Conne ction
Package T ypes
none
3.2.3. JBossAS5 - Local T x Dat asource Service
Overview
T able 3.10 6. Overview
De s cription:
Local Trans action Datas ource s de ploye d in
the ins tance of JBos s AS
no
JBos s AS5
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 3.10 7.
Name
Compone nt Type
Compone nt Subtype
Compone nt Name
Te mplate Name
Compone nt Name
Prope rty
282
Descript io n
The name of the
Re s ource
configuration
prope rty whos e
value s hould be
us e d as the
unde rlying
Manage dCompone nt
name whe n cre ating
a ne w Re s ource of
this type .
Required
Int ernal Name
ye s
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
te mplate Name
compone ntName Pro
pe rty
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.10 8. Met rics
Name
T ype
Descript io n
Int ernal Name
Run State
Conne ction
Available ?
trait
trait
runState
cus tom.conne ctionAv
ailable
Pool JNDI Name
trait
Run State
could a conne ction to
the unde rlying data
provide r be
obtaine d? Ple as e
s e e the
docume ntation
be fore e nabling this
me tric
the JNDI name of the
conne ction pool for
this datas ource
the maximum
numbe r of
conne ctions that are
available
the numbe r of
conne ctions that are
curre ntly in the pool
the numbe r of
conne ctions that
have be e n cre ate d
s ince the datas ource
was las t s tarte d
the numbe r of
conne ctions that
have be e n
de s troye d s ince the
datas ource was las t
s tarte d
the numbe r of
conne ctions that are
curre ntly in us e
Local Trans action
the mos t
conne ctions that
have be e n
s imultane ous ly in
us e s ince this
datas ource was
s tarte d
Max Siz e
Available Conne ction me as ure me nt
Count
Conne ction Count
me as ure me nt
Conne ction Cre ate d
Count
me as ure me nt
Conne ction
De s troye d Count
me as ure me nt
In Us e Conne ction
Count
me as ure me nt
Local Trans action
Max Conne ctions In
Us e Count
trait
me as ure me nt
Max Siz e
me as ure me nt
poolJndiName
available Conne ction
Count
conne ctionCount
conne ctionCre ate dC
ount
conne ctionDe s troye
dCount
inUs e Conne ctionCou
nt
local-trans action
maxConne ctions InUs
e Count
maxSiz e
283
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Min Siz e
me as ure me nt
Min Siz e
minSiz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.10 9.
Name
Descript io n
Required
Int ernal Name
JNDI Name
The global JNDI
Name unde r which
to bind the
datas ource
The de fault
us e rname whe n
cre ating a ne w
conne ction.
The de fault
pas s word whe n
cre ating a ne w
conne ction.
The minimum
numbe r of
conne ctions the pool
s hould hold. The
de fault is 0.
The maximum
numbe r of
conne ctions the pool
s hould hold. The
de fault is 10.
The fully qualifie d
name of the JDBC
drive r clas s (e .g.
"oracle .jdbc.drive r.Or
acle Drive r").
ye s
jndi-name
no
us e r-name
no
pas s word
no
min-pool-s iz e
no
max-pool-s iz e
ye s
drive r-clas s
Us e rname
Pas s word
Minimum Pool Siz e
Maximum Pool Siz e
JDBC Drive r Clas s
284
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Conne ction URL
The JDBC URL for the
databas e (e .g.
"jdbc:oracle :thin:@ho
s t.e xample .com:152
1:db"). To de fine a
high availablity (HA)
datas ource , s pe cify
a lis t of URLs
s e parate d by URL
de limite rs (e .g.
"jdbc:oracle :thin:@ho
s t1.e xample .com:15
21:db1|jdbc:oracle :thi
n:@hos t2.e xample .c
om:1521:db2").
Arbitrary conne ction
prope rtie s that
s hould be pas s e d to
the
java.s ql.Drive r.conne
ct(url, props )
me thod.
The numbe r of
time s that allocating
a conne ction s hould
be trie d be fore
throwing an
e xce ption. The
de fault is 0.
The time in
millis e conds to wait
be twe e n re trying to
allocate a
conne ction. The
de fault is 5000 (5
s e conds ).
Spe cify if
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Background
validation is me ant
to re duce the
ove rall load on the
RDBMS s ys te m
whe n validating a
conne ction. The
de fault is No.
ye s
conne ction-url
no
conne ctionprope rtie s
no
allocation-re try
no
allocation-re try-waitmillis
no
backgroundvalidation
Conne ction
Prope rtie s
Allocation Re try
Allocation Re try Wait
Millis
Background
Validation
285
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Background
Validation Millis
The inte rval, in
millis e conds , at
which the
Conne ctionValidator
will run. Se t to 0 to
dis able background
validation. The
de fault is 0.
Indicate s the
maximum time in
millis e conds to block
while waiting for a
conne ction be fore
throwing an
e xce ption. Note that
this blocks only
while waiting for a
pe rmit for a
conne ction, and will
ne ve r throw an
e xce ption if cre ating
a ne w conne ction
take s an inordinate ly
long time . The
de fault is 30000 (30
s e conds ).
The maximum time ,
in minute s , a
conne ction may be
idle be fore be ing
clos e d. The de fault
is 30.
If s e t, unconditionally
s e ts the boole an
re turn value of
javax.trans action.xa.
XARe s ource .is Same
RM(XARe s ource ).
The Obje ctName of
the JMX Invoke r
MBe an as s ociate d
with this datas ource .
Me tadata prope rtie s .
If true , the
datas ource cannot
re us e a conne ction
outs ide a trans action
once e nlis te d in a
global trans action
and vice -ve rs a. The
de fault is Ye s .
no
backgroundvalidation-millis
no
blocking-time outmillis
no
idle -time out-minute s
no
is Same RM-ove rride value
no
jmx-invoke r-name
no
no
me tadata
no-tx-s e parate -pools
Blocking Time out in
Millis e conds
Idle Time out
Is Same RM
Ove rride Value
Jmx Invoke r Name
Me tadata
No Tx Se parate
Pools
286
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Pre fill
Whe the r to atte mpt
no
to pre fill the
conne ction pool to
the minimum
numbe r of
conne ctions . NOTE:
Only s upporting
pools (One Pool)
s upport this fe ature .
A warning can be
found in the logs if
the pool doe s not
s upport this . The
de fault is No.
Se curity s e ttings for no
conne ctions in the
pool.
The fully qualifie d
no
clas s name of the
clas s to us e for
formatting manage d
conne ction pool
s tatis tics for this
datas ource . The
clas s mus t
imple me nt the
org.jbos s .re s ource .s
tatis tic.formatte r.Stat
is tics Formatte r.
inte rface . The
de fault is
"org.jbos s .re s ource .
s tatis tic.pool.JBos s D
e faultSubPoolStatis ti
cFormatte r".
Se curity Se ttings
Statis tics Formatte r
Required
Int ernal Name
pre fill
s e curity-domain
s tatis tics -formatte r
287
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Type Mapping
The name of the
corre s ponding type mapping in
conf/s tandardjbos s c
mp-jdbc.xml. The
type mappings
provide d by de fault:
DB2, InformixDB,
MaxDB, mySQL,
Oracle 9i, PointBas e ,
Inte rBas e , Mime r
SQL, McKoi, SapDB,
DB2/400, SOLID,
Hype rs onic SQL,
Firs tSQL/J, MS
SQLSERVER2000, MS
SQLSERVER,
Clouds cape , De rby,
Fire bird, Pos tgre SQL
8.0, Pos tgre SQL,
Sybas e , Ingre s .
Note , the re may be
cus tom type
mappings de fine d in
addition to the s e
pre de fine d
mappings .
Indicate s whe the r
the JNDI name
s hould be bound
unde r the "java"
conte xt, which
caus e s the
DataSource to only
be acce s s ible from
within the JBos s AS
VM. The de fault is
Ye s .
Whe the r idle
conne ctions be low
the min-pool-s iz e
s hould be clos e d.
The de fault is No.
no
type -mapping
no
us e -java-conte xt
no
us e -s trict-min
Us e Java Conte xt
Us e Strict Min
288
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Validate On Match
Descript io n
The validate -onmatch e le me nt
indicate s whe the r or
not conne ction le ve l
validation s hould be
done whe n a
conne ction factory
atte mpts to match a
manage d conne ction
for a give n s e t. This
is typically e xclus ive
to the us e of
background
validation. The
de fault is Ye s .
Che ck Valid
The SQL s tate me nt
Conne ction SQL
to us e to che ck the
validity of a pool
conne ction.
Conne ction
The conne ction
De finition
de finition ins ide the
RAR de ployme nt
unique ly ide ntifie d
by the conne ction
factory inte rface ,
e .g.
"javax.s ql.DataSourc
e ".
Exce ption Sorte r
The fully qualifie d
Clas s Name
name of a Java clas s
imple me nting the
org.jbos s .re s ource .a
dapte r.jdbc.Exce ptio
nSorte r inte rface
that s hould be us e d
to che ck if a JDBC
e xce ption s hould be
broadcas t.
Ne w Conne ction SQL An SQL s tate me nt to
e xe cute whe ne ve r a
ne w conne ction is
adde d to the pool;
this can be us e d to
s e t the conne ction
s che ma, e tc.
Required
Int ernal Name
no
validate -on-match
no
che ck-validconne ction-s ql
no
conne ction-de finition
no
e xce ption-s orte rclas s -name
no
ne w-conne ction-s ql
289
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Pre pare d State me nt
Cache Siz e
The numbe r of
pre pare d
s tate me nts pe r
conne ction to be
ke pt ope n and
re us e d in
s ubs e que nt
re que s ts . The y are
s tore d in an LRU
cache . Se t to 0 to
dis able the cache .
The de fault is 0.
Any configure d
que ry time out in
s e conds . A value of
0 me ans no time out.
The de fault is 0.
The RAR de ployme nt
to as s ociate with the
conne ction manage r
MBe an. e .g. jms ra.rar or
myapplication.e ar#m
y.rar for ne s te d
rars .
Whe the r to s e t the
que ry time out bas e d
on the time
re maining until
trans action time out;
any configure d
que ry time out will
be us e d if the re is
no trans action. The
de fault is No.
Should pre pare d
s tate me nts be
s hare d? The de fault
is No.
Fully qualifie d name
of the Java clas s
us e d to che ck if a
conne ction has
be come s tale .
Whe the r to che ck for
unclos e d
State me nts and
Re s ultSe ts whe n
conne ctions are
re turne d to the pool.
The de fault is "ye s no-warnings ".
no
pre pare d-s tate me ntcache -s iz e
no
que ry-time out
no
rar-name
no
s e t-tx-que ry-time out
no
s hare -pre pare ds tate me nts
no
s tale -conne ctionche cke r-clas s -name
no
track-s tate me nts
Que ry Time out
Rar Name
Se t Tx Que ry
Time out
Share Pre pare d
State me nts
Stale Conne ction
Che cke r Clas s
Name
Track State me nts
290
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Trans action Is olation
The Trans action
Is olation le ve l. The
de fault s e tting is to
us e whiche ve r
is olation le ve l is
provide d by de fault
by the databas e .
Spe cifie s the
de limite r for URLs in
the value of the
conne ction-url
prope rty for HA
datas ource s . The
de fault is "|".
The fully qualifie d
clas s name of a Java
clas s imple me nting
the
org.jbos s .re s ource .a
dapte r.jdbc.URLSe le c
torStrate gy
inte rface .
Any configure d
time out, in
millis e conds , for
inte rnal locks on the
re s ource adapte r
obje cts . A value of 0
me ans no time out.
The de fault is 0.
The fully qualifie d
name of a Java clas s
imple me nting the
org.jbos s .re s ource .a
dapte r.jdbc.ValidCon
ne ctionChe cke r
whos e pingDatabas e
me thod s hould be
us e d to che ck if a
conne ction is s till
valid be fore handing
it out from the pool.
no
trans action-is olation
no
url-de limite r
no
url-s e le ctors trate gy-clas s -name
no
us e -try-lock
no
valid-conne ctionche cke r-clas s -name
Url De limite r
Url Se le ctor
Strate gy Clas s
Name
Us e Try Lock
Valid Conne ction
Che cke r Clas s
Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
T able 3.110 . Met rics
291
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Flus h
Lis t Formatte d Sub Pool Statis tics
Flus h the conne ctions in the pool
Obtain a formatte d s ub pool s tatis tics
re port
Obtain a s tatis tics re port
Te s t if a conne ction can be obtaine d re turns true if a conne ction was obtaine d,
or fals e if not; NOTE: this ope ration will
always re turn a s tatus of Succe s s ful - the
re s ults of the ope ration mus t be ins pe cte d
to s e e whe the r or not a conne ction was
obtaine d
Lis t Statis tics
Te s t Conne ction
Package T ypes
none
3.2.4. JBossAS5 - XA Dat asource Service
Overview
T able 3.111. Overview
De s cription:
XA Datas ource s de ploye d in the ins tance
of JBos s AS
no
JBos s AS5
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 3.112.
Name
Compone nt Type
Compone nt Subtype
Compone nt Name
Te mplate Name
Compone nt Name
Prope rty
292
Descript io n
The name of the
Re s ource
configuration
prope rty whos e
value s hould be
us e d as the
unde rlying
Manage dCompone nt
name whe n cre ating
a ne w Re s ource of
this type .
Required
Int ernal Name
ye s
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
te mplate Name
compone ntName Pro
pe rty
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.113. Met rics
Name
T ype
Descript io n
Int ernal Name
Run State
Conne ction
Available ?
trait
trait
runState
cus tom.conne ctionAv
ailable
Pool JNDI Name
trait
Run State
could a conne ction to
the unde rlying data
provide r be
obtaine d? Ple as e
s e e the
docume ntation
be fore e nabling this
me tric
the JNDI name of the
conne ction pool for
this datas ource
the maximum
numbe r of
conne ctions that are
available
the numbe r of
conne ctions that are
curre ntly in the pool
the numbe r of
conne ctions that
have be e n cre ate d
s ince the datas ource
was las t s tarte d
the numbe r of
conne ctions that
have be e n
de s troye d s ince the
datas ource was las t
s tarte d
the numbe r of
conne ctions that are
curre ntly in us e
Local Trans action
the mos t
conne ctions that
have be e n
s imultane ous ly in
us e s ince this
datas ource was
s tarte d
Max Siz e
Available Conne ction me as ure me nt
Count
Conne ction Count
me as ure me nt
Conne ction Cre ate d
Count
me as ure me nt
Conne ction
De s troye d Count
me as ure me nt
In Us e Conne ction
Count
me as ure me nt
Local Trans action
Max Conne ctions In
Us e Count
trait
me as ure me nt
Max Siz e
me as ure me nt
poolJndiName
available Conne ction
Count
conne ctionCount
conne ctionCre ate dC
ount
conne ctionDe s troye
dCount
inUs e Conne ctionCou
nt
local-trans action
maxConne ctions InUs
e Count
maxSiz e
293
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Min Siz e
me as ure me nt
Min Siz e
minSiz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.114.
Name
Descript io n
Required
Int ernal Name
JNDI Name
The global JNDI
Name unde r which
to bind the
datas ource
The de fault
us e rname whe n
cre ating a ne w
conne ction.
The de fault
pas s word whe n
cre ating a ne w
conne ction.
The minimum
numbe r of
conne ctions the pool
s hould hold. The
de fault is 0.
The maximum
numbe r of
conne ctions the pool
s hould hold. The
de fault is 10.
The fully qualifie d
name of the
javax.s ql.XADataSou
rce imple me ntation
clas s .
ye s
jndi-name
no
us e r-name
no
pas s word
no
min-pool-s iz e
no
max-pool-s iz e
ye s
xa-datas ource -clas s
Us e rname
Pas s word
Minimum Pool Siz e
Maximum Pool Siz e
XA DataSource
Clas s
294
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
XA Datas ource
Prope rtie s
The prope rtie s to
as s ign to the
XADataSource
imple me ntation
clas s . Each prope rty
is mappe d onto the
XADataSource
imple me ntation by
looking for a
JavaBe ans s tyle
ge tte r me thod for
the prope rty name .
If found, the value of
the prope rty is s e t
us ing the JavaBe ans
s e tte r with the
e le me nt te xt
trans late d to the
true prope rty type
us ing the
java.be ans .Prope rty
Editor for the type .
XA trans action
time out, in s e conds
(pas s e d to
XARe s ource .s e tTran
s actionTime out()) de fault is z e ro which
doe s not invoke the
s e tte r.
For HA XA
datas ource s ,
s pe cifie s the name
of an XADataSource
prope rty that
contains a lis t of
URLs .
The numbe r of
time s that allocating
a conne ction s hould
be trie d be fore
throwing an
e xce ption. The
de fault is 0.
The time in
millis e conds to wait
be twe e n re trying to
allocate a
conne ction. The
de fault is 5000 (5
s e conds ).
no
xa-datas ource prope rtie s
no
xa-re s ource -time out
no
url-prope rty
no
allocation-re try
no
allocation-re try-waitmillis
XA Re s ource
Time out
URL Prope rty
Allocation Re try
Allocation Re try Wait
Millis
295
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Background
Validation
Spe cify if
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Background
validation is me ant
to re duce the
ove rall load on the
RDBMS s ys te m
whe n validating a
conne ction. The
de fault is No.
The inte rval, in
millis e conds , at
which the
Conne ctionValidator
will run. Se t to 0 to
dis able background
validation. The
de fault is 0.
Indicate s the
maximum time in
millis e conds to block
while waiting for a
conne ction be fore
throwing an
e xce ption. Note that
this blocks only
while waiting for a
pe rmit for a
conne ction, and will
ne ve r throw an
e xce ption if cre ating
a ne w conne ction
take s an inordinate ly
long time . The
de fault is 30000 (30
s e conds ).
The maximum time ,
in minute s , a
conne ction may be
idle be fore be ing
clos e d. The de fault
is 30.
If s e t, unconditionally
s e ts the boole an
re turn value of
javax.trans action.xa.
XARe s ource .is Same
RM(XARe s ource ).
no
backgroundvalidation
no
backgroundvalidation-millis
no
blocking-time outmillis
no
idle -time out-minute s
no
is Same RM-ove rride value
Background
Validation Millis
Blocking Time out in
Millis e conds
Idle Time out
Is Same RM
Ove rride Value
296
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Jmx Invoke r Name
The Obje ctName of
the JMX Invoke r
MBe an as s ociate d
with this datas ource .
Me tadata prope rtie s .
If true , the
datas ource cannot
re us e a conne ction
outs ide a trans action
once e nlis te d in a
global trans action
and vice -ve rs a. The
de fault is Ye s .
Whe the r to atte mpt
to pre fill the
conne ction pool to
the minimum
numbe r of
conne ctions . NOTE:
Only s upporting
pools (One Pool)
s upport this fe ature .
A warning can be
found in the logs if
the pool doe s not
s upport this . The
de fault is No.
Se curity s e ttings for
conne ctions in the
pool.
The fully qualifie d
clas s name of the
clas s to us e for
formatting manage d
conne ction pool
s tatis tics for this
datas ource . The
clas s mus t
imple me nt the
org.jbos s .re s ource .s
tatis tic.formatte r.Stat
is tics Formatte r.
inte rface . The
de fault is
"org.jbos s .re s ource .
s tatis tic.pool.JBos s D
e faultSubPoolStatis ti
cFormatte r".
no
jmx-invoke r-name
no
no
me tadata
no-tx-s e parate -pools
no
pre fill
no
s e curity-domain
no
s tatis tics -formatte r
Me tadata
No Tx Se parate
Pools
Pre fill
Se curity Se ttings
Statis tics Formatte r
297
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Type Mapping
The name of the
corre s ponding type mapping in
conf/s tandardjbos s c
mp-jdbc.xml. The
type mappings
provide d by de fault:
DB2, InformixDB,
MaxDB, mySQL,
Oracle 9i, PointBas e ,
Inte rBas e , Mime r
SQL, McKoi, SapDB,
DB2/400, SOLID,
Hype rs onic SQL,
Firs tSQL/J, MS
SQLSERVER2000, MS
SQLSERVER,
Clouds cape , De rby,
Fire bird, Pos tgre SQL
8.0, Pos tgre SQL,
Sybas e , Ingre s .
Note , the re may be
cus tom type
mappings de fine d in
addition to the s e
pre de fine d
mappings .
Indicate s whe the r
the JNDI name
s hould be bound
unde r the "java"
conte xt, which
caus e s the
DataSource to only
be acce s s ible from
within the JBos s AS
VM. The de fault is
Ye s .
Whe the r idle
conne ctions be low
the min-pool-s iz e
s hould be clos e d.
The de fault is No.
no
type -mapping
no
us e -java-conte xt
no
us e -s trict-min
Us e Java Conte xt
Us e Strict Min
298
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Validate On Match
Descript io n
The validate -onmatch e le me nt
indicate s whe the r or
not conne ction le ve l
validation s hould be
done whe n a
conne ction factory
atte mpts to match a
manage d conne ction
for a give n s e t. This
is typically e xclus ive
to the us e of
background
validation. The
de fault is Ye s .
Che ck Valid
The SQL s tate me nt
Conne ction SQL
to us e to che ck the
validity of a pool
conne ction.
Conne ction
The conne ction
De finition
de finition ins ide the
RAR de ployme nt
unique ly ide ntifie d
by the conne ction
factory inte rface ,
e .g.
"javax.s ql.DataSourc
e ".
Exce ption Sorte r
The fully qualifie d
Clas s Name
name of a Java clas s
imple me nting the
org.jbos s .re s ource .a
dapte r.jdbc.Exce ptio
nSorte r inte rface
that s hould be us e d
to che ck if a JDBC
e xce ption s hould be
broadcas t.
Ne w Conne ction SQL An SQL s tate me nt to
e xe cute whe ne ve r a
ne w conne ction is
adde d to the pool;
this can be us e d to
s e t the conne ction
s che ma, e tc.
Required
Int ernal Name
no
validate -on-match
no
che ck-validconne ction-s ql
no
conne ction-de finition
no
e xce ption-s orte rclas s -name
no
ne w-conne ction-s ql
299
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Pre pare d State me nt
Cache Siz e
The numbe r of
pre pare d
s tate me nts pe r
conne ction to be
ke pt ope n and
re us e d in
s ubs e que nt
re que s ts . The y are
s tore d in an LRU
cache . Se t to 0 to
dis able the cache .
The de fault is 0.
Any configure d
que ry time out in
s e conds . A value of
0 me ans no time out.
The de fault is 0.
The RAR de ployme nt
to as s ociate with the
conne ction manage r
MBe an. e .g. jms ra.rar or
myapplication.e ar#m
y.rar for ne s te d
rars .
Whe the r to s e t the
que ry time out bas e d
on the time
re maining until
trans action time out;
any configure d
que ry time out will
be us e d if the re is
no trans action. The
de fault is No.
Should pre pare d
s tate me nts be
s hare d? The de fault
is No.
Fully qualifie d name
of the Java clas s
us e d to che ck if a
conne ction has
be come s tale .
Whe the r to che ck for
unclos e d
State me nts and
Re s ultSe ts whe n
conne ctions are
re turne d to the pool.
The de fault is "ye s no-warnings ".
no
pre pare d-s tate me ntcache -s iz e
no
que ry-time out
no
rar-name
no
s e t-tx-que ry-time out
no
s hare -pre pare ds tate me nts
no
s tale -conne ctionche cke r-clas s -name
no
track-s tate me nts
Que ry Time out
Rar Name
Se t Tx Que ry
Time out
Share Pre pare d
State me nts
Stale Conne ction
Che cke r Clas s
Name
Track State me nts
300
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Trans action Is olation
The Trans action
Is olation le ve l. The
de fault s e tting is to
us e whiche ve r
is olation le ve l is
provide d by de fault
by the databas e .
Spe cifie s the
de limite r for URLs in
the value of the
conne ction-url
prope rty for HA
datas ource s . The
de fault is "|".
The fully qualifie d
clas s name of a Java
clas s imple me nting
the
org.jbos s .re s ource .a
dapte r.jdbc.URLSe le c
torStrate gy
inte rface .
Any configure d
time out, in
millis e conds , for
inte rnal locks on the
re s ource adapte r
obje cts . A value of 0
me ans no time out.
The de fault is 0.
The fully qualifie d
name of a Java clas s
imple me nting the
org.jbos s .re s ource .a
dapte r.jdbc.ValidCon
ne ctionChe cke r
whos e pingDatabas e
me thod s hould be
us e d to che ck if a
conne ction is s till
valid be fore handing
it out from the pool.
If true , e nable
trans action
inte rle aving if the
DB ve ndor s upports
it (mos t do not). This
prope rty
s upe rs e de s the
"track-conne ction-bytx" prope rty from
e arlie r ve rs ions of
JBos s AS. The
de fault is fals e .
no
trans action-is olation
no
url-de limite r
no
url-s e le ctors trate gy-clas s -name
no
us e -try-lock
no
valid-conne ctionche cke r-clas s -name
no
inte rle aving
Url De limite r
Url Se le ctor
Strate gy Clas s
Name
Us e Try Lock
Valid Conne ction
Che cke r Clas s
Name
Inte rle aving
301
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
T able 3.115. Met rics
Name
Descript io n
Flus h
Lis t Formatte d Sub Pool Statis tics
Flus h the conne ctions in the pool
Obtain a formatte d s ub pool s tatis tics
re port
Obtain a s tatis tics re port
Te s t if a conne ction can be obtaine d re turns true if a conne ction was obtaine d,
or fals e if not; NOTE: this ope ration will
always re turn a s tatus of Succe s s ful - the
re s ults of the ope ration mus t be ins pe cte d
to s e e whe the r or not a conne ction was
obtaine d
Lis t Statis tics
Te s t Conne ction
Package T ypes
none
3.2.5. JBossAS5 - No T x Connect ionFact ory Service
Overview
T able 3.116. Overview
De s cription:
A Conne ctionFactory that doe s not take part
in JTA trans actions .
no
JBos s AS5
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 3.117.
Name
302
Descript io n
Required
Int ernal Name
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Cus tom Prope rtie s
Maps a lis t of
no
cus tom prope rty
name s to the the
fully qualifie d clas s
name s of the
org.rhq.plugins .jbos s
as 5.adapte r.api.Prop
e rtyAdapte r
imple me ntations
that s hould be us e d
for thos e prope rtie s .
ye s
ye s
ye s
ye s
The name of the
ye s
Re s ource
configuration
prope rty whos e
value s hould be
us e d as the
unde rlying
Manage dCompone nt
name whe n cre ating
a ne w Re s ource of
this type .
Compone nt Type
Compone nt Subtype
Compone nt Name
Te mplate Name
Compone nt Name
Prope rty
Required
Int ernal Name
cus tomPrope rtie s
compone ntType
compone ntSubtype
compone ntName
te mplate Name
compone ntName Pro
pe rty
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.118. Met rics
Name
T ype
Descript io n
Int ernal Name
Run State
Conne ction
Available ?
trait
trait
Run State
could a conne ction to
the unde rlying data
provide r be
obtaine d? Ple as e
s e e the
docume ntation
be fore e nabling this
me tric
Pool JNDI Name
Numbe r of available
conne ctions .
Conne ction Count
runState
cus tom.conne ctionAv
ailable
Pool JNDI Name
trait
Available Conne ction me as ure me nt
Count
Conne ction Count
me as ure me nt
poolJndiName
available Conne ction
Count
conne ctionCount
303
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Conne ction Cre ate d
Count
Conne ction
De s troye d Count
In Us e Conne ction
Count
me as ure me nt
conne ctionCre ate dC
ount
conne ctionDe s troye
dCount
inUs e Conne ctionCou
nt
Max Conne ctions In
Us e Count
me as ure me nt
Max Siz e
Min Siz e
me as ure me nt
me as ure me nt
Conne ction Cre ate d
Count
Conne ction
De s troye d Count
Mumbe r of
conne ctions
curre ntly in us e .
Maximum numbe r of
maximum
conne ctions that
have be e n in us e .
Max Siz e
Min Siz e
me as ure me nt
me as ure me nt
maxConne ctions InUs
e Count
maxSiz e
minSiz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.119.
Name
Descript io n
Required
Int ernal Name
JNDI Name
The global JNDI
name to bind the
conne ction factory
unde r.
The name of the
RAR file that contains
the de finition for the
re s ource we want to
provide . For ne s te d
RAR file s , the name
would look like
myapplication.e ar#m
y.rar.
The conne ction
factory inte rface
clas s . It s hould
match the
conne ctionfactoryinte rface in the
ra.xml file .
The minimum
numbe r of
conne ctions the pool
s hould hold. The
de fault is 0.
ye s
jndi-name
ye s
rar-name
ye s
conne ction-de finition
no
min-pool-s iz e
RAR Name
Conne ction
De finition
Minimum Pool Siz e
304
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Maximum Pool Siz e
The maximum
numbe r of
conne ctions the pool
s hould hold. The
de fault is 10.
The numbe r of
time s that allocating
a conne ction s hould
be trie d be fore
throwing an
e xce ption. The
de fault is 0.
The time in
millis e conds to wait
be twe e n re trying to
allocate a
conne ction. The
de fault is 5000 (5
s e conds ).
Spe cify if
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Background
validation is me ant
to re duce the
ove rall load on the
RDBMS s ys te m
whe n validating a
conne ction. The
de fault is No.
The inte rval, in
millis e conds , at
which the
Conne ctionValidator
will run. Se t to 0 to
dis able background
validation. The
de fault is 0.
no
max-pool-s iz e
no
allocation-re try
no
allocation-re try-waitmillis
no
backgroundvalidation
no
backgroundvalidation-millis
Allocation Re try
Allocation Re try Wait
Millis
Background
Validation
Background
Validation Millis
305
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Blocking Time out in
Millis e conds
Indicate s the
maximum time in
millis e conds to block
while waiting for a
conne ction be fore
throwing an
e xce ption. Note that
this blocks only
while waiting for a
pe rmit for a
conne ction, and will
ne ve r throw an
e xce ption if cre ating
a ne w conne ction
take s an inordinate ly
long time . The
de fault is 30000 (30
s e conds ).
The maximum time ,
in minute s , a
conne ction may be
idle be fore be ing
clos e d. The de fault
is 30.
If s e t, unconditionally
s e ts the boole an
re turn value of
javax.trans action.xa.
XARe s ource .is Same
RM(XARe s ource ).
The Obje ctName of
the JMX Invoke r
MBe an as s ociate d
with this datas ource .
Me tadata prope rtie s .
If true , the
datas ource cannot
re us e a conne ction
outs ide a trans action
once e nlis te d in a
global trans action
and vice -ve rs a. The
de fault is Ye s .
no
blocking-time outmillis
no
idle -time out-minute s
no
is Same RM-ove rride value
no
jmx-invoke r-name
no
no
me tadata
no-tx-s e parate -pools
Idle Time out
Is Same RM
Ove rride Value
Jmx Invoke r Name
Me tadata
No Tx Se parate
Pools
306
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Pre fill
Whe the r to atte mpt
no
to pre fill the
conne ction pool to
the minimum
numbe r of
conne ctions . NOTE:
Only s upporting
pools (One Pool)
s upport this fe ature .
A warning can be
found in the logs if
the pool doe s not
s upport this . The
de fault is No.
Se curity s e ttings for no
conne ctions in the
pool.
The fully qualifie d
no
clas s name of the
clas s to us e for
formatting manage d
conne ction pool
s tatis tics for this
datas ource . The
clas s mus t
imple me nt the
org.jbos s .re s ource .s
tatis tic.formatte r.Stat
is tics Formatte r.
inte rface . The
de fault is
"org.jbos s .re s ource .
s tatis tic.pool.JBos s D
e faultSubPoolStatis ti
cFormatte r".
Se curity Se ttings
Statis tics Formatte r
Required
Int ernal Name
pre fill
s e curity-domain
s tatis tics -formatte r
307
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Type Mapping
The name of the
corre s ponding type mapping in
conf/s tandardjbos s c
mp-jdbc.xml. The
type mappings
provide d by de fault:
DB2, InformixDB,
MaxDB, mySQL,
Oracle 9i, PointBas e ,
Inte rBas e , Mime r
SQL, McKoi, SapDB,
DB2/400, SOLID,
Hype rs onic SQL,
Firs tSQL/J, MS
SQLSERVER2000, MS
SQLSERVER,
Clouds cape , De rby,
Fire bird, Pos tgre SQL
8.0, Pos tgre SQL,
Sybas e , Ingre s .
Note , the re may be
cus tom type
mappings de fine d in
addition to the s e
pre de fine d
mappings .
Indicate s whe the r
the JNDI name
s hould be bound
unde r the "java"
conte xt, which
caus e s the
DataSource to only
be acce s s ible from
within the JBos s AS
VM. The de fault is
Ye s .
Whe the r idle
conne ctions be low
the min-pool-s iz e
s hould be clos e d.
The de fault is No.
no
type -mapping
no
us e -java-conte xt
no
us e -s trict-min
Us e Java Conte xt
Us e Strict Min
308
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Validate On Match
The validate -onno
match e le me nt
indicate s whe the r or
not conne ction le ve l
validation s hould be
done whe n a
conne ction factory
atte mpts to match a
manage d conne ction
for a give n s e t. This
is typically e xclus ive
to the us e of
background
validation. The
de fault is Ye s .
Prope rtie s to s upply no
to the
Manage dConne ctionF
actory (MCF) MBe an
s e rvice
configuration.
Config Prope rty
Required
Int ernal Name
validate -on-match
config-prope rty
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
T able 3.120 . Met rics
Name
Descript io n
Flus h
Lis t Formatte d Sub Pool Statis tics
Flus h the conne ctions in the pool
Obtain a formatte d s ub pool s tatis tics
re port
Obtain a s tatis tics re port
Te s t if a conne ction can be obtaine d re turns true if a conne ction was obtaine d,
or fals e if not; NOTE: this ope ration will
always re turn a s tatus of Succe s s ful - the
re s ults of the ope ration mus t be ins pe cte d
to s e e whe the r or not a conne ction was
obtaine d
Lis t Statis tics
Te s t Conne ction
Package T ypes
none
3.2.6. JBossAS5 - T x Connect ionFact ory Service
309
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Overview
T able 3.121. Overview
De s cription:
A Conne ctionFactory that take s part in JTA
trans actions .
no
JBos s AS5
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 3.122.
Name
Descript io n
Cus tom Prope rtie s
Maps a lis t of
no
cus tom prope rty
name s to the the
fully qualifie d clas s
name s of the
org.rhq.plugins .jbos s
as 5.adapte r.api.Prop
e rtyAdapte r
imple me ntations
that s hould be us e d
for thos e prope rtie s .
ye s
ye s
ye s
ye s
The name of the
ye s
Re s ource
configuration
prope rty whos e
value s hould be
us e d as the
unde rlying
Manage dCompone nt
name whe n cre ating
a ne w Re s ource of
this type .
Compone nt Type
Compone nt Subtype
Compone nt Name
Te mplate Name
Compone nt Name
Prope rty
Required
Int ernal Name
cus tomPrope rtie s
compone ntType
compone ntSubtype
compone ntName
te mplate Name
compone ntName Pro
pe rty
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
310
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.123. Met rics
Name
T ype
Descript io n
Int ernal Name
Trans action Type
trait
cus tom.trans actionTy
pe
Run State
Conne ction
Available ?
trait
trait
Pool JNDI Name
Available Conne ction
Count
Conne ction Count
Conne ction Cre ate d
Count
Conne ction
De s troye d Count
In Us e Conne ction
Count
trait
me as ure me nt
Max Conne ctions In
Us e Count
me as ure me nt
Max Siz e
Min Siz e
me as ure me nt
me as ure me nt
The type of
trans actions us e d by
this conne ction
factory - Local or XA
Run State
could a conne ction to
the unde rlying data
provide r be
obtaine d? Ple as e
s e e the
docume ntation
be fore e nabling this
me tric
Pool JNDI Name
Numbe r of available
conne ctions .
Conne ction Count
Conne ction Cre ate d
Count
Conne ction
De s troye d Count
Mumbe r of
conne ctions
curre ntly in us e .
Maximum numbe r of
maximum
conne ctions that
have be e n in us e .
Max Siz e
Min Siz e
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
runState
cus tom.conne ctionAv
ailable
poolJndiName
available Conne ction
Count
conne ctionCount
conne ctionCre ate dC
ount
conne ctionDe s troye
dCount
inUs e Conne ctionCou
nt
maxConne ctions InUs
e Count
maxSiz e
minSiz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.124.
Name
Descript io n
Required
Int ernal Name
JNDI Name
The global JNDI
name to bind the
conne ction factory
unde r.
ye s
jndi-name
311
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
RAR Name
The name of the
RAR file that contains
the de finition for the
re s ource we want to
provide . For ne s te d
RAR file s , the name
would look like
myapplication.e ar#m
y.rar.
The conne ction
factory inte rface
clas s . It s hould
match the
conne ctionfactoryinte rface in the
ra.xml file .
The minimum
numbe r of
conne ctions the pool
s hould hold. The
de fault is 0.
The maximum
numbe r of
conne ctions the pool
s hould hold. The
de fault is 10.
Whe the r on not to
us e XA trans actions .
The de fault is No.
The numbe r of
time s that allocating
a conne ction s hould
be trie d be fore
throwing an
e xce ption. The
de fault is 0.
The time in
millis e conds to wait
be twe e n re trying to
allocate a
conne ction. The
de fault is 5000 (5
s e conds ).
ye s
rar-name
ye s
conne ction-de finition
no
min-pool-s iz e
no
max-pool-s iz e
no
xa-trans action
no
allocation-re try
no
allocation-re try-waitmillis
Conne ction
De finition
Minimum Pool Siz e
Maximum Pool Siz e
XA Trans action
Allocation Re try
Allocation Re try Wait
Millis
312
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Background
Validation
Spe cify if
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Background
validation is me ant
to re duce the
ove rall load on the
RDBMS s ys te m
whe n validating a
conne ction. The
de fault is No.
The inte rval, in
millis e conds , at
which the
Conne ctionValidator
will run. Se t to 0 to
dis able background
validation. The
de fault is 0.
Indicate s the
maximum time in
millis e conds to block
while waiting for a
conne ction be fore
throwing an
e xce ption. Note that
this blocks only
while waiting for a
pe rmit for a
conne ction, and will
ne ve r throw an
e xce ption if cre ating
a ne w conne ction
take s an inordinate ly
long time . The
de fault is 30000 (30
s e conds ).
The maximum time ,
in minute s , a
conne ction may be
idle be fore be ing
clos e d. The de fault
is 30.
If s e t, unconditionally
s e ts the boole an
re turn value of
javax.trans action.xa.
XARe s ource .is Same
RM(XARe s ource ).
no
backgroundvalidation
no
backgroundvalidation-millis
no
blocking-time outmillis
no
idle -time out-minute s
no
is Same RM-ove rride value
Background
Validation Millis
Blocking Time out in
Millis e conds
Idle Time out
Is Same RM
Ove rride Value
313
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Jmx Invoke r Name
The Obje ctName of
the JMX Invoke r
MBe an as s ociate d
with this datas ource .
Me tadata prope rtie s .
If true , the
datas ource cannot
re us e a conne ction
outs ide a trans action
once e nlis te d in a
global trans action
and vice -ve rs a. The
de fault is Ye s .
Whe the r to atte mpt
to pre fill the
conne ction pool to
the minimum
numbe r of
conne ctions . NOTE:
Only s upporting
pools (One Pool)
s upport this fe ature .
A warning can be
found in the logs if
the pool doe s not
s upport this . The
de fault is No.
Se curity s e ttings for
conne ctions in the
pool.
The fully qualifie d
clas s name of the
clas s to us e for
formatting manage d
conne ction pool
s tatis tics for this
datas ource . The
clas s mus t
imple me nt the
org.jbos s .re s ource .s
tatis tic.formatte r.Stat
is tics Formatte r.
inte rface . The
de fault is
"org.jbos s .re s ource .
s tatis tic.pool.JBos s D
e faultSubPoolStatis ti
cFormatte r".
no
jmx-invoke r-name
no
no
me tadata
no-tx-s e parate -pools
no
pre fill
no
s e curity-domain
no
s tatis tics -formatte r
Me tadata
No Tx Se parate
Pools
Pre fill
Se curity Se ttings
Statis tics Formatte r
314
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Type Mapping
The name of the
corre s ponding type mapping in
conf/s tandardjbos s c
mp-jdbc.xml. The
type mappings
provide d by de fault:
DB2, InformixDB,
MaxDB, mySQL,
Oracle 9i, PointBas e ,
Inte rBas e , Mime r
SQL, McKoi, SapDB,
DB2/400, SOLID,
Hype rs onic SQL,
Firs tSQL/J, MS
SQLSERVER2000, MS
SQLSERVER,
Clouds cape , De rby,
Fire bird, Pos tgre SQL
8.0, Pos tgre SQL,
Sybas e , Ingre s .
Note , the re may be
cus tom type
mappings de fine d in
addition to the s e
pre de fine d
mappings .
Indicate s whe the r
the JNDI name
s hould be bound
unde r the "java"
conte xt, which
caus e s the
DataSource to only
be acce s s ible from
within the JBos s AS
VM. The de fault is
Ye s .
Whe the r idle
conne ctions be low
the min-pool-s iz e
s hould be clos e d.
The de fault is No.
no
type -mapping
no
us e -java-conte xt
no
us e -s trict-min
Us e Java Conte xt
Us e Strict Min
315
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Validate On Match
The validate -onmatch e le me nt
indicate s whe the r or
not conne ction le ve l
validation s hould be
done whe n a
conne ction factory
atte mpts to match a
manage d conne ction
for a give n s e t. This
is typically e xclus ive
to the us e of
background
validation. The
de fault is Ye s .
Prope rtie s to s upply
to the
Manage dConne ctionF
actory (MCF) MBe an
s e rvice
configuration.
If true , e nable
trans action
inte rle aving if the
DB ve ndor s upports
it (mos t do not). Can
only be s e t to true if
XA trans actions are
e nable d. This
prope rty
s upe rs e de s the
"track-conne ction-bytx" prope rty from
e arlie r ve rs ions of
JBos s AS. The
de fault is fals e .
The maximum time ,
in minute s , an XA
Re s ource can be
idle be fore it is
re move d. 0 me ans
no time out. The
de fault is 0.
no
validate -on-match
no
config-prope rty
no
inte rle aving
no
xa-re s ource -time out
Config Prope rty
Inte rle aving
XA Re s ource
Time out
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
T able 3.125. Met rics
316
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.125. Met rics
Name
Descript io n
Flus h
Lis t Formatte d Sub Pool Statis tics
Flus h the conne ctions in the pool
Obtain a formatte d s ub pool s tatis tics
re port
Obtain a s tatis tics re port
Te s t if a conne ction can be obtaine d re turns true if a conne ction was obtaine d,
or fals e if not; NOTE: this ope ration will
always re turn a s tatus of Succe s s ful - the
re s ults of the ope ration mus t be ins pe cte d
to s e e whe the r or not a conne ction was
obtaine d
Lis t Statis tics
Te s t Conne ction
Package T ypes
none
3.2.7. JBossAS5 - JBoss Messaging Service
Overview
T able 3.126. Overview
De s cription:
Single ton:
Plugin:
the JBos s Me s s aging JMS provide r
ye s
JBos s AS5
Child Resource T ypes
Se ction 3.2.7.1, “JBos s AS5 - Que ue Se rvice ”
Se ction 3.2.7.2, “JBos s AS5 - Topic Se rvice ”
Connect ion Propert ies
T able 3.127.
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Required
Int ernal Name
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
317
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.2.7.1. JBossAS5 - Queue Service
Overview
T able 3.128. Overview
De s cription:
Single ton:
Plugin:
a JMS que ue
no
JBos s AS5
No te
The me s s age counte r me trics will not be colle cte d by de fault. In orde r for the s e
me trics to be colle cte d for all Topics and Que ue s for a give n application s e rve r
ins tance , go to the ins tance 's JMX Cons ole , and invoke the
{{e nable Me s s age Counte rs }} ope ration on the
{{jbos s .me s s aging:s e rvice =Se rve rPe e r}} MBe an. To e ns ure the me s s age
counte rs are s till e nable d whe n the application s e rve r is re s tarte d, e dit that
ins tance 's {{de ploy/me s s aging/me s s aging-s e rvice .xml}} file and s e t the
{{Enable Me s s age Counte rs }} attribute to "true ".
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.129.
Name
Jms Type
318
Descript io n
Required
Int ernal Name
ye s
jms -type
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Cus tom Prope rtie s
Maps a lis t of
no
cus tom prope rty
name s to the the
fully qualifie d clas s
name s of the
org.rhq.plugins .jbos s
as 5.adapte r.api.Prop
e rtyAdapte r
imple me ntations
that s hould be us e d
for thos e prope rtie s .
ye s
ye s
ye s
ye s
The name of the
ye s
Re s ource
configuration
prope rty whos e
value s hould be
us e d as the
unde rlying
Manage dCompone nt
name whe n cre ating
a ne w Re s ource of
this type .
Compone nt Type
Compone nt Subtype
Compone nt Name
Te mplate Name
Compone nt Name
Prope rty
Required
Int ernal Name
cus tomPrope rtie s
compone ntType
compone ntSubtype
compone ntName
te mplate Name
compone ntName Pro
pe rty
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.130 . Met rics
Name
T ype
Descript io n
Int ernal Name
Run State
Cre ate d
Programmatically
trait
trait
Run State
Was this que ue
cre ate d
programmatically? If
Ye s , the que ue will
not s urvive a re s tart
of the application
s e rve r. If No, the
que ue was cre ate d
via a de ployme nt
XML file .
runState
cre ate dProgrammati
cally
319
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Me s s age Counte r
His tory Day Limit
trait
me s s age Counte rHis t
oryDayLimit
Cons ume r Count
me as ure me nt
De live ring Count
me as ure me nt
Me s s age Count
me as ure me nt
Sche dule d Me s s age
Count
me as ure me nt
Count
me as ure me nt
Count De lta
me as ure me nt
De pth
me as ure me nt
De pth De lta
me as ure me nt
Time Las t Update
me as ure me nt
Clus te re d
trait
This que ue 's
me s s age counte r
his tory day limit <0: unlimite d, =0:
his tory dis able d, >0:
maximum day count
The numbe r of
cons ume rs on the
que ue
The numbe r of
me s s age s curre ntly
be ing de live re d
The numbe r of
me s s age s in the
que ue
The numbe r of
s che dule d
me s s age s in the
que ue
The total me s s age
count s ince s tartup
or las t counte r re s e t
The me s s age count
de lta s ince las t
me thod call
The curre nt
me s s age count of
pe nding me s s age s
within the que ue
waiting for dis patch
The me s s age count
de lta of pe nding
me s s age s s ince las t
me thod call
The time s tamp of
the las t me s s age
add
True if this que ue is
clus te re d, fals e
othe rwis e
cons ume rCount
de live ringCount
me s s age Count
s che dule dMe s s age C
ount
me s s age Statis tics .c
ount
me s s age Statis tics .c
ountDe lta
me s s age Statis tics .d
e pth
me s s age Statis tics .d
e pthDe lta
me s s age Statis tics .ti
me Las tUpdate
clus te re d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.131.
320
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Name
The name of this
que ue (e .g.
'MyQue ue ').
This que ue 's JNDI
name (e .g.
'/que ue /MyQue ue ').
Is this que ue
clus te re d? For an
e xis ting que ue , this
prope rty is re adonly. If not s pe cifie d
whe n cre ating a ne w
que ue , the de fault
value is fals e .
Whe n paging
me s s age s to
s torage from a
s ubs cription, the y
firs t go into a "Down
Cache " be fore be ing
writte n to s torage .
This e nable s the
write to occur as a
s ingle ope ration,
thus aiding
pe rformance . This
s e tting de te rmine s
the maximum
numbe r of
me s s age s that the
Down Cache will hold
be fore the y are
flus he d to s torage .
Update s to this
prope rty will not go
into e ffe ct until the
que ue has be e n
re s tarte d. The
de fault value is
2000.
ye s
name
ye s
JNDIName
no
clus te re d
no
downCache Siz e
JNDI Name
Clus te re d
Down Cache Siz e
321
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Full Siz e
The maximum
no
numbe r of
me s s age s for the
que ue he ld in
me mory at any one
time . The actual
que ue can hold
many more
me s s age s than this ,
but the s e are page d
to and from s torage
as ne ce s s ary, as
me s s age s are
adde d or cons ume d.
Update s to this
prope rty will not go
into e ffe ct until the
que ue has be e n
re s tarte d. The
de fault value is
200000.
The numbe r of
no
de live ry atte mpts
be fore a me s s age
to a s ubs cribe r of
this que ue is move d
to the DLQ. The
de fault value is 10.
A value of -1
indicate s the de fault
value s hould be
us e d.
The maximum
no
numbe r of
me s s age s this
que ue can hold
be fore the y are
droppe d. A value of 1 me ans the re is no
maximum. The
de fault value is -1.
Max De live ry
Atte mpts
Max Siz e
322
Required
Int ernal Name
fullSiz e
maxDe live ryAtte mpt
s
maxSiz e
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Page Siz e
Whe n loading
me s s age s from a
s ubs cription, this is
the maximum
numbe r of
me s s age s to pre load in one
ope ration. Mus t be
le s s than Full Siz e
and gre ate r than or
e qual to Down
Cache Siz e . Update s
to this prope rty will
not go into e ffe ct
until the que ue has
be e n re s tarte d. The
de fault value is
2000.
The de lay in
millis e conds be fore
a rolle d back or
re cove re d me s s age
is re de live re d. Se t
to 0 to dis able
re de live ry. The
de fault value is 0. A
value of -1 indicate s
the de fault value
s hould be us e d.
The JMX Obje ctName
of the de ad le tte r
que ue (DLQ) for this
que ue (e .g.
"jbos s .me s s aging.de
s tination:s e rvice =Qu
e ue ,name =Private D
LQ") - ove rride s the
de fault DLQ on the
s e rve r pe e r.
The JMX Obje ctName
of the e xpiry que ue
for this que ue (e .g.
"jbos s .me s s aging.de
s tination:s e rvice =Qu
e ue ,name =Private E
xpiryQue ue ") ove rride s the
de fault e xpiry que ue
on the s e rve r pe e r.
no
page Siz e
no
re de live ryDe lay
no
DLQ
no
e xpiryQue ue
Re de live ry De lay
DLQ
Expiry Que ue
323
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se rve r Pe e r
The JMX Obje ctName
of the s e rve r pe e r
this que ue was
de ploye d on (e .g.
"jbos s .me s s aging:s e
rvice =Se rve rPe e r").
Update s to this
prope rty will not go
into e ffe ct until the
que ue has be e n
re s tarte d.
This e le me nt
s pe cifie s a XML
fragme nt which
de s cribe s the
acce s s control lis t to
be us e d by the
Se curityManage r to
authoriz e clie nt
ope rations agains t
the de s tination. The
conte nt mode l is the
s ame as for the
Se curityManage r
Se curityConf
attribute .
no
s e rve rPe e r
ye s
s e curityConfig
Se curity
Configurations
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.132. Met rics
Name
Descript io n
Re move All Me s s age s
Re move all me s s age s from the
de s tination.
Start the de s tination.
Stop the de s tination.
Lis t all me s s age s for the s pe cifie d s e le ctor
Lis t all durable me s s age s for the s pe cifie d
s e le ctor
Lis t all non durable me s s age s for the
s pe cifie d s e le ctor
Ge t the me s s age counte r as HTML
Ge t the me s s age counte r his tory as HTML
Re s e t the me s s age counte r
Re s e t the me s s age counte r his tory
Start
Stop
Lis t All Me s s age s
Lis t Durable Me s s age s
Lis t Non Durable Me s s age s
Lis t Me s s age Counte r As HTML
Lis t Me s s age Counte r His tory As HTML
Re s e t Me s s age Counte r
Re s e t Me s s age Counte r His tory
324
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Package T ypes
none
3.2.7.2. JBossAS5 - T opic Service
Overview
T able 3.133. Overview
De s cription:
Single ton:
Plugin:
a JMS topic
no
JBos s AS5
No te
The me s s age counte r me trics will not be colle cte d by de fault. In orde r for the s e
me trics to be colle cte d for all Topics and Que ue s for a give n application s e rve r
ins tance , go to the ins tance 's JMX Cons ole , and invoke the
{{e nable Me s s age Counte rs }} ope ration on the
{{jbos s .me s s aging:s e rvice =Se rve rPe e r}} MBe an. To e ns ure the me s s age
counte rs are s till e nable d whe n the application s e rve r is re s tarte d, e dit that
ins tance 's {{de ploy/me s s aging/me s s aging-s e rvice .xml}} file and s e t the
{{Enable Me s s age Counte rs }} attribute to "true ".
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.134.
Name
Descript io n
Jms Type
Cus tom Prope rtie s
ye s
Maps a lis t of
no
cus tom prope rty
name s to the the
fully qualifie d clas s
name s of the
org.rhq.plugins .jbos s
as 5.adapte r.api.Prop
e rtyAdapte r
imple me ntations
that s hould be us e d
for thos e prope rtie s .
ye s
ye s
ye s
ye s
Compone nt Type
Compone nt Subtype
Compone nt Name
Te mplate Name
Required
Int ernal Name
jms -type
cus tomPrope rtie s
compone ntType
compone ntSubtype
compone ntName
te mplate Name
325
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Compone nt Name
Prope rty
The name of the
Re s ource
configuration
prope rty whos e
value s hould be
us e d as the
unde rlying
Manage dCompone nt
name whe n cre ating
a ne w Re s ource of
this type .
ye s
compone ntName Pro
pe rty
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.135. Met rics
Name
T ype
Descript io n
Int ernal Name
Run State
Cre ate d
Programmatically
trait
trait
runState
cre ate dProgrammati
cally
Me s s age Counte r
His tory Day Limit
trait
All Me s s age Count
me as ure me nt
All Subs criptions
Count
me as ure me nt
Durable Me s s age
Count
me as ure me nt
Run State
Was this topic
cre ate d
programmatically? If
Ye s , the topic will not
s urvive a re s tart of
the application
s e rve r. If No, the
topic was cre ate d
via a de ployme nt
XML file .
This topic's
me s s age counte r
his tory day limit <0: unlimite d, =0:
his tory dis able d, >0:
maximum day count
The count of all
me s s age s in all
s ubs criptions to this
topic
The count of all
s ubs criptions to this
topic
The count of all
me s s age s for all
durable
s ubs criptions to this
topic
326
me s s age Counte rHis t
oryDayLimit
allMe s s age Count
allSubs criptions Coun
t
durable Me s s age Cou
nt
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Durable
Subs criptions Count
me as ure me nt
durable Subs criptions
Count
Non Durable
Me s s age Count
me as ure me nt
Non Durable
Subs criptions Count
me as ure me nt
Clus te re d
trait
The count of all
durable
s ubs criptions to this
topic
The count of all
me s s age s in all non
durable
s ubs criptions to this
topic
The count of all non
durable
s ubs criptions to this
topic
True if this topic is
clus te re d, fals e
othe rwis e
nonDurable Me s s age
Count
nonDurable Subs cript
ions Count
clus te re d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.136.
Name
Descript io n
Required
Int ernal Name
Name
The name of this
topic (e .g. 'MyTopic').
This topic's JNDI
name (e .g.
'/topic/MyTopic')
Is this topic
clus te re d? For an
e xis ting topic, this
prope rty is re adonly. If not s pe cifie d
whe n cre ating a ne w
topic, the de fault
value is fals e .
ye s
name
ye s
JNDIName
no
clus te re d
JNDI Name
Clus te re d
327
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Down Cache Siz e
Whe n paging
no
me s s age s to
s torage from a
s ubs cription, the y
firs t go into a "Down
Cache " be fore be ing
writte n to s torage .
This e nable s the
write to occur as a
s ingle ope ration,
thus aiding
pe rformance . This
s e tting de te rmine s
the maximum
numbe r of
me s s age s that the
Down Cache will hold
be fore the y are
flus he d to s torage .
Update s to this
prope rty will not go
into e ffe ct until the
topic has be e n
re s tarte d. The
de fault value is
2000.
The maximum
no
numbe r of
me s s age s he ld by
the topic
s ubs criptions in
me mory at any one
time . The actual
s ubs cription can hold
many more
me s s age s than this ,
but the s e are page d
to and from s torage
as ne ce s s ary, as
me s s age s are
adde d or cons ume d.
Update s to this
prope rty will not go
into e ffe ct until the
topic has be e n
re s tarte d. The
de fault value is
200000.
Full Siz e
328
Required
Int ernal Name
downCache Siz e
fullSiz e
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Max De live ry
Atte mpts
The numbe r of
de live ry atte mpts
be fore a me s s age
to a s ubs cribe r of
this topic is move d
to the DLQ. The
de fault value is 10.
A value of -1
indicate s the de fault
value s hould be
us e d.
The maximum
numbe r of
me s s age s this topic
can hold be fore the y
are droppe d. A
value of -1 me ans
the re is no
maximum. The
de fault value is -1.
Whe n loading
me s s age s from a
s ubs cription, this is
the maximum
numbe r of
me s s age s to pre load in one
ope ration. Mus t be
le s s than Full Siz e
and gre ate r than or
e qual to Down
Cache Siz e . Update s
to this prope rty will
not go into e ffe ct
until the topic has
be e n re s tarte d. The
de fault value is
2000.
The de lay in
millis e conds be fore
a rolle d back or
re cove re d me s s age
is re de live re d. Se t
to 0 to dis able
re de live ry. The
de fault value is 0. A
value of -1 indicate s
the de fault value
s hould be us e d.
no
maxDe live ryAtte mpt
s
no
maxSiz e
no
page Siz e
no
re de live ryDe lay
Max Siz e
Page Siz e
Re de live ry De lay
329
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
DLQ
The JMX Obje ctName
of the de ad le tte r
que ue (DLQ) for this
topic (e .g.
"jbos s .me s s aging.de
s tination:s e rvice =Qu
e ue ,name =Private D
LQ") - ove rride s the
de fault DLQ on the
s e rve r pe e r.
The JMX Obje ctName
of the e xpiry que ue
for this topic (e .g.
"jbos s .me s s aging.de
s tination:s e rvice =Qu
e ue ,name =Private E
xpiryQue ue ") ove rride s the
de fault e xpiry que ue
on the s e rve r pe e r.
The JMX Obje ctName
of the s e rve r pe e r
this topic was
de ploye d on (e .g.
"jbos s .me s s aging:s e
rvice =Se rve rPe e r").
Update s to this
prope rty will not go
into e ffe ct until the
topic has be e n
re s tarte d.
This e le me nt
s pe cifie s a XML
fragme nt which
de s cribe s the
acce s s control lis t to
be us e d by the
Se curityManage r to
authoriz e clie nt
ope rations agains t
the de s tination. The
conte nt mode l is the
s ame as for the
Se curityManage r
Se curityConf
attribute .
no
DLQ
no
e xpiryQue ue
no
s e rve rPe e r
ye s
s e curityConfig
Expiry Que ue
Se rve r Pe e r
Se curity
Configurations
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
330
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Operat io ns
T able 3.137. Met rics
Name
Descript io n
Re move All Me s s age s
Re move all me s s age s from the
de s tination.
Start the de s tination.
Stop the de s tination.
Lis t all me s s age s for the s pe cifie d
s ubs cription with the s pe cifie d s e le ctor
Lis t all durable me s s age s for the s pe cifie d
s ubs cription with the s pe cifie d s e le ctor
Lis t all non durable me s s age s for the
s pe cifie d s ubs cription with the s pe cifie d
s e le ctor
Re turn all s ubs criptions for the topic
Re turn all s ubs criptions for the topic as
HTML
Re turn all durable s ubs criptions for the
topic
Re turn all durable s ubs criptions for the
topic as HTML
Re turn all non-durable s ubs criptions for the
topic
Re turn all non-durable s ubs criptions for the
topic as HTML
Start
Stop
Lis t All Me s s age s
Lis t Durable Me s s age s
Lis t Non Durable Me s s age s
Lis t All Subs criptions
Lis t All Subs criptions As HTML
Lis t Durable Subs criptions
Lis t Durable Subs criptions As HTML
Lis t Non-Durable Subs criptions
Lis t Non-Durable Subs criptions As HTML
Package T ypes
none
3.2.8. JBossAS5 - Ent erprise Applicat ion (EAR) Service
Overview
T able 3.138. Overview
De s cription:
Single ton:
Plugin:
JEE e nte rpris e application (EAR)
no
JBos s AS5
Child Resource T ypes
none
Connect ion Propert ies
T able 3.139.
Name
Descript io n
Required
Int ernal Name
331
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
De ployme nt Ke y
The profile s e rvice
ke y for this EAR
ye s
de ployme ntKe y
ye s
ye s
e xte ns ion
de s criptionTe mplate
ye s
de ployme ntType Na
me
Exte ns ion
De s cription
Te mplate
De ployme nt Type
Name
The name of the
ite m from the
org.jbos s .de ploye rs .
s pi.manage me nt.Kno
wnDe ployme ntType
s e num
corre s ponding to
this de ployme nt's
type .
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.140 . Met rics
Name
T ype
Descript io n
Int ernal Name
Path
trait
cus tom.path
Explode d?
trait
the abs olute path of
this EAR file or
dire ctory
whe the r this EAR is
de ploye d e xplode d
(i.e . as a dire ctory)
cus tom.e xplode d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 3.141. Met rics
Name
Descript io n
Start
s tarts this EAR
332
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Stop
Re s tart
s tops this EAR
s tops and the n re s tarts this EAR
Package T ypes
T able 3.142. Package T ypes
Name
Cat ego ry
EAR File
De ployable
Descript io n
3.2.9. JBossAS5 - Web Applicat ion (WAR) Service
Overview
T able 3.143. Overview
De s cription:
Single ton:
Plugin:
a s tandalone we b application (WAR)
no
JBos s AS5
Child Resource T ypes
Se ction 3.2.9.1, “JBos s AS5 - We b Application Conte xt Se rvice ”
Connect ion Propert ies
T able 3.144.
Name
Descript io n
Required
Int ernal Name
De ployme nt Ke y
The profile s e rvice
ke y for this WAR
this WAR's conte xt
path (e .g. /admincons ole )
ye s
de ployme ntKe y
no
conte xtPath
ye s
ye s
e xte ns ion
de s criptionTe mplate
ye s
de ployme ntType Na
me
Conte xt Path
Exte ns ion
De s cription
Te mplate
De ployme nt Type
Name
The name of the
ite m from the
org.jbos s .de ploye rs .
s pi.manage me nt.Kno
wnDe ployme ntType
s e num
corre s ponding to
this de ployme nt's
type .
333
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.145. Met rics
Name
T ype
Descript io n
Int ernal Name
Path
trait
cus tom.path
Explode d?
trait
Conte xt Root
trait
Virtual Hos ts
trait
the abs olute path of
this WAR file or
dire ctory
whe the r this WAR is
de ploye d e xplode d
(i.e . as a dire ctory)
this conte xt root of
this WAR (e .g. jmxcons ole ) - us e d as a
unique path pre fix
for URLs
corre s ponding to this
WAR
the virtual hos t(s ) to
which this WAR is
de ploye d
cus tom.e xplode d
conte xtRoot
virtualHos ts
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 3.146. Met rics
Name
Descript io n
Start
Stop
Re s tart
s tarts this WAR
s tops this WAR
s tops and the n re s tarts this WAR
Package T ypes
T able 3.147. Package T ypes
334
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Cat ego ry
WAR File
De ployable
Descript io n
3.2.9.1. JBossAS5 - Web Applicat ion Cont ext Service
Overview
T able 3.148. Overview
De s cription:
Single ton:
Plugin:
a we b application conte xt
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.149.
Name
Compone nt Type
Compone nt Subtype
Compone nt Name
Re s pons e Time Log
File
Re s pons e Time Url
Exclude s
Re s pons e Time Url
Trans forms
Virtual Hos t
Descript io n
the full path to the
log file containing
re s pons e -time s tats
for this we bapp
a s pace -de limite d
lis t of re gular
e xpre s s ions
s pe cifying URLs that
s hould be e xclude d
from re s pons e -time
s tats colle ction
a s pace -de limite d
lis t of Pe rl-s tyle
s ubs titution
e xpre s s ions that
s hould be applie d to
all URLs for which
re s pons e -time s tats
are colle cte d (e .g.
|^/de pt/finance /.*|/de
pt/finance /*|)
this WAR's virtual
hos t (e .g. localhos t)
Required
Int ernal Name
ye s
ye s
ye s
no
compone ntType
compone ntSubtype
compone ntName
re s pons e Time LogFil
e
no
re s pons e Time UrlExc
lude s
no
re s pons e Time UrlTra
ns forms
ye s
virtualHos t
335
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.150 . Met rics
Name
T ype
Descript io n
Int ernal Name
Clus te re d
trait
clus te re d
Virtual Hos t
trait
Re s pons e Time
calltime
Curre ntly Active
Se s s ions
me as ure me nt
Maximum Active
Se s s ions
me as ure me nt
Cre ate d Se s s ions
me as ure me nt
Cre ate d Se s s ions
pe r Minute
me as ure me nt
Expire d Se s s ions
me as ure me nt
Expire d Se s s ions
pe r Minute
me as ure me nt
Re je cte d Se s s ions
me as ure me nt
Re je cte d Se s s ions
pe r Minute
me as ure me nt
Ave rage Se s s ion
Alive Time
me as ure me nt
True if this we b
application conte xt is
clus te re d
the virtual hos t with
which this conte xt is
as s ociate d
the minimum,
maximum, and
ave rage re s pons e
time s for re que s ts
s e rvice d by this
we bapp
the numbe r of
s e s s ions that are
curre ntly active for
this WAR
the maximum
numbe r of s e s s ions
that have be e n
active for this WAR
the numbe r of
s e s s ions cre ate d for
this WAR
the numbe r of
s e s s ions cre ate d for
this WAR
the numbe r of
e xpire d s e s s ions for
this WAR
the numbe r of
e xpire d s e s s ions for
this WAR
the numbe r of
s e s s ions re je cte d
for this WAR
the numbe r of
s e s s ions re je cte d
for this WAR
the ave rage alive
time of s e s s ions for
this WAR
336
virtualHos t
re s pons e Time
active Se s s ions
maxActive
s e s s ionCounte r
s e s s ionCounte r
e xpire dSe s s ions
e xpire dSe s s ions
re je cte dSe s s ions
re je cte dSe s s ions
s e s s ionAve rage Aliv
e Time
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Max Se s s ion Alive
Time
me as ure me nt
s e s s ionMaxAlive Tim
e
Minimum Re s pons e
Time
me as ure me nt
Ave rage Re s pons e
Time
me as ure me nt
Maximum Re s pons e
Time
me as ure me nt
Total Re s pons e
Time
me as ure me nt
Total Re s pons e
Time pe r Minute
me as ure me nt
Numbe r of Re que s ts
Se rvice d
me as ure me nt
Numbe r of Re que s ts
Se rvice d pe r Minute
me as ure me nt
Numbe r of Error
Re s pons e s
me as ure me nt
Numbe r of Error
Re s pons e s pe r
Minute
me as ure me nt
the maximum alive
time of s e s s ions for
this WAR
the minimum
re s pons e time for
re que s ts s e rvice d
by this WAR
the ave rage
re s pons e time for
re que s ts s e rvice d
by this WAR
the maximum
re s pons e time for
re que s ts s e rvice d
by this WAR
the total re s pons e
time for re que s ts
s e rvice d by this
WAR
the total re s pons e
time for re que s ts
s e rvice d by this
WAR
the numbe r of
re que s ts s e rvice d
by this WAR
the numbe r of
re que s ts s e rvice d
by this WAR
the numbe r of e rror
re s pons e s s e nt by
this WAR
the numbe r of e rror
re s pons e s s e nt by
this WAR
Se rvle t.minimumRe s
pons e Time
Se rvle t.ave rage Re s
pons e Time
Se rvle t.maximumRe
s pons e Time
Se rvle t.totalRe s pons
e Time
Se rvle t.totalRe s pons
e Time
Se rvle t.re que s tCoun
t
Se rvle t.re que s tCoun
t
Se rvle t.e rrorCount
Se rvle t.e rrorCount
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
337
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
3.2.10. JBossAS5 - Embedded Web Applicat ion (WAR) Service
Overview
T able 3.151. Overview
De s cription:
Single ton:
Plugin:
an e mbe dde d we b application (WAR)
no
JBos s AS5
Child Resource T ypes
Se ction 3.2.10.1, “JBos s AS5 - Embe dde d We b Application Conte xt Se rvice ”
Connect ion Propert ies
T able 3.152.
Name
Descript io n
Required
Int ernal Name
De ployme nt Ke y
The profile s e rvice
ke y for this WAR
this WAR's conte xt
path (e .g. /admincons ole
the full path to the
log file containing
re s pons e -time s tats
for this we bapp
a s pace -de limite d
lis t of re gular
e xpre s s ions
s pe cifying URLs that
s hould be e xclude d
from re s pons e -time
s tats colle ction
a s pace -de limite d
lis t of Pe rl-s tyle
s ubs titution
e xpre s s ions that
s hould be applie d to
all URLs for which
re s pons e -time s tats
are colle cte d (e .g.
|^/de pt/finance /.*|/de
pt/finance /*|)
ye s
de ployme ntKe y
no
conte xtPath
no
re s pons e Time LogFil
e
no
re s pons e Time UrlExc
lude s
no
re s pons e Time UrlTra
ns forms
ye s
ye s
e xte ns ion
de s criptionTe mplate
Conte xt Path
Re s pons e Time Log
File
Re s pons e Time Url
Exclude s
Re s pons e Time Url
Trans forms
Exte ns ion
De s cription
Te mplate
338
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
De ployme nt Type
Name
The name of the
ite m from the
org.jbos s .de ploye rs .
s pi.manage me nt.Kno
wnDe ployme ntType
s e num
corre s ponding to
this de ployme nt's
type .
ye s
de ployme ntType Na
me
ye s
e mbe dde d
Embe dde d
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.153. Met rics
Name
T ype
Descript io n
Int ernal Name
Pare nt
trait
cus tom.pare nt
Conte xt Root
trait
Virtual Hos ts
trait
the name of this
WAR's pare nt
de ployme nt
this conte xt root of
this WAR (e .g. jmxcons ole ) - us e d as a
unique path pre fix
for URLs
corre s ponding to this
WAR
the virtual hos t(s ) to
which this WAR is
de ploye d
conte xtRoot
virtualHos ts
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
339
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Package T ypes
none
3.2.10.1. JBossAS5 - Embedded Web Applicat ion Cont ext Service
Overview
T able 3.154. Overview
De s cription:
Single ton:
Plugin:
a we b application conte xt
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.155.
Name
Compone nt Type
Compone nt Subtype
Compone nt Name
Re s pons e Time Log
File
Re s pons e Time Url
Exclude s
Re s pons e Time Url
Trans forms
Virtual Hos t
340
Descript io n
the full path to the
log file containing
re s pons e -time s tats
for this we bapp
a s pace -de limite d
lis t of re gular
e xpre s s ions
s pe cifying URLs that
s hould be e xclude d
from re s pons e -time
s tats colle ction
a s pace -de limite d
lis t of Pe rl-s tyle
s ubs titution
e xpre s s ions that
s hould be applie d to
all URLs for which
re s pons e -time s tats
are colle cte d (e .g.
|^/de pt/finance /.*|/de
pt/finance /*|)
this WAR's virtual
hos t (e .g. localhos t)
Required
Int ernal Name
ye s
ye s
ye s
no
compone ntType
compone ntSubtype
compone ntName
re s pons e Time LogFil
e
no
re s pons e Time UrlExc
lude s
no
re s pons e Time UrlTra
ns forms
ye s
virtualHos t
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.156. Met rics
Name
T ype
Descript io n
Int ernal Name
Clus te re d
trait
clus te re d
Virtual Hos t
trait
Re s pons e Time
calltime
Curre ntly Active
Se s s ions
me as ure me nt
Maximum Active
Se s s ions
me as ure me nt
Cre ate d Se s s ions
me as ure me nt
Cre ate d Se s s ions
pe r Minute
me as ure me nt
Expire d Se s s ions
me as ure me nt
Expire d Se s s ions
pe r Minute
me as ure me nt
Re je cte d Se s s ions
me as ure me nt
Re je cte d Se s s ions
pe r Minute
me as ure me nt
Ave rage Se s s ion
Alive Time
me as ure me nt
True if this we b
application conte xt is
clus te re d
the virtual hos t with
which this conte xt is
as s ociate d
the minimum,
maximum, and
ave rage re s pons e
time s for re que s ts
s e rvice d by this
we bapp
the numbe r of
s e s s ions that are
curre ntly active for
this WAR
the maximum
numbe r of s e s s ions
that have be e n
active for this WAR
the numbe r of
s e s s ions cre ate d for
this WAR
the numbe r of
s e s s ions cre ate d for
this WAR
the numbe r of
e xpire d s e s s ions for
this WAR
the numbe r of
e xpire d s e s s ions for
this WAR
the numbe r of
s e s s ions re je cte d
for this WAR
the numbe r of
s e s s ions re je cte d
for this WAR
the ave rage alive
time of s e s s ions for
this WAR
virtualHos t
re s pons e Time
active Se s s ions
maxActive
s e s s ionCounte r
s e s s ionCounte r
e xpire dSe s s ions
e xpire dSe s s ions
re je cte dSe s s ions
re je cte dSe s s ions
s e s s ionAve rage Aliv
e Time
341
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Max Se s s ion Alive
Time
me as ure me nt
s e s s ionMaxAlive Tim
e
Minimum Re s pons e
Time
me as ure me nt
Ave rage Re s pons e
Time
me as ure me nt
Maximum Re s pons e
Time
me as ure me nt
Total Re s pons e
Time
me as ure me nt
Total Re s pons e
Time pe r Minute
me as ure me nt
Numbe r of Re que s ts
Se rvice d
me as ure me nt
Numbe r of Re que s ts
Se rvice d pe r Minute
me as ure me nt
Numbe r of Error
Re s pons e s
me as ure me nt
Numbe r of Error
Re s pons e s pe r
Minute
me as ure me nt
the maximum alive
time of s e s s ions for
this WAR
the minimum
re s pons e time for
re que s ts s e rvice d
by this WAR
the ave rage
re s pons e time for
re que s ts s e rvice d
by this WAR
the maximum
re s pons e time for
re que s ts s e rvice d
by this WAR
the total re s pons e
time for re que s ts
s e rvice d by this
WAR
the total re s pons e
time for re que s ts
s e rvice d by this
WAR
the numbe r of
re que s ts s e rvice d
by this WAR
the numbe r of
re que s ts s e rvice d
by this WAR
the numbe r of e rror
re s pons e s s e nt by
this WAR
the numbe r of e rror
re s pons e s s e nt by
this WAR
Se rvle t.minimumRe s
pons e Time
Se rvle t.ave rage Re s
pons e Time
Se rvle t.maximumRe
s pons e Time
Se rvle t.totalRe s pons
e Time
Se rvle t.totalRe s pons
e Time
Se rvle t.re que s tCoun
t
Se rvle t.re que s tCoun
t
Se rvle t.e rrorCount
Se rvle t.e rrorCount
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
342
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
3.2.11. JBossAS5 - EJB2 JAR Service
Overview
T able 3.157. Overview
De s cription:
Single ton:
Plugin:
a s tandalone EJB 2.x application
no
JBos s AS5
Child Resource T ypes
Se ction 3.2.11.1, “JBos s AS5 - EJB2 State le s s Se s s ion Be an Se rvice ”
Se ction 3.2.11.2, “JBos s AS5 - EJB2 State ful Se s s ion Be an Se rvice ”
Se ction 3.2.11.3, “JBos s AS5 - EJB2 Me s s age -Drive n Be an Se rvice ”
Se ction 3.2.11.4, “JBos s AS5 - EJB2 Entity Be an Se rvice ”
Connect ion Propert ies
T able 3.158.
Name
Descript io n
Required
Int ernal Name
De ployme nt Ke y
The profile s e rvice
ke y for this EJB JAR
ye s
de ployme ntKe y
ye s
ye s
e xte ns ion
de s criptionTe mplate
ye s
de ployme ntType Na
me
Exte ns ion
De s cription
Te mplate
De ployme nt Type
Name
The name of the
ite m from the
org.jbos s .de ploye rs .
s pi.manage me nt.Kno
wnDe ployme ntType
s e num
corre s ponding to
this de ployme nt's
type .
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.159. Met rics
343
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Path
trait
cus tom.path
Explode d?
trait
the abs olute path of
this EJB JAR file or
dire ctory
whe the r this EJB JAR
is de ploye d
e xplode d (i.e . as a
dire ctory)
cus tom.e xplode d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 3.160 . Met rics
Name
Descript io n
Start
Stop
Re s tart
s tarts this EJB JAR
s tops this EJB JAR
s tops and the n re s tarts this EJB JAR
Package T ypes
T able 3.161. Package T ypes
Name
Cat ego ry
EJB JAR File
De ployable
Descript io n
3.2.11.1. JBossAS5 - EJB2 St at eless Session Bean Service
Overview
T able 3.162. Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
344
An EJB2 State le s s Se s s ion Be an
no
JBos s AS5
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.163.
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Invocation Stats
Prope rty Name
Required
Int ernal Name
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
invocationStats Prope
rtyName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.164. Met rics
Name
T ype
Descript io n
Int ernal Name
Cre ate Count
me as ure me nt
Cre ate Count
Cre ate Count pe r
Minute
me as ure me nt
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
Curre nt Pool Siz e
me as ure me nt
Max Pool Siz e
me as ure me nt
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
be ans in the pool.
The maximum pool
s iz e .
Cre ate Count
Re move Count
Re move Count
Curre ntPoolSiz e
MaxPoolSiz e
345
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Me thod Invocation
Time
calltime
The minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB
me thodInvocationTim
e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.165. Met rics
Name
Descript io n
Vie w Me thod Statis tics
Dis play de taile d me thod invocation
s tatis tics .
Package T ypes
none
3.2.11.2. JBossAS5 - EJB2 St at ef ul Session Bean Service
Overview
T able 3.166. Overview
De s cription:
Single ton:
Plugin:
An EJB2 State ful Se s s ion Be an
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.167.
Name
Compone nt Type
Compone nt Subtype
Compone nt Name
346
Descript io n
Required
Int ernal Name
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Invocation Stats
Prope rty Name
Required
Int ernal Name
ye s
invocationStats Prope
rtyName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.168. Met rics
Name
T ype
Descript io n
Int ernal Name
Cre ate Count
me as ure me nt
Cre ate Count
Cre ate Count pe r
Minute
me as ure me nt
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
Curre nt Pool Siz e
me as ure me nt
Max Pool Siz e
me as ure me nt
Me thod Invocation
Time
calltime
Pas s ive Be ans
me as ure me nt
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
be ans in the pool.
The maximum pool
s iz e .
The minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB
The count of be ans
in the pas s ivate d
s tate
Cre ate Count
Re move Count
Re move Count
Curre ntPoolSiz e
MaxPoolSiz e
me thodInvocationTim
e
Pas s ivate dCount
347
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.169. Met rics
Name
Descript io n
Vie w Me thod Statis tics
Dis play de taile d me thod invocation
s tatis tics .
Package T ypes
none
3.2.11.3. JBossAS5 - EJB2 Message-Driven Bean Service
Overview
T able 3.170 . Overview
De s cription:
Single ton:
Plugin:
An EJB2 Me s s age Drive n Be an
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.171.
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Required
Int ernal Name
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
348
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Met rics
T able 3.172. Met rics
Name
T ype
Descript io n
Int ernal Name
Curre nt Pool Siz e
me as ure me nt
Curre ntPoolSiz e
Max Pool Siz e
me as ure me nt
Me s s age Count
me as ure me nt
Me s s age Count pe r
Minute
me as ure me nt
The numbe r of
be ans in the pool.
The maximum pool
s iz e .
The numbe r of
me s s age s
s e nt/re ce ive d
The numbe r of
me s s age s
s e nt/re ce ive d
MaxPoolSiz e
Me s s age Count
Me s s age Count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.2.11.4. JBossAS5 - EJB2 Ent it y Bean Service
Overview
T able 3.173. Overview
De s cription:
Single ton:
Plugin:
An EJB2 Entity Be an
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.174.
349
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Required
Int ernal Name
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.175. Met rics
Name
T ype
Descript io n
Int ernal Name
Cre ate Count
me as ure me nt
Cre ate Count
Cre ate Count pe r
Minute
me as ure me nt
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
Curre nt Pool Siz e
me as ure me nt
Max Pool Siz e
me as ure me nt
Cache Siz e
me as ure me nt
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
be ans in the pool.
The maximum pool
s iz e .
Cache Siz e
Cre ate Count
Re move Count
Re move Count
Curre ntPoolSiz e
MaxPoolSiz e
Cache Siz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
350
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.2.12. JBossAS5 - Embedded EJB2 JAR Service
Overview
T able 3.176. Overview
De s cription:
Single ton:
Plugin:
an e mbe dde d EJB 2.x application
no
JBos s AS5
Child Resource T ypes
Se ction 3.2.12.1, “JBos s AS5 - EJB2 State le s s Se s s ion Be an (Embe dde d) Se rvice ”
Se ction 3.2.12.2, “JBos s AS5 - EJB2 State ful Se s s ion Be an (Embe dde d) Se rvice ”
Se ction 3.2.12.3, “JBos s AS5 - EJB2 Me s s age -Drive n Be an (Embe dde d) Se rvice ”
Se ction 3.2.12.4, “JBos s AS5 - EJB2 Entity Be an (Embe dde d) Se rvice ”
Connect ion Propert ies
T able 3.177.
Name
Descript io n
Required
Int ernal Name
De ployme nt Ke y
The profile s e rvice
ke y for this EJB JAR
ye s
de ployme ntKe y
ye s
ye s
e xte ns ion
de s criptionTe mplate
ye s
de ployme ntType Na
me
Exte ns ion
De s cription
Te mplate
De ployme nt Type
Name
The name of the
ite m from the
org.jbos s .de ploye rs .
s pi.manage me nt.Kno
wnDe ployme ntType
s e num
corre s ponding to
this de ployme nt's
type .
351
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.178. Met rics
Name
T ype
Descript io n
Int ernal Name
Pare nt
trait
the name of this EJB
JAR's pare nt
de ployme nt
cus tom.pare nt
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.2.12.1. JBossAS5 - EJB2 St at eless Session Bean (Embedded) Service
Overview
T able 3.179. Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.180 .
352
An EJB2 State le s s Se s s ion Be an
no
JBos s AS5
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Invocation Stats
Prope rty Name
Required
Int ernal Name
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
invocationStats Prope
rtyName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.181. Met rics
Name
T ype
Descript io n
Int ernal Name
Cre ate Count
me as ure me nt
Cre ate Count
Cre ate Count pe r
Minute
me as ure me nt
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
Curre nt Pool Siz e
me as ure me nt
Max Pool Siz e
me as ure me nt
Me thod Invocation
Time
calltime
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
be ans in the pool.
The maximum pool
s iz e .
The minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB
Cre ate Count
Re move Count
Re move Count
Curre ntPoolSiz e
MaxPoolSiz e
me thodInvocationTim
e
353
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.182. Met rics
Name
Descript io n
Vie w Me thod Statis tics
Dis play de taile d me thod invocation
s tatis tics .
Package T ypes
none
3.2.12.2. JBossAS5 - EJB2 St at ef ul Session Bean (Embedded) Service
Overview
T able 3.183. Overview
De s cription:
Single ton:
Plugin:
An EJB2 State ful Se s s ion Be an
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.184.
Name
Compone nt Type
Compone nt Subtype
Compone nt Name
Invocation Stats
Prope rty Name
354
Descript io n
Required
Int ernal Name
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
invocationStats Prope
rtyName
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.185. Met rics
Name
T ype
Descript io n
Int ernal Name
Cre ate Count
me as ure me nt
Cre ate Count
Cre ate Count pe r
Minute
me as ure me nt
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
Curre nt Pool Siz e
me as ure me nt
Max Pool Siz e
me as ure me nt
Me thod Invocation
Time
calltime
Pas s ive Be ans
me as ure me nt
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
be ans in the pool.
The maximum pool
s iz e .
The minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB
The count of be ans
in the pas s ivate d
s tate
Cre ate Count
Re move Count
Re move Count
Curre ntPoolSiz e
MaxPoolSiz e
me thodInvocationTim
e
Pas s ivate dCount
355
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.186. Met rics
Name
Descript io n
Vie w Me thod Statis tics
Dis play de taile d me thod invocation
s tatis tics .
Package T ypes
none
3.2.12.3. JBossAS5 - EJB2 Message-Driven Bean (Embedded) Service
Overview
T able 3.187. Overview
De s cription:
Single ton:
Plugin:
An EJB2 Me s s age Drive n Be an
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.188.
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Required
Int ernal Name
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
356
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Met rics
T able 3.189. Met rics
Name
T ype
Descript io n
Int ernal Name
Curre nt Pool Siz e
me as ure me nt
Curre ntPoolSiz e
Max Pool Siz e
me as ure me nt
Me s s age Count
me as ure me nt
Me s s age Count pe r
Minute
me as ure me nt
The numbe r of
be ans in the pool.
The maximum pool
s iz e .
The numbe r of
me s s age s
s e nt/re ce ive d
The numbe r of
me s s age s
s e nt/re ce ive d
MaxPoolSiz e
Me s s age Count
Me s s age Count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.2.12.4. JBossAS5 - EJB2 Ent it y Bean (Embedded) Service
Overview
T able 3.190 . Overview
De s cription:
Single ton:
Plugin:
An EJB2 Entity Be an
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.191.
357
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Required
Int ernal Name
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.192. Met rics
Name
T ype
Descript io n
Int ernal Name
Cre ate Count
me as ure me nt
Cre ate Count
Cre ate Count pe r
Minute
me as ure me nt
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
Curre nt Pool Siz e
me as ure me nt
Max Pool Siz e
me as ure me nt
Cache Siz e
me as ure me nt
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
ins tance s of this
EJB2 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart.
The numbe r of
be ans in the pool.
The maximum pool
s iz e .
Cache Siz e
Cre ate Count
Re move Count
Re move Count
Curre ntPoolSiz e
MaxPoolSiz e
Cache Siz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
358
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.2.13. JBossAS5 - EJB3 JAR Service
Overview
T able 3.193. Overview
De s cription:
Single ton:
Plugin:
a s tandalone EJB 3.x application
no
JBos s AS5
Child Resource T ypes
Se ction 3.2.13.1, “JBos s AS5 - EJB3 State le s s Se s s ion Be an Se rvice ”
Se ction 3.2.13.2, “JBos s AS5 - EJB3 State ful Se s s ion Be an Se rvice ”
Se ction 3.2.13.3, “JBos s AS5 - EJB3 Me s s age -Drive n Be an Se rvice ”
Connect ion Propert ies
T able 3.194.
Name
Descript io n
Required
Int ernal Name
De ployme nt Ke y
The profile s e rvice
ke y for this EJB JAR
ye s
de ployme ntKe y
ye s
ye s
e xte ns ion
de s criptionTe mplate
ye s
de ployme ntType Na
me
Exte ns ion
De s cription
Te mplate
De ployme nt Type
Name
The name of the
ite m from the
org.jbos s .de ploye rs .
s pi.manage me nt.Kno
wnDe ployme ntType
s e num
corre s ponding to
this de ployme nt's
type .
359
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.195. Met rics
Name
T ype
Descript io n
Int ernal Name
Path
trait
cus tom.path
Explode d?
trait
the abs olute path of
this EJB JAR file or
dire ctory
whe the r this EJB JAR
is de ploye d
e xplode d (i.e . as a
dire ctory)
cus tom.e xplode d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 3.196. Met rics
Name
Descript io n
Start
Stop
Re s tart
s tarts this EJB JAR
s tops this EJB JAR
s tops and the n re s tarts this EJB JAR
Package T ypes
T able 3.197. Package T ypes
Name
Cat ego ry
EJB JAR File
De ployable
Descript io n
3.2.13.1. JBossAS5 - EJB3 St at eless Session Bean Service
Overview
T able 3.198. Overview
360
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
De s cription:
Single ton:
Plugin:
An EJB3 State le s s Se s s ion Be an (SLSB)
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.199.
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Invocation Stats
Prope rty Name
Required
Int ernal Name
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
invocationStats Prope
rtyName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.20 0 . Met rics
Name
T ype
Descript io n
Int ernal Name
EJB Name
Available Count
trait
me as ure me nt
name
available Count
Cre ate Count
me as ure me nt
Cre ate Count pe r
Minute
me as ure me nt
Curre nt Count
me as ure me nt
the name of this EJB
The numbe r of
poole d ins tance s of
this EJB3 Se s s ion
Be an in the me thodre ady s tate
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart
The total numbe r of
curre ntly poole d
ins tance s of this
EJB3 Se s s ion Be an
cre ate Count
cre ate Count
curre ntSiz e
361
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Max Siz e
me as ure me nt
maxSiz e
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
Me thod Invocation
Time
calltime
The maximum
numbe r of ins tance s
that are allowe d to
be poole d
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart
The minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB
re move Count
re move Count
me thodInvocationTim
e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.20 1. Met rics
Name
Descript io n
Vie w Me thod Statis tics
Dis play de taile d me thod invocation
s tatis tics .
Package T ypes
none
3.2.13.2. JBossAS5 - EJB3 St at ef ul Session Bean Service
Overview
T able 3.20 2. Overview
De s cription:
362
An EJB3 State ful Se s s ion Be an (SFSB)
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Single ton:
Plugin:
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.20 3.
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Invocation Stats
Prope rty Name
Required
Int ernal Name
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
invocationStats Prope
rtyName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.20 4. Met rics
Name
T ype
Descript io n
Int ernal Name
EJB Name
Available Count
trait
me as ure me nt
name
available Count
Cre ate Count
me as ure me nt
Cre ate Count pe r
Minute
me as ure me nt
Curre nt Count
me as ure me nt
the name of this EJB
The numbe r of
poole d ins tance s of
this EJB3 Se s s ion
Be an in the me thodre ady s tate
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart
The total numbe r of
curre ntly poole d
ins tance s of this
EJB3 Se s s ion Be an
cre ate Count
cre ate Count
curre ntSiz e
363
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Max Siz e
me as ure me nt
maxSiz e
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
Me thod Invocation
Time
calltime
Cache Siz e
Pas s ivate d Count
Total Siz e
me as ure me nt
me as ure me nt
me as ure me nt
The maximum
numbe r of ins tance s
that are allowe d to
be poole d
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart
The minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB
Cache Siz e
Pas s ivate d Count
Total Siz e
re move Count
re move Count
me thodInvocationTim
e
cache Siz e
pas s ivate dCount
totalSiz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.20 5. Met rics
Name
Descript io n
Vie w Me thod Statis tics
Dis play de taile d me thod invocation
s tatis tics .
Package T ypes
none
3.2.13.3. JBossAS5 - EJB3 Message-Driven Bean Service
Overview
364
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.20 6. Overview
De s cription:
Single ton:
Plugin:
An EJB3 Me s s age -Drive n Be an (MDB)
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.20 7.
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Invocation Stats
Prope rty Name
Required
Int ernal Name
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
invocationStats Prope
rtyName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.20 8. Met rics
Name
T ype
Descript io n
Int ernal Name
EJB Name
Minimum Pool Siz e
Maximum Pool Siz e
Maximum numbe r of
Me s s age s
trait
me as ure me nt
me as ure me nt
me as ure me nt
the name of this EJB
Minimum Pool Siz e
Maximum Pool Siz e
Maximum numbe r of
Me s s age s
name
minPoolSiz e
maxPoolSiz e
maxMe s s age s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.20 9. Met rics
365
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.20 9. Met rics
Name
Descript io n
Vie w Me thod Statis tics
Dis play de taile d me thod invocation
s tatis tics .
Package T ypes
none
3.2.14. JBossAS5 - Embedded EJB3 JAR Service
Overview
T able 3.210 . Overview
De s cription:
Single ton:
Plugin:
an e mbe dde d EJB 3.x application
no
JBos s AS5
Child Resource T ypes
Se ction 3.2.14.1, “JBos s AS5 - EJB3 State le s s Se s s ion Be an (Embe dde d) Se rvice ”
Se ction 3.2.14.2, “JBos s AS5 - EJB3 State ful Se s s ion Be an (Embe dde d) Se rvice ”
Se ction 3.2.14.3, “JBos s AS5 - EJB3 Me s s age -Drive n Be an (Embe dde d) Se rvice ”
Connect ion Propert ies
T able 3.211.
Name
Descript io n
Required
Int ernal Name
De ployme nt Ke y
The profile s e rvice
ke y for this EJB JAR
ye s
de ployme ntKe y
ye s
ye s
e xte ns ion
de s criptionTe mplate
ye s
de ployme ntType Na
me
Exte ns ion
De s cription
Te mplate
De ployme nt Type
Name
The name of the
ite m from the
org.jbos s .de ploye rs .
s pi.manage me nt.Kno
wnDe ployme ntType
s e num
corre s ponding to
this de ployme nt's
type .
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
366
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Met rics
T able 3.212. Met rics
Name
T ype
Descript io n
Int ernal Name
Pare nt
trait
the name of this EJB
JAR's pare nt
de ployme nt
cus tom.pare nt
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.2.14.1. JBossAS5 - EJB3 St at eless Session Bean (Embedded) Service
Overview
T able 3.213. Overview
De s cription:
Single ton:
Plugin:
An EJB3 State le s s Se s s ion Be an (SLSB)
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.214.
Name
Compone nt Type
Compone nt Subtype
Compone nt Name
Invocation Stats
Prope rty Name
Descript io n
Required
Int ernal Name
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
invocationStats Prope
rtyName
367
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.215. Met rics
Name
T ype
Descript io n
Int ernal Name
EJB Name
Available Count
trait
me as ure me nt
name
available Count
Cre ate Count
me as ure me nt
Cre ate Count pe r
Minute
me as ure me nt
Curre nt Count
me as ure me nt
Max Siz e
me as ure me nt
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
the name of this EJB
The numbe r of
poole d ins tance s of
this EJB3 Se s s ion
Be an in the me thodre ady s tate
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart
The total numbe r of
curre ntly poole d
ins tance s of this
EJB3 Se s s ion Be an
The maximum
numbe r of ins tance s
that are allowe d to
be poole d
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart
368
cre ate Count
cre ate Count
curre ntSiz e
maxSiz e
re move Count
re move Count
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Me thod Invocation
Time
calltime
The minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB
me thodInvocationTim
e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.216. Met rics
Name
Descript io n
Vie w Me thod Statis tics
Dis play de taile d me thod invocation
s tatis tics .
Package T ypes
none
3.2.14.2. JBossAS5 - EJB3 St at ef ul Session Bean (Embedded) Service
Overview
T able 3.217. Overview
De s cription:
Single ton:
Plugin:
An EJB3 State ful Se s s ion Be an (SFSB)
no
JBos s AS5
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.218.
Name
Compone nt Type
Compone nt Subtype
Compone nt Name
Descript io n
Required
Int ernal Name
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
369
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Invocation Stats
Prope rty Name
Required
Int ernal Name
ye s
invocationStats Prope
rtyName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.219. Met rics
Name
T ype
Descript io n
Int ernal Name
EJB Name
Available Count
trait
me as ure me nt
name
available Count
Cre ate Count
me as ure me nt
Cre ate Count pe r
Minute
me as ure me nt
Curre nt Count
me as ure me nt
Max Siz e
me as ure me nt
Re move Count
me as ure me nt
Re move Count pe r
Minute
me as ure me nt
the name of this EJB
The numbe r of
poole d ins tance s of
this EJB3 Se s s ion
Be an in the me thodre ady s tate
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
cre ate d s ince
s e rve r s tart
The total numbe r of
curre ntly poole d
ins tance s of this
EJB3 Se s s ion Be an
The maximum
numbe r of ins tance s
that are allowe d to
be poole d
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart
The numbe r of
ins tance s of this
EJB3 Se s s ion Be an
that have be e n
re move d s ince
s e rve r s tart
370
cre ate Count
cre ate Count
curre ntSiz e
maxSiz e
re move Count
re move Count
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Me thod Invocation
Time
calltime
me thodInvocationTim
e
Cache Siz e
Pas s ivate d Count
Total Siz e
me as ure me nt
me as ure me nt
me as ure me nt
The minimum,
maximum, and
ave rage invocation
time s for e ach of the
me thods e xpos e d
by this EJB
Cache Siz e
Pas s ivate d Count
Total Siz e
cache Siz e
pas s ivate dCount
totalSiz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.220 . Met rics
Name
Descript io n
Vie w Me thod Statis tics
Dis play de taile d me thod invocation
s tatis tics .
Package T ypes
none
3.2.14.3. JBossAS5 - EJB3 Message-Driven Bean (Embedded) Service
Overview
T able 3.221. Overview
De s cription:
Single ton:
Plugin:
An EJB3 Me s s age -Drive n Be an (MDB)
no
JBos s AS5
Child Reso urce T ypes
none
371
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Co nnect io n Pro pert ies
T able 3.222.
Name
Descript io n
Compone nt Type
Compone nt Subtype
Compone nt Name
Invocation Stats
Prope rty Name
Required
Int ernal Name
ye s
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
invocationStats Prope
rtyName
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.223. Met rics
Name
T ype
Descript io n
Int ernal Name
EJB Name
Minimum Pool Siz e
Maximum Pool Siz e
Maximum numbe r of
Me s s age s
trait
me as ure me nt
me as ure me nt
me as ure me nt
the name of this EJB
Minimum Pool Siz e
Maximum Pool Siz e
Maximum numbe r of
Me s s age s
name
minPoolSiz e
maxPoolSiz e
maxMe s s age s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.224. Met rics
Name
Descript io n
Vie w Me thod Statis tics
Dis play de taile d me thod invocation
s tatis tics .
Package T ypes
none
3.2.15. JBossAS5 - Resource Adapt er Archive (RAR) Service
372
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
3.2.15. JBossAS5 - Resource Adapt er Archive (RAR) Service
Overview
T able 3.225. Overview
De s cription:
a s tandalone JCA re s ource adapte r archive
(RAR)
no
JBos s AS5
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 3.226.
Name
Descript io n
Required
Int ernal Name
De ployme nt Ke y
The profile s e rvice
ke y for this RAR
ye s
de ployme ntKe y
ye s
ye s
e xte ns ion
de s criptionTe mplate
ye s
de ployme ntType Na
me
Exte ns ion
De s cription
Te mplate
De ployme nt Type
Name
The name of the
ite m from the
org.jbos s .de ploye rs .
s pi.manage me nt.Kno
wnDe ployme ntType
s e num
corre s ponding to
this de ployme nt's
type .
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.227. Met rics
Name
T ype
Descript io n
Int ernal Name
Path
trait
cus tom.path
Explode d?
trait
the abs olute path of
this RAR file or
dire ctory
whe the r this RAR is
de ploye d e xplode d
(i.e . as a dire ctory)
cus tom.e xplode d
373
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
T able 3.228. Met rics
Name
Descript io n
Start
Stop
Re s tart
s tarts this RAR
s tops this RAR
s tops and the n re s tarts this RAR
Package T ypes
T able 3.229. Package T ypes
Name
Cat ego ry
RAR File
De ployable
Descript io n
3.2.16. JBossAS5 - Embedded Resource Adapt er Archive (RAR) Service
Overview
T able 3.230 . Overview
De s cription:
an e mbe dde d JCA re s ource adapte r
archive (RAR)
no
JBos s AS5
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 3.231.
Name
Descript io n
Required
Int ernal Name
De ployme nt Ke y
The profile s e rvice
ke y for this RAR
ye s
de ployme ntKe y
ye s
e xte ns ion
Exte ns ion
374
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
De s cription
Te mplate
De ployme nt Type
Name
The name of the
ite m from the
org.jbos s .de ploye rs .
s pi.manage me nt.Kno
wnDe ployme ntType
s e num
corre s ponding to
this de ployme nt's
type .
Required
Int ernal Name
ye s
de s criptionTe mplate
ye s
de ployme ntType Na
me
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.232. Met rics
Name
T ype
Descript io n
Int ernal Name
Pare nt
trait
the name of this
RAR's pare nt
de ployme nt
cus tom.pare nt
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.2.17. JBossAS5 - Script Service
Overview
375
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.233. Overview
De s cription:
provide s the ability to e xe cute a s cript that
pe rforms s ome tas k re late d to its pare nt
JBos s AS s e rve r
no
JBos s AS5
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 3.234.
Name
Descript io n
Path
the abs olute path to ye s
the s cript file
the e nvironme nt
no
variable s that will be
pas s e d to the s cript;
e ach variable mus t
be on a ne w line and
have the s yntax
name =value ; the
variable 's value can
contain prope rtie s
with the s yntax
%prope rtyName %;
the s cript plugin will
inte rpolate the s e
with the curre nt
value s of the
corre s ponding
prope rtie s from the
s cript's pare nt
JBos s AS s e rve r's
conne ction
prope rtie s
Environme nt
Variable s
Required
Int ernal Name
path
e nvironme ntVariable
s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
376
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
Operat ions
T able 3.235. Met rics
Name
Descript io n
Exe cute Script
e xe cute the s cript; NOTE: e nvironme nt
variable s to be pas s e d to the s cript can be
configure d via this Script s e rvice 's
conne ction prope rtie s (unde r its Inve ntory
tab)
Package T ypes
T able 3.236. Package T ypes
Name
Cat ego ry
Descript io n
Exe cutable Script
Exe cutable Script
This is the s cript file to be
uploade d to the s e rve r's bin
dire ctory.
3.2.18. JBossAS5 - Service Binding Manager Service
Overview
T able 3.237. Overview
De s cription:
The Se rvice Binding Manage r manage s the
ports of the de ploye d s e rvice s
ye s
JBos s AS5
Single ton:
Plugin:
Child Resource T ypes
Se ction 3.2.18.1, “JBos s AS5 - Se rvice Binding Se t Se rvice ”
Connect ion Propert ies
T able 3.238.
Name
Compone nt Type
Compone nt Subtype
Compone nt Name
Descript io n
Required
Int ernal Name
ye s
ye s
ye s
compone ntType
compone ntSubtype
compone ntName
377
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.239. Met rics
Name
T ype
Descript io n
Int ernal Name
Active Binding Se t
trait
The active binding
s e t us e d to obtain
port bindings from.
active BindingSe tNam
e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.240 .
Name
378
Descript io n
Required
Int ernal Name
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Active Binding Se t
Name
The name of the
ye s
binding s e t the
Se rvice Binding
Manage r s hould us e
whe n re s olving
bindings . Note to
JBos s ON or Jopr
us e rs (doe s not
apply to JBos s AS
admin cons ole ):
CHANGING THIS
PROPERTY IS
POTENTIALLY
DANGEROUS
be caus e if the re are
any port conflicts on
the machine the
Application Se rve r is
running on, the
s e rve r will not s tart
up again and it will
not be pos s ible to
monitor it. To be
able to monitor the
s e rve r again afte r
the re s tart you have
to update the
"Naming Provide r
Url" in the
"Conne ction" s ubtab
in the "Inve ntory" of
the Application
Se rve r to the value
of
"jbos s :s e rvice =Nami
ng:Port" binding of
the active binding
s e t. I.e . if the
"jbos s :s e rvice =Nami
ng:Port" binding of
the active binding
s e t has the port s e t
to 4099 and
hos tname to
127.0.0.1, you have
to s e t the "Naming
Provide r Url" to
jnp://127.0.0.1:4099.
The s tandard port
ye s
bindings inhe rite d by
the binding s e ts .
Standard Bindings
Required
Int ernal Name
active BindingSe tNam
e
s tandardBindings
379
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.2.18.1. JBossAS5 - Service Binding Set Service
Overview
T able 3.241. Overview
De s cription:
The Se rvice Binding Se t de fine s all
bindings of a profile . It inhe rits the s tandard
bindings from the Se rvice Binding Manage r
and de fine s a port offs e t and ove rridde n
and additional bindings .
no
JBos s AS5
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
none
Met rics
T able 3.242. Met rics
Name
T ype
Descript io n
Int ernal Name
Name
trait
name
De fault Hos t Name
trait
Port Offs e t
trait
The name of this
binding s e t.
The de fault hos t
name of this binding
s e t.
The port offs e t of
this binding s e t.
380
de faultHos tName
portOffs e t
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.243.
Name
Descript io n
Name
The name of this
ye s
binding s e t.
The hos t name that
ye s
s hould be us e d for
all bindings whos e
configuration doe s
not s pe cify "fixe d
hos t name ".
A value to add to the ye s
port configuration for
a s tandard binding to
de rive the port to
us e in this binding
s e t. This doe s n't
apply to s tandard
bindings de fine d as
'fixe d port'.
De fault Hos t Name
Port Offs e t
Required
Int ernal Name
name
de faultHos tName
portOffs e t
381
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Ove rride Bindings
The binding
configurations that
apply only to this
binding s e t, e ithe r
non-s tandard
bindings or one s
that ove rride
s tandard binding
configurations . The
binding s e t inhe rits
the s tandard
bindings from the
Se rvice Binding
Manage r, applie s the
port offs e t to the m
(unle s s the s tandard
binding is de fine d as
"fixe d port"), and
appe nds the
ove rride bindings .
The s e can e ithe r
re de fine a s tandard
binding or de fine a
brand ne w binding.
The s tandard
bindings and the
ove rride bindings
the n de fine the full
s e t of the bindings
that are de fine d by
the binding s e t.
ye s
ove rride Bindings
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.244. Met rics
Name
Descript io n
Dis play Bindings
Dis plays the full s e t of bindings as the y
would look if this bindings s e t was active .
Package T ypes
none
3.3. JBoss AS 7 and EAP 6 - St andalone Server
382
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Overview
T able 3.245. Overview
De s cription:
Single ton:
Plugin:
Standalone AS7 s e rve r
no
JBos s AS7
No te
The s e rve r can be s tarte d, re s tarte d, or s toppe d via the Start, Re s tart, and
Shutdown ope rations . The Start and Re s tart ope rations s tart the s e rve r by
e xe cuting the s e rve r s tart s cript, typically s tandalone .s h on UNIX or s tandalone .bat
on Windows . The following conne ction s e ttings can be us e d to configure the s tart
s cript e xe cution: * Start Script - the abs olute path of the s tart s cript (e .g. "/opt/jbos s as -7.1.1.Final/bin/s tandalone .s h") * Start Script Pre fix - a pre fix command line to be
pre pe nde d to the s tart s cript command line (e .g. "nohup s udo -u jbos s -g jbos s ") *
Start Script Argume nts - argume nts to be pas s e d to the s tart s cript (e .g. "--s e rve rconfig=s tandalone -full-ha.xml") * Start Script Environme nt - e nvironme nt variable s to
be s e t in the s tart s cript's e nvironme nt (e .g. "JAVA_HOME=/us r/java/jdk1.6.0_30")
The s e s e ttings are automatically initializ e d by the JBos s AS7 plugin dis cove ry code
to match the curre ntly running s e rve r proce s s ' command line and e nvironme nt. The
s e ttings are not us e d by the Stop ope ration, s ince it s tops the s e rve r via the
manage me nt inte rface , not via a s cript. For more de taile d de s criptions of the
s e ttings , s e e the Conne ction Se ttings s e ction be low.
Child Resource T ypes
Se ction 3.3.1, “JBos s AS 7 and EAP 6 - ModClus te r Standalone Se rvice ”
Se ction 3.3.2, “JBos s AS 7 and EAP 6 - JVM Se rvice ”
Se ction 3.3.3, “JBos s AS 7 and EAP 6 - JBos s We b Se rvice ”
Se ction 3.3.4, “JBos s AS 7 and EAP 6 - Ge ne ral JCA conne ctors Se rvice ”
Se ction 3.3.5, “JBos s AS 7 and EAP 6 - Datas ource s (Standalone ) Se rvice ”
Se ction 3.3.6, “JBos s AS 7 and EAP 6 - Logging Se rvice ”
Se ction 3.3.7, “JBos s AS 7 and EAP 6 - We bs e rvice s Se rvice ”
Se ction 3.3.8, “JBos s AS 7 and EAP 6 - Naming Se rvice ”
Se ction 3.3.9, “JBos s AS 7 and EAP 6 - Trans actions Subs ys te m (Standalone ) Se rvice ”
Se ction 3.3.10, “JBos s AS 7 and EAP 6 - Ne twork Inte rface Se rvice ”
Se ction 3.3.11, “JBos s AS 7 and EAP 6 - Socke tBindingGroup Se rvice ”
Se ction 3.3.12, “JBos s AS 7 and EAP 6 - De ployme nt Se rvice ”
Se ction 3.3.13, “JBos s AS 7 and EAP 6 - De ployme ntScanne r Se rvice ”
Se ction 3.3.14, “JBos s AS 7 and EAP 6 - JacORB Se rvice ”
383
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Se ction 3.3.15, “JBos s AS 7 and EAP 6 - JDR Se rvice ”
Se ction 3.3.16, “JBos s AS 7 and EAP 6 - JCA Se rvice ”
Se ction 3.3.17, “JBos s AS 7 and EAP 6 - JAXR Se rvice ”
Se ction 3.3.18, “JBos s AS 7 and EAP 6 - JPA Se rvice ”
Se ction 3.3.19, “JBos s AS 7 and EAP 6 - CMP Se rvice ”
Se ction 3.3.20, “JBos s AS 7 and EAP 6 - EE Se rvice ”
Se ction 3.3.21, “JBos s AS 7 and EAP 6 - Se curity Se rvice ”
Se ction 3.3.22, “JBos s AS 7 and EAP 6 - Thre ads Se rvice ”
Se ction 3.3.23, “JBos s AS 7 and EAP 6 - EJB3 Se rvice ”
Se ction 3.3.24, “JBos s AS 7 and EAP 6 - JMX Se rvice ”
Se ction 3.3.25, “JBos s AS 7 and EAP 6 - Re s ource Adapte rs Se rvice ”
Se ction 3.3.26, “JBos s AS 7 and EAP 6 - Infinis pan Se rvice ”
Se ction 3.3.27, “JBos s AS 7 and EAP 6 - JGroups Se rvice ”
Se ction 3.3.28, “JBos s AS 7 and EAP 6 - Re moting Se rvice ”
Se ction 3.3.29, “JBos s AS 7 and EAP 6 - Os gi Se rvice ”
Se ction 3.3.30, “JBos s AS 7 and EAP 6 - Mail Se rvice ”
Se ction 3.3.31, “JBos s AS 7 and EAP 6 - Me s s aging Se rvice ”
Aut odiscovery Process Scans
T able 3.246. Met rics
Name
Query
Standalone AS
proce s s |bas e name |match=^java.*,arg|org.j
bos s .as .s tandalone |match=.*
Connect ion Propert ies
T able 3.247.
Name
384
Descript io n
Required
Int ernal Name
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Start Script Path
The path to the
no
s cript that the Start
and Re s tart
ope rations s hould
us e to s tart the
s e rve r. If the path is
not abs olute , it is
re s olve d re lative to
the s e rve r home
dire ctory (e .g.
"bin/s tandalone .s h",
"bin/domain.s h").
A pre fix command
no
line that s hould be
pre pe nde d to the
s tart s cript
command line by the
Start and Re s tart
ope rations ; the
pre fix command
mus t be an abs olute
path (e .g.
"/us r/bin/s udo"). This
prope rty is mos t
commonly us e d to
run the AS7 proce s s
as a diffe re nt us e r
than the RHQ Age nt
(e .g. "s udo -u jbos s g jbos s " could be
us e d to run AS7 as
us e r "jbos s " and
group "jbos s ". It is
als o pos s ible to
chain pre fix
commands (e .g.
"nohup s udo -u
jbos s " could be us e d
to make AS7 ignore
HUP s ignals and to
run as us e r "jbos s ").
Start Script Pre fix
Required
Int ernal Name
s tartScript
s tartScriptPre fix
385
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Start Script
Environme nt
Variable s
The variable s that
no
the Start and Re s tart
ope rations will add
to the e nvironme nt
of the s e rve r s tart
s cript. Each
name =value pair
s hould be on a ne w
line . Variable value s
s hould *not* be
e nclos e d in quote s
(e .g.
PATH=/us r/bin:/bin).
On UNIX s ys te ms ,
the typical minimum
s e t of e nvironme nt
variable s is :
PATH=/us r/bin:/bin .
And on Windows the
typical minimum s e t
is :
PATH=C:\Windows \S
ys te m32;C:\Windows
, OS=Windows _NT ,
SYSTEMROOT=C:\Wi
ndows . In addition, it
is good practice to
s e t JAVA_HOME to
the abs olute path of
the ins tall dire ctory
of the JRE or JDK you
wis h to us e to run
the AS7 ins tance .
Howe ve r, if
JAVA_HOME is not
s pe cifie d, the s tart
s cript will atte mpt to
find java in the
PATH. The re is
curre ntly a 2000
characte r limit for
this value .
386
Required
Int ernal Name
s tartScriptEnv
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Start Script
Argume nts
The argume nts that
no
the Start and Re s tart
ope rations will pas s
to the s e rve r s tart
s cript. Each
argume nt s hould be
on a ne w line - for
e xample : --s e rve rconfig=s tandalone ha-full.xml. As an
e xce ption, the value
of a s pace -de limite d
option can optionally
be on the s ame line
as the option - for
e xample : -c
s tandalone -hafull.xml. The re is
curre ntly a 2000
characte r limit for
this value .
Int ernal Name
s tartScriptArgs
387
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Additional
JAVA_OPTS
Prope rty us e d to
no
make pe rs is te nt
change s to
JAVA_OPTS.
!!!WARNING!!!
Fe ature available
only if s tandard
configuration file is
us e d
(s tandalone .conf or
s tandalone .conf.bat).
Ple as e do not
update the
configuration file
manually afte r
s e tting this prope rty.
If value not s e t the n
configuration s pe cific
value s are us e d.
Value not s e t doe s
not imply that
configuration file
doe s not s e t
JAVA_OPTS, it s imply
me ans that the
value was not s e t
via RHQ.
!!!WARNING!!! Value
will be pe rs is te d to
s tandalone .conf or
s tandalone .conf.bat
config file (OS
de pe nde nt). Us e this
option to make the
JAVA_OPTS
configuration
available for
re s tarts outs ide of
RHQ. The value (e .g.:
-Xms 512M Xmx1024M) will be
pe rs is te d in the
configuration file . To
re move any
modifications done
to the config file
uns e t this prope rty.
The s e rve r re quire s
re s tart for the s e
change s to take
e ffe ct.
Native manage me nt ye s
API hos t
Native Hos t
388
Required
Int ernal Name
javaOpts Additional
native Hos t
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Native Port
Native manage me nt
API port
ye s
native Port
ye s
ye s
logEve ntSource s
trus tStrate gy
ye s
hos tname Ve rification
no
trus ts tore
Log Eve nt Source s
Trus t Strate gy
De fine s the trus t
s trate gy to us e
whe n re ading the
s e rve r ce rtificate :
Standard:
s tandard
ve rification us ing
a trus ts tore
Trus t Se lf-s igne d:
trus t s e lf-s igne d
ce rtificate s
(ce rtification chain
s iz e e quals to 1)
Trus t Any: trus t
any s e rve r
ce rtificate
Hos tname
Ve rification
De fine s the
hos tname
ve rification logic:
Strict: The
hos tname mus t
match e ithe r the
firs t CN, or any of
the Subje ct
Alte rnative s . A
wildcard can
occur in the CN,
and in any of the
Subje ct
Alte rnative s .
Brows e rcompatible : s ame
as Strict, e xce pt
that it allows
ne s te d
s ubdomains
validation with
wildcards .
Skip: no
hos tname
ve rification
Trus ts tore
Path to a trus ts tore
file . If unde fine d, the
JVM de fault
trus ts tore is us e d.
389
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Trus ts tore Type
Descript io n
Trus ts tore file
format (re quire d
whe n the Truststore
prope rty is s e t). All
ce rtifie d JVMs
s upport jks (Java
Ke yStore ) or pkcs12
formats .
Trus ts tore Pas s word Pas s word prote cting
the trus ts tore file .
Clie nt Ce rtificate
Authe ntication
Ke ys tore
Path to a ke ys tore
file . Re quire d whe n
Client Certificate
Authentication is on.
Ke ys tore Type
Ke ys tore file format
(re quire d whe n the
Keystore prope rty is
s e t). All ce rtifie d
JVMs s upport jks
(Java Ke yStore ) or
pkcs12 formats .
Ke ys tore Pas s word
Pas s word prote cting
the ke ys tore file .
Ke y Pas s word
Pas s word prote cting
the s e cre t ke y in
the ke ys tore file .
Hos tname
Port
Se cure
Encrypte d trans port
indicator
Us e r
Manage me nt us e r
for a s e cure d AS
Pas s word
Pas s word for the
manage me nt us e r
Manage me nt
Maximum time in
Conne ction Time out millis e conds to ke e p
alive an idle
manage me nt
conne ction. Ze ro and
ne gative value s will
dis able conne ction
pe rs is te nce .
De faults to 5000
ms .
Home Dire ctory
Root dire ctory of the
s e rve r ins tallation
Bas e Dire ctory
Bas e dire ctory for
s e rve r conte nt
Configuration
Bas e configuration
Dire ctory
dire ctory
390
Required
Int ernal Name
no
trus ts tore Type
no
trus ts tore Pas s word
ye s
no
clie ntce rtAuthe nticati
on
ke ys tore
no
ke ys tore Type
no
ke ys tore Pas s word
no
ke yPas s word
ye s
ye s
ye s
hos tname
port
s e cure
no
us e r
no
pas s word
no
manage me ntConne c
tionTime out
no
home Dir
no
bas e Dir
no
configDir
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Log Dire ctory
the dire ctory whe re
no
log file s will be
writte n for this
s e rve r
Se rve r product type no
(e .g. AS or EAP)
Whe the r this EAP
ye s
s e rve r s upports
patching. This s hould
be automatically
de duce d by the
age nt. It is highly
re comme nde d to
le ave this with the
dis cove re d value .
Howe ve r, you will
ne e d to manually
update this value if
you manually
upgrade your s e rve r
from a ve rs ion that
doe s not s upport
patching to a ve rs ion
that doe s .
Product Type
Supports Patching
Required
Int ernal Name
logDir
productType
s upports Patching
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.248. Met rics
Name
T ype
Descript io n
Int ernal Name
Numbe r of
manage me nt
re que s ts
Numbe r of
manage me nt
re que s ts pe r Minute
Time us e d for
manage me nt
re que s ts
Time us e d for
manage me nt
re que s ts pe r Minute
Maximum re que s t
time
me as ure me nt
Numbe r of re que s ts _inte rnal:mgmtRe que
s e nt to the controlle r s ts
me as ure me nt
Numbe r of re que s ts _inte rnal:mgmtRe que
s e nt to the controlle r s ts
me as ure me nt
Total time for
re que s ts
_inte rnal:re que s tTim
e
me as ure me nt
Total time for
re que s ts
_inte rnal:re que s tTim
e
me as ure me nt
Max time for a
re que s t s ince las t
me tric ge t
_inte rnal:maxTime
391
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Se rve r State
trait
s e rve r-s tate
Se rve r Code Name
trait
De taile d s e rve r
s tate
Se rve r Code Name
Se rve r Ve rs ion
trait
Se rve r Ve rs ion
Product Name
Product Ve rs ion
trait
trait
Product Name
Product Ve rs ion
Se rve r Start Time
JGroups Multicas t
Addre s s
trait
trait
Se rve r Config File
trait
De ploy Dire ctory
trait
Te mporary
Dire ctory
trait
Active Patche s
trait
Se rve r Start Time
the hos t and port
us e d by JGroups for
multicas t
The name of the
s e rve r configuration
file this s e rve r is
us ing
The de ployme nt
dire ctory for file
bas e d bundle s
(us ually
's tandalone /de ploym
e nts ')
The te mporary
dire ctory (us ually
's tandalone /tmp').
May s e rve as
de ployme nt
dire ctory for
handove r only
bundle s '
The commas e parate d lis t of
patche s that are
curre ntly applie d to
the s e rve r. The firs t
e ntry is always the
cumulative patch,
followe d by 0 or
more one -off
patche s .
_s km:re le as e code name
_s km:re le as e ve rs ion
_s km:product-name
_s km:productve rs ion
s tartTime
multicas tAddre s s
config-file
de ployDir
te mp-dir
active -patche s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.249.
392
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Prope rtie s
Path
Ins talle d e xte ns ions
Bas e Dir
Config Dir
Config File
Descript io n
The s tandard paths
provide d by the
s ys te m include :
jbos s .home - the
root dire ctory of the
JBos s AS
dis tribution;
us e r.home - us e r's
home dire ctory;
us e r.dir - us e r's
curre nt working
dire ctory; java.home
- java ins tallation
dire ctory;
jbos s .s e rve r.bas e .di
r - root dire ctory for
an individual s e rve r
ins tance ;
jbos s .s e rve r.data.dir
- dire ctory the
s e rve r will us e for
pe rs is te nt data file
s torage ;
jbos s .s e rve r.log.dir dire ctory the s e rve r
will us e for log file
s torage ;
jbos s .s e rve r.tmp.dir
- dire ctory the
s e rve r will us e for
te mporary file
s torage ;
jbos s .domain.s e rve r
s .dir - dire ctory
unde r which a hos t
controlle r will cre ate
the working are a for
individual s e rve r
ins tance s
The bas e dire ctory
for JBos s Application
Se rve r.
The dire ctory whe re
the configurations
are s tore d.
The configuration file
us e d to launch JBos s
Application Se rve r.
Required
Int ernal Name
no
no
*2
*3
no
ye s
*1
bas e -dir
ye s
config-dir
ye s
config-file
393
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Conte nt Dir
The dire ctory whe re
us e r conte nt (e .g.
de ployme nts ) that is
manage d by the
s e rve r is s tore d.
The data dire ctory.
De pre cate d variant
of 'conte nt-dir'.
A lis t of e xt
dire ctorie s .
The home dire ctory
for JBos s Application
Se rve r.
The hos t name .
The curre nt running
mode of the s e rve r.
Eithe r LIVE (normal
ope rations ) or
ADMIN_ONLY. An
ADMIN_ONLY s e rve r
will s tart any
configure d
manage me nt
inte rface s and
acce pt manage me nt
re que s ts , but will not
s tart s e rvice s us e d
for handling e nd
us e r re que s ts .
The type of the
running s e rve r.
The dire ctory whe re
log file s are s e nt.
The dire ctory whe re
module s are found.
The name of the
s e rve r node .
The qualifie d hos t
name .
The name of the
s e rve r.
The te mporary
dire ctory.
ye s
conte nt-dir
ye s
ye s
data-dir
de ploy-dir
ye s
e xt-dirs
ye s
home -dir
ye s
ye s
hos t-name
initial-running-mode
ye s
launch-type
ye s
log-dir
ye s
module s -dir
ye s
node -name
ye s
qualifie d-hos t-name
ye s
s e rve r-name
ye s
te mp-dir
Data Dir
De ploy Dir
Ext Dirs
Home Dir
Hos t Name
Initial Running Mode
Launch Type
Log Dir
Module s Dir
Node Name
Qualifie d Hos t Name
Se rve r Name
Te mp Dir
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
394
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.250 . Met rics
Name
Descript io n
Re load
Make the s e rve r re -load the (change d)
configuration. To load a diffe re nt s tartup
config us e 're s tart'
Start the s e rve r by invoking its s tart s cript
Re s tart the s e rve r by s hutting it down and
invoking its s tart s cript
Shut down the s e rve r.
Ins talls a us e r in the s e rve r for
manage me nt
Exe cute s command via jbos s -cli
Exe cute s s cript via jbos s -cli
Start
Re s tart
Shutdown
Ins tall RHQ us e r
Exe cute CLI commands
Exe cute CLI s cript
Package T ypes
none
3.3.1. JBoss AS 7 and EAP 6 - ModClust er St andalone Service
Overview
T able 3.251. Overview
De s cription:
Single ton:
Plugin:
Mod_clus te r s upport
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.1.1, “JBos s AS 7 and EAP 6 - Se rvice Configuration Se rvice ”
Connect ion Propert ies
T able 3.252.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
395
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Conf igurat ion Propert ies
none
Operat ions
T able 3.253. Met rics
Name
Descript io n
Add Proxy
Add the proxy to the lis t of httpd conne cte d
to the node .
Re ad the lis t of httpd conne cte d to the
node .
Se nd a DUMP to httpd and dis play the
re s ult.
Se nd a INFO to httpd and dis play the re s ult.
Re fre s h the node s e nding a ne w CONFIG
me s s age to Apache httpd.
Re move the proxy to the lis t of httpd
conne cte d to the node .
Re s e t the node conne ction to Apache httpd.
Lis t Proxie s
Re ad Proxie s Configuration
Re ad Proxie s Info
Re fre s h
Re move Proxy
Re s e t
Package T ypes
none
3.3.1.1. JBoss AS 7 and EAP 6 - Service Conf igurat ion Service
Overview
T able 3.254. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.1.1.1, “JBos s AS 7 and EAP 6 - Dynamic Load Provide r Se rvice ”
Se ction 3.3.1.1.2, “JBos s AS 7 and EAP 6 - Ss l Se rvice ”
Co nnect io n Pro pert ies
T able 3.255.
Name
Path
396
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.256.
Name
Descript io n
Required
Int ernal Name
Proxy Lis t
Lis t of proxie s ,
Format
(hos tname :port)
s e parate d with
commas .
Bas e URL for MCMP
re que s ts .
Name of Socke t
binding to us e for
the Adve rtis e
s ocke t.
Us e Adve rtis e logic
or not.
String containing the
s e curity ke y for the
Adve rtis e logic.
The balance r name .
Name of the we b
conne ctor us e d to
communicate with
the load balance r.
loadBalancingGroup
name .
Lis t of conte xts
mod_clus te r s hould
ignore , Format String
s e parate d with
commas .
Enable conte xts
e ve n if dis able d in
mod_clus te r_mange r
(httpd).
Us e s ticky s e s s ions
for re que s ts .
Re move s e s s ion
information on
failove r.
no
proxy-lis t
no
proxy-url
no
adve rtis e -s ocke t
no
adve rtis e
no
adve rtis e -s e curityke y
no
ye s
balance r
conne ctor
no
load-balancing-group
no
e xclude d-conte xts
no
auto-e nable -conte xts
no
s ticky-s e s s ion
no
s ticky-s e s s ionre move
Proxy Url
Adve rtis e Socke t
Adve rtis e
Adve rtis e Se curity
Ke y
Balance r
Conne ctor
Load Balancing
Group
Exclude d Conte xts
Auto Enable
Conte xts
Sticky Se s s ion
Sticky Se s s ion
Re move
397
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Sticky Se s s ion Force
Don't failove r a
re que s t with
s e s s ion information.
Time out to wait in
httpd for an
available worke r to
proce s s the
re que s ts .
Max atte mpts to
proce s s an
ide mpote nt re que s t.
Enable s /dis able s
packe t flus hing in
httpd.
Time to wait be fore
flus hing packe ts in
httpd.
Time (in s e conds ) in
which to wait for a
pong ans we r to a
ping.
Soft maximum idle
conne ction count in
httpd
Time to live (in
s e conds ) for idle
conne ctions above
s max
Time out (in s e conds )
for proxy
conne ctions to a
node .
Max time to wait for
conte xt to proce s s
pe nding re que s ts .
Time out to wait for
httpd to ans we r a
MCMP me s s age .
no
s ticky-s e s s ion-force
no
worke r-time out
no
max-atte mpts
no
flus h-packe ts
no
flus h-wait
no
ping
no
s max
no
ttl
no
node -time out
no
s top-conte xt-time out
no
s ocke t-time out
Worke r Time out
Max Atte mpts
Flus h Packe ts
Flus h Wait
Ping
Smax
Ttl
Node Time out
Stop Conte xt
Time out
Socke t Time out
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.257. Met rics
Name
398
Descript io n
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Add Cus tom Me tric
Add ne w cus tom me tric to the load
balance r provide r.
Add ne w me tric to the load balance r
provide r.
Re move a cus tom me tric from the load
balance r provide r.
Add ne w me tric to the load balance r
provide r.
Add Me tric
Re move Cus tom Me tric
Re move Me tric
Package T ypes
none
3.3.1.1.1. JBo ss AS 7 and EAP 6 - Dynamic Lo ad Pro vider Service
Overview
T able 3.258. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.1.1.1.1, “JBos s AS 7 and EAP 6 - Cus tom Load Me tric Se rvice ”
Se ction 3.3.1.1.1.2, “JBos s AS 7 and EAP 6 - Load Me tric Se rvice ”
Co nnect io n Pro pert ies
T able 3.259.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.260 .
399
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
De cay
De cay. The de fault
value is 2.
His tory. The de fault
value is 9.
no
de cay
no
his tory
His tory
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.1.1.1.1. JBo ss AS 7 and EAP 6 - Cust o m Lo ad Met ric Service
Ove rvie w
T able 3.261. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.262.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.263.
400
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Capacity
Capacity of the
no
me tric. The de fault
value is 1
Clas s name of the
ye s
cus tom me tric.
We ight of the me tric. no
The de fault value is
1.
Clas s
We ight
Required
Int ernal Name
capacity
clas s
we ight
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.1.1.1.2. JBo ss AS 7 and EAP 6 - Lo ad Met ric Service
Ove rvie w
T able 3.264. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.265.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
401
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Configuration Prope rtie s
T able 3.266.
Name
Descript io n
Capacity
Capacity of the
no
me tric. The de fault
value is 1.
Type of the me tric
ye s
We ight of the me tric. no
The de fault value is
1.
Type
We ight
Required
Int ernal Name
capacity
type
we ight
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.1.1.2. JBo ss AS 7 and EAP 6 - Ssl Service
Overview
T able 3.267. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.268.
Name
Path
402
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.269.
Name
Descript io n
Required
Int ernal Name
Ca Ce rtificate File
Ca Re vocation Ur
Ce rtificate authority.
Ce rtificate authority
re vocation lis t.
Ke y file for the
ce rtificate .
The allowe d ciphe r
s uite .
The ke y alias .
Pas s word.
The SSL protocols
that are e nable d.
no
no
ca-ce rtificate -file
ca-re vocation-ur
no
ce rtificate -ke y-file
no
ciphe r-s uite
no
no
no
ke y-alias
pas s word
protocol
Ce rtificate Ke y File
Ciphe r Suite
Ke y Alias
Pas s word
Protocol
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.2. JBoss AS 7 and EAP 6 - JVM Service
Overview
T able 3.270 . Overview
De s cription:
Single ton:
Plugin:
Information about the unde rlying JVM
ye s
JBos s AS7
403
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Child Resource T ypes
Se ction 3.3.2.1, “JBos s AS 7 and EAP 6 - Ope rating Sys te m Se rvice ”
Se ction 3.3.2.2, “JBos s AS 7 and EAP 6 - Me mory Se rvice ”
Se ction 3.3.2.3, “JBos s AS 7 and EAP 6 - Runtime Se rvice ”
Se ction 3.3.2.4, “JBos s AS 7 and EAP 6 - Thre ading Se rvice ”
Se ction 3.3.2.5, “JBos s AS 7 and EAP 6 - Garbage Colle ctor Se rvice ”
Se ction 3.3.2.6, “JBos s AS 7 and EAP 6 - Me mory Pool Se rvice ”
Connect ion Propert ies
T able 3.271.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.3.2.1. JBoss AS 7 and EAP 6 - Operat ing Syst em Service
Overview
T able 3.272. Overview
De s cription:
Single ton:
Plugin:
404
ye s
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.273.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.274. Met rics
Name
T ype
Descript io n
Int ernal Name
Available
Proce s s ors
me as ure me nt
available -proce s s ors
Sys te m Load
Ave rage
me as ure me nt
The numbe r of
proce s s ors available
to the Java virtual
machine .
The s ys te m load
ave rage for the las t
minute . The load
ave rage may not be
available on s ome
platforms ; if the load
ave rage is not
available , a ne gative
value is re turne d.
s ys te m-loadave rage
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
405
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
3.3.2.2. JBoss AS 7 and EAP 6 - Memory Service
Overview
T able 3.275. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.276.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.277. Met rics
Name
T ype
Descript io n
Int ernal Name
Obje ct Pe nding
Finaliz ation Count
me as ure me nt
obje ct-pe ndingfinaliz ation-count
Initial he ap us age
me as ure me nt
Us e d he ap
me as ure me nt
The approximate
numbe r of obje cts
for which finaliz ation
is pe nding.
The amount of
me mory in byte s
that the Java virtual
machine initially
re que s ts from the
ope rating s ys te m for
me mory
manage me nt.
The amount of us e d
me mory in byte s .
406
he ap-me moryus age :init
he ap-me moryus age :us e d
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Committe d he ap
me as ure me nt
he ap-me moryus age :committe d
Maximum he ap
us age
me as ure me nt
Initial non-he ap
us age
me as ure me nt
The amount of
me mory in byte s
that is committe d for
the Java virtual
machine to us e .
The maximum
amount of me mory
in byte s that can be
us e d for me mory
manage me nt.
The amount of
me mory in byte s
that the Java virtual
machine initially
re que s ts from the
ope rating s ys te m for
me mory
manage me nt.
The amount of us e d
me mory in byte s .
The amount of
me mory in byte s
that is committe d for
the Java virtual
machine to us e .
The maximum
amount of me mory
in byte s that can be
us e d for me mory
manage me nt.
Us e d non-he ap
me as ure me nt
me mory
Committe d non-he ap me as ure me nt
me mory
Maximum non-he ap
us age
me as ure me nt
he ap-me moryus age :max
non-he ap-me moryus age :init
non-he ap-me moryus age :us e d
non-he ap-me moryus age :committe d
non-he ap-me moryus age :max
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
T able 3.278. Met rics
Name
Descript io n
Trigge r GC
Runs the garbage colle ctor.
Package T ypes
none
407
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
3.3.2.3. JBoss AS 7 and EAP 6 - Runt ime Service
Overview
T able 3.279. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.280 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.281. Met rics
Name
T ype
Descript io n
Int ernal Name
Uptime
me as ure me nt
The uptime of the
Java virtual machine
in millis e conds .
uptime
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
408
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
3.3.2.4. JBoss AS 7 and EAP 6 - T hreading Service
Overview
T able 3.282. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.283.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.284. Met rics
Name
T ype
Descript io n
Int ernal Name
Thre ad Count
me as ure me nt
thre ad-count
Pe ak Thre ad Count
me as ure me nt
Total Starte d Thre ad
Count
me as ure me nt
Dae mon Thre ad
Count
me as ure me nt
The curre nt numbe r
of live thre ads
including both
dae mon and nondae mon thre ads .
The pe ak live thre ad
count s ince the Java
virtual machine
s tarte d or pe ak was
re s e t.
The total numbe r of
thre ads cre ate d and
als o s tarte d s ince
the Java virtual
machine s tarte d.
The curre nt numbe r
of live dae mon
thre ads .
pe ak-thre ad-count
total-s tarte d-thre adcount
dae mon-thre adcount
409
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Curre nt Thre ad Cpu
Time
me as ure me nt
The total CPU time
for the curre nt
thre ad in
nanos e conds , or -1 if
'thre ad-cpu-time e nable d' is 'fals e '. A
Java virtual machine
imple me ntation may
not s upport CPU time
me as ure me nt. If
'thre ad-cpu-time s upporte d', is 'fals e '
unde fine d.
The CPU time that
the curre nt thre ad
has e xe cute d in
us e r mode in
nanos e conds , or -1 if
'thre ad-cpu-time e nable d' is 'fals e '. A
Java virtual machine
imple me ntation may
not s upport CPU time
me as ure me nt. If
'thre ad-cpu-time s upporte d', is 'fals e '
the re s ult will be
unde fine d
curre nt-thre ad-cputime
Curre nt Thre ad Us e r me as ure me nt
Time
curre nt-thre ad-us e rtime
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.285.
Name
Descript io n
Required
Int ernal Name
Thre ad Conte ntion
Monitoring Enable d
Whe the r thre ad
conte ntion
monitoring is
e nable d.
Whe the r thre ad CPU
time me as ure me nt
is e nable d.
Whe the r the Java
virtual machine
s upports thre ad
conte ntion
monitoring.
no
thre ad-conte ntionmonitoring-e nable d
no
thre ad-cpu-time e nable d
no
thre ad-conte ntionmonitorings upporte d
Thre ad Cpu Time
Enable d
Thre ad Conte ntion
Monitoring
Supporte d
410
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Thre ad Cpu Time
Supporte d
Whe the r the Java
virtual machine
imple me ntation
s upports CPU time
me as ure me nt for
any thre ad.
Whe the r the Java
virtual machine
s upports CPU time
me as ure me nt for
the curre nt thre ad.
Whe the r the Java
virtual machine
s upports monitoring
of obje ct monitor
us age .
Whe the r the Java
virtual machine
s upports monitoring
of ownable
s ynchroniz e r us age .
no
thre ad-cpu-time s upporte d
no
curre nt-thre ad-cputime -s upporte d
no
obje ct-monitorus age -s upporte d
no
s ynchroniz e r-us age s upporte d
Curre nt Thre ad Cpu
Time Supporte d
Obje ct Monitor
Us age Supporte d
Synchroniz e r Us age
Supporte d
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.286. Met rics
Name
Descript io n
Dump All Thre ads
Re turns the thre ad info for all live thre ads
with s tack trace and s ynchroniz ation
information.
Finds cycle s of thre ads that are in de adlock
waiting to acquire obje ct monitors or
ownable s ynchroniz e rs .
Finds cycle s of thre ads that are in de adlock
waiting to acquire obje ct monitors .
Re turns the total CPU time for a thre ad of
the s pe cifie d ID in nanos e conds .
Re turns the thre ad info for a thre ad of the
s pe cifie d id. The s tack trace , locke d
monitors , and locke d s ynchroniz e rs in the
re turne d re ply obje ct will be e mpty.
Re turns the thre ad info for e ach thre ad
whos e ID is in the input lis t.
Find De adlocke d Thre ads
Find Monitor De adlocke d Thre ads
Ge t Thre ad Cpu Time
Ge t Thre ad Info
Ge t Thre ad Infos
411
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Ge t Thre ad Us e r Time
Re turns the CPU time that a thre ad of the
s pe cifie d ID has e xe cute d in us e r mode in
nanos e conds .
Re s e ts the pe ak thre ad count to the
curre nt numbe r of live thre ads .
Ge t all live thre ad IDs . If a s e curity
manage r is ins talle d and the calle r doe s
not have
Manage me ntPe rmis s ion('monitor'), the
re s ult will be unde fine d.
Re s e t Pe ak Thre ad Count
Ge t All thre ad ids
Package T ypes
none
3.3.2.5. JBoss AS 7 and EAP 6 - Garbage Collect or Service
Overview
T able 3.287. Overview
De s cription:
Pare nt re s ource for the re s ource s
providing the manage me nt inte rface for
the garbage colle ction of the Java virtual
machine .
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
Se ction 3.3.2.5.1, “JBos s AS 7 and EAP 6 - Garbage Colle ctor Re s ource Se rvice ”
Co nnect io n Pro pert ies
T able 3.288.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
412
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
Operat io ns
none
Package T ypes
none
3.3.2.5.1. JBo ss AS 7 and EAP 6 - Garbage Co llect o r Reso urce Service
Overview
T able 3.289. Overview
De s cription:
The manage me nt inte rface for one of the
garbage colle ctors in the Java virtual
machine .
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.290 .
Name
Descript io n
Path
Include Runtime
Required
Int ernal Name
ye s
ye s
path
include Runtime
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.291. Met rics
Name
T ype
Descript io n
Int ernal Name
Colle ction Count
me as ure me nt
colle ction-count
Colle ction Count pe r
Minute
me as ure me nt
The total numbe r of
colle ctions that have
occurre d.
The total numbe r of
colle ctions that have
occurre d.
colle ction-count
413
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Colle ction Time
me as ure me nt
colle ction-time
Colle ction Time pe r
Minute
me as ure me nt
Name
trait
Valid
trait
The approximate
accumulate d
colle ction e laps e d
time in millis e conds .
The approximate
accumulate d
colle ction e laps e d
time in millis e conds .
The name
re pre s e nting this
garbage colle ctor
Whe the r this this
me mory manage r is
valid in the Java
virtual machine .
colle ction-time
name
valid
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.292.
Name
Descript io n
Required
Int ernal Name
Me mory Pool Name s
The name of
me mory pools that
this garbage
colle ctor manage s .
ye s
me mory-pool-name s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.2.6. JBoss AS 7 and EAP 6 - Memory Pool Service
Overview
414
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.293. Overview
De s cription:
Pare nt re s ource for the re s ource s
providing the manage me nt inte rface for
the Java virtual machine 's me mory pools .
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
Se ction 3.3.2.6.1, “JBos s AS 7 and EAP 6 - Me mory Pool Re s ource Se rvice ”
Co nnect io n Pro pert ies
T able 3.294.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.2.6.1. JBo ss AS 7 and EAP 6 - Memo ry Po o l Reso urce Service
Overview
T able 3.295. Overview
De s cription:
Single ton:
The manage me nt inte rface for a me mory
pool. A me mory pool re pre s e nts the
me mory re s ource manage d by the Java
virtual machine and is manage d by one or
more me mory manage rs .
no
415
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Plugin:
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.296.
Name
Descript io n
Path
Include Runtime
Required
Int ernal Name
ye s
ye s
path
include Runtime
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.297. Met rics
Name
T ype
Descript io n
Int ernal Name
Colle ction Us age Init
me as ure me nt
colle ction-us age :init
Colle ction Us age Us e d
Colle ction Us age Committe d
me as ure me nt
Colle ction Us age Max
me as ure me nt
The amount of
me mory in byte s
that the Java virtual
machine initially
re que s ts from the
ope rating s ys te m for
me mory
manage me nt.
The amount of us e d
me mory in byte s .
The amount of
me mory in byte s
that is committe d for
the Java virtual
machine to us e .
The maximum
amount of me mory
in byte s that can be
us e d for me mory
manage me nt.
416
me as ure me nt
colle ctionus age :us e d
colle ctionus age :committe d
colle ction-us age :max
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Colle ction Us age
Thre s hold Count
me as ure me nt
colle ction-us age thre s hold-count
Colle ction Us age
Thre s hold Exce e de d
trait
The numbe r of time s
that the Java virtual
machine has
de te cte d that the
me mory us age has
re ache d or
e xce e de d the
colle ction us age
thre s hold. A me mory
pool may not s upport
a colle ction us age
thre s hold. If
'colle ction-us age thre s holds upporte d', is 'fals e '
trying to re ad this
attribute via the
're ad-attribute '
ope ration will re s ult
in failure , and the
value of this
attribute in the
re s ult of a 're adre s ource ' ope ration
will be 'unde fine d'.
Whe the r the
me mory us age of
this me mory pool
afte r the mos t
re ce nt colle ction on
which the Java virtual
machine has
e xpe nde d e ffort has
re ache d or
e xce e de d its
colle ction us age
thre s hold. A me mory
pool may not s upport
a colle ction us age
thre s hold. If
'colle ction-us age thre s holds upporte d', is 'fals e '
trying to re ad this
attribute via the
're ad-attribute '
ope ration will re s ult
in failure , and the
value of this
attribute in the
re s ult of a 're adre s ource ' ope ration
will be 'unde fine d'.
colle ction-us age thre s hold-e xce e de d
417
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Colle ction Us age
Thre s hold
Supporte d
trait
colle ction-us age thre s hold-s upporte d
Name
trait
Pe ak Us age - Init
me as ure me nt
Pe ak Us age - Us e d
me as ure me nt
Pe ak Us age Committe d
me as ure me nt
Pe ak Us age - Max
me as ure me nt
Type
trait
Us age - Init
me as ure me nt
Us age - Us e d
me as ure me nt
Us age - Committe d
me as ure me nt
Us age - Max
me as ure me nt
Whe the r this
me mory pool
s upports a colle ction
us age thre s hold.
The name
re pre s e nting this
me mory pool.
The amount of
me mory in byte s
that the Java virtual
machine initially
re que s ts from the
ope rating s ys te m for
me mory
manage me nt.
The amount of us e d
me mory in byte s .
The amount of
me mory in byte s
that is committe d for
the Java virtual
machine to us e .
The maximum
amount of me mory
in byte s that can be
us e d for me mory
manage me nt.
The type of this
me mory pool.
The amount of
me mory in byte s
that the Java virtual
machine initially
re que s ts from the
ope rating s ys te m for
me mory
manage me nt.
The amount of us e d
me mory in byte s .
The amount of
me mory in byte s
that is committe d for
the Java virtual
machine to us e .
The maximum
amount of me mory
in byte s that can be
us e d for me mory
manage me nt.
418
name
pe ak-us age :init
pe ak-us age :us e d
pe akus age :committe d
pe ak-us age :max
type
us age :init
us age :us e d
us age :committe d
us age :max
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Us age Thre s hold
Count
me as ure me nt
us age -thre s holdcount
Us age Thre s hold
Exce e de d
trait
Us age Thre s hold
Supporte d
trait
Valid
trait
The numbe r of time s
that the me mory
us age has cros s e d
the us age thre s hold.
A me mory pool may
not s upport a us age
thre s hold. If 'us age thre s holds upporte d', is 'fals e '
trying to re ad this
attribute via the
're ad-attribute '
ope ration will re s ult
in failure , and the
value of this
attribute in the
re s ult of a 're adre s ource ' ope ration
will be 'unde fine d'.
Whe the r the
me mory us age of
this me mory pool
re ache s or e xce e ds
its us age thre s hold
value . A me mory
pool may not s upport
a us age thre s hold. If
'us age -thre s holds upporte d', is 'fals e '
trying to re ad this
attribute via the
're ad-attribute '
ope ration will re s ult
in failure , and the
value of this
attribute in the
re s ult of a 're adre s ource ' ope ration
will be 'unde fine d'.
Whe the r this
me mory pool
s upports us age
thre s hold.
Whe the r this
me mory pool is valid
in the Java virtual
machine . A me mory
pool be come s invalid
once the Java virtual
machine re move s it
from the me mory
s ys te m.
us age -thre s holde xce e de d
us age -thre s holds upporte d
valid
419
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.298.
Name
Descript io n
Required
Int ernal Name
Colle ction Us age
Thre s hold
The colle ction us age
thre s hold value of
this me mory pool in
byte s . A me mory
pool may not
s upport a colle ction
us age thre s hold. If
'colle ction-us age thre s holds upporte d', is 'fals e '
trying to re ad this
attribute via the
're ad-attribute '
ope ration will re s ult
in failure , and the
value of this
attribute in the
re s ult of a 're adre s ource ' ope ration
will be 'unde fine d'.
The name s of the
me mory manage rs
that manage this
me mory pool.
The us age thre s hold
value of this
me mory pool in
byte s . A me mory
pool may not
s upport a us age
thre s hold. If 'us age thre s holds upporte d', is 'fals e '
trying to re ad this
attribute via the
're ad-attribute '
ope ration will re s ult
in failure , and the
value of this
attribute in the
re s ult of a 're adre s ource ' ope ration
will be 'unde fine d'.
no
colle ction-us age thre s hold
ye s
me mory-manage rname s
no
us age -thre s hold
Me mory Manage r
Name s
Us age Thre s hold
420
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.299. Met rics
Name
Descript io n
Re s e t Pe ak Us age
Re s e ts the pe ak me mory us age s tatis tic of
this me mory pool to the curre nt me mory
us age .
Package T ypes
none
3.3.3. JBoss AS 7 and EAP 6 - JBossWeb Service
Overview
T able 3.30 0 . Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.3.1, “JBos s AS 7 and EAP 6 - Conne ctor Se rvice ”
Se ction 3.3.3.2, “JBos s AS 7 and EAP 6 - VHos t Se rvice ”
Connect ion Propert ies
T able 3.30 1.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
421
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Conf igurat ion Propert ies
T able 3.30 2.
Name
Descript io n
Required
Int ernal Name
Dis able d: 0
Enable the de fault
Se rvle t mapping.
The de fault value is
fals e .
Force a file
e ncoding.
Enable folde r
lis tings . The de fault
value is fals e .
Maximum re curs ion
for PROPFIND. The
de fault value is 3.
Allow write HTTP
me thods (PUT,
DELETE). The de fault
value is true .
Enable s e ndfile if
pos s ible , for file s
bigge r than the
s pe cifie d byte s iz e .
The de fault value is
49152.
Se cre t for We bDAV
locking ope rations .
Enable We bDAV
functionality. The
de fault value is
fals e .
Che ck inte rval for
JSP update s us ing a
background thre ad.
The de fault value is
0.
Enable the
de ve lopme nt mode ,
which give s more
information whe n an
e rror occurs . The
de fault value is
fals e .
Enable the JSP
containe r. The
de fault value is
fals e .
no
dis able d:0
no
file -e ncoding
no
lis tings
no
max-de pth
no
re ad-only
no
s e ndfile
no
s e cre t
no
we bdav
no
che ck-inte rval
no
de ve lopme nt
no
dis able d:1
File Encoding
Lis tings
Max De pth
Re ad Only
Se ndfile
Se cre t
We bdav
Che ck Inte rval
De ve lopme nt
Dis able d: 1
422
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Dis play Source
Fragme nt
Whe n a runtime
e rror occurs ,
atte mpts to dis play
corre s ponding JSP
s ource fragme nt.
The de fault value is
true .
Write SMAP data to a
file . The de fault
value is fals e .
Enable e rrors whe n
us ing a bad clas s in
us e Be an. The
de fault value is
fals e .
Ge ne rate String
cons tants as char
arrays . The de fault
value is fals e .
Spe cify the e ncoding
us e d for Java
s ource s . The de fault
value is UTF8.
Ke e p the ge ne rate d
Se rvle ts . The
de fault value is true .
Map to the JSP
s ource . The de fault
value is true .
Minimum amount of
time be twe e n two
te s ts for update s , in
s e conds . The de fault
value is 4.
Re try faile d JSP
compilations on e ach
re que s t. The de fault
value is fals e .
Spe cify a diffe re nt
work dire ctory.
Enable SMAP. The
de fault value is true .
Source VM le ve l for
compilation. The
de fault value is 1.5.
Enable tag pooling.
The de fault value is
true .
Targe t VM le ve l for
compilation. The
de fault value is 1.5.
no
dis play-s ource fragme nt
no
dump-s map
no
e rror-on-us e -be aninvalid-clas s attribute
no
ge ne rate -s trings -as char-arrays
no
java-e ncoding
no
ke e p-ge ne rate d
no
mappe d-file
no
modification-te s tinte rval
no
re compile -on-fail
no
s cratch-dir
no
s map
no
s ource -vm
no
tag-pooling
no
targe t-vm
Dump Smap
Error On Us e Be an
Invalid Clas s
Attribute
Ge ne rate Strings As
Char Arrays
Java Encoding
Ke e p Ge ne rate d
Mappe d File
Modification Te s t
Inte rval
Re compile On Fail
Scratch Dir
Smap
Source Vm
Tag Pooling
Targe t Vm
423
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Trim Space s
Trim s ome s pace s
from the ge ne rate d
Se rvle t. The de fault
value is fals e .
Enable adve rtis ing
the JSP e ngine in xpowe re d-by. The
de fault value is true .
A we lcome file
de claration.
The we b containe r's
de fault virtual
s e rve r. The de fault
value is de fault-hos t.
The ide ntifie r for
this s e rve r ins tance .
Add the native
initializ ation lis te ne r
to the we b
containe r. The
de fault value is true .
no
trim-s pace s
no
x-powe re d-by
no
we lcome -file
ye s
de fault-virtuals e rve r
no
ins tance -id
no
native
X Powe re d By
We lcome File
De fault Virtual
Se rve r
Ins tance Id
Native
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.3.1. JBoss AS 7 and EAP 6 - Connect or Service
Overview
T able 3.30 3. Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
424
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.30 4.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.30 5. Met rics
Name
T ype
Descript io n
Int ernal Name
Byte s Se nt
me as ure me nt
byte s Se nt
Byte s Se nt pe r
Minute
Byte s Re ce ive d
me as ure me nt
Byte s Re ce ive d pe r
Minute
me as ure me nt
Proce s s ing Time
me as ure me nt
Numbe r of byte s e nt
by the conne ctor.
Numbe r of byte s e nt
by the conne ctor.
Numbe r of byte
re ce ive d by the
conne ctor (POST
data).
Numbe r of byte
re ce ive d by the
conne ctor (POST
data).
Proce s s ing time
us e d by the
conne ctor. Im millis e conds .
Proce s s ing time
us e d by the
conne ctor. Im millis e conds .
Numbe r of e rror that
occurs whe n
proce s s ing re que s ts
by the conne ctor.
Numbe r of e rror that
occurs whe n
proce s s ing re que s ts
by the conne ctor.
Max time s pe nt to
proce s s a re que s ts .
Numbe r of the
re que s t proce s s e d
by the conne ctor.
Numbe r of the
re que s t proce s s e d
by the conne ctor.
me as ure me nt
Proce s s ing Time pe r me as ure me nt
Minute
Error Count
me as ure me nt
Error Count pe r
Minute
me as ure me nt
Max Time
me as ure me nt
Re que s t Count
me as ure me nt
Re que s t Count pe r
Minute
me as ure me nt
byte s Se nt
byte s Re ce ive d
byte s Re ce ive d
proce s s ingTime
proce s s ingTime
e rrorCount
e rrorCount
maxTime
re que s tCount
re que s tCount
425
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Max conne ctions
me as ure me nt
Numbe r of max
conne ctions this
conne ctor can
handle (s e e
configuration to s e t
it)
_e xpr:maxconne ctions
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.30 6.
Name
Configuration
Sche me
Socke t Binding
Enable d
Enable Lookups
Exe cutor
426
Descript io n
The we b conne ctor
s che me .
The we b conne ctor
s ocke t-binding
re fe re nce , this
conne ctor s hould be
bound to.
De fine s whe the r the
conne ctor s hould be
s tarte d on s tartup.
The de fault value is
true .
Enable DNS lookups
for Se rvle t API. The
de fault value is
fals e .
The name of the
e xe cutor that s hould
be us e d for the
proce s s ing thre ads
of this conne ctor. If
unde fine d de faults
to us ing an inte rnal
pool.
Required
Int ernal Name
no
ye s
*Configuration+
s che me
ye s
s ocke t-binding
no
e nable d
no
e nable -lookups
no
e xe cutor
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Max conne ctions
Amount of
concurre nt
conne ctions that can
be proce s s e d by the
conne ctor with
optimum
pe rformance . The
de fault value
de pe nds on the
conne ctor us e d.
Maximum s iz e in
byte s of a POST
re que s t that can be
pars e d by the
containe r. The
de fault value is
2097152.
Maximum s iz e in
byte s of a POST
re que s t that will be
s ave d during ce rtain
authe ntication
s che me s . The
de fault value is
4096.
A unique name for
the conne ctor.
The we b conne ctor
protocol. (e .g.
'HTTP/1.1' or 'AJP' or
a name of a clas s
imple me nting
ProtocolHandle r and
MBe anRe gis tration )
The hos t name that
will be us e d whe n
s e nding a re dire ct.
The de fault value is
null.
The port that will be
us e d whe n s e nding
a re dire ct.
The port for
re dire ction to a
s e cure conne ctor.
The de fault value is
8433.
no
maxconne ctions :e xpr
no
max-pos t-s iz e
no
max-s ave -pos t-s iz e
no
name
ye s
protocol
no
proxy-name
no
proxy-port
no
re dire ct-port:e xpr
Max Pos t Siz e
Max Save Pos t Siz e
Name
Protocol
Proxy Name
Proxy Port
Re dire ct Port
427
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se cure
Indicate s if conte nt
s e nt or re ce ive d by
the conne ctor is
s e cure d from the
us e r pe rs pe ctive .
The de fault value is
fals e .
The lis t of virtual
s e rve rs that can be
acce s s e d through
this conne ctor. The
de fault is to allow all
virtual s e rve rs .
no
s e cure
no
virtual-s e rve r
Virtual Se rve r
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.3.2. JBoss AS 7 and EAP 6 - VHost Service
Overview
T able 3.30 7. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.3.2.1, “JBos s AS 7 and EAP 6 - Re write Rule s Se rvice ”
Se ction 3.3.3.2.2, “JBos s AS 7 and EAP 6 - Acce s s Log Se rvice ”
Co nnect io n Pro pert ies
T able 3.30 8.
Name
Path
428
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.30 9. Met rics
Name
T ype
Descript io n
Int ernal Name
_alias e s
trait
Alias e s for this
virtual hos t
_alias e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.310 .
Name
Descript io n
Configuration
Virtual s e rve r
alias e s
De fault We b Module
Enable We lcome
Root
Name
The virtual s e rve r
alias e s
The we b module
de ployme nt name
that will be mappe d
as the root we bapp.
Whe the r or not the
bundle d we lcome
dire ctory is us e d as
the root we b
conte xt. The de fault
value is fals e .
A unique virtual hos t
name
Required
Int ernal Name
no
ye s
*Configuration+
alias
ye s
de fault-we b-module
ye s
e nable -we lcome -root
no
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
429
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Package T ypes
none
3.3.3.2.1. JBo ss AS 7 and EAP 6 - Rewrit e Rules Service
Overview
T able 3.311. Overview
De s cription:
A lis t of re write rule s that will be
proce s s e d in orde r on the URL or vhos t
s pe cifie d in the re que s t. Thos e follow the
rule s for mod_re write . Ple as e cons ult the
manual for he lp on s e ttings
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.312.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.313.
Name
Conditions
Flags
Patte rn
430
Descript io n
Option flags for this
re write rule . Cons ult
the mod_re write
docs .
The patte rn that will
be matche d. Cons ult
the mod_re write
docs .
Required
Int ernal Name
no
ye s
*1
flags
ye s
patte rn
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Subs titution
The s tring that will
re place the original
URL or vhos t.
Cons ult the
mod_re write docs .
ye s
s ubs titution
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.3.2.2. JBo ss AS 7 and EAP 6 - Access Lo g Service
Overview
T able 3.314. Overview
De s cription:
The acce s s log configuration for this virtual
s e rve r.
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.315.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
431
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Co nf igurat io n Pro pert ies
T able 3.316.
Name
Descript io n
Required
Int ernal Name
Path
The re lative folde r
path.
The folde r the path
is re lative to. The
de fault value is
jbos s .s e rve r.log.dir.
Enable e xte nde d
patte rn, with more
options . The de fault
value is fals e .
The acce s s log
patte rn. The de fault
value is common.
Pre fix for the log file
name . The de fault
value is fals e .
Hos t re s olution. The
de fault value is
fals e .
Rotate the acce s s
log e ve ry day. The
de fault value is true .
no
path
no
re lative -to
no
e xte nde d
no
patte rn
no
pre fix
no
re s olve -hos ts
no
rotate
Re lative To
Exte nde d
Patte rn
Pre fix
Re s olve Hos ts
Rotate
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.4. JBoss AS 7 and EAP 6 - General JCA connect ors Service
Overview
T able 3.317. Overview
De s cription:
Single ton:
Plugin:
432
Ge ne ral s e ttings of the JCA e ngine . Not
ne ce s s arily for e nd-us e rs
ye s
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Child Resource T ypes
none
Connect ion Propert ies
T able 3.318.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.319.
Name
Descript io n
Required
Int ernal Name
De fault
Workmanage r Short
Running Thre ad Pool
De fault
Workmanage r Long
Running Thre ad Pool
Be an Validation
Enable d
Spe cify the name of
s hort running thre ad
pool
Spe cify the name of
long running thre ad
pool
Spe cify whe the r
be an validation is
e nable d
Enabling the
validation
Should an archive
validation e rror
re port fail the
de ployme nt. De fault:
true
Should an archive
validation warning
re port fail the
de ployme nt. De fault:
fals e
e nable /dis able
de bug information
logging for cache d
conne ction manage r
ye s
de faultworkmanage r-s hortrunning-thre ad-pool
de faultworkmanage r-longrunning-thre ad-pool
be an-validatione nable d
Archive Validation
Enable d
Archive Validation
Fail On Error
Archive Validation
Fail On Warn
Cache d Conne ction
Manage r De bug
ye s
ye s
ye s
ye s
archive -validatione nable d
archive -validationfail-on-e rror
ye s
archive -validationfail-on-warn
ye s
cache d-conne ctionmanage r-de bug
433
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Cache d Conne ction
Manage r Error
e nable /dis able e rror
information logging
for cache d
conne ction manage r
ye s
cache d-conne ctionmanage r-e rror
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.5. JBoss AS 7 and EAP 6 - Dat asources (St andalone) Service
Overview
T able 3.320 . Overview
De s cription:
Datas ource s s ubs ys te m for Standalone
s e rve rs .
ye s
JBos s AS7
Single ton:
Plugin:
Child Resource T ypes
Se ction 3.3.5.1, “JBos s AS 7 and EAP 6 - DataSource (Standalone ) Se rvice ”
Se ction 3.3.5.2, “JBos s AS 7 and EAP 6 - XADataSource (Standalone ) Se rvice ”
Connect ion Propert ies
T able 3.321.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
434
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Met rics
none
Conf igurat ion Propert ies
T able 3.322.
Name
Descript io n
Available drive rs
Required
Int ernal Name
ye s
*4
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.5.1. JBoss AS 7 and EAP 6 - Dat aSource (St andalone) Service
Overview
T able 3.323. Overview
De s cription:
Single ton:
Plugin:
A non-XA data s ource
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.324.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
435
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Met rics
T able 3.325. Met rics
Name
T ype
Descript io n
Int ernal Name
Pre pare d State me nt
Cache Curre nt Siz e
me as ure me nt
Pre pare dState me ntC
ache Curre ntSiz e
Pre pare d State me nt
Cache Mis s Count
me as ure me nt
Pre pare d State me nt
Cache Mis s Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Add Count
me as ure me nt
Pre pare d State me nt
Cache Acce s s Count
me as ure me nt
Pre pare d State me nt
Cache Acce s s Count
pe r Minute
Pre pare d State me nt
Cache De le te Count
me as ure me nt
Pre pare d State me nt
Cache De le te Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Hit Count
me as ure me nt
Pre pare d State me nt
Cache Hit Count pe r
Minute
me as ure me nt
Active Count
Available Count
Ave rage Blocking
Time
me as ure me nt
me as ure me nt
me as ure me nt
The numbe r of
pre pare d and
callable s tate me nts
curre ntly cache d in
the s tate me nt cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of
s tate me nts adde d to
the s tate me nt cache
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The active count
The available count
The ave rage time
s pe nt blocking for a
conne ction
436
me as ure me nt
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache AddCount
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache HitCount
Pre pare dState me ntC
ache HitCount
Active Count
Available Count
Ave rage BlockingTim
e
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Ave rage Cre ation
Time
me as ure me nt
Ave rage Cre ationTim
e
Cre ate d Count
Cre ate d Count pe r
Minute
De s troye d Count
De s troye d Count
pe r Minute
Max Cre ation Time
me as ure me nt
me as ure me nt
The ave rage time
s pe nt cre ating a
phys ical conne ction
The cre ate d count
The cre ate d count
me as ure me nt
me as ure me nt
The de s troye d count
The de s troye d count
De s troye dCount
De s troye dCount
me as ure me nt
MaxCre ationTime
Max Us e d Count
me as ure me nt
Max Wait Time
me as ure me nt
Time d Out
Time d Out pe r
Minute
Total Cre ation Time
me as ure me nt
me as ure me nt
The maximum time
for cre ating a
phys ical conne ction
The maximum
numbe r of
conne ctions us e d
The maximum wait
time for a conne ction
The time d out count
The time d out count
TotalCre ationTime
Total Cre ation Time
pe r Minute
me as ure me nt
Total Blocking Time
me as ure me nt
The total time s pe nt
cre ating phys ical
conne ctions
The total time s pe nt
cre ating phys ical
conne ctions
The total blocking
time
The total blocking
time
Conne ction
Available ?
The min pool s iz e
s e tting
The max pool s iz e
s e tting
me as ure me nt
Total Blocking Time
me as ure me nt
pe r Minute
Conne ction
trait
Available ?
Min Pool Siz e s e tting me as ure me nt
Max Pool Siz e
s e tting
me as ure me nt
Cre ate dCount
Cre ate dCount
MaxUs e dCount
MaxWaitTime
Time dOut
Time dOut
TotalCre ationTime
TotalBlockingTime
TotalBlockingTime
conne ctionAvailable
min-pool-s iz e
max-pool-s iz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.326.
Name
Conne ction Prope rty
Descript io n
Required
Int ernal Name
no
*1
437
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Conne ction Url
The JDBC drive r
conne ction URL
Name of the
(e xis ting) JDBC
drive r to us e
The fully qualifie d
name of the JDBC
drive r clas s
Spe cifie s the JNDI
name for the
datas ource
De fine s the JDBC
drive r the
datas ource s hould
us e with this format:
drive rname >#majorve rs ion.minorve rs ion whe re
drive r-name is the
fully qualifie d name
of the JDBC drive r
clas s
Spe cify the
us e rname us e d
whe n cre ating a ne w
conne ction.
Spe cify the
pas s word us e d
whe n cre ating a ne w
conne ction.
Spe cifie s an SQL
s tate me nt to
e xe cute whe ne ve r a
conne ction is adde d
to the conne ction
pool.
Spe cifie s the
de limite r for URLs in
conne ction-url for HA
datas ource s
A clas s that
imple me nts
org.jbos s .jca.adapte r
s .jdbc.URLSe le ctorSt
rate gy
Se tting this to fals e
will bind the
DataSource into
global JNDI;
Spe cifie s if the
datas ource s hould
be e nable d
ye s
conne ction-url
ye s
drive r-name
no
drive r-clas s
ye s
jndi-name
no
drive r
no
us e r-name
no
pas s word
no
ne w-conne ction-s ql
no
url-de limite r
no
url-s e le ctors trate gy-clas s -name
no
us e -java-conte xt
no
e nable d
Drive r Name
Drive r Clas s
Jndi Name
Drive r
Us e r Name
Pas s word
Ne w Conne ction Sql
Url De limite r
Url Se le ctor
Strate gy Clas s
Name
Us e Java Conte xt
Enable d
438
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Jta
Enable JTA
inte gration
The max-pool-s iz e
e le me nt indicate s
the maximum
numbe r of
conne ctions for a
pool. No more
conne ctions will be
cre ate d in e ach s ubpool.
The min-pool-s iz e
e le me nt indicate s
the minimum
numbe r of
conne ctions a pool
s hould hold. The s e
are not cre ate d until
a Subje ct is known
from a re que s t for a
conne ction.
Whe the r to atte mpt
to pre fill the
conne ction pool.
Changing this value
re quire a s e rve r
re s tart.
De fine if the minpool-s iz e s hould be
cons ide re d a s trictly.
Indicate s Subje ct
(from s e curity
domain) are us e d to
dis tinguis h
conne ctions in the
pool. The conte nt of
the s e curity-domain
is the name of the
JAAS s e curity
manage r that will
handle authe ntication
. This name
corre late s to the
JAAS login-config.xml
de s criptor
applicationpolicy/name
attribute .
re -authe ntication
plugin
imple me ntation
provide d for s pe cific
purpos e (i.e ve ndor)
no
jta
no
max-pool-s iz e
no
min-pool-s iz e
no
pool-pre fill
no
pool-us e -s trict-min
no
s e curity-domain
no
re auth-plugin-clas s name
Max Pool Siz e
Min Pool Siz e
Pool Pre fill
Pool Us e Strict Min
Se curity Domain
Re auth Plugin Clas s
Name
439
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Flus h Strate gy
Spe cifie s how the
pool s hould be flus h
in cas e of an e rror.
Spe cifie s if multiple
us e rs will acce s s
the datas ource
through the
ge tConne ction(us e r,
pas s word) me thod
and he nce if the
inte rnal pool type
s hould account for
that
The numbe r of
pre pare d
s tate me nts pe r
conne ction in an LRU
cache
Whe the r to s hare
pre pare s tate me nts ,
i.e . whe the r as king
for s ame s tate me nt
twice without clos ing
us e s the s ame
unde rlying pre pare d
s tate me nt
Whe the r to che ck for
unclos e d
s tate me nts whe n a
conne ction is
re turne d to the pool
and re s ult s e ts are
clos e d whe n a
s tate me nt is
clos e d/re turn to the
pre pare d s tate me nt
cache . valid value s
are : fals e - do not
track s tate me nts
and re s ults true track s tate me nts
and re s ult s e ts and
warn whe n the y are
not clos e d nowarn track s tate me nts but
do no warn about
the m be ing unclos e d
no
flus h-s trate gy
no
allow-multiple -us e rs
no
pre pare ds tate me nts -cache s iz e
no
s hare -pre pare ds tate me nts
no
track-s tate me nts
Allow Multiple Us e rs
Pre pare d
State me nts Cache
Siz e
Share Pre pare d
State me nts
Track State me nts
440
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Allocation Re try
The allocation re try
e le me nt indicate s
the numbe r of time s
that allocating a
conne ction s hould
be trie d be fore
throwing an
e xce ption.
Indicate s the time in
millis e conds to wait
be twe e n re trying to
allocate a
conne ction.
The blockingtime out-millis
e le me nt indicate s
the maximum time
in millis e conds to
block while waiting
for a conne ction
be fore throwing an
e xce ption. Note that
this blocks only
while waiting for a
pe rmit for a
conne ction, and will
ne ve r throw an
e xce ption if cre ating
a ne w conne ction
take s an inordinate ly
long time .
The idle -time outminute s e le me nts
indicate s the
maximum time in
minute s a
conne ction may be
idle be fore be ing
clos e d. The actual
maximum time
de pe nds als o on the
Idle Re move r s can
time , which is 1/2
the s malle s t idle time out-minute s of
any pool. Changing
this value re quire a
s e rve r re s tart.
Any configure d
que ry time out in
s e conds The de fault
is no time out
no
allocation-re try
no
allocation-re try-waitmillis
no
blocking-time outwait-millis
no
idle -time out-minute s
no
que ry-time out
Allocation Re try Wait
Millis
Blocking Time out
Wait Millis
Idle Time out Minute s
Que ry Time out
441
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Us e Try Lock
Any configure d
time out for inte rnal
locks on the
re s ource adapte r
obje cts in s e conds
Whe the r to s e t the
que ry time out bas e d
on the time
re maining until
trans action time out,
any configure d
que ry time out will
be us e d if the re is
no trans action.
Se t
java.s ql.Conne ction
trans action is olation
le ve l to us e . The
cons tants de fine d by
trans action-is olationvalue s are the
pos s ible trans action
is olation le ve ls .
Spe cify an SQL
s tate me nt to che ck
validity of a pool
conne ction. This may
be calle d whe n
manage d conne ction
is take n from pool
for us e .
An
org.jbos s .jca.adapte r
s .jdbc.Exce ptionSort
e r that provide s a
boole an
is Exce ptionFatal(SQL
Exce ption e ) me thod
to validate is an
e xce ption s hould be
broadcas t to all
javax.re s ource .s pi.C
onne ctionEve ntLis te
ne r as a
conne ctionErrorOccu
rre d
no
us e -try-lock
no
s e t-tx-que ry-time out
no
trans action-is olation
no
che ck-validconne ction-s ql
no
e xce ption-s orte rclas s -name
Se t Tx Que ry
Time out
Trans action Is olation
Che ck Valid
Conne ction Sql
Exce ption Sorte r
Clas s Name
442
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Stale Conne ction
Che cke r Clas s
Name
An
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onChe cke r that
provide s a boole an
is Stale Conne ction(S
QLExce ption e )
me thod which if it it
re turns true will
wrap the e xce ption
in an
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onExce ption
An
org.jbos s .jca.adapte r
s .jdbc.ValidConne ctio
nChe cke r that
provide s a
SQLExce ption
is ValidConne ction(Co
nne ction e ) me thod
to validate is a
conne ction is valid.
An e xce ption me ans
the conne ction is
de s troye d. This
ove rride s the che ckvalid-conne ction-s ql
whe n pre s e nt.
The backgroundvalidation-millis
e le me nt s pe cifie s
the amount of time ,
in millis e conds , that
background
validation will run.
Changing this value
re quire a s e rve r
re s tart.
An e le me nt to
s pe cify that
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Changing this
value re quire a
s e rve r re s tart.
no
s tale -conne ctionche cke r-clas s -name
no
valid-conne ctionche cke r-clas s -name
no
backgroundvalidation-millis
no
backgroundvalidation
Valid Conne ction
Che cke r Clas s
Name
Background
Validation Millis
Background
Validation
443
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Us e Fas t Fail
Whe the r fail a
conne ction allocation
on the firs t
conne ction if it is
invalid (true ) or ke e p
trying until the pool
is e xhaus te d of all
pote ntial
conne ctions (fals e )
The validate -onmatch e le me nt
indicate s whe the r or
not conne ction le ve l
validation s hould be
done whe n a
conne ction factory
atte mpts to match a
manage d conne ction
for a give n s e t. This
is typically e xclus ive
to the us e of
background
validation
whate ve r s py or not
the jdbc conne ction
Enable the us e of a
cache d conne ction
manage r
no
us e -fas t-fail
no
validate -on-match
no
s py
no
us e -ccm
Validate On Match
Spy
Us e Ccm
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.327. Met rics
Name
Descript io n
Enable
Dis able
Flus h All Conne ction In Pool
Flus h Idle Conne ction In Pool
Te s t Conne ction In Pool
Enable s the data-s ource
Dis able s the data-s ource
Flus he s the pool for all conne ctions
Flus he s the pool for idle conne ctions
Te s ts if a conne ction can be obtaine d
Package T ypes
none
3.3.5.2. JBoss AS 7 and EAP 6 - XADat aSource (St andalone) Service
444
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Overview
T able 3.328. Overview
De s cription:
Single ton:
Plugin:
An XA data s ource
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.329.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.330 . Met rics
Name
T ype
Descript io n
Int ernal Name
Pre pare d State me nt
Cache Curre nt Siz e
me as ure me nt
Pre pare dState me ntC
ache Curre ntSiz e
Pre pare d State me nt
Cache Mis s Count
me as ure me nt
Pre pare d State me nt
Cache Mis s Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Add Count
me as ure me nt
The numbe r of
pre pare d and
callable s tate me nts
curre ntly cache d in
the s tate me nt cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of
s tate me nts adde d to
the s tate me nt cache
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache AddCount
445
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Pre pare d State me nt
Cache Acce s s Count
me as ure me nt
Pre pare dState me ntC
ache Acce s s Count
Pre pare d State me nt
Cache Acce s s Count
pe r Minute
Pre pare d State me nt
Cache De le te Count
me as ure me nt
Pre pare d State me nt
Cache De le te Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Hit Count
me as ure me nt
Pre pare d State me nt
Cache Hit Count pe r
Minute
me as ure me nt
Active Count
Available Count
Ave rage Blocking
Time
me as ure me nt
me as ure me nt
me as ure me nt
Ave rage Cre ation
Time
me as ure me nt
Cre ate d Count
Cre ate d Count pe r
Minute
De s troye d Count
De s troye d Count
pe r Minute
Max Cre ation Time
me as ure me nt
me as ure me nt
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The active count
The available count
The ave rage time
s pe nt blocking for a
conne ction
The ave rage time
s pe nt cre ating a
phys ical conne ction
The cre ate d count
The cre ate d count
me as ure me nt
me as ure me nt
The de s troye d count
The de s troye d count
De s troye dCount
De s troye dCount
me as ure me nt
MaxCre ationTime
Max Us e d Count
me as ure me nt
Max Wait Time
me as ure me nt
Time d Out
Time d Out pe r
Minute
Total Cre ation Time
me as ure me nt
me as ure me nt
The maximum time
for cre ating a
phys ical conne ction
The maximum
numbe r of
conne ctions us e d
The maximum wait
time for a conne ction
The time d out count
The time d out count
The total time s pe nt
cre ating phys ical
conne ctions
TotalCre ationTime
446
me as ure me nt
me as ure me nt
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache HitCount
Pre pare dState me ntC
ache HitCount
Active Count
Available Count
Ave rage BlockingTim
e
Ave rage Cre ationTim
e
Cre ate dCount
Cre ate dCount
MaxUs e dCount
MaxWaitTime
Time dOut
Time dOut
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Total Cre ation Time
pe r Minute
me as ure me nt
TotalCre ationTime
Total Blocking Time
me as ure me nt
The total time s pe nt
cre ating phys ical
conne ctions
The total blocking
time
The total blocking
time
Conne ction
Available ?
The min pool s iz e
s e tting
The max pool s iz e
s e tting
Total Blocking Time
me as ure me nt
pe r Minute
Conne ction
trait
Available ?
Min Pool Siz e s e tting me as ure me nt
Max Pool Siz e
s e tting
me as ure me nt
TotalBlockingTime
TotalBlockingTime
conne ctionAvailable
min-pool-s iz e
max-pool-s iz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.331.
Name
Prope rtie s
Xa Datas ource
Clas s
Jndi Name
Drive r Name
Us e r Name
Descript io n
Required
Int ernal Name
ye s
ye s
*2
xa-datas ource -clas s
The fully qualifie d
name of the
javax.s ql.XADataSou
rce imple me ntation
Spe cifie s the JNDI
ye s
name for the
datas ource
De fine s the JDBC
ye s
drive r the
datas ource s hould
us e . It is a s ymbolic
name matching the
the name of
ins talle d drive r. In
cas e the drive r is
de ploye d as jar, the
name is the name of
de ployme nt unit
Spe cify the
no
us e rname us e d
whe n cre ating a ne w
conne ction.
jndi-name
drive r-name
us e r-name
447
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Pas s word
Spe cify the
pas s word us e d
whe n cre ating a ne w
conne ction.
Spe cifie s an SQL
s tate me nt to
e xe cute whe ne ve r a
conne ction is adde d
to the conne ction
pool.
Spe cifie s the
de limite r for URLs in
conne ction-url for HA
datas ource s
A clas s that
imple me nts
org.jbos s .jca.adapte r
s .jdbc.URLSe le ctorSt
rate gy
Se tting this to fals e
will bind the
DataSource into
global JNDI;
Spe cifie s if the
datas ource s hould
be e nable d
The max-pool-s iz e
e le me nt indicate s
the maximum
numbe r of
conne ctions for a
pool. No more
conne ctions will be
cre ate d in e ach s ubpool.
The min-pool-s iz e
e le me nt indicate s
the minimum
numbe r of
conne ctions a pool
s hould hold. The s e
are not cre ate d until
a Subje ct is known
from a re que s t for a
conne ction.
Whe the r to atte mpt
to pre fill the
conne ction pool.
Changing this value
re quire a s e rve r
re s tart.
no
pas s word
no
ne w-conne ction-s ql
no
url-de limite r
no
url-s e le ctors trate gy-clas s -name
no
us e -java-conte xt
no
e nable d
no
max-pool-s iz e
no
min-pool-s iz e
no
pool-pre fill
Ne w Conne ction Sql
Url De limite r
Url Se le ctor
Strate gy Clas s
Name
Us e Java Conte xt
Enable d
Max Pool Siz e
Min Pool Siz e
Pool Pre fill
448
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Pool Us e Strict Min
De fine if the minpool-s iz e s hould be
cons ide re d a s trictly.
An e le me nt to
e nable inte rle aving
for XA conne ction
factorie s
Oracle doe s not like
XA conne ctions
ge tting us e d both
ins ide and outs ide a
JTA trans action. To
workaround the
proble m you can
cre ate s e parate
s ub-pools for the
diffe re nt conte xt
Should the Xid be
padde d
The is -s ame -rmove rride e le me nt
allows one to
unconditionally s e t
whe the r the
javax.trans action.xa.
XARe s ource .is Same
RM(XARe s ource )
re turns true or fals e
Should the
XARe s ource
ins tance s be
wrappe d in a
org.jbos s .tm.XARe s o
urce Wrappe r
ins tance
Indicate s Subje ct
(from s e curity
domain) are us e d to
dis tinguis h
conne ctions in the
pool. The conte nt of
the s e curity-domain
is the name of the
JAAS s e curity
manage r that will
handle authe ntication
. This name
corre late s to the
JAAS login-config.xml
de s criptor
applicationpolicy/name
attribute .
no
pool-us e -s trict-min
no
inte rle aving
no
no-tx-s e parate -pool
no
pad-xid
no
s ame -rm-ove rride
no
wrap-xa-datas ource
no
s e curity-domain
Inte rle aving
No Tx Se parate Pool
Pad Xid
Same Rm Ove rride
Wrap Xa Datas ource
Se curity Domain
449
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Re cove ry Plugin
Clas s Name
re cove ry plugin
imple me ntation
provide d for s pe cific
purpos e (i.e ve ndor)
re -authe ntication
plugin
imple me ntation
provide d for s pe cific
purpos e (i.e ve ndor)
Spe cifie s how the
pool s hould be flus h
in cas e of an e rror.
The numbe r of
pre pare d
s tate me nts pe r
conne ction in an LRU
cache
Whe the r to s hare
pre pare s tate me nts ,
i.e . whe the r as king
for s ame s tate me nt
twice without clos ing
us e s the s ame
unde rlying pre pare d
s tate me nt
Whe the r to che ck for
unclos e d
s tate me nts whe n a
conne ction is
re turne d to the pool
and re s ult s e ts are
clos e d whe n a
s tate me nt is
clos e d/re turn to the
pre pare d s tate me nt
cache . valid value s
are : fals e - do not
track s tate me nts
and re s ults true track s tate me nts
and re s ult s e ts and
warn whe n the y are
not clos e d nowarn track s tate me nts but
do no warn about
the m be ing unclos e d
The allocation re try
e le me nt indicate s
the numbe r of time s
that allocating a
conne ction s hould
be trie d be fore
throwing an
e xce ption.
no
re cove ry-pluginclas s -name
no
re auth-plugin-clas s name
no
flus h-s trate gy
no
pre pare ds tate me nts -cache s iz e
no
s hare -pre pare ds tate me nts
no
track-s tate me nts
no
allocation-re try
Re auth Plugin Clas s
Name
Flus h Strate gy
Pre pare d
State me nts Cache
Siz e
Share Pre pare d
State me nts
Track State me nts
Allocation Re try
450
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Allocation Re try Wait
Millis
he allocation re try
wait millis e le me nt
indicate s the time in
millis e conds to wait
be twe e n re trying to
allocate a
conne ction.
The blockingtime out-millis
e le me nt indicate s
the maximum time
in millis e conds to
block while waiting
for a conne ction
be fore throwing an
e xce ption. Note that
this blocks only
while waiting for a
pe rmit for a
conne ction, and will
ne ve r throw an
e xce ption if cre ating
a ne w conne ction
take s an inordinate ly
long time .
The idle -time outminute s e le me nts
indicate s the
maximum time in
minute s a
conne ction may be
idle be fore be ing
clos e d. The actual
maximum time
de pe nds als o on the
Idle Re move r s can
time , which is 1/2
the s malle s t idle time out-minute s of
any pool. Changing
this value re quire a
s e rve r re s tart.
Any configure d
que ry time out in
s e conds The de fault
is no time out
Any configure d
time out for inte rnal
locks on the
re s ource adapte r
obje cts in s e conds
no
allocation-re try-waitmillis
no
blocking-time outwait-millis
no
idle -time out-minute s
no
que ry-time out
no
us e -try-lock
Blocking Time out
Wait Millis
Idle Time out Minute s
Que ry Time out
Us e Try Lock
451
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se t Tx Que ry
Time out
Whe the r to s e t the
que ry time out bas e d
on the time
re maining until
trans action time out,
any configure d
que ry time out will
be us e d if the re is
no trans action.
Se t
java.s ql.Conne ction
trans action is olation
le ve l to us e . The
cons tants de fine d by
trans action-is olationvalue s are the
pos s ible trans action
is olation le ve ls .
Spe cify an SQL
s tate me nt to che ck
validity of a pool
conne ction. This may
be calle d whe n
manage d conne ction
is take n from pool
for us e .
An
org.jbos s .jca.adapte r
s .jdbc.Exce ptionSort
e r that provide s a
boole an
is Exce ptionFatal(SQL
Exce ption e ) me thod
to validate is an
e xce ption s hould be
broadcas t to all
javax.re s ource .s pi.C
onne ctionEve ntLis te
ne r as a
conne ctionErrorOccu
rre d
no
s e t-tx-que ry-time out
no
trans action-is olation
no
che ck-validconne ction-s ql
no
e xce ption-s orte rclas s -name
Trans action Is olation
Che ck Valid
Conne ction Sql
Exce ption Sorte r
Clas s Name
452
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Stale Conne ction
Che cke r Clas s
Name
An
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onChe cke r that
provide s a boole an
is Stale Conne ction(S
QLExce ption e )
me thod which if it it
re turns true will
wrap the e xce ption
in an
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onExce ption
An
org.jbos s .jca.adapte r
s .jdbc.ValidConne ctio
nChe cke r that
provide s a
SQLExce ption
is ValidConne ction(Co
nne ction e ) me thod
to validate is a
conne ction is valid.
An e xce ption me ans
the conne ction is
de s troye d. This
ove rride s the che ckvalid-conne ction-s ql
whe n pre s e nt.
The backgroundvalidation-millis
e le me nt s pe cifie s
the amount of time ,
in millis e conds , that
background
validation will run.
Changing this value
re quire a s e rve r
re s tart.
An e le me nt to
s pe cify that
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Changing this
value re quire a
s e rve r re s tart.
no
s tale -conne ctionche cke r-clas s -name
no
valid-conne ctionche cke r-clas s -name
no
backgroundvalidation-millis
no
backgroundvalidation
Valid Conne ction
Che cke r Clas s
Name
Background
Validation Millis
Background
Validation
453
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Us e Fas t Fail
Whe the r fail a
conne ction allocation
on the firs t
conne ction if it is
invalid (true ) or ke e p
trying until the pool
is e xhaus te d of all
pote ntial
conne ctions (fals e )
The validate -onmatch e le me nt
indicate s whe the r or
not conne ction le ve l
validation s hould be
done whe n a
conne ction factory
atte mpts to match a
manage d conne ction
for a give n s e t. This
is typically e xclus ive
to the us e of
background
validation
Pas s e d to
XARe s ource .s e tTran
s actionTime out()
De fault is z e ro
which doe s not
invoke the s e tte r. In
s e conds
whate ve r s py or not
the jdbc conne ction
Enable the us e of a
cache d conne ction
manage r
us e rname us e d to
try conne ction
re cove ry
pas s word us e d to
try conne ction
re cove ry
s e curity-domain
us e d to try
conne ction re cove ry
if true no re cove ry
are trie d for this
conne ction pool
no
us e -fas t-fail
no
validate -on-match
no
xa-re s ource -time out
no
s py
no
us e -ccm
no
re cove ry-us e rname
no
re cove ry-pas s word
no
re cove ry-s e curitydomain
no
no-re cove ry
Validate On Match
Xa Re s ource
Time out
Spy
Us e Ccm
Re cove ry Us e rname
Re cove ry Pas s word
Re cove ry Se curity
Domain
No Re cove ry
454
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.332. Met rics
Name
Descript io n
Enable
Dis able
Flus h All Conne ction In Pool
Flus h Idle Conne ction In Pool
Te s t Conne ction In Pool
Enable s the data-s ource
Dis able s the data-s ource
Flus he s the pool for all conne ctions
Flus he s the pool for idle conne ctions
Te s ts if a conne ction can be obtaine d
Package T ypes
none
3.3.6. JBoss AS 7 and EAP 6 - Logging Service
Overview
T able 3.333. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.6.1, “JBos s AS 7 and EAP 6 - As ync Handle r Se rvice ”
Se ction 3.3.6.2, “JBos s AS 7 and EAP 6 - Cons ole Handle r Se rvice ”
Se ction 3.3.6.3, “JBos s AS 7 and EAP 6 - Cus tom Handle r Se rvice ”
Se ction 3.3.6.4, “JBos s AS 7 and EAP 6 - File Handle r Se rvice ”
Se ction 3.3.6.5, “JBos s AS 7 and EAP 6 - Logge r Se rvice ”
Se ction 3.3.6.6, “JBos s AS 7 and EAP 6 - Pe riodic Rotating File Handle r Se rvice ”
Se ction 3.3.6.7, “JBos s AS 7 and EAP 6 - Siz e Rotating File Handle r Se rvice ”
Connect ion Propert ies
T able 3.334.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
455
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.335.
Name
Descript io n
Required
Int ernal Name
Le ve l
The log le ve l
s pe cifying which
me s s age le ve ls will
be logge d by this .
Me s s age le ve ls
lowe r than this value
will be dis carde d.
The Handle rs
as s ociate d with this
Logge r.
no
le ve l
ye s
handle rs
Handle rs
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.6.1. JBoss AS 7 and EAP 6 - Async Handler Service
Overview
T able 3.336. Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
456
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
Co nnect io n Pro pert ies
T able 3.337.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.338.
Name
Descript io n
Required
Int ernal Name
Formatte r
De fine s a formatte r.
The de fault value is
%d{HH:mm:s s ,SSS}
%-5p [%c] (%t)
%s %E%n.
The log le ve l
s pe cifying which
me s s age le ve ls will
be logge d by this .
Me s s age le ve ls
lowe r than this value
will be dis carde d.
Spe cify what action
to take whe n the
ove rflowing. The
valid options are
'block' and 'dis card'.
The de fault value is
BLOCK.
The que ue le ngth to
us e be fore flus hing
writing
The Handle rs
as s ociate d with this
as ync handle r.
no
formatte r
no
le ve l
ye s
ove rflow-action
ye s
que ue -le ngth
no
s ubhandle rs
Le ve l
Ove rflow Action
Que ue Le ngth
Subhandle rs
457
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.339. Met rics
Name
Descript io n
As s ign Subhandle r
Dis able
Enable
Unas s ign Subhandle r
As s ign a s ubhandle r to the ASYNC handle r.
Dis able a logging handle r.
Enable a logging handle r.
Unas s ign a s ubhandle r from the ASYNC
handle r.
Package T ypes
none
3.3.6.2. JBoss AS 7 and EAP 6 - Console Handler Service
Overview
T able 3.340 . Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.341.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
458
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Co nf igurat io n Pro pert ies
T able 3.342.
Name
Descript io n
Required
Int ernal Name
Autoflus h
Automatically flus h
afte r e ach write . The
de fault value is true .
The characte r
e ncoding us e d by
this Handle r.
De fine s a formatte r.
The de fault value is
%d{HH:mm:s s ,SSS}
%-5p [%c] (%t)
%s %E%n.
The log le ve l
s pe cifying which
me s s age le ve ls will
be logge d by this .
Me s s age le ve ls
lowe r than this value
will be dis carde d.
De fine s the targe t
of the cons ole
handle r. The value
can e ithe r be
SYSTEM_OUT or
SYSTEM_ERR. The
de fault value is
Sys te m.out.
no
autoflus h
no
e ncoding
no
formatte r
no
le ve l
no
targe t
Encoding
Formatte r
Le ve l
Targe t
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.343. Met rics
Name
Descript io n
Dis able
Enable
Dis able a logging handle r.
Enable a logging handle r.
Package T ypes
none
3.3.6.3. JBoss AS 7 and EAP 6 - Cust om Handler Service
459
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Overview
T able 3.344. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.345.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.346.
Name
Descript io n
Required
Int ernal Name
Clas s
The logging handle r
clas s to be us e d.
The characte r
e ncoding us e d by
this Handle r.
De fine s a formatte r.
The de fault value is
%d{HH:mm:s s ,SSS}
%-5p [%c] (%t)
%s %E%n.
The log le ve l
s pe cifying which
me s s age le ve ls will
be logge d by this .
Me s s age le ve ls
lowe r than this value
will be dis carde d.
ye s
clas s
no
e ncoding
no
formatte r
no
le ve l
Encoding
Formatte r
Le ve l
460
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Module
The module that the
logging handle r
de pe nds on.
ye s
module
ye s
prope rtie s
Prope rtie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.347. Met rics
Name
Descript io n
Dis able
Enable
Dis able a logging handle r.
Enable a logging handle r.
Package T ypes
none
3.3.6.4. JBoss AS 7 and EAP 6 - File Handler Service
Overview
T able 3.348. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.349.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
461
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.350 .
Name
Descript io n
Required
Int ernal Name
Appe nd
Spe cify whe the r to
appe nd to the targe t
file . The de fault
value is true .
Automatically flus h
afte r e ach write . The
de fault value is true .
The characte r
e ncoding us e d by
this Handle r.
The file de s cription
cons is ting of the
path and optional
re lative to path.
De fine s a formatte r.
The de fault value is
%d{HH:mm:s s ,SSS}
%-5p [%c] (%t)
%s %E%n.
The log le ve l
s pe cifying which
me s s age le ve ls will
be logge d by this .
Me s s age le ve ls
lowe r than this value
will be dis carde d.
no
appe nd
no
autoflus h
no
e ncoding
no
file
no
formatte r
no
le ve l
Autoflus h
Encoding
File
Formatte r
Le ve l
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.351. Met rics
Name
Descript io n
Dis able
Enable
Dis able a logging handle r.
Enable a logging handle r.
Package T ypes
none
462
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
3.3.6.5. JBoss AS 7 and EAP 6 - Logger Service
Overview
T able 3.352. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.353.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.354.
Name
Descript io n
Handle rs
The Handle rs
no
as s ociate d with this
Logge r.
The log le ve l
no
s pe cifying which
me s s age le ve ls will
be logge d by this .
Me s s age le ve ls
lowe r than this value
will be dis carde d.
Spe cifie s whe the r or no
not this logge r
s hould s e nd its
output to it's pare nt
Logge r. The de fault
value is true .
Le ve l
Us e Pare nt Handle rs
Required
Int ernal Name
handle rs
le ve l
us e -pare nt-handle rs
463
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.355. Met rics
Name
Descript io n
Change Log Le ve l
Change the logging le ve l for a logge r
cate gory.
Package T ypes
none
3.3.6.6. JBoss AS 7 and EAP 6 - Periodic Rot at ing File Handler Service
Overview
T able 3.356. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.357.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
464
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.358.
Name
Descript io n
Required
Int ernal Name
Appe nd
Spe cify whe the r to
appe nd to the targe t
file . The de fault
value is true .
Automatically flus h
afte r e ach write . The
de fault value is true .
The characte r
e ncoding us e d by
this Handle r.
The file de s cription
cons is ting of the
path and optional
re lative to path.
De fine s a formatte r.
The de fault value is
%d{HH:mm:s s ,SSS}
%-5p [%c] (%t)
%s %E%n.
The log le ve l
s pe cifying which
me s s age le ve ls will
be logge d by this .
Me s s age le ve ls
lowe r than this value
will be dis carde d.
Se t the s uffix s tring.
The s tring is in a
format which can be
unde rs tood by
java.te xt.Simple Date
Format. The pe riod
of the rotation is
automatically
calculate d bas e d on
the s uffix.
no
appe nd
no
autoflus h
no
e ncoding
no
file
no
formatte r
no
le ve l
ye s
s uffix
Autoflus h
Encoding
File
Formatte r
Le ve l
Suffix
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.359. Met rics
Name
Descript io n
Dis able
Enable
Dis able a logging handle r.
Enable a logging handle r.
465
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Package T ypes
none
3.3.6.7. JBoss AS 7 and EAP 6 - Size Rot at ing File Handler Service
Overview
T able 3.360 . Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.361.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.362.
Name
Descript io n
Appe nd
Spe cify whe the r to
no
appe nd to the targe t
file . The de fault
value is true .
Automatically flus h
no
afte r e ach write . The
de fault value is true .
The characte r
no
e ncoding us e d by
this Handle r.
Autoflus h
Encoding
466
Required
Int ernal Name
appe nd
autoflus h
e ncoding
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
File
The file de s cription
cons is ting of the
path and optional
re lative to path.
De fine s a formatte r.
The de fault value is
%d{HH:mm:s s ,SSS}
%-5p [%c] (%t)
%s %E%n.
The log le ve l
s pe cifying which
me s s age le ve ls will
be logge d by this .
Me s s age le ve ls
lowe r than this value
will be dis carde d.
The maximum
numbe r of backups
to ke e p. The de fault
value is 1.
The s iz e at which to
rotate the log file .
The de fault value is
2m.
no
file
no
formatte r
no
le ve l
ye s
max-backup-inde x
ye s
rotate -s iz e
Formatte r
Le ve l
Max Backup Inde x
Rotate Siz e
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.363. Met rics
Name
Descript io n
Dis able
Enable
Dis able a logging handle r.
Enable a logging handle r.
Package T ypes
none
3.3.7. JBoss AS 7 and EAP 6 - Webservices Service
Overview
T able 3.364. Overview
De s cription:
Single ton:
ye s
467
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Plugin:
JBos s AS7
Child Resource T ypes
Se ction 3.3.7.1, “JBos s AS 7 and EAP 6 - Endpoint Se rvice ”
Connect ion Propert ies
T able 3.365.
Name
Descript io n
Path
Manage d Runtime
Required
Int ernal Name
ye s
ye s
path
manage dRuntime
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.366.
Name
Descript io n
Required
Int ernal Name
Modify Ws dl
Addre s s
Whe the r the s oap
addre s s can be
modifie d.
no
modify-ws dl-addre s s
468
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Ws dl Hos t
The WSDL, that is a
no
re quire d
de ployme nt artifact
for an e ndpoint, has
a <s oap:addre s s >
e le me nt which
points to the location
of the e ndpoint.
JBos s s upports
re writing of that
SOAP addre s s . If the
conte nt of
<s oap:addre s s > is a
valid URL, JBos s WS
will not re write it
unle s s 'modify-ws dladdre s s ' is true . If
the conte nt of
<s oap:addre s s > is
not a valid URL,
JBos s WS will re write
it us ing the attribute
value s give n be low.
If 'ws dl-hos t' is s e t
to
'jbos s ws .unde fine d.h
os t', JBos s WS us e s
re que s te rs hos t
whe n re writing the
<s oap:addre s s >
The non-s e cure port no
that will be us e d for
re writing the SOAP
addre s s . If abs e nt
the port will be
ide ntifie d by
que rying the lis t of
ins talle d conne ctors .
The s e cure port that no
will be us e d for
re writing the SOAP
addre s s . If abs e nt
the port will be
ide ntifie d by
que rying the lis t of
ins talle d conne ctors .
Ws dl Port
Ws dl Se cure Port
Required
Int ernal Name
ws dl-hos t
ws dl-port
ws dl-s e cure -port
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
469
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Operat ions
none
Package T ypes
none
3.3.7.1. JBoss AS 7 and EAP 6 - Endpoint Service
Overview
T able 3.367. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.7.1.1, “JBos s AS 7 and EAP 6 - Pos t Handle r Chain Se rvice ”
Se ction 3.3.7.1.2, “JBos s AS 7 and EAP 6 - Pre Handle r Chain Se rvice ”
Se ction 3.3.7.1.3, “JBos s AS 7 and EAP 6 - Prope rty Se rvice ”
Co nnect io n Pro pert ies
T able 3.368.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
470
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
3.3.7.1.1. JBo ss AS 7 and EAP 6 - Po st Handler Chain Service
Overview
T able 3.369. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.7.1.1.1, “JBos s AS 7 and EAP 6 - Pos t Handle r Se rvice ”
Co nnect io n Pro pert ies
T able 3.370 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.371.
Name
Descript io n
Required
Int ernal Name
Protocol Bindings
Protocol binding
no
protocol-bindings
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
471
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
3.3.7.1.1.1. JBo ss AS 7 and EAP 6 - Po st Handler Service
Ove rvie w
T able 3.372. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.373.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.374.
Name
Descript io n
Required
Int ernal Name
Clas s
Handle r clas s
ye s
clas s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.7.1.2. JBo ss AS 7 and EAP 6 - Pre Handler Chain Service
Overview
472
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.375. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.7.1.2.1, “JBos s AS 7 and EAP 6 - Pre Handle r Se rvice ”
Co nnect io n Pro pert ies
T able 3.376.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.377.
Name
Descript io n
Required
Int ernal Name
Protocol Bindings
Protocol binding
no
protocol-bindings
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.7.1.2.1. JBo ss AS 7 and EAP 6 - Pre Handler Service
Ove rvie w
473
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.378. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.379.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.380 .
Name
Descript io n
Required
Int ernal Name
Clas s
Handle r clas s
ye s
clas s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.7.1.3. JBo ss AS 7 and EAP 6 - Pro pert y Service
Overview
T able 3.381. Overview
De s cription:
474
A prope rty
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.382.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.383.
Name
Descript io n
Required
Int ernal Name
Value
The prope rty value .
no
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.8. JBoss AS 7 and EAP 6 - Naming Service
Overview
T able 3.384. Overview
475
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.8.1, “JBos s AS 7 and EAP 6 - Binding Se rvice ”
Connect ion Propert ies
T able 3.385.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
T able 3.386. Met rics
Name
Descript io n
JNDIVie w
Pe e k at the JNDI tre e
Package T ypes
none
3.3.8.1. JBoss AS 7 and EAP 6 - Binding Service
Overview
T able 3.387. Overview
De s cription:
Single ton:
Plugin:
476
JNDI bindings for primitive type s
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.388.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.389.
Name
Descript io n
Required
Int ernal Name
Binding Type
The type of binding
to cre ate , may be
s imple , lookup or
obje ct-factory
The obje ct factory
clas s name for
obje ct factory
bindings
The e ntry to lookup
in JNDI for lookup
bindings
The module to load
the obje ct factory
from for obje ct
factory bindings
The type of the
value to bind for
s imple bindings , this
mus t be a primitive
type
The value to bind for
s imple bindings
ye s
binding-type
no
clas s
no
lookup
no
module
no
type
no
value
Clas s
Lookup
Module
Type
Value
477
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.9. JBoss AS 7 and EAP 6 - T ransact ions Subsyst em (St andalone)
Service
Overview
T able 3.390 . Overview
De s cription:
Single ton:
Plugin:
The trans actions s ubs ys te m.
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.9.1, “JBos s AS 7 and EAP 6 - Log Store (Standalone ) Se rvice ”
Connect ion Propert ies
T able 3.391.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.392. Met rics
Name
T ype
Descript io n
Numbe r Of Ne s te d
Trans actions
me as ure me nt
The total numbe r of
numbe r-of-ne s te dne s te d (s ub)
trans actions
trans actions cre ate d.
478
Int ernal Name
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Numbe r Of Ne s te d
Trans actions pe r
Minute
Numbe r Of Time d
Out Trans actions
me as ure me nt
numbe r-of-ne s te dtrans actions
Numbe r Of Time d
Out Trans actions
pe r Minute
me as ure me nt
Numbe r Of
Committe d
Trans actions
Numbe r Of
Committe d
Trans actions pe r
Minute
Numbe r Of
Trans actions
me as ure me nt
The total numbe r of
ne s te d (s ub)
trans actions cre ate d.
The numbe r of
trans actions that
have rolle d back due
to time out.
The numbe r of
trans actions that
have rolle d back due
to time out.
The numbe r of
committe d
trans actions .
The numbe r of
committe d
trans actions .
numbe r-oftrans actions
Numbe r Of
Trans actions pe r
Minute
me as ure me nt
Numbe r Of
He uris tics
me as ure me nt
Numbe r Of
He uris tics pe r
Minute
me as ure me nt
Numbe r Of Aborte d
Trans actions
me as ure me nt
Numbe r Of Aborte d
Trans actions pe r
Minute
me as ure me nt
Numbe r Of Inflight
Trans actions
me as ure me nt
Numbe r Of Inflight
Trans actions pe r
Minute
me as ure me nt
The total numbe r of
trans actions (tople ve l and ne s te d)
cre ate d
The total numbe r of
trans actions (tople ve l and ne s te d)
cre ate d
The numbe r of
trans actions which
have te rminate d
with he uris tic
outcome s .
The numbe r of
trans actions which
have te rminate d
with he uris tic
outcome s .
The numbe r of
aborte d (i.e .
rolle dback)
trans actions .
The numbe r of
aborte d (i.e .
rolle dback)
trans actions .
The numbe r of
trans actions that
have be gun but not
ye t te rminate d.
The numbe r of
trans actions that
have be gun but not
ye t te rminate d.
me as ure me nt
me as ure me nt
me as ure me nt
numbe r-of-time d-outtrans actions
numbe r-of-time d-outtrans actions
numbe r-ofcommitte dtrans actions
numbe r-ofcommitte dtrans actions
numbe r-oftrans actions
numbe r-of-he uris tics
numbe r-of-he uris tics
numbe r-of-aborte dtrans actions
numbe r-of-aborte dtrans actions
numbe r-of-inflighttrans actions
numbe r-of-inflighttrans actions
479
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Numbe r Of
Application Rollbacks
me as ure me nt
numbe r-ofapplication-rollbacks
Numbe r Of
Application Rollbacks
pe r Minute
me as ure me nt
Numbe r Of
Re s ource Rollbacks
me as ure me nt
Numbe r Of
Re s ource Rollbacks
pe r Minute
me as ure me nt
The numbe r of
trans actions that
have be e n rolle d
back by application
re que s t. This
include s thos e that
time out, s ince the
time out be haviour is
cons ide re d an
attribute of the
application
configuration.
The numbe r of
trans actions that
have be e n rolle d
back by application
re que s t. This
include s thos e that
time out, s ince the
time out be haviour is
cons ide re d an
attribute of the
application
configuration.
The numbe r of
trans actions that
rolle d back due to
re s ource
(participant) failure .
The numbe r of
trans actions that
rolle d back due to
re s ource
(participant) failure .
numbe r-ofapplication-rollbacks
numbe r-of-re s ource rollbacks
numbe r-of-re s ource rollbacks
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.393.
Name
480
Descript io n
Required
Int ernal Name
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Re lative To
Re fe re nce s a global
path configuration in
the domain mode l,
de faulting to the
JBos s Application
Se rve r data
dire ctory
(jbos s .s e rve r.data.di
r). The value of the
'path' attribute will
tre ate d as re lative
to this path. Us e an
e mpty s tring to
dis able the de fault
be havior and force
the value of the
'path' attribute to be
tre ate d as an
abs olute path. The
de fault value is
jbos s .s e rve r.data.dir
.
Indicate s whe the r
the trans action
manage r s hould us e
a UUID bas e d
proce s s id.
Us e d to re fe re nce
the corre ct s ocke t
binding to us e for
the re cove ry
e nvironme nt.
If true this e nable s
the Java Trans action
Se rvice . The de fault
value is fals e .
De note s a re lative
or abs olute
file s ys te m path
de noting whe re the
trans action manage r
obje ct s tore s hould
s tore data. By
de fault the value is
tre ate d as re lative
to the path de note d
by the 're lative -to'
attribute . The de fault
value is tx-obje cts tore .
no
re lative -to
no
proce s s -id-uuid
no
s ocke t-binding
no
jts
no
obje ct-s tore -path
Proce s s Id Uuid
Socke t Binding
Jts
Obje ct Store Path
481
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Path
De note s a re lative
or abs olute
file s ys te m path
de noting whe re the
trans action manage r
core s hould s tore
data. By de fault the
value is tre ate d as
re lative to the path
de note d by the
're lative -to' attribute .
The de fault value is
var.
The name of the
s ocke t binding
configuration to us e
if the trans action
manage r s hould us e
a s ocke t-bas e d
proce s s id. Will be
'unde fine d' if
'proce s s -id-uuid' is
'true '; othe rwis e
mus t be s e t.
The de fault time out.
The de fault value is
300.
The maximum
numbe r of ports to
s e arch for an ope n
port if the
trans action manage r
s hould us e a s ocke tbas e d proce s s id. If
the port s pe cifie d by
the s ocke t binding
re fe re nce d in
'proce s s -id-s ocke tbinding' is occupie d,
the ne xt highe r port
will be trie d until an
ope n port is found or
the numbe r of ports
s pe cifie d by this
attribute have be e n
trie d. Will be
'unde fine d' if
'proce s s -id-uuid' is
'true '. The de fault
value is 10.
no
path
no
proce s s -id-s ocke tbinding
no
de fault-time out
no
proce s s -id-s ocke tmax-ports
Proce s s Id Socke t
Binding
De fault Time out
Proce s s Id Socke t
Max Ports
482
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Re cove ry Lis te ne r
Us e d to s pe cify if
the re cove ry
s ys te m s hould lis te n
on a ne twork s ocke t
or not. The de fault
value is fals e .
Us e d to re fe re nce
the corre ct s ocke t
binding to us e for
the trans action
s tatus manage r.
Us e d to s e t the
node ide ntifie r on
the core
e nvironme nt. The
de fault value is 1.
Whe the r the
trans action s tatus
manage r (TSM)
s e rvice , ne e de d for
out of proce s s
re cove ry, s hould be
provide d or not. The
de fault value is
fals e .
Re fe re nce s a global
path configuration in
the domain mode l,
de faulting to the
JBos s Application
Se rve r data
dire ctory
(jbos s .s e rve r.data.di
r). The value of the
'path' attribute will
tre ate d as re lative
to this path. Us e an
e mpty s tring to
dis able the de fault
be havior and force
the value of the
'path' attribute to be
tre ate d as an
abs olute path. The
de fault value is
jbos s .s e rve r.data.dir
.
Whe the r s tatis tics
s hould be e nable d.
The de fault value is
fals e .
no
re cove ry-lis te ne r
no
s tatus -s ocke t-binding
no
node -ide ntifie r
no
e nable -ts m-s tatus
no
obje ct-s tore -re lative to
no
e nable -s tatis tics
Status Socke t
Binding
Node Ide ntifie r
Enable Ts m Status
Obje ct Store
Re lative To
Enable Statis tics
483
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.9.1. JBoss AS 7 and EAP 6 - Log St ore (St andalone) Service
Overview
T able 3.394. Overview
De s cription:
Re pre s e ntation of the trans action logging
s torage me chanis m.
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
Se ction 3.3.9.1.1, “JBos s AS 7 and EAP 6 - Trans actions (Standalone ) Se rvice ”
Co nnect io n Pro pert ies
T able 3.395.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.396.
484
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Type
Spe cifie s the
imple me ntation type
of the logging s tore .
no
type
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.397. Met rics
Name
Descript io n
Probe
Scan for ne w trans action logs . This
ope ration will cre ate s a child for e ach
pe nding trans action.
Package T ypes
none
3.3.9.1.1. JBo ss AS 7 and EAP 6 - T ransact io ns (St andalo ne) Service
Overview
T able 3.398. Overview
De s cription:
Single ton:
Plugin:
The pe rs is te nt information that the
trans action manage r s tore s for the
purpos e of re cove ring a trans action in the
e ve nt of failure . The probe ope ration will
add and re move trans actions from the
mode l as the corre s ponding re al
trans actions s tart and finis h the pre pare
and commit phas e s . A s tuck trans action will
re main in the mode l until e ithe r it is
comple te d or e xplicitly re move d by the
de le te ope ration.
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.9.1.1.1, “JBos s AS 7 and EAP 6 - Participants (Standalone ) Se rvice ”
Co nnect io n Pro pert ies
T able 3.399.
485
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Include Runtime
Required
Int ernal Name
ye s
ye s
path
include Runtime
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.40 0 .
Name
Descript io n
Required
Int ernal Name
Age In Se conds
The time s ince this
trans action was
pre pare d or whe n
the re cove ry
s ys te m las t trie d to
re cove r it.
The id of this
trans action.
The JMX name of
this trans action.
The type name
unde r which this
re cord is s tore d.
no
age -in-s e conds
no
id
no
jmx-name
no
type
Id
Jmx Name
Type
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.40 1. Met rics
Name
486
Descript io n
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
De le te
Re move this trans action log. WARNING afte r
this ope ration the trans action manage r will
have no knowle dge of the trans action and
will the re fore ne ve r be able to re cove r it. If
you are s ure that the trans action is
comple te the n the ope ration is s afe . The
re pre s e ntation of the trans action log is
re move d from the mode l too.
Package T ypes
none
3.3.9.1.1.1. JBo ss AS 7 and EAP 6 - Part icipant s (St andalo ne) Service
Ove rvie w
T able 3.40 2. Overview
De s cription:
The re s ource s that did work in a
trans action.
no
JBos s AS7
Single ton:
Plugin:
Child Re s ource Type s
none
Conne ction Prope rtie s
T able 3.40 3.
Name
Descript io n
Path
Include Runtime
Required
Int ernal Name
ye s
ye s
path
include Runtime
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.40 4.
Name
Descript io n
Required
Int ernal Name
487
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Eis Product Name
The JCA e nte rpris e
information
s ys te m's product
name .
The JCA e nte rpris e
information
s ys te m's product
ve rs ion
The JMX name of
this participant.
JNDI name of this
participant.
Re ports the
commitme nt s tatus
of this participant
(can be one of
Pe nding, Pre pare d,
Faile d, He uris tic or
Re adonly).
The type name
unde r which this
re cord is s tore d.
no
e is -product-name
no
e is -product-ve rs ion
no
jmx-name
no
jndi-name
no
s tatus
no
type
Eis Product Ve rs ion
Jmx Name
Jndi Name
Status
Type
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
T able 3.40 5. Met rics
Name
Descript io n
Re cove r
If this re cord is in a he uris tic s tate the n
atte mpt to re play the commit phas e of the
2PC trans action.
Re fre s h the manage me nt vie w of the
attribute s of this participant re cord by
que rying the trans action log. (Note that the
re ad-re s ource ope raton only re ads the
mode l, he nce the ne e d for this re fre s h
ope ration).
Re fre s h
Package Type s
none
3.3.10. JBoss AS 7 and EAP 6 - Net work Int erf ace Service
Overview
488
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.40 6. Overview
De s cription:
A name d ne twork inte rface , along with
re quire d crite ria for de te rmining the IP
addre s s to as s ociate with that inte rface
no
JBos s AS7
Single ton:
Plugin:
Child Resource T ypes
none
Connect ion Propert ies
T able 3.40 7.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.40 8.
Name
Descript io n
Required
Int ernal Name
489
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Any Addre s s
Attribute indicating
that s ocke ts us ing
this inte rface s hould
be bound to a
wildcard addre s s .
The IPv6 wildcard
addre s s (::) will be
us e d unle s s the
java.ne t.pre fe rIpV4S
tack s ys te m
prope rty is s e t to
true , in which cas e
the IPv4 wildcard
addre s s (0.0.0.0)
will be us e d. If a
s ocke t is bound to
an IPv6 anylocal
addre s s on a duals tack machine , it can
acce pt both IPv6 and
IPv4 traffic; if it is
bound to an IPv4
(IPv4-mappe d)
anylocal addre s s , it
can only acce pt IPv4
traffic.
Attribute indicating
that s ocke ts us ing
this inte rface s hould
be bound to the IPv4
wildcard addre s s
(0.0.0.0).
Attribute indicating
that s ocke ts us ing
this inte rface s hould
be bound to the IPv6
wildcard addre s s (::).
Attribute indicating
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r or not the
addre s s is link-local.
An 'unde fine d' or
'fals e ' value me ans
this attribute is not
re le vant to the IP
addre s s s e le ction.
no
any-addre s s
no
any-ipv4-addre s s
no
any-ipv6-addre s s
no
link-local-addre s s
Any Ipv 4 Addre s s
Any Ipv 6 Addre s s
Link Local Addre s s
490
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Loopback
Attribute indicating
no
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r or not it is a
loopback addre s s .
An 'unde fine d' or
'fals e ' value me ans
this attribute is not
re le vant to the IP
addre s s s e le ction.
Attribute indicating
no
that the IP addre s s
for this inte rface
s hould be the give n
value , if a loopback
inte rface e xis ts on
the machine . A
'loopback addre s s '
may not actually be
configure d on the
machine 's loopback
inte rface . Diffe rs
from ine t-addre s s in
that the give n value
will be us e d e ve n if
no NIC can be found
that has the IP
s pe cifie d addre s s
as s ociate d with it.
An 'unde fine d' or
'fals e ' value me ans
this attribute is not
re le vant to the IP
addre s s s e le ction.
Attribute indicating
no
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r or not its
ne twork inte rface
s upports multicas t.
An 'unde fine d' or
'fals e ' value me ans
this attribute is not
re le vant to the IP
addre s s s e le ction.
Loopback Addre s s
Multicas t
Required
Int ernal Name
loopback
loopback-addre s s
multicas t
491
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Nic
Attribute indicating
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r its ne twork
inte rface has the
give n name . The
name of a ne twork
inte rface (e .g. e th0,
e th1, lo). An
'unde fine d' value
me ans this attribute
is not re le vant to
the IP addre s s
s e le ction.
Attribute indicating
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r its ne twork
inte rface has a
name that matche s
the give n re gular
e xpre s s ion. Value is
a re gular
e xpre s s ion agains t
which the name s of
the ne twork
inte rface s available
on the machine can
be matche d to find
an acce ptable
inte rface . An
'unde fine d' value
me ans this attribute
is not re le vant to
the IP addre s s
s e le ction.
no
nic
no
nic-match
Nic Match
492
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Point To Point
Attribute indicating
no
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r or not its
ne twork inte rface is
a point-to-point
inte rface . An
'unde fine d' or 'fals e '
value me ans this
attribute is not
re le vant to the IP
addre s s s e le ction
Attribute indicating
no
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r or not it is a
publicly routable
addre s s . An
'unde fine d' or 'fals e '
value me ans this
attribute is not
re le vant to the IP
addre s s s e le ction
Attribute indicating
no
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r or it is a
s ite -local addre s s .
An 'unde fine d' or
'fals e ' value me ans
this attribute is not
re le vant to the IP
addre s s s e le ction
Public Addre s s
Site Local Addre s s
Required
Int ernal Name
point-to-point
public-addre s s
s ite -local-addre s s
493
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Subne t Match
Attribute indicating
no
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r or it the
addre s s fits in the
give n s ubne t
de finition. Value is a
ne twork IP addre s s
and the numbe r of
bits in the addre s s '
ne twork pre fix,
writte n in 's las h
notation'; e .g.
'192.168.0.0/16'. An
'unde fine d' value
me ans this attribute
is not re le vant to
the IP addre s s
s e le ction.
Attribute indicating
no
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r its ne twork
inte rface is curre ntly
up. An 'unde fine d' or
'fals e ' value me ans
this attribute is not
re le vant to the IP
addre s s s e le ction
Attribute indicating
no
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r its ne twork
inte rface is a virtual
inte rface . An
'unde fine d' or 'fals e '
value me ans this
attribute is not
re le vant to the IP
addre s s s e le ction
Up
Virtual
494
Required
Int ernal Name
s ubne t-match
up
virtual
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Ine t Addre s s
Attribute indicating
that part of the
s e le ction crite ria for
choos ing an IP
addre s s for this
inte rface s hould be
whe the r or not the
addre s s matche s
the give n value .
Value is e ithe r a IP
addre s s in IPv6 or
IPv4 dotte d de cimal
notation, or a
hos tname that can
be re s olve d to an IP
addre s s . An
'unde fine d' value
me ans this attribute
is not re le vant to
the IP addre s s
s e le ction.
no
ine t-addre s s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.11. JBoss AS 7 and EAP 6 - Socket BindingGroup Service
Overview
T able 3.40 9. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Resource T ypes
none
Connect ion Propert ies
495
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.410 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.411.
Name
Descript io n
Bindings
Bindings
Bindings
De fault Inte rface
Port Offs e t
Required
Int ernal Name
ye s
ye s
ye s
ye s
*
*1
*2
de fault-inte rface
De fault Inte rface for
the s e bindings . Se e
Ne twork Inte rface s
for its de finition
Offs e t from s tandard no
ports for this group.
This is only available
in s tandalone mode
port-offs e t
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.12. JBoss AS 7 and EAP 6 - Deployment Service
Overview
496
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.412. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Resource T ypes
Se ction 3.3.12.1, “JBos s AS 7 and EAP 6 - We bs e rvice s Runtime Se rvice ”
Se ction 3.3.12.2, “JBos s AS 7 and EAP 6 - We b Runtime Se rvice ”
Se ction 3.3.12.3, “JBos s AS 7 and EAP 6 - Me s s aging Runtime Se rvice ”
Se ction 3.3.12.4, “JBos s AS 7 and EAP 6 - Subde ployme nt Se rvice ”
Se ction 3.3.12.5, “JBos s AS 7 and EAP 6 - JPA Runtime Se rvice ”
Se ction 3.3.12.6, “JBos s AS 7 and EAP 6 - Datas ource s Runtime Se rvice ”
Se ction 3.3.12.7, “JBos s AS 7 and EAP 6 - EJB3 Runtime Se rvice ”
Se ction 3.3.12.8, “JBos s AS 7 and EAP 6 - Re s ource Adapte rs Runtime Se rvice ”
Connect ion Propert ies
T able 3.413.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.414. Met rics
Name
T ype
Descript io n
Int ernal Name
497
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Status
trait
The curre nt runtime
s tatus of a
de ployme nt.
Pos s ible s tatus
mode s are OK,
FAILED, and
STOPPED. FAILED
indicate s a
de pe nde ncy is
mis s ing or a s e rvice
could not s tart.
STOPPED indicate s
that the de ployme nt
was manually
s toppe d.
s tatus
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.415.
Name
Descript io n
Required
Int ernal Name
Conte nt
Lis t of pie ce s of
conte nt that
compris e the
de ployme nt.
Boole an indicating
whe the r the
de ployme nt conte nt
is curre ntly
de ploye d in the
runtime (or s hould
be de ploye d in the
runtime the ne xt
time the s e rve r
s tarts .)
Unique ide ntifie r of
the de ployme nt.
Mus t be unique
acros s all
de ployme nts .
ye s
conte nt
no
e nable d
no
name
Enable d
Name
498
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Pe rs is te nt
Boole an indicating
whe the r the
e xis te nce of the
de ployme nt s hould
be re corde d in the
pe rs is te nt s e rve r
configuration. Only
re le vant to a
s tandalone mode
s e rve r. De fault is
'true '. A de ployme nt
manage d by a
de ployme nt s canne r
would have this s e t
to 'fals e ' to e ns ure
the de ployme nt is
only de ploye d at
s e rve r s tart if the
s canne r again
de te cts the
de ployme nt.
Name by which the
de ployme nt s hould
be known within a
s e rve r runtime . This
would be e quivale nt
to the file name of a
de ployme nt file , and
would form the bas is
for s uch things as
de fault Java
Ente rpris e Edition
application and
module name s . This
would typically be
the s ame as 'name ',
but in s ome cas e s
us e rs may wis h to
have two
de ployme nts with
the s ame runtime name (e .g. two
ve rs ions of foo.war)
both available in the
de ployme nt conte nt
re pos itory, in which
cas e the
de ployme nts would
ne e d to have
dis tinct name ;
value s but would
have the s ame
runtime -name .
no
pe rs is te nt
no
runtime -name
Runtime Name
499
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
T able 3.416. Met rics
Name
Descript io n
Enable
Dis able
Re s tart
Package T ypes
T able 3.417. Package T ypes
Name
Cat ego ry
Descript io n
File
De ployable
De ployme nts on this s e rve r
group
3.3.12.1. JBoss AS 7 and EAP 6 - Webservices Runt ime Service
Overview
T able 3.418. Overview
De s cription:
Runtime re s ource s e xpos e d by we b
s e rvice compone nts in the de ployme nt.
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
Se ction 3.3.12.1.1, “JBos s AS 7 and EAP 6 - Endpoint Runtime Se rvice ”
Co nnect io n Pro pert ies
T able 3.419.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
500
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.1.1. JBo ss AS 7 and EAP 6 - Endpo int Runt ime Service
Overview
T able 3.420 . Overview
De s cription:
Single ton:
Plugin:
We bs e rvice e ndpoint.
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.421.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.422. Met rics
Name
T ype
Descript io n
Int ernal Name
Ave rage Proce s s ing
Time
Fault Count
me as ure me nt
Ave rage e ndpoint
proce s s ing time .
Count of faults the
e ndpoint ge ne rate d.
ave rage -proce s s ingtime
fault-count
me as ure me nt
501
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Max Proce s s ing
Time
Min Proce s s ing Time
me as ure me nt
max-proce s s ing-time
Re que s t Count
me as ure me nt
Re s pons e Count
me as ure me nt
Total Proce s s ing
Time
me as ure me nt
Maximal e ndpoint
proce s s ing time .
Minimal e ndpoint
proce s s ing time .
Count of re que s ts
the e ndpoint
proce s s e d.
Count of re s pons e s
the e ndpoint
ge ne rate d.
Total e ndpoint
proce s s ing time .
me as ure me nt
min-proce s s ing-time
re que s t-count
re s pons e -count
total-proce s s ing-time
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.423.
Name
Descript io n
Required
Int ernal Name
Clas s
We bs e rvice
e ndpoint clas s .
We bs e rvice
e ndpoint conte xt.
We bs e rvice
e ndpoint name .
We bs e rvice
e ndpoint type .
We bs e rvice
e ndpoint WSDL URL.
no
clas s
no
conte xt
no
name
no
type
no
ws dl-url
Conte xt
Name
Type
Ws dl Url
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.12.2. JBoss AS 7 and EAP 6 - Web Runt ime Service
502
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Overview
T able 3.424. Overview
De s cription:
Runtime re s ource s e xpos e d by we b
compone nts in the de ployme nt.
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.425.
Name
Descript io n
Required
Int ernal Name
Re s pons e Time Log
File
the full path to the
log file containing
re s pons e -time s tats
for this we bapp
a s pace -de limite d
lis t of re gular
e xpre s s ions
s pe cifying URLs that
s hould be e xclude d
from re s pons e -time
s tats colle ction
a s pace -de limite d
lis t of Pe rl-s tyle
s ubs titution
e xpre s s ions that
s hould be applie d to
all URLs for which
re s pons e -time s tats
are colle cte d (e .g.
|^/de pt/finance /.*|/de
pt/finance /*|)
no
re s pons e Time LogFil
e
no
re s pons e Time UrlExc
lude s
no
re s pons e Time UrlTra
ns forms
ye s
path
Re s pons e Time Url
Exclude s
Re s pons e Time Url
Trans forms
Path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.426. Met rics
Name
T ype
Descript io n
Int ernal Name
503
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Virtual Hos t
trait
virtual-hos t
Conte xt Root
trait
Re s pons e Time
calltime
Curre ntly Active
Se s s ions
me as ure me nt
Duplicate d Se s s ion
Ids
me as ure me nt
Expire d Se s s ions
me as ure me nt
Expire d Se s s ions
pe r Minute
Maximum Active
Se s s ions
me as ure me nt
Re je cte d Se s s ions
me as ure me nt
Re je cte d Se s s ions
pe r Minute
Ave rage Se s s ion
Alive Time
Max Se s s ion Alive
Time
Cre ate d Se s s ions
me as ure me nt
Cre ate d Se s s ions
pe r Minute
me as ure me nt
the virtual hos t this
we bapp is de ploye d
to
the conte xt root of
this we bapp
the minimum,
maximum, and
ave rage re s pons e
time s for re que s ts
s e rvice d by this
we bapp
The numbe r of
s e s s ions that are
curre ntly active
The numbe r of
duplicate d s e s s ion
ide ntifie rs
The numbe r of
e xpire d s e s s ions
The numbe r of
e xpire d s e s s ions
The maximum
numbe r of s e s s ions
that have be e n
active
The numbe r of
s e s s ions re je cte d
The numbe r of
s e s s ions re je cte d
The ave rage alive
time of s e s s ions
The maximum alive
time of s e s s ions
The numbe r of
s e s s ions cre ate d
The numbe r of
s e s s ions cre ate d
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
conte xt-root
re s pons e Time
active -s e s s ions
duplicate d-s e s s ionids
e xpire d-s e s s ions
e xpire d-s e s s ions
max-active -s e s s ions
re je cte d-s e s s ions
re je cte d-s e s s ions
s e s s ion-avg-alive time
s e s s ion-max-alive time
s e s s ions -cre ate d
s e s s ions -cre ate d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
504
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Package T ypes
none
3.3.12.3. JBoss AS 7 and EAP 6 - Messaging Runt ime Service
Overview
T able 3.427. Overview
De s cription:
Runtime re s ource s e xpos e d by me s s aging
re s ource s include d in this de ployme nt.
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
Se ction 3.3.12.3.1, “JBos s AS 7 and EAP 6 - Horne tQ Se rve r Runtime Se rvice ”
Co nnect io n Pro pert ies
T able 3.428.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.3.1. JBo ss AS 7 and EAP 6 - Ho rnet Q Server Runt ime Service
Overview
T able 3.429. Overview
505
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
De s cription:
Single ton:
Plugin:
A Horne tQ s e rve r ins tance .
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.12.3.1.1, “JBos s AS 7 and EAP 6 - JMS Que ue Runtime Se rvice ”
Se ction 3.3.12.3.1.2, “JBos s AS 7 and EAP 6 - JMS Topic Runtime Se rvice ”
Co nnect io n Pro pert ies
T able 3.430 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.431. Met rics
Name
T ype
Descript io n
Int ernal Name
Starte d
trait
s tarte d
Ve rs ion
trait
Whe the r this s e rve r
is s tarte d.
The s e rve r's
ve rs ion.
ve rs ion
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.432.
Name
Descript io n
Allow Failback
Whe the r this s e rve r no
will automatically
s hutdown if the
original live s e rve r
come s back up. The
de fault value is true .
506
Required
Int ernal Name
allow-failback
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
As ync Conne ction
Exe cution Enable d
Whe the r incoming
packe ts on the
s e rve r s hould be
hande d off to a
thre ad from the
thre ad pool for
proce s s ing. Fals e if
the y s hould be
handle d on the
re moting thre ad.
The de fault value is
true .
Whe the r this s e rve r
is a backup s e rve r.
The de fault value is
fals e .
The pas s word us e d
by clus te r
conne ctions to
communicate
be twe e n the
clus te re d node s .
The de fault value is
CHANGE ME!!.
The us e r us e d by
clus te r conne ctions
to communicate
be twe e n the
clus te re d node s .
The de fault value is
HORNETQ.CLUSTER.A
DMIN.USER.
Whe the r the s e rve r
is clus te re d. The
de fault value is
fals e .
If s e t, this will
ove rride how long
(in ms ) to ke e p a
conne ction alive
without re ce iving a
ping. The de fault
value is -1.
Whe the r the s e rve r
s hould cre ate the
bindings dire ctory on
s tart up. The de fault
value is true .
Whe the r the s e rve r
s hould cre ate the
journal dire ctory on
s tart up. The de fault
value is true .
no
as ync-conne ctione xe cution-e nable d
no
backup
no
clus te r-pas s word
no
clus te r-us e r
no
clus te re d
no
conne ction-ttlove rride
no
cre ate -bindings -dir
no
cre ate -journal-dir
Backup
Clus te r Pas s word
Clus te r Us e r
Clus te re d
Conne ction Ttl
Ove rride
Cre ate Bindings Dir
Cre ate Journal Dir
507
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Failback De lay
How long to wait
be fore failback
occurs on live
s e rve r re s tart. The
de fault value is
5000.
Whe the r this backup
s e rve r (if it is a
backup s e rve r)
s hould come live on
a normal s e rve r
s hutdown. The
de fault value is
fals e .
The s iz e of the
cache for pre cre ating me s s age
IDs . The de fault
value is 2000.
The JMX domain
us e d to re gis te r
inte rnal Horne tQ
MBe ans in the
MBe anSe rve r. The
de fault value is
org.horne tq.
Whe the r Horne tQ
s hould e xpos e its
inte rnal
manage me nt API via
JMX. This is not
re comme nde d, as
acce s s ing the s e
MBe ans can le ad to
incons is te nt
configuration. The
de fault value is
fals e .
The s iz e of the
inte rnal buffe r on
the journal.
The time out (in
nanos e conds ) us e d
to flus h inte rnal
buffe rs on the
journal.
The minimal numbe r
of journal data file s
be fore we can s tart
compacting. The
de fault value is 10.
no
failback-de lay
no
failove r-on-s hutdown
no
id-cache -s iz e
no
jmx-domain
no
jmx-manage me nte nable d
no
journal-buffe r-s iz e
no
journal-buffe rtime out
no
journal-compact-minfile s
Failove r On
Shutdown
Id Cache Siz e
Jmx Domain
Jmx Manage me nt
Enable d
Journal Buffe r Siz e
Journal Buffe r
Time out
Journal Compact Min
File s
508
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Journal Compact
Pe rce ntage
The pe rce ntage of
live data on which
we cons ide r
compacting the
journal. The de fault
value is 30.
The s iz e (in byte s )
of e ach journal file .
The de fault value is
10485760.
The maximum
numbe r of write
re que s ts that can be
in the AIO que ue at
any one time .
How many journal
file s to pre -cre ate .
The de fault value is
2.
Whe the r to wait for
non trans action data
to be s ynce d to the
journal be fore
re turning a
re s pons e to the
clie nt. The de fault
value is true .
Whe the r to wait for
trans action data to
be s ynchroniz e d to
the journal be fore
re turning a
re s pons e to the
clie nt. The de fault
value is true .
The type of journal
to us e . The de fault
value is ASYNCIO.
The name of the
conne ctor us e d to
conne ct to the live
conne ctor. If this
s e rve r is not a
backup that us e s
s hare d nothing HA,
it's value is
'unde fine d'.
Whe the r to
pe riodically log the
journal's write rate
and flus h rate . The
de fault value is
fals e .
no
journal-compactpe rce ntage
no
journal-file -s iz e
no
journal-max-io
no
journal-min-file s
no
journal-s ync-nontrans actional
no
journal-s ynctrans actional
no
journal-type
no
live -conne ctor-re f
no
log-journal-write -rate
Journal File Siz e
Journal Max Io
Journal Min File s
Journal Sync Non
Trans actional
Journal Sync
Trans actional
Journal Type
Live Conne ctor Re f
Log Journal Write
Rate
509
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Manage me nt
Addre s s
Addre s s to s e nd
manage me nt
me s s age s to. The
de fault value is
jms .que ue .horne tq.
manage me nt.
The name of the
addre s s that
cons ume rs bind to
to re ce ive
manage me nt
notifications . The
de fault value is
horne tq.notifications .
Fre que ncy to
s ample JVM me mory
in ms (or -1 to
dis able me mory
s ampling). The
de fault value is -1.
Pe rce ntage of
available me mory
which if e xce e de d
re s ults in a warning
log. The de fault
value is 25.
Whe the r me s s age
counte rs are
e nable d. The de fault
value is fals e .
How many days to
ke e p me s s age
counte r his tory. The
de fault value is 10.
The s ample pe riod
(in ms ) to us e for
me s s age counte rs .
The de fault value is
10000.
How ofte n (in ms ) to
s can for e xpire d
me s s age s . The
de fault value is
30000.
The priority of the
thre ad e xpiring
me s s age s . The
de fault value is 3.
no
manage me ntaddre s s
no
manage me ntnotification-addre s s
no
me mory-me as ure inte rval:e xpr
no
me mory-warningthre s hold:e xpr
no
me s s age -counte re nable d
no
me s s age -counte rmax-day-his tory
no
me s s age -counte rs ample -pe riod
no
me s s age -e xpirys can-pe riod
no
me s s age -e xpirythre ad-priority
Manage me nt
Notification Addre s s
Me mory Me as ure
Inte rval
Me mory Warning
Thre s hold
Me s s age Counte r
Enable d
Me s s age Counte r
Max Day His tory
Me s s age Counte r
Sample Pe riod
Me s s age Expiry
Scan Pe riod
Me s s age Expiry
Thre ad Priority
510
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Page Max
Concurre nt Io
The maximum
numbe r of
concurre nt re ads
allowe d on paging.
The de fault value is
5.
TODO. The de fault
value is -1.
Whe the r the
de live ry count is
pe rs is te d be fore
de live ry. Fals e
me ans that this only
happe ns afte r a
me s s age has be e n
cance lle d. The
de fault value is
fals e .
Whe the r IDs are
pe rs is te d to the
journal. The de fault
value is true .
Whe the r the s e rve r
will us e the file
bas e d journal for
pe rs is te nce . The
de fault value is true .
The lis t of
inte rce ptor clas s e s
us e d by this s e rve r.
Whe the r on s tartup
to pe rform a
diagnos tic te s t on
how fas t your dis k
can s ync. Us e ful
whe n de te rmining
pe rformance is s ue s .
The de fault value is
fals e .
The numbe r of
thre ads that the
main s che dule d
thre ad pool has . The
de fault value is 5.
The s e curity domain
to us e to ve rify us e r
and role information.
The de fault value is
othe r.
Whe the r s e curity is
e nable d. The de fault
value is true .
no
page -maxconcurre nt-io
no
pe rf-blas t-page s
no
pe rs is t-de live rycount-be fore de live ry
no
pe rs is t-id-cache
no
pe rs is te nce -e nable d
no
re motinginte rce ptors :nullable
no
run-s ync-s pe e d-te s t
no
s che dule d-thre adpool-max-s iz e :e xpr
no
s e curity-domain
no
s e curity-e nable d
Pe rf Blas t Page s
Pe rs is t De live ry
Count Be fore
De live ry
Pe rs is t Id Cache
Pe rs is te nce Enable d
Re moting
Inte rce ptors
Run Sync Spe e d
Te s t
Sche dule d Thre ad
Pool Max Siz e
Se curity Domain
Se curity Enable d
511
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se curity Invalidation
Inte rval
How long (in ms ) to
wait be fore
invalidating the
s e curity cache . The
de fault value is
10000.
How ofte n to dump
bas ic runtime
information to the
s e rve r log. A value
le s s than 1 dis able s
this fe ature . The
de fault value is -1.
Whe the r this s e rve r
is us ing a s hare d
s tore for failove r.
The de fault value is
true .
The numbe r of
thre ads that the
main thre ad pool
has . -1 me ans no
limit. The de fault
value is 30.
How long (in ms )
be fore a trans action
can be re move d
from the re s ource
manage r afte r
cre ate time . The
de fault value is
300000.
How ofte n (in ms ) to
s can for time out
trans actions . The
de fault value is
1000.
Whe the r the s e rve r
s upports wild card
routing. The de fault
value is true .
no
s e curity-invalidationinte rval
no
s e rve r-dumpinte rval
no
s hare d-s tore
no
thre ad-pool-maxs iz e :e xpr
no
trans action-time out
no
trans action-time outs can-pe riod
no
wild-card-routinge nable d
Se rve r Dump
Inte rval
Share d Store
Thre ad Pool Max
Siz e
Trans action Time out
Trans action Time out
Scan Pe riod
Wild Card Routing
Enable d
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.433. Met rics
512
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Clos e Conne ctions for Addre s s
Clos e s all the conne ctions of clie nts
conne cte d to this s e rve r whos e re mote
addre s s contains the s pe cifie d IP addre s s .
Re turns true if any conne ctions we re
clos e d, fals e othe rwis e .
He uris tically commits a pre pare d
trans action.
Force the me s s aging s e rve r to s top and
notify clie nts to failove r.
Re turns the addre s s s e ttings as a JSON
s tring for an addre s s match. The re turne d
String is a JSON s tring containing an array
of addre s s s e ttings de tails .
Re turns the conne ctors configure d for this
s e rve r us ing JSON s e rializ ation.
Re turns the ID of the las t me s s age s e nt
from the give n s e s s ion to the give n
addre s s .
Ge ts the s e s s ion's cre ation time . Re turns
the cre ation time , re pre s e nte d as a s tring
s howing the numbe r of millis e conds s ince
the e poch.
Lis ts all the cons ume rs .
Lis ts the IDs of all the conne ctions
conne cte d to this s e rve r.
Lis t all JMS conne ctions .
Lis ts all the cons ume rs which be longs to
the JMS Conne ction s pe cifie d by the
conne ction-id.
Lis ts trans actions which have be e n
he uris tically committe d. Re turns a lis t of
s trings . The Strings are Bas e -64
re pre s e ntation of the trans action XID.
Lis ts trans actions which have be e n
he uris tically rolle d back. Re turns a lis t of
s trings . The Strings are Bas e -64
re pre s e ntation of the trans action XID.
Lis t all the pre pare d trans action, s orte d by
date , olde s t firs t, with de tails , in HTML
format.
Lis t all the pre pare d trans action, s orte d by
date , olde s t firs t, with de tails , in JSON
format.
Lis t all the pre pare d trans actions , s orte d
by date , olde s t firs t, with de tails in JMS, in
HTML format
Lis t all the pre pare d trans actions , s orte d
by date , olde s t firs t, with de tails in JMS
format, in JSON format
Commit Pre pare d Trans action
Force Failove r
Ge t Addre s s Se ttings as JSON
Ge t Conne ctors as JSON
Ge t Las t Se nt Me s s age ID
Ge t Se s s ion Cre ation Time
Lis t All Cons ume rs as JSON
Lis t Conne ction IDs
Lis t Conne ctions as JSON
Lis t Cons ume rs as JSON
Lis t He uris tic Committe d Trans actions
Lis t He uris tic Rolle d Back Trans actions
Lis t Pre pare d Trans action De tails as HTML
Lis t Pre pare d Trans action De tails as JSON
Lis t Pre pare d Trans action JMS De tails as
HTML
Lis t Pre pare d Trans action JMS de tails as
JSON
513
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Lis t Pre pare d Trans actions
Lis t all the pre pare d trans action, s orte d by
date , olde s t firs t. Re turns a lis t of s trings .
The Strings are Bas e -64 re pre s e ntation of
the trans action XID and can be us e d to
he uris tically commit or rollback the
trans actions .
For all s e s s ions , lis ts information about
me s s age produce rs us ing JSON
s e rializ ation.
Lis ts the addre s s e s of all the clie nts
conne cte d to the give n addre s s . If an ipaddre s s argume nt is s upplie d, only thos e
clie nts whos e re mote addre s s s tring
include s the give n ip-addre s s s tring will be
re turne d.
Lis ts all the s e s s ions IDs for the s pe cifie d
conne ction ID.
Lis ts all the s e s s ions IDs for the s pe cifie d
conne ction ID. The re turne d String is a
JSON s tring containing an array of s e s s ion
ids .
Lis ts all addre s s e s to which the de s ignate d
s e s s ion has s e nt me s s age s . The re turne d
String is a JSON s tring containing an array
of addre s s name s .
Re s e t all me s s age counte rs his tory.
Re s e t all me s s age counte rs .
He uris tically rolls back a pre pare d
trans action. Re turns true if the trans action
was s ucce s s fully rolle d back, fals e
othe rwis e .
Lis t Produce rs Info as JSON
Lis t Re mote Addre s s e s
Lis t Se s s ions
Lis t Se s s ions as JSON
Lis t Targe t De s tinations
Re s e t All Me s s age Counte r His torie s
Re s e t All Me s s age Counte rs
Rollback Pre pare d Trans action
Package T ypes
none
3.3.12.3.1.1. JBo ss AS 7 and EAP 6 - JMS Queue Runt ime Service
Ove rvie w
T able 3.434. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
none
Conne ction Prope rtie s
T able 3.435.
514
De fine s a JMS que ue .
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.436. Met rics
Name
T ype
Descript io n
Int ernal Name
Cons ume r Count
me as ure me nt
cons ume r-count
De ad Le tte r
Addre s s
De live ring Count
trait
Durable
trait
Expiry Addre s s
trait
Me s s age Count
me as ure me nt
Me s s age s Adde d
me as ure me nt
Paus e d
trait
Que ue Addre s s
trait
Sche dule d Count
me as ure me nt
Se le ctor
trait
The numbe r of
cons ume rs
cons uming
me s s age s from this
que ue .
The addre s s to s e nd
de ad me s s age s to.
The numbe r of
me s s age s that this
que ue is curre ntly
de live ring to its
cons ume rs .
Whe the r the que ue
is durable or not.
The de fault value is
true .
The addre s s to s e nd
e xpire d me s s age s
to.
The numbe r of
me s s age s curre ntly
in this que ue .
The numbe r of
me s s age s adde d to
this que ue s ince it
was cre ate d.
Whe the r the que ue
is paus e d.
The que ue addre s s
de fine s what
addre s s is us e d for
routing me s s age s .
The numbe r of
s che dule d
me s s age s in this
que ue .
The que ue s e le ctor.
me as ure me nt
de ad-le tte r-addre s s
de live ring-count
durable
e xpiry-addre s s
me s s age -count
me s s age s -adde d
paus e d
que ue -addre s s
s che dule d-count
s e le ctor
515
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Te mporary
trait
Whe the r the que ue
is te mporary.
te mporary
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.437.
Name
Descript io n
Required
Int ernal Name
Entrie s
The jndi name s the
que ue will be bound
to.
no
e ntrie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
T able 3.438. Met rics
Name
Descript io n
Change Me s s age Priority
Change the priority of the me s s age
corre s ponding to the give n me s s age -id.
Re turns true if the me s s age was e xpire d,
fals e othe rwis e .
Change the priority of the me s s age s
corre s ponding to the give n filte r. Re turns
the numbe r of re move d me s s age s .
Re turns the numbe r of the me s s age s in
the que ue matching the give n filte r.
Expire the me s s age corre s ponding to the
give n me s s age -id. Re turns true if the
me s s age was e xpire d, fals e othe rwis e .
Expire the me s s age s matching the give n
filte r.
A s tring in JSON format.
Lis t the me s s age counte r as a s tring in
HTML format.
Lis t the me s s age counte r as a s tring in
JSON format.
Lis t the me s s age counte r his tory.
Change Me s s age s Priority
Count Me s s age s
Expire Me s s age
Expire Me s s age s
Lis t Cons ume rs as JSON
Lis t Me s s age Counte r as HTML
Lis t Me s s age Counte r as JSON
Lis t Me s s age Counte r His tory as HTML
516
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Lis t Me s s age Counte r His tory as JSON
Lis t the me s s age counte r his tory as a
s tring in JSON format.
Lis t all me s s age s in the que ue that match
the filte r
Lis t all me s s age s in the que ue that match
the filte r and re turn the m as a s tring in
JSON format.
Move the me s s age corre s ponding to the
give n me s s age -id to anothe r que ue
Move the me s s age s corre s ponding to the
give n filte r to anothe r que ue .
Paus e the que ue .
Re move the me s s age corre s ponding to the
give n me s s age -id.
Re move me s s age s matching the give n
filte r from the de s tination.
Re s e t the me s s age counte rs .
Re s ume the que ue .
Se nd the me s s age corre s ponding to the
give n me s s age -id to this que ue 's De ad
Le tte r Addre s s .
Se nd the me s s age s corre s ponding to the
give n filte r to this que ue 's De ad Le tte r
Addre s s .
Lis t Me s s age s
Lis t Me s s age s as JSON
Move Me s s age
Move Me s s age s
Paus e
Re move Me s s age
Re move Me s s age s
Re s e t Me s s age Counte r
Re s ume
Se nd Me s s age to De ad Le tte r Addre s s
Se nd Me s s age s to De ad Le tte r Addre s s
Package Type s
none
3.3.12.3.1.2. JBo ss AS 7 and EAP 6 - JMS T o pic Runt ime Service
Ove rvie w
T able 3.439. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
De fine s a JMS que ue .
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.440 .
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
517
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.441. Met rics
Name
T ype
Descript io n
Int ernal Name
De live ring Count
me as ure me nt
de live ring-count
Durable Me s s age
Count
me as ure me nt
The numbe r of
me s s age s that this
que ue is curre ntly
de live ring to its
cons ume rs .
The numbe r of
me s s age s for all
durable s ubs cribe rs
for this topic.
The numbe r of
durable s ubs cribe rs
for this topic.
The numbe r of
me s s age s curre ntly
in this que ue .
The numbe r of
me s s age s adde d to
this que ue s ince it
was cre ate d.
The numbe r of
me s s age s for all
non-durable
s ubs cribe rs for this
topic.
The numbe r of nondurable s ubs cribe rs
for this topic.
The numbe r of
(durable and nondurable ) s ubs cribe rs
for this topic.
Whe the r the topic is
te mporary.
The addre s s the
topic points to.
Durable Subs cription me as ure me nt
Count
Me s s age Count
me as ure me nt
Me s s age s Adde d
me as ure me nt
Non Durable
Me s s age Count
me as ure me nt
Non Durable
Subs cription Count
me as ure me nt
Subs cription Count
me as ure me nt
Te mporary
trait
Topic Addre s s
trait
durable -me s s age count
durable -s ubs criptioncount
me s s age -count
me s s age s -adde d
non-durable me s s age -count
non-durable s ubs cription-count
s ubs cription-count
te mporary
topic-addre s s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
518
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Configuration Prope rtie s
T able 3.442.
Name
Descript io n
Required
Int ernal Name
JNDI Name s
The jndi name s the
que ue will be bound
to.
no
e ntrie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
T able 3.443. Met rics
Name
Descript io n
Count Me s s age s for Subs cription
Count the numbe r of me s s age s matching
the filte r for the give n s ubs cription.
Drop all s ubs criptions from this topic.
Drop a durable s ubs cription
Lis t all s ubs criptions .
Lis t all s ubs criptions as a s tring in JSON
format.
Lis t only the durable s ubs criptions .
Lis t only the durable s ubs criptions , as a
s tring in JSON format.
Lis t all the me s s age s for the give n
s ubs cription.
Lis t all the me s s age s for the give n
s ubs cription as a s tring in JSON format.
Lis t only the non-durable s ubs criptions .
Lis t only the non-durable s ubs criptions , as
a s tring in JSON format.
Re move me s s age s matching the give n
filte r from the de s tination.
Drop All Subs criptions
Drop Durable Subs cription
Lis t All Subs criptions
Lis t All Subs criptions as JSON
Lis t Durable Subs criptions
Lis t Durable Subs criptions as JSON
Lis t Me s s age s for Subs cription
Lis t Me s s age s for Subs cription as JSON
Lis t Non-Durable Subs criptions
Lis t Non-Durable Subs criptions as JSON
Re move Me s s age s
Package Type s
none
3.3.12.4. JBoss AS 7 and EAP 6 - Subdeployment Service
Overview
T able 3.444. Overview
519
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
De s cription:
Runtime re s ource s as s ociate d with a child
de ployme nt package d ins ide anothe r
de ployme nt; for e xample a war package d
ins ide an e ar.
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
Se ction 3.3.12.4.1, “JBos s AS 7 and EAP 6 - We bs e rvice s Runtime Se rvice ”
Se ction 3.3.12.4.2, “JBos s AS 7 and EAP 6 - We b Runtime Se rvice ”
Se ction 3.3.12.4.3, “JBos s AS 7 and EAP 6 - Me s s aging Runtime Se rvice ”
Se ction 3.3.12.4.4, “JBos s AS 7 and EAP 6 - JPA Runtime Se rvice ”
Se ction 3.3.12.4.5, “JBos s AS 7 and EAP 6 - Datas ource s Runtime Se rvice ”
Se ction 3.3.12.4.6, “JBos s AS 7 and EAP 6 - EJB3 Runtime Se rvice ”
Se ction 3.3.12.4.7, “JBos s AS 7 and EAP 6 - Re s ource Adapte rs Runtime Se rvice ”
Co nnect io n Pro pert ies
T able 3.445.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.4.1. JBo ss AS 7 and EAP 6 - Webservices Runt ime Service
Overview
520
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.446. Overview
De s cription:
Runtime re s ource s e xpos e d by we b
s e rvice compone nts in the de ployme nt.
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
Se ction 3.3.12.4.1.1, “JBos s AS 7 and EAP 6 - Endpoint Runtime Se rvice ”
Co nnect io n Pro pert ies
T able 3.447.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.4.1.1. JBo ss AS 7 and EAP 6 - Endpo int Runt ime Service
Ove rvie w
T able 3.448. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
We bs e rvice e ndpoint.
no
JBos s AS7
none
Conne ction Prope rtie s
521
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.449.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.450 . Met rics
Name
T ype
Descript io n
Int ernal Name
Ave rage Proce s s ing
Time
Fault Count
me as ure me nt
ave rage -proce s s ingtime
fault-count
Max Proce s s ing
Time
Min Proce s s ing Time
me as ure me nt
Re que s t Count
me as ure me nt
Re s pons e Count
me as ure me nt
Total Proce s s ing
Time
me as ure me nt
Ave rage e ndpoint
proce s s ing time .
Count of faults the
e ndpoint ge ne rate d.
Maximal e ndpoint
proce s s ing time .
Minimal e ndpoint
proce s s ing time .
Count of re que s ts
the e ndpoint
proce s s e d.
Count of re s pons e s
the e ndpoint
ge ne rate d.
Total e ndpoint
proce s s ing time .
me as ure me nt
me as ure me nt
max-proce s s ing-time
min-proce s s ing-time
re que s t-count
re s pons e -count
total-proce s s ing-time
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.451.
Name
Descript io n
Required
Int ernal Name
Clas s
We bs e rvice
e ndpoint clas s .
We bs e rvice
e ndpoint conte xt.
We bs e rvice
e ndpoint name .
no
clas s
no
conte xt
no
name
Conte xt
Name
522
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Type
We bs e rvice
e ndpoint type .
We bs e rvice
e ndpoint WSDL URL.
no
type
no
ws dl-url
Ws dl Url
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.12.4.2. JBo ss AS 7 and EAP 6 - Web Runt ime Service
Overview
T able 3.452. Overview
De s cription:
Runtime re s ource s e xpos e d by we b
compone nts in the de ployme nt.
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.453.
Name
Descript io n
Required
Int ernal Name
Re s pons e Time Log
File
the full path to the
log file containing
re s pons e -time s tats
for this we bapp
a s pace -de limite d
lis t of re gular
e xpre s s ions
s pe cifying URLs that
s hould be e xclude d
from re s pons e -time
s tats colle ction
no
re s pons e Time LogFil
e
no
re s pons e Time UrlExc
lude s
Re s pons e Time Url
Exclude s
523
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Re s pons e Time Url
Trans forms
a s pace -de limite d
lis t of Pe rl-s tyle
s ubs titution
e xpre s s ions that
s hould be applie d to
all URLs for which
re s pons e -time s tats
are colle cte d (e .g.
|^/de pt/finance /.*|/de
pt/finance /*|)
no
re s pons e Time UrlTra
ns forms
ye s
path
Path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.454. Met rics
Name
T ype
Descript io n
Int ernal Name
Virtual Hos t
trait
virtual-hos t
Conte xt Root
trait
Re s pons e Time
calltime
Curre ntly Active
Se s s ions
me as ure me nt
Duplicate d Se s s ion
Ids
me as ure me nt
Expire d Se s s ions
me as ure me nt
Expire d Se s s ions
pe r Minute
Maximum Active
Se s s ions
me as ure me nt
Re je cte d Se s s ions
me as ure me nt
the virtual hos t this
we bapp is de ploye d
to
the conte xt root of
this we bapp
the minimum,
maximum, and
ave rage re s pons e
time s for re que s ts
s e rvice d by this
we bapp
The numbe r of
s e s s ions that are
curre ntly active
The numbe r of
duplicate d s e s s ion
ide ntifie rs
The numbe r of
e xpire d s e s s ions
The numbe r of
e xpire d s e s s ions
The maximum
numbe r of s e s s ions
that have be e n
active
The numbe r of
s e s s ions re je cte d
524
me as ure me nt
conte xt-root
re s pons e Time
active -s e s s ions
duplicate d-s e s s ionids
e xpire d-s e s s ions
e xpire d-s e s s ions
max-active -s e s s ions
re je cte d-s e s s ions
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Re je cte d Se s s ions
pe r Minute
Ave rage Se s s ion
Alive Time
Max Se s s ion Alive
Time
Cre ate d Se s s ions
me as ure me nt
re je cte d-s e s s ions
Cre ate d Se s s ions
pe r Minute
me as ure me nt
The numbe r of
s e s s ions re je cte d
The ave rage alive
time of s e s s ions
The maximum alive
time of s e s s ions
The numbe r of
s e s s ions cre ate d
The numbe r of
s e s s ions cre ate d
me as ure me nt
me as ure me nt
me as ure me nt
s e s s ion-avg-alive time
s e s s ion-max-alive time
s e s s ions -cre ate d
s e s s ions -cre ate d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.4.3. JBo ss AS 7 and EAP 6 - Messaging Runt ime Service
Overview
T able 3.455. Overview
De s cription:
Runtime re s ource s e xpos e d by me s s aging
re s ource s include d in this de ployme nt.
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
Se ction 3.3.12.4.3.1, “JBos s AS 7 and EAP 6 - Horne tQ Se rve r Runtime Se rvice ”
Co nnect io n Pro pert ies
T able 3.456.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
525
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.4.3.1. JBo ss AS 7 and EAP 6 - Ho rnet Q Server Runt ime Service
Ove rvie w
T able 3.457. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
A Horne tQ s e rve r ins tance .
no
JBos s AS7
Se ction 3.3.12.4.3.1.1, “JBos s AS 7 and EAP 6 - JMS Que ue Runtime Se rvice ”
Se ction 3.3.12.4.3.1.2, “JBos s AS 7 and EAP 6 - JMS Topic Runtime Se rvice ”
Conne ction Prope rtie s
T able 3.458.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.459. Met rics
526
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Starte d
trait
s tarte d
Ve rs ion
trait
Whe the r this s e rve r
is s tarte d.
The s e rve r's
ve rs ion.
ve rs ion
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.460 .
Name
Descript io n
Required
Int ernal Name
Allow Failback
Whe the r this s e rve r
will automatically
s hutdown if the
original live s e rve r
come s back up. The
de fault value is true .
Whe the r incoming
packe ts on the
s e rve r s hould be
hande d off to a
thre ad from the
thre ad pool for
proce s s ing. Fals e if
the y s hould be
handle d on the
re moting thre ad.
The de fault value is
true .
Whe the r this s e rve r
is a backup s e rve r.
The de fault value is
fals e .
The pas s word us e d
by clus te r
conne ctions to
communicate
be twe e n the
clus te re d node s .
The de fault value is
CHANGE ME!!.
no
allow-failback
no
as ync-conne ctione xe cution-e nable d
no
backup
no
clus te r-pas s word
As ync Conne ction
Exe cution Enable d
Backup
Clus te r Pas s word
527
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Clus te r Us e r
The us e r us e d by
clus te r conne ctions
to communicate
be twe e n the
clus te re d node s .
The de fault value is
HORNETQ.CLUSTER.A
DMIN.USER.
Whe the r the s e rve r
is clus te re d. The
de fault value is
fals e .
If s e t, this will
ove rride how long
(in ms ) to ke e p a
conne ction alive
without re ce iving a
ping. The de fault
value is -1.
Whe the r the s e rve r
s hould cre ate the
bindings dire ctory on
s tart up. The de fault
value is true .
Whe the r the s e rve r
s hould cre ate the
journal dire ctory on
s tart up. The de fault
value is true .
How long to wait
be fore failback
occurs on live
s e rve r re s tart. The
de fault value is
5000.
Whe the r this backup
s e rve r (if it is a
backup s e rve r)
s hould come live on
a normal s e rve r
s hutdown. The
de fault value is
fals e .
The s iz e of the
cache for pre cre ating me s s age
IDs . The de fault
value is 2000.
no
clus te r-us e r
no
clus te re d
no
conne ction-ttlove rride
no
cre ate -bindings -dir
no
cre ate -journal-dir
no
failback-de lay
no
failove r-on-s hutdown
no
id-cache -s iz e
Clus te re d
Conne ction Ttl
Ove rride
Cre ate Bindings Dir
Cre ate Journal Dir
Failback De lay
Failove r On
Shutdown
Id Cache Siz e
528
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Jmx Domain
The JMX domain
us e d to re gis te r
inte rnal Horne tQ
MBe ans in the
MBe anSe rve r. The
de fault value is
org.horne tq.
Whe the r Horne tQ
s hould e xpos e its
inte rnal
manage me nt API via
JMX. This is not
re comme nde d, as
acce s s ing the s e
MBe ans can le ad to
incons is te nt
configuration. The
de fault value is
fals e .
The s iz e of the
inte rnal buffe r on
the journal.
The time out (in
nanos e conds ) us e d
to flus h inte rnal
buffe rs on the
journal.
The minimal numbe r
of journal data file s
be fore we can s tart
compacting. The
de fault value is 10.
The pe rce ntage of
live data on which
we cons ide r
compacting the
journal. The de fault
value is 30.
The s iz e (in byte s )
of e ach journal file .
The de fault value is
10485760.
The maximum
numbe r of write
re que s ts that can be
in the AIO que ue at
any one time .
How many journal
file s to pre -cre ate .
The de fault value is
2.
no
jmx-domain
no
jmx-manage me nte nable d
no
journal-buffe r-s iz e
no
journal-buffe rtime out
no
journal-compact-minfile s
no
journal-compactpe rce ntage
no
journal-file -s iz e
no
journal-max-io
no
journal-min-file s
Jmx Manage me nt
Enable d
Journal Buffe r Siz e
Journal Buffe r
Time out
Journal Compact Min
File s
Journal Compact
Pe rce ntage
Journal File Siz e
Journal Max Io
Journal Min File s
529
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Journal Sync Non
Trans actional
Whe the r to wait for
non trans action data
to be s ynce d to the
journal be fore
re turning a
re s pons e to the
clie nt. The de fault
value is true .
Whe the r to wait for
trans action data to
be s ynchroniz e d to
the journal be fore
re turning a
re s pons e to the
clie nt. The de fault
value is true .
The type of journal
to us e . The de fault
value is ASYNCIO.
The name of the
conne ctor us e d to
conne ct to the live
conne ctor. If this
s e rve r is not a
backup that us e s
s hare d nothing HA,
it's value is
'unde fine d'.
Whe the r to
pe riodically log the
journal's write rate
and flus h rate . The
de fault value is
fals e .
Addre s s to s e nd
manage me nt
me s s age s to. The
de fault value is
jms .que ue .horne tq.
manage me nt.
The name of the
addre s s that
cons ume rs bind to
to re ce ive
manage me nt
notifications . The
de fault value is
horne tq.notifications .
Fre que ncy to
s ample JVM me mory
in ms (or -1 to
dis able me mory
s ampling). The
de fault value is -1.
no
journal-s ync-nontrans actional
no
journal-s ynctrans actional
no
journal-type
no
live -conne ctor-re f
no
log-journal-write -rate
no
manage me ntaddre s s
no
manage me ntnotification-addre s s
no
me mory-me as ure inte rval:e xpr
Journal Sync
Trans actional
Journal Type
Live Conne ctor Re f
Log Journal Write
Rate
Manage me nt
Addre s s
Manage me nt
Notification Addre s s
Me mory Me as ure
Inte rval
530
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Me mory Warning
Thre s hold
Pe rce ntage of
available me mory
which if e xce e de d
re s ults in a warning
log. The de fault
value is 25.
Whe the r me s s age
counte rs are
e nable d. The de fault
value is fals e .
How many days to
ke e p me s s age
counte r his tory. The
de fault value is 10.
The s ample pe riod
(in ms ) to us e for
me s s age counte rs .
The de fault value is
10000.
How ofte n (in ms ) to
s can for e xpire d
me s s age s . The
de fault value is
30000.
The priority of the
thre ad e xpiring
me s s age s . The
de fault value is 3.
The maximum
numbe r of
concurre nt re ads
allowe d on paging.
The de fault value is
5.
TODO. The de fault
value is -1.
Whe the r the
de live ry count is
pe rs is te d be fore
de live ry. Fals e
me ans that this only
happe ns afte r a
me s s age has be e n
cance lle d. The
de fault value is
fals e .
Whe the r IDs are
pe rs is te d to the
journal. The de fault
value is true .
no
me mory-warningthre s hold:e xpr
no
me s s age -counte re nable d
no
me s s age -counte rmax-day-his tory
no
me s s age -counte rs ample -pe riod
no
me s s age -e xpirys can-pe riod
no
me s s age -e xpirythre ad-priority
no
page -maxconcurre nt-io
no
pe rf-blas t-page s
no
pe rs is t-de live rycount-be fore de live ry
no
pe rs is t-id-cache
Me s s age Counte r
Enable d
Me s s age Counte r
Max Day His tory
Me s s age Counte r
Sample Pe riod
Me s s age Expiry
Scan Pe riod
Me s s age Expiry
Thre ad Priority
Page Max
Concurre nt Io
Pe rf Blas t Page s
Pe rs is t De live ry
Count Be fore
De live ry
Pe rs is t Id Cache
531
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Pe rs is te nce Enable d
Whe the r the s e rve r
will us e the file
bas e d journal for
pe rs is te nce . The
de fault value is true .
The lis t of
inte rce ptor clas s e s
us e d by this s e rve r.
Whe the r on s tartup
to pe rform a
diagnos tic te s t on
how fas t your dis k
can s ync. Us e ful
whe n de te rmining
pe rformance is s ue s .
The de fault value is
fals e .
The numbe r of
thre ads that the
main s che dule d
thre ad pool has . The
de fault value is 5.
The s e curity domain
to us e to ve rify us e r
and role information.
The de fault value is
othe r.
Whe the r s e curity is
e nable d. The de fault
value is true .
How long (in ms ) to
wait be fore
invalidating the
s e curity cache . The
de fault value is
10000.
How ofte n to dump
bas ic runtime
information to the
s e rve r log. A value
le s s than 1 dis able s
this fe ature . The
de fault value is -1.
Whe the r this s e rve r
is us ing a s hare d
s tore for failove r.
The de fault value is
true .
no
pe rs is te nce -e nable d
no
re motinginte rce ptors :nullable
no
run-s ync-s pe e d-te s t
no
s che dule d-thre adpool-max-s iz e :e xpr
no
s e curity-domain
no
s e curity-e nable d
no
s e curity-invalidationinte rval
no
s e rve r-dumpinte rval
no
s hare d-s tore
Re moting
Inte rce ptors
Run Sync Spe e d
Te s t
Sche dule d Thre ad
Pool Max Siz e
Se curity Domain
Se curity Enable d
Se curity Invalidation
Inte rval
Se rve r Dump
Inte rval
Share d Store
532
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Thre ad Pool Max
Siz e
The numbe r of
thre ads that the
main thre ad pool
has . -1 me ans no
limit. The de fault
value is 30.
How long (in ms )
be fore a trans action
can be re move d
from the re s ource
manage r afte r
cre ate time . The
de fault value is
300000.
How ofte n (in ms ) to
s can for time out
trans actions . The
de fault value is
1000.
Whe the r the s e rve r
s upports wild card
routing. The de fault
value is true .
no
thre ad-pool-maxs iz e :e xpr
no
trans action-time out
no
trans action-time outs can-pe riod
no
wild-card-routinge nable d
Trans action Time out
Trans action Time out
Scan Pe riod
Wild Card Routing
Enable d
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
T able 3.461. Met rics
Name
Descript io n
Clos e Conne ctions for Addre s s
Clos e s all the conne ctions of clie nts
conne cte d to this s e rve r whos e re mote
addre s s contains the s pe cifie d IP addre s s .
Re turns true if any conne ctions we re
clos e d, fals e othe rwis e .
He uris tically commits a pre pare d
trans action.
Force the me s s aging s e rve r to s top and
notify clie nts to failove r.
Re turns the addre s s s e ttings as a JSON
s tring for an addre s s match. The re turne d
String is a JSON s tring containing an array
of addre s s s e ttings de tails .
Re turns the conne ctors configure d for this
s e rve r us ing JSON s e rializ ation.
Commit Pre pare d Trans action
Force Failove r
Ge t Addre s s Se ttings as JSON
Ge t Conne ctors as JSON
533
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Ge t Las t Se nt Me s s age ID
Re turns the ID of the las t me s s age s e nt
from the give n s e s s ion to the give n
addre s s .
Ge ts the s e s s ion's cre ation time . Re turns
the cre ation time , re pre s e nte d as a s tring
s howing the numbe r of millis e conds s ince
the e poch.
Lis ts all the cons ume rs .
Lis ts the IDs of all the conne ctions
conne cte d to this s e rve r.
Lis t all JMS conne ctions .
Lis ts all the cons ume rs which be longs to
the JMS Conne ction s pe cifie d by the
conne ction-id.
Lis ts trans actions which have be e n
he uris tically committe d. Re turns a lis t of
s trings . The Strings are Bas e -64
re pre s e ntation of the trans action XID.
Lis ts trans actions which have be e n
he uris tically rolle d back. Re turns a lis t of
s trings . The Strings are Bas e -64
re pre s e ntation of the trans action XID.
Lis t all the pre pare d trans action, s orte d by
date , olde s t firs t, with de tails , in HTML
format.
Lis t all the pre pare d trans action, s orte d by
date , olde s t firs t, with de tails , in JSON
format.
Lis t all the pre pare d trans actions , s orte d
by date , olde s t firs t, with de tails in JMS, in
HTML format
Lis t all the pre pare d trans actions , s orte d
by date , olde s t firs t, with de tails in JMS
format, in JSON format
Lis t all the pre pare d trans action, s orte d by
date , olde s t firs t. Re turns a lis t of s trings .
The Strings are Bas e -64 re pre s e ntation of
the trans action XID and can be us e d to
he uris tically commit or rollback the
trans actions .
For all s e s s ions , lis ts information about
me s s age produce rs us ing JSON
s e rializ ation.
Lis ts the addre s s e s of all the clie nts
conne cte d to the give n addre s s . If an ipaddre s s argume nt is s upplie d, only thos e
clie nts whos e re mote addre s s s tring
include s the give n ip-addre s s s tring will be
re turne d.
Lis ts all the s e s s ions IDs for the s pe cifie d
conne ction ID.
Ge t Se s s ion Cre ation Time
Lis t All Cons ume rs as JSON
Lis t Conne ction IDs
Lis t Conne ctions as JSON
Lis t Cons ume rs as JSON
Lis t He uris tic Committe d Trans actions
Lis t He uris tic Rolle d Back Trans actions
Lis t Pre pare d Trans action De tails as HTML
Lis t Pre pare d Trans action De tails as JSON
Lis t Pre pare d Trans action JMS De tails as
HTML
Lis t Pre pare d Trans action JMS de tails as
JSON
Lis t Pre pare d Trans actions
Lis t Produce rs Info as JSON
Lis t Re mote Addre s s e s
Lis t Se s s ions
534
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Lis t Se s s ions as JSON
Lis ts all the s e s s ions IDs for the s pe cifie d
conne ction ID. The re turne d String is a
JSON s tring containing an array of s e s s ion
ids .
Lis ts all addre s s e s to which the de s ignate d
s e s s ion has s e nt me s s age s . The re turne d
String is a JSON s tring containing an array
of addre s s name s .
Re s e t all me s s age counte rs his tory.
Re s e t all me s s age counte rs .
He uris tically rolls back a pre pare d
trans action. Re turns true if the trans action
was s ucce s s fully rolle d back, fals e
othe rwis e .
Lis t Targe t De s tinations
Re s e t All Me s s age Counte r His torie s
Re s e t All Me s s age Counte rs
Rollback Pre pare d Trans action
Package Type s
none
3.3.12.4.3.1.1. JBo ss AS 7 and EAP 6 - JMS Queue Runt ime Service
Ove rvie w
T able 3.462. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
De fine s a JMS que ue .
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.463.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.464. Met rics
Name
T ype
Descript io n
Int ernal Name
535
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Cons ume r Count
me as ure me nt
cons ume r-count
De ad Le tte r
Addre s s
De live ring Count
trait
Durable
trait
Expiry Addre s s
trait
Me s s age Count
me as ure me nt
Me s s age s Adde d
me as ure me nt
Paus e d
trait
Que ue Addre s s
trait
Sche dule d Count
me as ure me nt
Se le ctor
Te mporary
trait
trait
The numbe r of
cons ume rs
cons uming
me s s age s from this
que ue .
The addre s s to s e nd
de ad me s s age s to.
The numbe r of
me s s age s that this
que ue is curre ntly
de live ring to its
cons ume rs .
Whe the r the que ue
is durable or not.
The de fault value is
true .
The addre s s to s e nd
e xpire d me s s age s
to.
The numbe r of
me s s age s curre ntly
in this que ue .
The numbe r of
me s s age s adde d to
this que ue s ince it
was cre ate d.
Whe the r the que ue
is paus e d.
The que ue addre s s
de fine s what
addre s s is us e d for
routing me s s age s .
The numbe r of
s che dule d
me s s age s in this
que ue .
The que ue s e le ctor.
Whe the r the que ue
is te mporary.
me as ure me nt
de ad-le tte r-addre s s
de live ring-count
durable
e xpiry-addre s s
me s s age -count
me s s age s -adde d
paus e d
que ue -addre s s
s che dule d-count
s e le ctor
te mporary
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.465.
536
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Entrie s
The jndi name s the
que ue will be bound
to.
no
e ntrie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
T able 3.466. Met rics
Name
Descript io n
Change Me s s age Priority
Change the priority of the me s s age
corre s ponding to the give n me s s age -id.
Re turns true if the me s s age was e xpire d,
fals e othe rwis e .
Change the priority of the me s s age s
corre s ponding to the give n filte r. Re turns
the numbe r of re move d me s s age s .
Re turns the numbe r of the me s s age s in
the que ue matching the give n filte r.
Expire the me s s age corre s ponding to the
give n me s s age -id. Re turns true if the
me s s age was e xpire d, fals e othe rwis e .
Expire the me s s age s matching the give n
filte r.
A s tring in JSON format.
Lis t the me s s age counte r as a s tring in
HTML format.
Lis t the me s s age counte r as a s tring in
JSON format.
Lis t the me s s age counte r his tory.
Lis t the me s s age counte r his tory as a
s tring in JSON format.
Lis t all me s s age s in the que ue that match
the filte r
Lis t all me s s age s in the que ue that match
the filte r and re turn the m as a s tring in
JSON format.
Move the me s s age corre s ponding to the
give n me s s age -id to anothe r que ue
Move the me s s age s corre s ponding to the
give n filte r to anothe r que ue .
Paus e the que ue .
Re move the me s s age corre s ponding to the
give n me s s age -id.
Re move me s s age s matching the give n
filte r from the de s tination.
Change Me s s age s Priority
Count Me s s age s
Expire Me s s age
Expire Me s s age s
Lis t Cons ume rs as JSON
Lis t Me s s age Counte r as HTML
Lis t Me s s age Counte r as JSON
Lis t Me s s age Counte r His tory as HTML
Lis t Me s s age Counte r His tory as JSON
Lis t Me s s age s
Lis t Me s s age s as JSON
Move Me s s age
Move Me s s age s
Paus e
Re move Me s s age
Re move Me s s age s
537
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Re s e t Me s s age Counte r
Re s ume
Se nd Me s s age to De ad Le tte r Addre s s
Re s e t the me s s age counte rs .
Re s ume the que ue .
Se nd the me s s age corre s ponding to the
give n me s s age -id to this que ue 's De ad
Le tte r Addre s s .
Se nd the me s s age s corre s ponding to the
give n filte r to this que ue 's De ad Le tte r
Addre s s .
Se nd Me s s age s to De ad Le tte r Addre s s
Package Type s
none
3.3.12.4.3.1.2. JBo ss AS 7 and EAP 6 - JMS T o pic Runt ime Service
Ove rvie w
T able 3.467. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
De fine s a JMS que ue .
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.468.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.469. Met rics
Name
T ype
Descript io n
Int ernal Name
De live ring Count
me as ure me nt
de live ring-count
Durable Me s s age
Count
me as ure me nt
The numbe r of
me s s age s that this
que ue is curre ntly
de live ring to its
cons ume rs .
The numbe r of
me s s age s for all
durable s ubs cribe rs
for this topic.
538
durable -me s s age count
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Durable Subs cription me as ure me nt
Count
Me s s age Count
me as ure me nt
Me s s age s Adde d
me as ure me nt
Non Durable
Me s s age Count
me as ure me nt
Non Durable
Subs cription Count
me as ure me nt
Subs cription Count
me as ure me nt
Te mporary
trait
Topic Addre s s
trait
Descript io n
Int ernal Name
The numbe r of
durable s ubs cribe rs
for this topic.
The numbe r of
me s s age s curre ntly
in this que ue .
The numbe r of
me s s age s adde d to
this que ue s ince it
was cre ate d.
The numbe r of
me s s age s for all
non-durable
s ubs cribe rs for this
topic.
The numbe r of nondurable s ubs cribe rs
for this topic.
The numbe r of
(durable and nondurable ) s ubs cribe rs
for this topic.
Whe the r the topic is
te mporary.
The addre s s the
topic points to.
durable -s ubs criptioncount
me s s age -count
me s s age s -adde d
non-durable me s s age -count
non-durable s ubs cription-count
s ubs cription-count
te mporary
topic-addre s s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.470 .
Name
Descript io n
Required
Int ernal Name
JNDI Name s
The jndi name s the
que ue will be bound
to.
no
e ntrie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
T able 3.471. Met rics
539
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Count Me s s age s for Subs cription
Count the numbe r of me s s age s matching
the filte r for the give n s ubs cription.
Drop all s ubs criptions from this topic.
Drop a durable s ubs cription
Lis t all s ubs criptions .
Lis t all s ubs criptions as a s tring in JSON
format.
Lis t only the durable s ubs criptions .
Lis t only the durable s ubs criptions , as a
s tring in JSON format.
Lis t all the me s s age s for the give n
s ubs cription.
Lis t all the me s s age s for the give n
s ubs cription as a s tring in JSON format.
Lis t only the non-durable s ubs criptions .
Lis t only the non-durable s ubs criptions , as
a s tring in JSON format.
Re move me s s age s matching the give n
filte r from the de s tination.
Drop All Subs criptions
Drop Durable Subs cription
Lis t All Subs criptions
Lis t All Subs criptions as JSON
Lis t Durable Subs criptions
Lis t Durable Subs criptions as JSON
Lis t Me s s age s for Subs cription
Lis t Me s s age s for Subs cription as JSON
Lis t Non-Durable Subs criptions
Lis t Non-Durable Subs criptions as JSON
Re move Me s s age s
Package Type s
none
3.3.12.4.4. JBo ss AS 7 and EAP 6 - JPA Runt ime Service
Overview
T able 3.472. Overview
De s cription:
Single ton:
Plugin:
The configuration of the JPA s ubs ys te m.
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.12.4.4.1, “JBos s AS 7 and EAP 6 - Hibe rnate Pe rs is te nce Unit Se rvice ”
Co nnect io n Pro pert ies
T able 3.473.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
540
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.4.4.1. JBo ss AS 7 and EAP 6 - Hibernat e Persist ence Unit Service
Ove rvie w
T able 3.474. Overview
De s cription:
Runtime information about JPA us e in the
de ployme nt.
ye s
JBos s AS7
Single ton:
Plugin:
Child Re s ource Type s
Se ction 3.3.12.4.4.1.1, “JBos s AS 7 and EAP 6 - Entity Cache Se rvice ”
Se ction 3.3.12.4.4.1.2, “JBos s AS 7 and EAP 6 - Entity Se rvice ”
Se ction 3.3.12.4.4.1.3, “JBos s AS 7 and EAP 6 - Colle ction Se rvice ”
Conne ction Prope rtie s
T able 3.475.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.476. Met rics
Name
T ype
Descript io n
Int ernal Name
Clos e State me nt
Count
me as ure me nt
Numbe r of re le as e d
pre pare d
s tate me nts .
clos e -s tate me ntcount
541
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Clos e State me nt
Count pe r Minute
me as ure me nt
clos e -s tate me ntcount
Colle ction
Count
Colle ction
Count pe r
Colle ction
Count
Colle ction
Count pe r
Colle ction
Count
Fe tch
me as ure me nt
Fe tch
Minute
Load
me as ure me nt
Load
Minute
Re cre ate d
me as ure me nt
Colle ction Re cre ate d
Count pe r Minute
me as ure me nt
Colle ction Re move
Count
Colle ction Re move
Count pe r Minute
Colle ction Update
Count
Colle ction Update
Count pe r Minute
Comple te d
Trans action Count
me as ure me nt
Comple te d
Trans action Count
pe r Minute
Conne ct Count
me as ure me nt
Conne ct Count pe r
Minute
me as ure me nt
Entity De le te Count
me as ure me nt
Entity De le te Count
pe r Minute
Entity Fe tch Count
me as ure me nt
Entity Fe tch Count
pe r Minute
Entity Ins e rt Count
me as ure me nt
Entity Ins e rt Count
pe r Minute
Entity Load Count
me as ure me nt
Numbe r of re le as e d
pre pare d
s tate me nts .
Numbe r of
colle ctions fe tche d.
Numbe r of
colle ctions fe tche d.
Numbe r of
colle ctions loade d.
Numbe r of
colle ctions loade d.
Numbe r of
colle ctions
re cre ate d.
Numbe r of
colle ctions
re cre ate d.
Numbe r of
colle ctions re move d.
Numbe r of
colle ctions re move d.
Numbe r of
colle ctions update d.
Numbe r of
colle ctions update d.
Numbe r of
comple te d
trans actions .
Numbe r of
comple te d
trans actions .
Ge t the numbe r of
conne ctions as ke d
for by the s e s s ions .
Ge t the numbe r of
conne ctions as ke d
for by the s e s s ions .
Ge t numbe r of e ntity
de le te s .
Ge t numbe r of e ntity
de le te s .
Ge t numbe r of e ntity
fe tche s .
Ge t numbe r of e ntity
fe tche s .
Ge t numbe r of e ntity
ins e rts .
Ge t numbe r of e ntity
ins e rts .
Ge t numbe r of e ntity
loads .
542
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
colle ction-fe tch-count
colle ction-fe tch-count
colle ction-load-count
colle ction-load-count
colle ction-re cre ate dcount
colle ction-re cre ate dcount
colle ction-re move count
colle ction-re move count
colle ction-update count
colle ction-update count
comple te dtrans action-count
comple te dtrans action-count
conne ct-count
conne ct-count
e ntity-de le te -count
e ntity-de le te -count
e ntity-fe tch-count
e ntity-fe tch-count
e ntity-ins e rt-count
e ntity-ins e rt-count
e ntity-load-count
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Entity Load Count
pe r Minute
Entity Update Count
me as ure me nt
e ntity-load-count
Entity Update Count
pe r Minute
Flus h Count
me as ure me nt
Flus h Count pe r
Minute
me as ure me nt
Optimis tic Failure
Count
Optimis tic Failure
Count pe r Minute
Pre pare d State me nt
Count
me as ure me nt
Pre pare d State me nt
Count pe r Minute
me as ure me nt
Que ry Cache Hit
Count
me as ure me nt
Que ry Cache Hit
Count pe r Minute
me as ure me nt
Que ry Cache Mis s
Count
me as ure me nt
Que ry Cache Mis s
Count pe r Minute
me as ure me nt
Que ry Cache Put
Count
me as ure me nt
Que ry Cache Put
Count pe r Minute
me as ure me nt
Que ry Exe cution
Count
Que ry Exe cution
Count pe r Minute
me as ure me nt
Ge t numbe r of e ntity
loads .
Ge t numbe r of e ntity
update s .
Ge t numbe r of e ntity
update s .
Ge t the numbe r of
flus he s e xe cute d by
s e s s ions (e ithe r
implicit or e xplicit).
Ge t the numbe r of
flus he s e xe cute d by
s e s s ions (e ithe r
implicit or e xplicit).
Numbe r of optimis tic
lock e xce ptions .
Numbe r of optimis tic
lock e xce ptions .
Numbe r of acquire d
pre pare d
s tate me nts .
Numbe r of acquire d
pre pare d
s tate me nts .
Ge t the numbe r of
cache d que rie s
s ucce s s fully
re trie ve d from
cache .
Ge t the numbe r of
cache d que rie s
s ucce s s fully
re trie ve d from
cache .
Ge t the numbe r of
cache d que rie s not
found in cache .
Ge t the numbe r of
cache d que rie s not
found in cache .
Ge t the numbe r of
cache able que rie s
put in cache .
Ge t the numbe r of
cache able que rie s
put in cache .
Ge t numbe r of
e xe cute d que rie s .
Ge t numbe r of
e xe cute d que rie s .
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
e ntity-update -count
e ntity-update -count
flus h-count
flus h-count
optimis tic-failure count
optimis tic-failure count
pre pare d-s tate me ntcount
pre pare d-s tate me ntcount
que ry-cache -hitcount
que ry-cache -hitcount
que ry-cache -mis s count
que ry-cache -mis s count
que ry-cache -putcount
que ry-cache -putcount
que ry-e xe cutioncount
que ry-e xe cutioncount
543
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Que ry Exe cution
Max Time
me as ure me nt
que ry-e xe cutionmax-time
Que ry Exe cution
Max Time Que ry
String
Se cond Le ve l Cache
Hit Count
trait
Se cond Le ve l Cache
Hit Count pe r Minute
me as ure me nt
Se cond Le ve l Cache
Mis s Count
me as ure me nt
Se cond Le ve l Cache
Mis s Count pe r
Minute
me as ure me nt
Se cond Le ve l Cache
Put Count
me as ure me nt
Se cond Le ve l Cache
Put Count pe r Minute
me as ure me nt
Ge t the time in
millis e conds of the
s lowe s t que ry.
Ge t the que ry s tring
for the s lowe s t
que ry.
Numbe r of
cache able
e ntitie s /colle ctions
s ucce s s fully
re trie ve d from the
cache .
Numbe r of
cache able
e ntitie s /colle ctions
s ucce s s fully
re trie ve d from the
cache .
Numbe r of
cache able
e ntitie s /colle ctions
not found in the
cache and loade d.
Numbe r of
cache able
e ntitie s /colle ctions
not found in the
cache and loade d.
Numbe r of
cache able
e ntitie s /colle ctions
put in the cache .
Numbe r of
cache able
e ntitie s /colle ctions
put in the cache .
Numbe r of s e s s ions
clos e d.
Numbe r of s e s s ions
clos e d.
Numbe r of s e s s ions
ope ne d.
Numbe r of s e s s ions
ope ne d.
Numbe r of
s ucce s s ful
trans actions .
Numbe r of
s ucce s s ful
trans actions .
me as ure me nt
Se s s ion Clos e Count me as ure me nt
Se s s ion Clos e Count me as ure me nt
pe r Minute
Se s s ion Ope n Count me as ure me nt
Se s s ion Ope n Count
pe r Minute
Succe s s ful
Trans action Count
me as ure me nt
Succe s s ful
Trans action Count
pe r Minute
me as ure me nt
544
me as ure me nt
que ry-e xe cutionmax-time -que rys tring
s e cond-le ve l-cache hit-count
s e cond-le ve l-cache hit-count
s e cond-le ve l-cache mis s -count
s e cond-le ve l-cache mis s -count
s e cond-le ve l-cache put-count
s e cond-le ve l-cache put-count
s e s s ion-clos e -count
s e s s ion-clos e -count
s e s s ion-ope n-count
s e s s ion-ope n-count
s ucce s s fultrans action-count
s ucce s s fultrans action-count
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.477.
Name
Descript io n
Required
Int ernal Name
Enable d
De te rmine if
s tatis tics are
e nable d.
no
e nable d
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
T able 3.478. Met rics
Name
Descript io n
Subs ys te m:cle ar
Subs ys te m:e vict All
Subs ys te m:s ummary
Vie w Que rie s
Cle ar s tatis tics .
Evict all e ntitie s from s e cond le ve l cache .
Log the s tatis tics .
Vie w s tatis tical information about que rie s
e xe cute d by Hibe rnate
Package Type s
none
3.3.12.4.4.1.1. JBo ss AS 7 and EAP 6 - Ent it y Cache Service
Ove rvie w
T able 3.479. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
Statis tics for a Hibe rnate Se cond Le ve l
Cache re gion.
ye s
JBos s AS7
none
Conne ction Prope rtie s
T able 3.480 .
545
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.481. Met rics
Name
T ype
Descript io n
Int ernal Name
Ele me nt Count In
Me mory
me as ure me nt
e le me nt-count-inme mory
Hit Count
me as ure me nt
Mis s Count
me as ure me nt
Put Count
me as ure me nt
Numbe r of
cache able
e ntitie s /colle ctions
curre ntly s tore d in
me mory.
Numbe r of
cache able
e ntitie s /colle ctions
s ucce s s fully
re trie ve d from the
cache .
Numbe r of
cache able
e ntitie s /colle ctions
not found in the
cache and loade d.
Numbe r of
cache able
e ntitie s /colle ctions
put in the cache .
hit-count
mis s -count
put-count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
none
Ope rations
none
Package Type s
none
3.3.12.4.4.1.2. JBo ss AS 7 and EAP 6 - Ent it y Service
546
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
3.3.12.4.4.1.2. JBo ss AS 7 and EAP 6 - Ent it y Service
Ove rvie w
T able 3.482. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
Statis tics for individual e ntitie s .
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.483.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.484. Met rics
Name
T ype
Descript io n
Int ernal Name
Entity De le te Count
me as ure me nt
e ntity-de le te -count
Entity De le te Count
pe r Minute
Entity Fe tch Count
me as ure me nt
Entity Fe tch Count
pe r Minute
Entity Ins e rt Count
me as ure me nt
Entity Ins e rt Count
pe r Minute
Entity Load Count
me as ure me nt
Entity Load Count
pe r Minute
Entity Update Count
me as ure me nt
Entity Update Count
pe r Minute
Optimis tic Failure
Count
me as ure me nt
Ge t numbe r of e ntity
de le te s .
Ge t numbe r of e ntity
de le te s .
Ge t numbe r of e ntity
fe tche s .
Ge t numbe r of e ntity
fe tche s .
Ge t numbe r of e ntity
ins e rts .
Ge t numbe r of e ntity
ins e rts .
Ge t numbe r of e ntity
loads .
Ge t numbe r of e ntity
loads .
Ge t numbe r of e ntity
update s .
Ge t numbe r of e ntity
update s .
Numbe r of optimis tic
lock e xce ptions .
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
e ntity-de le te -count
e ntity-fe tch-count
e ntity-fe tch-count
e ntity-ins e rt-count
e ntity-ins e rt-count
e ntity-load-count
e ntity-load-count
e ntity-update -count
e ntity-update -count
optimis tic-failure count
547
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Optimis tic Failure
Count pe r Minute
me as ure me nt
Numbe r of optimis tic
lock e xce ptions .
optimis tic-failure count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
none
Ope rations
none
Package Type s
none
3.3.12.4.4.1.3. JBo ss AS 7 and EAP 6 - Co llect io n Service
Ove rvie w
T able 3.485. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
Statis tics for individual colle ctions .
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.486.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.487. Met rics
548
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Colle ction Fe tch
Count
me as ure me nt
colle ction-fe tch-count
Colle ction Fe tch
Count pe r Minute
me as ure me nt
Colle ction Load
Count
me as ure me nt
Colle ction Load
Count pe r Minute
me as ure me nt
Colle ction Re cre ate d
Count
me as ure me nt
Colle ction Re cre ate d
Count pe r Minute
me as ure me nt
Colle ction Re move
Count
me as ure me nt
Colle ction Re move
Count pe r Minute
me as ure me nt
Colle ction Update
Count
me as ure me nt
Colle ction Update
Count pe r Minute
me as ure me nt
Numbe r of time s
colle ction was
fe tche d.
Numbe r of time s
colle ction was
fe tche d.
Numbe r of time s
colle ction was
loade d.
Numbe r of time s
colle ction was
loade d.
Numbe r of time s
colle ction was
re cre ate d.
Numbe r of time s
colle ction was
re cre ate d.
Numbe r of time s
colle ction was
re move d.
Numbe r of time s
colle ction was
re move d.
Numbe r of time s
colle ction was
update d.
Numbe r of time s
colle ction was
update d.
colle ction-fe tch-count
colle ction-load-count
colle ction-load-count
colle ction-re cre ate dcount
colle ction-re cre ate dcount
colle ction-re move count
colle ction-re move count
colle ction-update count
colle ction-update count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
none
Ope rations
none
Package Type s
none
3.3.12.4.5. JBo ss AS 7 and EAP 6 - Dat aso urces Runt ime Service
Overview
T able 3.488. Overview
549
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.488. Overview
De s cription:
Runtime re s ource s e xpos e d by data
s ource s include d in this de ployme nt.
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
Se ction 3.3.12.4.5.1, “JBos s AS 7 and EAP 6 - XA Datas ource Runtime Se rvice ”
Se ction 3.3.12.4.5.2, “JBos s AS 7 and EAP 6 - Datas ource Runtime Se rvice ”
Co nnect io n Pro pert ies
T able 3.489.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.4.5.1. JBo ss AS 7 and EAP 6 - XA Dat aso urce Runt ime Service
Ove rvie w
T able 3.490 . Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
none
550
A JDBC XA data-s ource configuration
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Conne ction Prope rtie s
T able 3.491.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.492. Met rics
Name
T ype
Descript io n
Int ernal Name
Pre pare d State me nt
Cache Curre nt Siz e
me as ure me nt
Pre pare dState me ntC
ache Curre ntSiz e
Pre pare d State me nt
Cache Mis s Count
me as ure me nt
Pre pare d State me nt
Cache Mis s Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Add Count
me as ure me nt
Pre pare d State me nt
Cache Acce s s Count
me as ure me nt
Pre pare d State me nt
Cache Acce s s Count
pe r Minute
Pre pare d State me nt
Cache De le te Count
me as ure me nt
Pre pare d State me nt
Cache De le te Count
pe r Minute
me as ure me nt
The numbe r of
pre pare d and
callable s tate me nts
curre ntly cache d in
the s tate me nt cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of
s tate me nts adde d to
the s tate me nt cache
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of
s tate me nts
dis carde d from the
cache
me as ure me nt
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache AddCount
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache De le te Count
551
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Pre pare d State me nt
Cache Hit Count
me as ure me nt
Pre pare dState me ntC
ache HitCount
Pre pare d State me nt
Cache Hit Count pe r
Minute
me as ure me nt
Active Count
Available Count
Ave rage Blocking
Time
me as ure me nt
me as ure me nt
me as ure me nt
Ave rage Cre ation
Time
me as ure me nt
Cre ate d Count
Cre ate d Count pe r
Minute
De s troye d Count
De s troye d Count
pe r Minute
Max Cre ation Time
me as ure me nt
me as ure me nt
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The active count
The available count
The ave rage time
s pe nt blocking for a
conne ction
The ave rage time
s pe nt cre ating a
phys ical conne ction
The cre ate d count
The cre ate d count
me as ure me nt
me as ure me nt
The de s troye d count
The de s troye d count
De s troye dCount
De s troye dCount
me as ure me nt
MaxCre ationTime
Max Us e d Count
me as ure me nt
Max Wait Time
me as ure me nt
Time d Out
Time d Out pe r
Minute
Total Cre ation Time
me as ure me nt
me as ure me nt
The maximum time
for cre ating a
phys ical conne ction
The maximum
numbe r of
conne ctions us e d
The maximum wait
time for a conne ction
The time d out count
The time d out count
TotalCre ationTime
Total Cre ation Time
pe r Minute
me as ure me nt
Total Blocking Time
me as ure me nt
The total time s pe nt
cre ating phys ical
conne ctions
The total time s pe nt
cre ating phys ical
conne ctions
The total blocking
time
The total blocking
time
Conne ction
Available ?
The min pool s iz e
s e tting
The max pool s iz e
s e tting
me as ure me nt
Total Blocking Time
me as ure me nt
pe r Minute
Conne ction
trait
Available ?
Min Pool Siz e s e tting me as ure me nt
Max Pool Siz e
s e tting
552
me as ure me nt
Pre pare dState me ntC
ache HitCount
Active Count
Available Count
Ave rage BlockingTim
e
Ave rage Cre ationTim
e
Cre ate dCount
Cre ate dCount
MaxUs e dCount
MaxWaitTime
Time dOut
Time dOut
TotalCre ationTime
TotalBlockingTime
TotalBlockingTime
conne ctionAvailable
min-pool-s iz e
max-pool-s iz e
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.493.
Name
Prope rtie s
Allocation Re try
Allocation Re try Wait
Millis
Background
Validation
Background
Validation Millis
Descript io n
Required
Int ernal Name
no
no
*2
allocation-re try
The allocation re try
e le me nt indicate s
the numbe r of time s
that allocating a
conne ction s hould
be trie d be fore
throwing an
e xce ption
The allocation re try
no
wait millis e le me nt
s pe cifie s the
amount of time , in
millis e conds , to wait
be twe e n re trying to
allocate a conne ction
An e le me nt to
no
s pe cify that
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Changing this
value can be done
only on dis able d
datas ource , re quire s
a s e rve r re s tart
othe rwis e . The
de fault value is
fals e .
The backgroundno
validation-millis
e le me nt s pe cifie s
the amount of time ,
in millis e conds , that
background
validation will run.
Changing this value
can be done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e
allocation-re try-waitmillis
backgroundvalidation
backgroundvalidation-millis
553
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Blocking Time out
Wait Millis
The blockingtime out-millis
e le me nt s pe cifie s
the maximum time ,
in millis e conds , to
block while waiting
for a conne ction
be fore throwing an
e xce ption. Note that
this blocks only
while waiting for
locking a conne ction,
and will ne ve r throw
an e xce ption if
cre ating a ne w
conne ction take s an
inordinate ly long
time
Spe cify an SQL
s tate me nt to che ck
validity of a pool
conne ction. This may
be calle d whe n
manage d conne ction
is obtaine d from the
pool
De fine s the JDBC
drive r the
datas ource s hould
us e . It is a s ymbolic
name matching the
the name of
ins talle d drive r. In
cas e the drive r is
de ploye d as jar, the
name is the name of
de ployme nt unit
Spe cifie s if the
datas ource s hould
be e nable d
An
org.jbos s .jca.adapte r
s .jdbc.Exce ptionSort
e r that provide s an
is Exce ptionFatal(SQL
Exce ption) me thod
to validate if an
e xce ption s hould
broadcas t an e rror
The e xce ption
s orte r prope rtie s
Spe cifie s how the
pool s hould be flus h
in cas e of an e rror.
no
blocking-time outwait-millis
no
che ck-validconne ction-s ql
no
drive r-name
no
e nable d
no
e xce ption-s orte rclas s -name
no
e xce ption-s orte rprope rtie s
flus h-s trate gy
Che ck Valid
Conne ction Sql
Drive r Name
Enable d
Exce ption Sorte r
Clas s Name
Exce ption Sorte r
Prope rtie s
Flus h Strate gy
554
no
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Idle Time out Minute s
The idle -time outminute s e le me nts
s pe cifie s the
maximum time , in
minute s , a
conne ction may be
idle be fore be ing
clos e d. The actual
maximum time
de pe nds als o on the
Idle Re move r s can
time , which is half of
the s malle s t idle time out-minute s
value of any pool.
Changing this value
can be done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e .
An e le me nt to
e nable inte rle aving
for XA conne ctions .
The de fault value is
fals e .
Spe cifie s the JNDI
name for the
datas ource
Enable JTA
inte gration. The
de fault value is true .
The max-pool-s iz e
e le me nt s pe cifie s
the maximum
numbe r of
conne ctions for a
pool. No more
conne ctions will be
cre ate d in e ach s ubpool. The de fault
value is 20.
The min-pool-s iz e
e le me nt s pe cifie s
the minimum
numbe r of
conne ctions for a
pool. The de fault
value is 0.
Spe cifie s an SQL
s tate me nt to
e xe cute whe ne ve r a
conne ction is adde d
to the conne ction
pool
no
idle -time out-minute s
no
inte rle aving
no
jndi-name
no
jta
no
max-pool-s iz e
no
min-pool-s iz e
no
ne w-conne ction-s ql
Inte rle aving
Jndi Name
Jta
Max Pool Siz e
Min Pool Siz e
Ne w Conne ction Sql
555
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
No Re cove ry
Spe cifie s if the
conne ction pool
s hould be e xclude d
from re cove ry
Oracle doe s not like
XA conne ctions
ge tting us e d both
ins ide and outs ide a
JTA trans action. To
workaround the
proble m you can
cre ate s e parate
s ub-pools for the
diffe re nt conte xts .
The de fault value is
fals e .
Should the Xid be
padde d. The de fault
value is fals e .
Spe cifie s the
pas s word us e d
whe n cre ating a ne w
conne ction
Should the pool be
pre fille d. Changing
this value can be
done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e .
The de fault value is
fals e .
Spe cifie s if the minpool-s iz e s hould be
cons ide re d s trictly.
The de fault value is
fals e .
The numbe r of
pre pare d
s tate me nts pe r
conne ction in an LRU
cache
Any configure d
que ry time out in
s e conds . If not
provide d no time out
will be s e t
The fully qualifie d
clas s name of the
re authe ntication
plugin
imple me ntation
no
no-re cove ry
no
no-tx-s e parate -pool
no
pad-xid
no
pas s word
no
pool-pre fill
no
pool-us e -s trict-min
no
pre pare ds tate me nts -cache s iz e
no
que ry-time out
no
re auth-plugin-clas s name
No Tx Se parate Pool
Pad Xid
Pas s word
Pool Pre fill
Pool Us e Strict Min
Pre pare d
State me nts Cache
Siz e
Que ry Time out
Re auth Plugin Clas s
Name
556
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Re auth Plugin
Prope rtie s
The prope rtie s for
the re authe ntication
plugin
The pas s word us e d
for re cove ry
The fully qualifie d
clas s name of the
re cove ry plugin
imple me ntation
The prope rtie s for
the re cove ry plugin
The s e curity domain
us e d for re cove ry
The us e r name
us e d for re cove ry
The is -s ame -rmove rride e le me nt
allows one to
unconditionally s e t
whe the r the
javax.trans action.xa.
XARe s ource .is Same
RM(XARe s ource )
re turns true or fals e
Spe cifie s the
s e curity domain
which de fine s the
javax.s e curity.auth.S
ubje ct that are us e d
to dis tinguis h
conne ctions in the
pool
Whe the r to s e t the
que ry time out bas e d
on the time
re maining until
trans action time out.
Any configure d
que ry time out will
be us e d if the re is
no trans action. The
de fault value is
fals e .
no
re auth-pluginprope rtie s
no
re cove ry-pas s word
no
re cove ry-pluginclas s -name
no
no
re cove ry-pluginprope rtie s
re cove ry-s e curitydomain
re cove ry-us e rname
no
s ame -rm-ove rride
no
s e curity-domain
no
s e t-tx-que ry-time out
Re cove ry Pas s word
Re cove ry Plugin
Clas s Name
Re cove ry Plugin
Prope rtie s
Re cove ry Se curity
Domain
Re cove ry Us e rname
Same Rm Ove rride
Se curity Domain
Se t Tx Que ry
Time out
no
557
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Share Pre pare d
State me nts
Whe the r to s hare
pre pare d
s tate me nts , i.e .
whe the r as king for
s ame s tate me nt
twice without clos ing
us e s the s ame
unde rlying pre pare d
s tate me nt. The
de fault value is
fals e .
Enable s pying of
SQL s tate me nts .
The de fault value is
fals e .
An
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onChe cke r that
provide s an
is Stale Conne ction(S
QLExce ption)
me thod which if it
re turns true will
wrap the e xce ption
in an
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onExce ption
The s tale conne ction
che cke r prope rtie s
Whe the r to che ck for
unclos e d
s tate me nts whe n a
conne ction is
re turne d to the pool,
re s ult s e ts are
clos e d, a s tate me nt
is clos e d or re turn
to the pre pare d
s tate me nt cache .
Valid value s are :
'fals e ' - do not track
s tate me nts , 'true ' track s tate me nts
and re s ult s e ts and
warn whe n the y are
not clos e d, 'nowarn'
- track s tate me nts
but do not warn
about the m be ing
unclos e d. The
de fault value is
'NOWARN'.
no
s hare -pre pare ds tate me nts
no
s py
no
s tale -conne ctionche cke r-clas s -name
no
s tale -conne ctionche cke r-prope rtie s
track-s tate me nts
Spy
Stale Conne ction
Che cke r Clas s
Name
Stale Conne ction
Che cke r Prope rtie s
Track State me nts
558
no
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Trans action Is olation
Se t the
java.s ql.Conne ction
trans action is olation
le ve l. Valid value s
are :
TRANSACTION_READ
_UNCOMMITTED,
TRANSACTION_READ
_COMMITTED,
TRANSACTION_REPE
ATABLE_READ,
TRANSACTION_SERIA
LIZABLE and
TRANSACTION_NONE
Spe cifie s the
de lime te r for URLs
in conne ction-url for
HA datas ource s
A clas s that
imple me nts
org.jbos s .jca.adapte r
s .jdbc.URLSe le ctorSt
rate gy
Enable the us e of a
cache d conne ction
manage r. The
de fault value is true .
Whe the r to fail a
conne ction allocation
on the firs t try if it is
invalid (true ) or ke e p
trying until the pool
is e xhaus te d of all
pote ntial
conne ctions (fals e ).
The de fault value is
fals e .
Se tting this to fals e
will bind the
datas ource into
global JNDI. The
de fault value is true .
Any configure d
time out for inte rnal
locks on the
re s ource adapte r
obje cts in s e conds
Spe cify the us e r
name us e d whe n
cre ating a ne w
conne ction
no
trans action-is olation
no
url-de limite r
no
url-s e le ctors trate gy-clas s -name
no
us e -ccm
no
us e -fas t-fail
no
us e -java-conte xt
no
us e -try-lock
no
us e r-name
Url De limite r
Url Se le ctor
Strate gy Clas s
Name
Us e Ccm
Us e Fas t Fail
Us e Java Conte xt
Us e Try Lock
Us e r Name
559
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Valid Conne ction
Che cke r Clas s
Name
An
org.jbos s .jca.adapte r
s .jdbc.ValidConne ctio
nChe cke r that
provide s an
is ValidConne ction(Co
nne ction) me thod to
validate a
conne ction. If an
e xce ption is
re turne d that me ans
the conne ction is
invalid. This
ove rride s the che ckvalid-conne ction-s ql
e le me nt
The valid conne ction
che cke r prope rtie s
The validate -onmatch e le me nt
s pe cifie s if
conne ction validation
s hould be done
whe n a conne ction
factory atte mpts to
match a manage d
conne ction. This is
typically e xclus ive to
the us e of
background
validation. The
de fault value is
fals e .
Should the
XARe s ource
ins tance s be
wrappe d in a
org.jbos s .tm.XARe s o
urce Wrappe r
ins tance . The de fault
value is true .
The fully qualife d
name of the
javax.s ql.XADataSou
rce imple me ntation
The value is pas s e d
to
XARe s ource .s e tTran
s actionTime out(), in
s e conds . De fault is
z e ro
no
valid-conne ctionche cke r-clas s -name
no
no
valid-conne ctionche cke r-prope rtie s
validate -on-match
no
wrap-xa-re s ource
no
xa-datas ource -clas s
no
xa-re s ource -time out
Valid Conne ction
Che cke r Prope rtie s
Validate On Match
Wrap Xa Re s ource
Xa Datas ource
Clas s
Xa Re s ource
Time out
560
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
T able 3.494. Met rics
Name
Descript io n
Subs ys te m:flus h All Conne ction In Pool
Subs ys te m:flus h Idle Conne ction In Pool
Subs ys te m:te s t Conne ction In Pool
Package Type s
Flus he s all conne ctions in the pool
Flus he s all idle conne ctions in the pool
Te s t if a conne ction can be obtaine d
none
3.3.12.4.5.2. JBo ss AS 7 and EAP 6 - Dat aso urce Runt ime Service
Ove rvie w
T able 3.495. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
A JDBC data-s ource configuration
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.496.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.497. Met rics
Name
T ype
Descript io n
Int ernal Name
561
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Pre pare d State me nt
Cache Curre nt Siz e
me as ure me nt
Pre pare dState me ntC
ache Curre ntSiz e
Pre pare d State me nt
Cache Mis s Count
me as ure me nt
Pre pare d State me nt
Cache Mis s Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Add Count
me as ure me nt
Pre pare d State me nt
Cache Acce s s Count
me as ure me nt
Pre pare d State me nt
Cache Acce s s Count
pe r Minute
Pre pare d State me nt
Cache De le te Count
me as ure me nt
Pre pare d State me nt
Cache De le te Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Hit Count
me as ure me nt
Pre pare d State me nt
Cache Hit Count pe r
Minute
me as ure me nt
Active Count
Available Count
Ave rage Blocking
Time
me as ure me nt
me as ure me nt
me as ure me nt
Ave rage Cre ation
Time
me as ure me nt
Cre ate d Count
me as ure me nt
The numbe r of
pre pare d and
callable s tate me nts
curre ntly cache d in
the s tate me nt cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of
s tate me nts adde d to
the s tate me nt cache
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The active count
The available count
The ave rage time
s pe nt blocking for a
conne ction
The ave rage time
s pe nt cre ating a
phys ical conne ction
The cre ate d count
562
me as ure me nt
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache AddCount
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache HitCount
Pre pare dState me ntC
ache HitCount
Active Count
Available Count
Ave rage BlockingTim
e
Ave rage Cre ationTim
e
Cre ate dCount
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Cre ate d Count pe r
Minute
De s troye d Count
De s troye d Count
pe r Minute
Max Cre ation Time
me as ure me nt
The cre ate d count
Cre ate dCount
me as ure me nt
me as ure me nt
The de s troye d count
The de s troye d count
De s troye dCount
De s troye dCount
me as ure me nt
MaxCre ationTime
Max Us e d Count
me as ure me nt
Max Wait Time
me as ure me nt
Time d Out
Time d Out pe r
Minute
Total Cre ation Time
me as ure me nt
me as ure me nt
The maximum time
for cre ating a
phys ical conne ction
The maximum
numbe r of
conne ctions us e d
The maximum wait
time for a conne ction
The time d out count
The time d out count
TotalCre ationTime
Total Cre ation Time
pe r Minute
me as ure me nt
Total Blocking Time
me as ure me nt
The total time s pe nt
cre ating phys ical
conne ctions
The total time s pe nt
cre ating phys ical
conne ctions
The total blocking
time
The total blocking
time
Conne ction
Available ?
The min pool s iz e
s e tting
The max pool s iz e
s e tting
me as ure me nt
Total Blocking Time
me as ure me nt
pe r Minute
Conne ction
trait
Available ?
Min Pool Siz e s e tting me as ure me nt
Max Pool Siz e
s e tting
me as ure me nt
MaxUs e dCount
MaxWaitTime
Time dOut
Time dOut
TotalCre ationTime
TotalBlockingTime
TotalBlockingTime
conne ctionAvailable
min-pool-s iz e
max-pool-s iz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.498.
Name
Conne ction Prope rty
Descript io n
Required
Int ernal Name
no
*1
563
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Allocation Re try
The allocation re try
e le me nt indicate s
the numbe r of time s
that allocating a
conne ction s hould
be trie d be fore
throwing an
e xce ption
The allocation re try
wait millis e le me nt
s pe cifie s the
amount of time , in
millis e conds , to wait
be twe e n re trying to
allocate a conne ction
An e le me nt to
s pe cify that
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Changing this
value can be done
only on dis able d
datas ource , re quire s
a s e rve r re s tart
othe rwis e . The
de fault value is
fals e .
The backgroundvalidation-millis
e le me nt s pe cifie s
the amount of time ,
in millis e conds , that
background
validation will run.
Changing this value
can be done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e
no
allocation-re try
no
allocation-re try-waitmillis
no
backgroundvalidation
no
backgroundvalidation-millis
Allocation Re try Wait
Millis
Background
Validation
Background
Validation Millis
564
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Blocking Time out
Wait Millis
The blockingtime out-millis
e le me nt s pe cifie s
the maximum time ,
in millis e conds , to
block while waiting
for a conne ction
be fore throwing an
e xce ption. Note that
this blocks only
while waiting for
locking a conne ction,
and will ne ve r throw
an e xce ption if
cre ating a ne w
conne ction take s an
inordinate ly long
time
Spe cify an SQL
s tate me nt to che ck
validity of a pool
conne ction. This may
be calle d whe n
manage d conne ction
is obtaine d from the
pool
The JDBC drive r
conne ction URL
The fully qualife d
name of the JDBC
datas ource clas s
The fully qualife d
name of the JDBC
drive r clas s
De fine s the JDBC
drive r the
datas ource s hould
us e . It is a s ymbolic
name matching the
the name of
ins talle d drive r. In
cas e the drive r is
de ploye d as jar, the
name is the name of
de ployme nt unit
Spe cifie s if the
datas ource s hould
be e nable d
no
blocking-time outwait-millis
no
che ck-validconne ction-s ql
no
conne ction-url
no
datas ource -clas s
no
drive r-clas s
no
drive r-name
no
e nable d
Che ck Valid
Conne ction Sql
Conne ction Url
Datas ource Clas s
Drive r Clas s
Drive r Name
Enable d
565
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Exce ption Sorte r
Clas s Name
An
org.jbos s .jca.adapte r
s .jdbc.Exce ptionSort
e r that provide s an
is Exce ptionFatal(SQL
Exce ption) me thod
to validate if an
e xce ption s hould
broadcas t an e rror
The e xce ption
s orte r prope rtie s
Spe cifie s how the
pool s hould be flus h
in cas e of an e rror.
The idle -time outminute s e le me nts
s pe cifie s the
maximum time , in
minute s , a
conne ction may be
idle be fore be ing
clos e d. The actual
maximum time
de pe nds als o on the
Idle Re move r s can
time , which is half of
the s malle s t idle time out-minute s
value of any pool.
Changing this value
can be done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e .
Spe cifie s the JNDI
name for the
datas ource
Enable JTA
inte gration. The
de fault value is true .
The max-pool-s iz e
e le me nt s pe cifie s
the maximum
numbe r of
conne ctions for a
pool. No more
conne ctions will be
cre ate d in e ach s ubpool. The de fault
value is 20.
no
e xce ption-s orte rclas s -name
no
no
e xce ption-s orte rprope rtie s
flus h-s trate gy
no
idle -time out-minute s
no
jndi-name
no
jta
no
max-pool-s iz e
Exce ption Sorte r
Prope rtie s
Flus h Strate gy
Idle Time out Minute s
Jndi Name
Jta
Max Pool Siz e
566
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Min Pool Siz e
The min-pool-s iz e
e le me nt s pe cifie s
the minimum
numbe r of
conne ctions for a
pool. The de fault
value is 0.
Spe cifie s an SQL
s tate me nt to
e xe cute whe ne ve r a
conne ction is adde d
to the conne ction
pool
Spe cifie s the
pas s word us e d
whe n cre ating a ne w
conne ction
Should the pool be
pre fille d. Changing
this value can be
done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e .
The de fault value is
fals e .
Spe cifie s if the minpool-s iz e s hould be
cons ide re d s trictly.
The de fault value is
fals e .
The numbe r of
pre pare d
s tate me nts pe r
conne ction in an LRU
cache
Any configure d
que ry time out in
s e conds . If not
provide d no time out
will be s e t
The fully qualifie d
clas s name of the
re authe ntication
plugin
imple me ntation
The prope rtie s for
the re authe ntication
plugin
no
min-pool-s iz e
no
ne w-conne ction-s ql
no
pas s word
no
pool-pre fill
no
pool-us e -s trict-min
no
pre pare ds tate me nts -cache s iz e
no
que ry-time out
no
re auth-plugin-clas s name
no
re auth-pluginprope rtie s
Ne w Conne ction Sql
Pas s word
Pool Pre fill
Pool Us e Strict Min
Pre pare d
State me nts Cache
Siz e
Que ry Time out
Re auth Plugin Clas s
Name
Re auth Plugin
Prope rtie s
567
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se curity Domain
Spe cifie s the
s e curity domain
which de fine s the
javax.s e curity.auth.S
ubje ct that are us e d
to dis tinguis h
conne ctions in the
pool
Whe the r to s e t the
que ry time out bas e d
on the time
re maining until
trans action time out.
Any configure d
que ry time out will
be us e d if the re is
no trans action. The
de fault value is
fals e .
Whe the r to s hare
pre pare d
s tate me nts , i.e .
whe the r as king for
s ame s tate me nt
twice without clos ing
us e s the s ame
unde rlying pre pare d
s tate me nt. The
de fault value is
fals e .
Enable s pying of
SQL s tate me nts .
The de fault value is
fals e .
An
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onChe cke r that
provide s an
is Stale Conne ction(S
QLExce ption)
me thod which if it
re turns true will
wrap the e xce ption
in an
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onExce ption
The s tale conne ction
che cke r prope rtie s
no
s e curity-domain
no
s e t-tx-que ry-time out
no
s hare -pre pare ds tate me nts
no
s py
no
s tale -conne ctionche cke r-clas s -name
no
s tale -conne ctionche cke r-prope rtie s
Se t Tx Que ry
Time out
Share Pre pare d
State me nts
Spy
Stale Conne ction
Che cke r Clas s
Name
Stale Conne ction
Che cke r Prope rtie s
568
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Track State me nts
Whe the r to che ck for
unclos e d
s tate me nts whe n a
conne ction is
re turne d to the pool,
re s ult s e ts are
clos e d, a s tate me nt
is clos e d or re turn
to the pre pare d
s tate me nt cache .
Valid value s are :
'fals e ' - do not track
s tate me nts , 'true ' track s tate me nts
and re s ult s e ts and
warn whe n the y are
not clos e d, 'nowarn'
- track s tate me nts
but do not warn
about the m be ing
unclos e d. The
de fault value is
'NOWARN'.
Se t the
java.s ql.Conne ction
trans action is olation
le ve l. Valid value s
are :
TRANSACTION_READ
_UNCOMMITTED,
TRANSACTION_READ
_COMMITTED,
TRANSACTION_REPE
ATABLE_READ,
TRANSACTION_SERIA
LIZABLE and
TRANSACTION_NONE
Spe cifie s the
de lime te r for URLs
in conne ction-url for
HA datas ource s
A clas s that
imple me nts
org.jbos s .jca.adapte r
s .jdbc.URLSe le ctorSt
rate gy
Enable the us e of a
cache d conne ction
manage r. The
de fault value is true .
no
track-s tate me nts
no
trans action-is olation
no
url-de limite r
no
url-s e le ctors trate gy-clas s -name
no
us e -ccm
Trans action Is olation
Url De limite r
Url Se le ctor
Strate gy Clas s
Name
Us e Ccm
569
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Us e Fas t Fail
Whe the r to fail a
conne ction allocation
on the firs t try if it is
invalid (true ) or ke e p
trying until the pool
is e xhaus te d of all
pote ntial
conne ctions (fals e ).
The de fault value is
fals e .
Se tting this to fals e
will bind the
datas ource into
global JNDI. The
de fault value is true .
Any configure d
time out for inte rnal
locks on the
re s ource adapte r
obje cts in s e conds
Spe cify the us e r
name us e d whe n
cre ating a ne w
conne ction
An
org.jbos s .jca.adapte r
s .jdbc.ValidConne ctio
nChe cke r that
provide s an
is ValidConne ction(Co
nne ction) me thod to
validate a
conne ction. If an
e xce ption is
re turne d that me ans
the conne ction is
invalid. This
ove rride s the che ckvalid-conne ction-s ql
e le me nt
The valid conne ction
che cke r prope rtie s
no
us e -fas t-fail
no
us e -java-conte xt
no
us e -try-lock
no
us e r-name
no
valid-conne ctionche cke r-clas s -name
no
valid-conne ctionche cke r-prope rtie s
Us e Java Conte xt
Us e Try Lock
Us e r Name
Valid Conne ction
Che cke r Clas s
Name
Valid Conne ction
Che cke r Prope rtie s
570
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Validate On Match
The validate -onno
match e le me nt
s pe cifie s if
conne ction validation
s hould be done
whe n a conne ction
factory atte mpts to
match a manage d
conne ction. This is
typically e xclus ive to
the us e of
background
validation. The
de fault value is
fals e .
Int ernal Name
validate -on-match
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
T able 3.499. Met rics
Name
Subs ys te m:flus h All Conne ction In Pool
Subs ys te m:flus h Idle Conne ction In Pool
Subs ys te m:te s t Conne ction In Pool
Package Type s
Descript io n
Flus he s all conne ctions in the pool
Flus he s all idle conne ctions in the pool
Te s t if a conne ction can be obtaine d
none
3.3.12.4.6. JBo ss AS 7 and EAP 6 - EJB3 Runt ime Service
Overview
T able 3.50 0 . Overview
De s cription:
Single ton:
Plugin:
Runtime re s ource s e xpos e d by EJBs
compone nts include d in this de ployme nt.
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.12.4.6.1, “JBos s AS 7 and EAP 6 - Me s s age Drive n Be an Runtime Se rvice ”
Se ction 3.3.12.4.6.2, “JBos s AS 7 and EAP 6 - Single ton Be an Runtime Se rvice ”
Se ction 3.3.12.4.6.3, “JBos s AS 7 and EAP 6 - State le s s Se s s ion Be an Runtime Se rvice ”
571
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Se ction 3.3.12.4.6.4, “JBos s AS 7 and EAP 6 - Entity Be an Runtime Se rvice ”
Se ction 3.3.12.4.6.5, “JBos s AS 7 and EAP 6 - State ful Se s s ion Be an Runtime Se rvice ”
Co nnect io n Pro pert ies
T able 3.50 1.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.4.6.1. JBo ss AS 7 and EAP 6 - Message Driven Bean Runt ime Service
Ove rvie w
T able 3.50 2. Overview
De s cription:
Be an compone nt include d in the
de ployme nt.
no
JBos s AS7
Single ton:
Plugin:
Child Re s ource Type s
none
Conne ction Prope rtie s
T able 3.50 3.
Name
Path
572
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.50 4. Met rics
Name
T ype
Descript io n
Int ernal Name
Pool Available Count
me as ure me nt
pool-available -count
Pool Cre ate Count
me as ure me nt
Pool Curre nt Siz e
me as ure me nt
Pool Max Siz e
me as ure me nt
Pool Re move Count
me as ure me nt
Pe ak concurre nt
invocations
Invocations
me as ure me nt
Invocations pe r
Minute
me as ure me nt
Wait Time
me as ure me nt
Exe cution Time
me as ure me nt
Exe cution Time pe r
Minute
Me thod Exe cution
Time
me as ure me nt
The numbe r of
available (i.e . not in
us e ) ins tance s in the
pool.
The numbe r of be an
ins tance s that have
be e n cre ate d.
The curre nt s iz e of
the pool.
The maximum s iz e
of the pool.
The numbe r of be an
ins tance s that have
be e n re move d.
Pe ak concurre nt
invocations .
Numbe r of
invocations
proce s s e d.
Numbe r of
invocations
proce s s e d.
Time s pe nt waiting
to obtain an
ins tance .
Time s pe nt within a
be an me thod
Time s pe nt within a
be an me thod
The e xe cution time s
of individual
me thods on a be an.
Note that you ne e d
to e nable s tatis tics
at s e rve r le ve l in
the e jb3 s ubs ys te m
me as ure me nt
calltime
pool-cre ate -count
pool-curre nt-s iz e
pool-max-s iz e
pool-re move -count
pe ak-concurre ntinvocations
invocations
invocations
wait-time
e xe cution-time
e xe cution-time
__calltime :e xe cutiontime
573
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.50 5.
Name
Descript io n
Required
Int ernal Name
Compone nt Clas s
Name
De clare d Role s
The compone nt's
clas s name .
The role s de clare d
(via @De clare Role s )
on this EJB
compone nt.
The run-as role (if
any) for this EJB
compone nt.
The s e curity domain
for this EJB
compone nt.
EJB time rs
as s ociate d with the
compone nt.
no
ye s
compone nt-clas s name
de clare d-role s
no
run-as -role
no
s e curity-domain
ye s
time rs
Run As Role
Se curity Domain
Time rs
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.12.4.6.2. JBo ss AS 7 and EAP 6 - Singlet o n Bean Runt ime Service
Ove rvie w
T able 3.50 6. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
574
Single ton be an compone nt include d in the
de ployme nt.
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
Conne ction Prope rtie s
T able 3.50 7.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.50 8. Met rics
Name
T ype
Descript io n
Int ernal Name
Pe ak concurre nt
invocations
Invocations
me as ure me nt
pe ak-concurre ntinvocations
invocations
Invocations pe r
Minute
me as ure me nt
Wait Time
me as ure me nt
Exe cution Time
me as ure me nt
Exe cution Time pe r
Minute
Me thod Exe cution
Time
me as ure me nt
Pe ak concurre nt
invocations .
Numbe r of
invocations
proce s s e d.
Numbe r of
invocations
proce s s e d.
Time s pe nt waiting
to obtain an
ins tance .
Time s pe nt within a
be an me thod
Time s pe nt within a
be an me thod
The e xe cution time s
of individual
me thods on a be an.
Note that you ne e d
to e nable s tatis tics
at s e rve r le ve l in
the e jb3 s ubs ys te m
me as ure me nt
calltime
invocations
wait-time
e xe cution-time
e xe cution-time
__calltime :e xe cutiontime
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.50 9.
575
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Compone nt Clas s
Name
De clare d Role s
The compone nt's
clas s name .
The role s de clare d
(via @De clare Role s )
on this EJB
compone nt.
The run-as role (if
any) for this EJB
compone nt.
The s e curity domain
for this EJB
compone nt.
EJB time rs
as s ociate d with the
compone nt.
no
ye s
compone nt-clas s name
de clare d-role s
no
run-as -role
no
s e curity-domain
ye s
time rs
Run As Role
Se curity Domain
Time rs
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.12.4.6.3. JBo ss AS 7 and EAP 6 - St at eless Sessio n Bean Runt ime Service
Ove rvie w
T able 3.510 . Overview
De s cription:
State le s s s e s s ion be an compone nt
include d in the de ployme nt.
no
JBos s AS7
Single ton:
Plugin:
Child Re s ource Type s
none
Conne ction Prope rtie s
T able 3.511.
Name
Path
576
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.512. Met rics
Name
T ype
Descript io n
Int ernal Name
Pool Available Count
me as ure me nt
pool-available -count
Pool Cre ate Count
me as ure me nt
Pool Curre nt Siz e
me as ure me nt
Pool Max Siz e
me as ure me nt
Pool Re move Count
me as ure me nt
Pe ak concurre nt
invocations
Invocations
me as ure me nt
Invocations pe r
Minute
me as ure me nt
Wait Time
me as ure me nt
Exe cution Time
me as ure me nt
Exe cution Time pe r
Minute
Me thod Exe cution
Time
me as ure me nt
The numbe r of
available (i.e . not in
us e ) ins tance s in the
pool.
The numbe r of be an
ins tance s that have
be e n cre ate d.
The curre nt s iz e of
the pool.
The maximum s iz e
of the pool.
The numbe r of be an
ins tance s that have
be e n re move d.
Pe ak concurre nt
invocations .
Numbe r of
invocations
proce s s e d.
Numbe r of
invocations
proce s s e d.
Time s pe nt waiting
to obtain an
ins tance .
Time s pe nt within a
be an me thod
Time s pe nt within a
be an me thod
The e xe cution time s
of individual
me thods on a be an.
Note that you ne e d
to e nable s tatis tics
at s e rve r le ve l in
the e jb3 s ubs ys te m
me as ure me nt
calltime
pool-cre ate -count
pool-curre nt-s iz e
pool-max-s iz e
pool-re move -count
pe ak-concurre ntinvocations
invocations
invocations
wait-time
e xe cution-time
e xe cution-time
__calltime :e xe cutiontime
577
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.513.
Name
Descript io n
Required
Int ernal Name
Compone nt Clas s
Name
De clare d Role s
The compone nt's
clas s name .
The role s de clare d
(via @De clare Role s )
on this EJB
compone nt.
The run-as role (if
any) for this EJB
compone nt.
The s e curity domain
for this EJB
compone nt.
EJB time rs
as s ociate d with the
compone nt.
no
ye s
compone nt-clas s name
de clare d-role s
no
run-as -role
no
s e curity-domain
ye s
time rs
Run As Role
Se curity Domain
Time rs
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.12.4.6.4. JBo ss AS 7 and EAP 6 - Ent it y Bean Runt ime Service
Ove rvie w
T able 3.514. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
578
Entity be an compone nt include d in the
de ployme nt.
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
Conne ction Prope rtie s
T able 3.515.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.516. Met rics
Name
T ype
Descript io n
Int ernal Name
Pool Available Count
me as ure me nt
pool-available -count
Pool Cre ate Count
me as ure me nt
Pool Curre nt Siz e
me as ure me nt
Pool Max Siz e
me as ure me nt
Pool Re move Count
me as ure me nt
Pe ak concurre nt
invocations
Invocations
me as ure me nt
Invocations pe r
Minute
me as ure me nt
Wait Time
me as ure me nt
Exe cution Time
me as ure me nt
Exe cution Time pe r
Minute
me as ure me nt
The numbe r of
available (i.e . not in
us e ) ins tance s in the
pool.
The numbe r of be an
ins tance s that have
be e n cre ate d.
The curre nt s iz e of
the pool.
The maximum s iz e
of the pool.
The numbe r of be an
ins tance s that have
be e n re move d.
Pe ak concurre nt
invocations .
Numbe r of
invocations
proce s s e d.
Numbe r of
invocations
proce s s e d.
Time s pe nt waiting
to obtain an
ins tance .
Time s pe nt within a
be an me thod
Time s pe nt within a
be an me thod
me as ure me nt
pool-cre ate -count
pool-curre nt-s iz e
pool-max-s iz e
pool-re move -count
pe ak-concurre ntinvocations
invocations
invocations
wait-time
e xe cution-time
e xe cution-time
579
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Me thod Exe cution
Time
calltime
The e xe cution time s
of individual
me thods on a be an.
Note that you ne e d
to e nable s tatis tics
at s e rve r le ve l in
the e jb3 s ubs ys te m
__calltime :e xe cutiontime
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.517.
Name
Descript io n
Required
Int ernal Name
Compone nt Clas s
Name
De clare d Role s
The compone nt's
clas s name .
The role s de clare d
(via @De clare Role s )
on this EJB
compone nt.
The run-as role (if
any) for this EJB
compone nt.
The s e curity domain
for this EJB
compone nt.
no
ye s
compone nt-clas s name
de clare d-role s
no
run-as -role
no
s e curity-domain
Run As Role
Se curity Domain
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.12.4.6.5. JBo ss AS 7 and EAP 6 - St at ef ul Sessio n Bean Runt ime Service
Ove rvie w
T able 3.518. Overview
580
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
De s cription:
State ful s e s s ion be an compone nt include d
in the de ployme nt.
no
JBos s AS7
Single ton:
Plugin:
Child Re s ource Type s
none
Conne ction Prope rtie s
T able 3.519.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.520 . Met rics
Name
T ype
Descript io n
Int ernal Name
Pe ak concurre nt
invocations
Invocations
me as ure me nt
pe ak-concurre ntinvocations
invocations
Invocations pe r
Minute
me as ure me nt
Wait Time
me as ure me nt
Exe cution Time
me as ure me nt
Exe cution Time pe r
Minute
Me thod Exe cution
Time
me as ure me nt
Pe ak concurre nt
invocations .
Numbe r of
invocations
proce s s e d.
Numbe r of
invocations
proce s s e d.
Time s pe nt waiting
to obtain an
ins tance .
Time s pe nt within a
be an me thod
Time s pe nt within a
be an me thod
The e xe cution time s
of individual
me thods on a be an.
Note that you ne e d
to e nable s tatis tics
at s e rve r le ve l in
the e jb3 s ubs ys te m
me as ure me nt
calltime
invocations
wait-time
e xe cution-time
e xe cution-time
__calltime :e xe cutiontime
581
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
T able 3.521.
Name
Descript io n
Required
Int ernal Name
Compone nt Clas s
Name
De clare d Role s
The compone nt's
clas s name .
The role s de clare d
(via @De clare Role s )
on this EJB
compone nt.
The run-as role (if
any) for this EJB
compone nt.
The s e curity domain
for this EJB
compone nt.
no
ye s
compone nt-clas s name
de clare d-role s
no
run-as -role
no
s e curity-domain
Run As Role
Se curity Domain
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.12.4.7. JBo ss AS 7 and EAP 6 - Reso urce Adapt ers Runt ime Service
Overview
T able 3.522. Overview
De s cription:
Single ton:
Plugin:
Configuration of the re s ource adapte rs
s ubs ys te m.
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.12.4.7.1, “JBos s AS 7 and EAP 6 - Conne ction De finition Runtime Se rvice ”
582
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Co nnect io n Pro pert ies
T able 3.523.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.4.7.1. JBo ss AS 7 and EAP 6 - Co nnect io n Def init io n Runt ime Service
Ove rvie w
T able 3.524. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
Spe cifie s the conne ction de finitions .
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.525.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
583
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.526. Met rics
Name
T ype
Descript io n
Int ernal Name
Active Count
Available Count
Ave rage Blocking
Time
me as ure me nt
me as ure me nt
me as ure me nt
Active Count
Available Count
Ave rage BlockingTim
e
Ave rage Cre ation
Time
me as ure me nt
Cre ate d Count
De s troye d Count
Max Cre ation Time
me as ure me nt
me as ure me nt
me as ure me nt
Max Us e d Count
me as ure me nt
Max Wait Time
me as ure me nt
Time d Out
Total Blocking Time
me as ure me nt
me as ure me nt
Total Cre ation Time
me as ure me nt
The active count
The available count
The ave rage time
s pe nt blocking for a
conne ction
The ave rage time
s pe nt cre ating a
phys ical conne ction
The cre ate d count
The de s troye d count
The maximum time
for cre ating a
phys ical conne ction
The maximum
numbe r of
conne ctions us e d
The maximum wait
time for a conne ction
The time d out count
The total blocking
time
The total time s pe nt
cre ating phys ical
conne ctions
Ave rage Cre ationTim
e
Cre ate dCount
De s troye dCount
MaxCre ationTime
MaxUs e dCount
MaxWaitTime
Time dOut
TotalBlockingTime
TotalCre ationTime
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
none
Ope rations
none
Package Type s
none
584
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
3.3.12.5. JBoss AS 7 and EAP 6 - JPA Runt ime Service
Overview
T able 3.527. Overview
De s cription:
Single ton:
Plugin:
The configuration of the JPA s ubs ys te m.
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.12.5.1, “JBos s AS 7 and EAP 6 - Hibe rnate Pe rs is te nce Unit Se rvice ”
Co nnect io n Pro pert ies
T able 3.528.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.5.1. JBo ss AS 7 and EAP 6 - Hibernat e Persist ence Unit Service
Overview
T able 3.529. Overview
De s cription:
Single ton:
Plugin:
Runtime information about JPA us e in the
de ployme nt.
ye s
JBos s AS7
585
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Child Reso urce T ypes
Se ction 3.3.12.5.1.1, “JBos s AS 7 and EAP 6 - Entity Cache Se rvice ”
Se ction 3.3.12.5.1.2, “JBos s AS 7 and EAP 6 - Entity Se rvice ”
Se ction 3.3.12.5.1.3, “JBos s AS 7 and EAP 6 - Colle ction Se rvice ”
Co nnect io n Pro pert ies
T able 3.530 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.531. Met rics
Name
T ype
Descript io n
Int ernal Name
Clos e State me nt
Count
me as ure me nt
clos e -s tate me ntcount
Clos e State me nt
Count pe r Minute
me as ure me nt
Colle ction
Count
Colle ction
Count pe r
Colle ction
Count
Colle ction
Count pe r
Colle ction
Count
Fe tch
me as ure me nt
Fe tch
Minute
Load
me as ure me nt
Load
Minute
Re cre ate d
me as ure me nt
Colle ction Re cre ate d
Count pe r Minute
me as ure me nt
Colle ction
Count
Colle ction
Count pe r
Colle ction
Count
Re move
me as ure me nt
Re move
Minute
Update
me as ure me nt
Numbe r of re le as e d
pre pare d
s tate me nts .
Numbe r of re le as e d
pre pare d
s tate me nts .
Numbe r of
colle ctions fe tche d.
Numbe r of
colle ctions fe tche d.
Numbe r of
colle ctions loade d.
Numbe r of
colle ctions loade d.
Numbe r of
colle ctions
re cre ate d.
Numbe r of
colle ctions
re cre ate d.
Numbe r of
colle ctions re move d.
Numbe r of
colle ctions re move d.
Numbe r of
colle ctions update d.
586
me as ure me nt
me as ure me nt
me as ure me nt
clos e -s tate me ntcount
colle ction-fe tch-count
colle ction-fe tch-count
colle ction-load-count
colle ction-load-count
colle ction-re cre ate dcount
colle ction-re cre ate dcount
colle ction-re move count
colle ction-re move count
colle ction-update count
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Colle ction Update
Count pe r Minute
Comple te d
Trans action Count
me as ure me nt
colle ction-update count
comple te dtrans action-count
Comple te d
Trans action Count
pe r Minute
Conne ct Count
me as ure me nt
Conne ct Count pe r
Minute
me as ure me nt
Entity De le te Count
me as ure me nt
Entity De le te Count
pe r Minute
Entity Fe tch Count
me as ure me nt
Entity Fe tch Count
pe r Minute
Entity Ins e rt Count
me as ure me nt
Entity Ins e rt Count
pe r Minute
Entity Load Count
me as ure me nt
Entity Load Count
pe r Minute
Entity Update Count
me as ure me nt
Entity Update Count
pe r Minute
Flus h Count
me as ure me nt
Flus h Count pe r
Minute
me as ure me nt
Optimis tic Failure
Count
Optimis tic Failure
Count pe r Minute
Pre pare d State me nt
Count
me as ure me nt
Pre pare d State me nt
Count pe r Minute
me as ure me nt
Numbe r of
colle ctions update d.
Numbe r of
comple te d
trans actions .
Numbe r of
comple te d
trans actions .
Ge t the numbe r of
conne ctions as ke d
for by the s e s s ions .
Ge t the numbe r of
conne ctions as ke d
for by the s e s s ions .
Ge t numbe r of e ntity
de le te s .
Ge t numbe r of e ntity
de le te s .
Ge t numbe r of e ntity
fe tche s .
Ge t numbe r of e ntity
fe tche s .
Ge t numbe r of e ntity
ins e rts .
Ge t numbe r of e ntity
ins e rts .
Ge t numbe r of e ntity
loads .
Ge t numbe r of e ntity
loads .
Ge t numbe r of e ntity
update s .
Ge t numbe r of e ntity
update s .
Ge t the numbe r of
flus he s e xe cute d by
s e s s ions (e ithe r
implicit or e xplicit).
Ge t the numbe r of
flus he s e xe cute d by
s e s s ions (e ithe r
implicit or e xplicit).
Numbe r of optimis tic
lock e xce ptions .
Numbe r of optimis tic
lock e xce ptions .
Numbe r of acquire d
pre pare d
s tate me nts .
Numbe r of acquire d
pre pare d
s tate me nts .
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
comple te dtrans action-count
conne ct-count
conne ct-count
e ntity-de le te -count
e ntity-de le te -count
e ntity-fe tch-count
e ntity-fe tch-count
e ntity-ins e rt-count
e ntity-ins e rt-count
e ntity-load-count
e ntity-load-count
e ntity-update -count
e ntity-update -count
flus h-count
flus h-count
optimis tic-failure count
optimis tic-failure count
pre pare d-s tate me ntcount
pre pare d-s tate me ntcount
587
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Que ry Cache Hit
Count
me as ure me nt
que ry-cache -hitcount
Que ry Cache Hit
Count pe r Minute
me as ure me nt
Que ry Cache Mis s
Count
me as ure me nt
Que ry Cache Mis s
Count pe r Minute
me as ure me nt
Que ry Cache Put
Count
me as ure me nt
Que ry Cache Put
Count pe r Minute
me as ure me nt
Que ry Exe cution
Count
Que ry Exe cution
Count pe r Minute
Que ry Exe cution
Max Time
me as ure me nt
Que ry Exe cution
Max Time Que ry
String
Se cond Le ve l Cache
Hit Count
trait
Se cond Le ve l Cache
Hit Count pe r Minute
me as ure me nt
Se cond Le ve l Cache
Mis s Count
me as ure me nt
Ge t the numbe r of
cache d que rie s
s ucce s s fully
re trie ve d from
cache .
Ge t the numbe r of
cache d que rie s
s ucce s s fully
re trie ve d from
cache .
Ge t the numbe r of
cache d que rie s not
found in cache .
Ge t the numbe r of
cache d que rie s not
found in cache .
Ge t the numbe r of
cache able que rie s
put in cache .
Ge t the numbe r of
cache able que rie s
put in cache .
Ge t numbe r of
e xe cute d que rie s .
Ge t numbe r of
e xe cute d que rie s .
Ge t the time in
millis e conds of the
s lowe s t que ry.
Ge t the que ry s tring
for the s lowe s t
que ry.
Numbe r of
cache able
e ntitie s /colle ctions
s ucce s s fully
re trie ve d from the
cache .
Numbe r of
cache able
e ntitie s /colle ctions
s ucce s s fully
re trie ve d from the
cache .
Numbe r of
cache able
e ntitie s /colle ctions
not found in the
cache and loade d.
588
me as ure me nt
me as ure me nt
me as ure me nt
que ry-cache -hitcount
que ry-cache -mis s count
que ry-cache -mis s count
que ry-cache -putcount
que ry-cache -putcount
que ry-e xe cutioncount
que ry-e xe cutioncount
que ry-e xe cutionmax-time
que ry-e xe cutionmax-time -que rys tring
s e cond-le ve l-cache hit-count
s e cond-le ve l-cache hit-count
s e cond-le ve l-cache mis s -count
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Se cond Le ve l Cache
Mis s Count pe r
Minute
me as ure me nt
s e cond-le ve l-cache mis s -count
Se cond Le ve l Cache
Put Count
me as ure me nt
Se cond Le ve l Cache
Put Count pe r Minute
me as ure me nt
Numbe r of
cache able
e ntitie s /colle ctions
not found in the
cache and loade d.
Numbe r of
cache able
e ntitie s /colle ctions
put in the cache .
Numbe r of
cache able
e ntitie s /colle ctions
put in the cache .
Numbe r of s e s s ions
clos e d.
Numbe r of s e s s ions
clos e d.
Numbe r of s e s s ions
ope ne d.
Numbe r of s e s s ions
ope ne d.
Numbe r of
s ucce s s ful
trans actions .
Numbe r of
s ucce s s ful
trans actions .
Se s s ion Clos e Count me as ure me nt
Se s s ion Clos e Count me as ure me nt
pe r Minute
Se s s ion Ope n Count me as ure me nt
Se s s ion Ope n Count
pe r Minute
Succe s s ful
Trans action Count
me as ure me nt
Succe s s ful
Trans action Count
pe r Minute
me as ure me nt
me as ure me nt
s e cond-le ve l-cache put-count
s e cond-le ve l-cache put-count
s e s s ion-clos e -count
s e s s ion-clos e -count
s e s s ion-ope n-count
s e s s ion-ope n-count
s ucce s s fultrans action-count
s ucce s s fultrans action-count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.532.
Name
Descript io n
Required
Int ernal Name
Enable d
De te rmine if
s tatis tics are
e nable d.
no
e nable d
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
589
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.533. Met rics
Name
Descript io n
Subs ys te m:cle ar
Subs ys te m:e vict All
Subs ys te m:s ummary
Vie w Que rie s
Cle ar s tatis tics .
Evict all e ntitie s from s e cond le ve l cache .
Log the s tatis tics .
Vie w s tatis tical information about que rie s
e xe cute d by Hibe rnate
Package T ypes
none
3.3.12.5.1.1. JBo ss AS 7 and EAP 6 - Ent it y Cache Service
Ove rvie w
T able 3.534. Overview
De s cription:
Statis tics for a Hibe rnate Se cond Le ve l
Cache re gion.
ye s
JBos s AS7
Single ton:
Plugin:
Child Re s ource Type s
none
Conne ction Prope rtie s
T able 3.535.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.536. Met rics
Name
T ype
Descript io n
Int ernal Name
Ele me nt Count In
Me mory
me as ure me nt
Numbe r of
cache able
e ntitie s /colle ctions
curre ntly s tore d in
me mory.
e le me nt-count-inme mory
590
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Hit Count
me as ure me nt
hit-count
Mis s Count
me as ure me nt
Put Count
me as ure me nt
Numbe r of
cache able
e ntitie s /colle ctions
s ucce s s fully
re trie ve d from the
cache .
Numbe r of
cache able
e ntitie s /colle ctions
not found in the
cache and loade d.
Numbe r of
cache able
e ntitie s /colle ctions
put in the cache .
mis s -count
put-count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
none
Ope rations
none
Package Type s
none
3.3.12.5.1.2. JBo ss AS 7 and EAP 6 - Ent it y Service
Ove rvie w
T able 3.537. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
Statis tics for individual e ntitie s .
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.538.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
591
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.539. Met rics
Name
T ype
Descript io n
Int ernal Name
Entity De le te Count
me as ure me nt
e ntity-de le te -count
Entity De le te Count
pe r Minute
Entity Fe tch Count
me as ure me nt
Entity Fe tch Count
pe r Minute
Entity Ins e rt Count
me as ure me nt
Entity Ins e rt Count
pe r Minute
Entity Load Count
me as ure me nt
Entity Load Count
pe r Minute
Entity Update Count
me as ure me nt
Entity Update Count
pe r Minute
Optimis tic Failure
Count
Optimis tic Failure
Count pe r Minute
me as ure me nt
Ge t numbe r of e ntity
de le te s .
Ge t numbe r of e ntity
de le te s .
Ge t numbe r of e ntity
fe tche s .
Ge t numbe r of e ntity
fe tche s .
Ge t numbe r of e ntity
ins e rts .
Ge t numbe r of e ntity
ins e rts .
Ge t numbe r of e ntity
loads .
Ge t numbe r of e ntity
loads .
Ge t numbe r of e ntity
update s .
Ge t numbe r of e ntity
update s .
Numbe r of optimis tic
lock e xce ptions .
Numbe r of optimis tic
lock e xce ptions .
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
me as ure me nt
e ntity-de le te -count
e ntity-fe tch-count
e ntity-fe tch-count
e ntity-ins e rt-count
e ntity-ins e rt-count
e ntity-load-count
e ntity-load-count
e ntity-update -count
e ntity-update -count
optimis tic-failure count
optimis tic-failure count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
none
Ope rations
none
Package Type s
none
592
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
3.3.12.5.1.3. JBo ss AS 7 and EAP 6 - Co llect io n Service
Ove rvie w
T able 3.540 . Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
Statis tics for individual colle ctions .
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.541.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
T able 3.542. Met rics
Name
T ype
Descript io n
Int ernal Name
Colle ction Fe tch
Count
me as ure me nt
colle ction-fe tch-count
Colle ction Fe tch
Count pe r Minute
me as ure me nt
Colle ction Load
Count
me as ure me nt
Colle ction Load
Count pe r Minute
me as ure me nt
Colle ction Re cre ate d
Count
me as ure me nt
Colle ction Re cre ate d
Count pe r Minute
me as ure me nt
Colle ction Re move
Count
me as ure me nt
Numbe r of time s
colle ction was
fe tche d.
Numbe r of time s
colle ction was
fe tche d.
Numbe r of time s
colle ction was
loade d.
Numbe r of time s
colle ction was
loade d.
Numbe r of time s
colle ction was
re cre ate d.
Numbe r of time s
colle ction was
re cre ate d.
Numbe r of time s
colle ction was
re move d.
colle ction-fe tch-count
colle ction-load-count
colle ction-load-count
colle ction-re cre ate dcount
colle ction-re cre ate dcount
colle ction-re move count
593
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Colle ction Re move
Count pe r Minute
me as ure me nt
colle ction-re move count
Colle ction Update
Count
me as ure me nt
Colle ction Update
Count pe r Minute
me as ure me nt
Numbe r of time s
colle ction was
re move d.
Numbe r of time s
colle ction was
update d.
Numbe r of time s
colle ction was
update d.
colle ction-update count
colle ction-update count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Configuration Prope rtie s
none
Ope rations
none
Package Type s
none
3.3.12.6. JBoss AS 7 and EAP 6 - Dat asources Runt ime Service
Overview
T able 3.543. Overview
De s cription:
Runtime re s ource s e xpos e d by data
s ource s include d in this de ployme nt.
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
Se ction 3.3.12.6.1, “JBos s AS 7 and EAP 6 - XA Datas ource Runtime Se rvice ”
Se ction 3.3.12.6.2, “JBos s AS 7 and EAP 6 - Datas ource Runtime Se rvice ”
Co nnect io n Pro pert ies
T able 3.544.
Name
Path
594
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.6.1. JBo ss AS 7 and EAP 6 - XA Dat aso urce Runt ime Service
Overview
T able 3.545. Overview
De s cription:
Single ton:
Plugin:
A JDBC XA data-s ource configuration
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.546.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.547. Met rics
595
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Pre pare d State me nt
Cache Curre nt Siz e
me as ure me nt
Pre pare dState me ntC
ache Curre ntSiz e
Pre pare d State me nt
Cache Mis s Count
me as ure me nt
Pre pare d State me nt
Cache Mis s Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Add Count
me as ure me nt
Pre pare d State me nt
Cache Acce s s Count
me as ure me nt
Pre pare d State me nt
Cache Acce s s Count
pe r Minute
Pre pare d State me nt
Cache De le te Count
me as ure me nt
Pre pare d State me nt
Cache De le te Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Hit Count
me as ure me nt
Pre pare d State me nt
Cache Hit Count pe r
Minute
me as ure me nt
Active Count
Available Count
Ave rage Blocking
Time
me as ure me nt
me as ure me nt
me as ure me nt
Ave rage Cre ation
Time
me as ure me nt
Cre ate d Count
me as ure me nt
The numbe r of
pre pare d and
callable s tate me nts
curre ntly cache d in
the s tate me nt cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of
s tate me nts adde d to
the s tate me nt cache
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The active count
The available count
The ave rage time
s pe nt blocking for a
conne ction
The ave rage time
s pe nt cre ating a
phys ical conne ction
The cre ate d count
596
me as ure me nt
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache AddCount
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache HitCount
Pre pare dState me ntC
ache HitCount
Active Count
Available Count
Ave rage BlockingTim
e
Ave rage Cre ationTim
e
Cre ate dCount
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Cre ate d Count pe r
Minute
De s troye d Count
De s troye d Count
pe r Minute
Max Cre ation Time
me as ure me nt
The cre ate d count
Cre ate dCount
me as ure me nt
me as ure me nt
The de s troye d count
The de s troye d count
De s troye dCount
De s troye dCount
me as ure me nt
MaxCre ationTime
Max Us e d Count
me as ure me nt
Max Wait Time
me as ure me nt
Time d Out
Time d Out pe r
Minute
Total Cre ation Time
me as ure me nt
me as ure me nt
The maximum time
for cre ating a
phys ical conne ction
The maximum
numbe r of
conne ctions us e d
The maximum wait
time for a conne ction
The time d out count
The time d out count
TotalCre ationTime
Total Cre ation Time
pe r Minute
me as ure me nt
Total Blocking Time
me as ure me nt
The total time s pe nt
cre ating phys ical
conne ctions
The total time s pe nt
cre ating phys ical
conne ctions
The total blocking
time
The total blocking
time
Conne ction
Available ?
The min pool s iz e
s e tting
The max pool s iz e
s e tting
me as ure me nt
Total Blocking Time
me as ure me nt
pe r Minute
Conne ction
trait
Available ?
Min Pool Siz e s e tting me as ure me nt
Max Pool Siz e
s e tting
me as ure me nt
MaxUs e dCount
MaxWaitTime
Time dOut
Time dOut
TotalCre ationTime
TotalBlockingTime
TotalBlockingTime
conne ctionAvailable
min-pool-s iz e
max-pool-s iz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.548.
Name
Prope rtie s
Descript io n
Required
Int ernal Name
no
*2
597
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Allocation Re try
The allocation re try
e le me nt indicate s
the numbe r of time s
that allocating a
conne ction s hould
be trie d be fore
throwing an
e xce ption
The allocation re try
wait millis e le me nt
s pe cifie s the
amount of time , in
millis e conds , to wait
be twe e n re trying to
allocate a conne ction
An e le me nt to
s pe cify that
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Changing this
value can be done
only on dis able d
datas ource , re quire s
a s e rve r re s tart
othe rwis e . The
de fault value is
fals e .
The backgroundvalidation-millis
e le me nt s pe cifie s
the amount of time ,
in millis e conds , that
background
validation will run.
Changing this value
can be done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e
no
allocation-re try
no
allocation-re try-waitmillis
no
backgroundvalidation
no
backgroundvalidation-millis
Allocation Re try Wait
Millis
Background
Validation
Background
Validation Millis
598
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Blocking Time out
Wait Millis
The blockingtime out-millis
e le me nt s pe cifie s
the maximum time ,
in millis e conds , to
block while waiting
for a conne ction
be fore throwing an
e xce ption. Note that
this blocks only
while waiting for
locking a conne ction,
and will ne ve r throw
an e xce ption if
cre ating a ne w
conne ction take s an
inordinate ly long
time
Spe cify an SQL
s tate me nt to che ck
validity of a pool
conne ction. This may
be calle d whe n
manage d conne ction
is obtaine d from the
pool
De fine s the JDBC
drive r the
datas ource s hould
us e . It is a s ymbolic
name matching the
the name of
ins talle d drive r. In
cas e the drive r is
de ploye d as jar, the
name is the name of
de ployme nt unit
Spe cifie s if the
datas ource s hould
be e nable d
An
org.jbos s .jca.adapte r
s .jdbc.Exce ptionSort
e r that provide s an
is Exce ptionFatal(SQL
Exce ption) me thod
to validate if an
e xce ption s hould
broadcas t an e rror
The e xce ption
s orte r prope rtie s
Spe cifie s how the
pool s hould be flus h
in cas e of an e rror.
no
blocking-time outwait-millis
no
che ck-validconne ction-s ql
no
drive r-name
no
e nable d
no
e xce ption-s orte rclas s -name
no
e xce ption-s orte rprope rtie s
flus h-s trate gy
Che ck Valid
Conne ction Sql
Drive r Name
Enable d
Exce ption Sorte r
Clas s Name
Exce ption Sorte r
Prope rtie s
Flus h Strate gy
no
599
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Idle Time out Minute s
The idle -time outminute s e le me nts
s pe cifie s the
maximum time , in
minute s , a
conne ction may be
idle be fore be ing
clos e d. The actual
maximum time
de pe nds als o on the
Idle Re move r s can
time , which is half of
the s malle s t idle time out-minute s
value of any pool.
Changing this value
can be done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e .
An e le me nt to
e nable inte rle aving
for XA conne ctions .
The de fault value is
fals e .
Spe cifie s the JNDI
name for the
datas ource
Enable JTA
inte gration. The
de fault value is true .
The max-pool-s iz e
e le me nt s pe cifie s
the maximum
numbe r of
conne ctions for a
pool. No more
conne ctions will be
cre ate d in e ach s ubpool. The de fault
value is 20.
The min-pool-s iz e
e le me nt s pe cifie s
the minimum
numbe r of
conne ctions for a
pool. The de fault
value is 0.
Spe cifie s an SQL
s tate me nt to
e xe cute whe ne ve r a
conne ction is adde d
to the conne ction
pool
no
idle -time out-minute s
no
inte rle aving
no
jndi-name
no
jta
no
max-pool-s iz e
no
min-pool-s iz e
no
ne w-conne ction-s ql
Inte rle aving
Jndi Name
Jta
Max Pool Siz e
Min Pool Siz e
Ne w Conne ction Sql
600
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
No Re cove ry
Spe cifie s if the
conne ction pool
s hould be e xclude d
from re cove ry
Oracle doe s not like
XA conne ctions
ge tting us e d both
ins ide and outs ide a
JTA trans action. To
workaround the
proble m you can
cre ate s e parate
s ub-pools for the
diffe re nt conte xts .
The de fault value is
fals e .
Should the Xid be
padde d. The de fault
value is fals e .
Spe cifie s the
pas s word us e d
whe n cre ating a ne w
conne ction
Should the pool be
pre fille d. Changing
this value can be
done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e .
The de fault value is
fals e .
Spe cifie s if the minpool-s iz e s hould be
cons ide re d s trictly.
The de fault value is
fals e .
The numbe r of
pre pare d
s tate me nts pe r
conne ction in an LRU
cache
Any configure d
que ry time out in
s e conds . If not
provide d no time out
will be s e t
The fully qualifie d
clas s name of the
re authe ntication
plugin
imple me ntation
no
no-re cove ry
no
no-tx-s e parate -pool
no
pad-xid
no
pas s word
no
pool-pre fill
no
pool-us e -s trict-min
no
pre pare ds tate me nts -cache s iz e
no
que ry-time out
no
re auth-plugin-clas s name
No Tx Se parate Pool
Pad Xid
Pas s word
Pool Pre fill
Pool Us e Strict Min
Pre pare d
State me nts Cache
Siz e
Que ry Time out
Re auth Plugin Clas s
Name
601
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Re auth Plugin
Prope rtie s
The prope rtie s for
the re authe ntication
plugin
The pas s word us e d
for re cove ry
The fully qualifie d
clas s name of the
re cove ry plugin
imple me ntation
The prope rtie s for
the re cove ry plugin
The s e curity domain
us e d for re cove ry
The us e r name
us e d for re cove ry
The is -s ame -rmove rride e le me nt
allows one to
unconditionally s e t
whe the r the
javax.trans action.xa.
XARe s ource .is Same
RM(XARe s ource )
re turns true or fals e
Spe cifie s the
s e curity domain
which de fine s the
javax.s e curity.auth.S
ubje ct that are us e d
to dis tinguis h
conne ctions in the
pool
Whe the r to s e t the
que ry time out bas e d
on the time
re maining until
trans action time out.
Any configure d
que ry time out will
be us e d if the re is
no trans action. The
de fault value is
fals e .
no
re auth-pluginprope rtie s
no
re cove ry-pas s word
no
re cove ry-pluginclas s -name
no
no
re cove ry-pluginprope rtie s
re cove ry-s e curitydomain
re cove ry-us e rname
no
s ame -rm-ove rride
no
s e curity-domain
no
s e t-tx-que ry-time out
Re cove ry Pas s word
Re cove ry Plugin
Clas s Name
Re cove ry Plugin
Prope rtie s
Re cove ry Se curity
Domain
Re cove ry Us e rname
Same Rm Ove rride
Se curity Domain
Se t Tx Que ry
Time out
602
no
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Share Pre pare d
State me nts
Whe the r to s hare
pre pare d
s tate me nts , i.e .
whe the r as king for
s ame s tate me nt
twice without clos ing
us e s the s ame
unde rlying pre pare d
s tate me nt. The
de fault value is
fals e .
Enable s pying of
SQL s tate me nts .
The de fault value is
fals e .
An
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onChe cke r that
provide s an
is Stale Conne ction(S
QLExce ption)
me thod which if it
re turns true will
wrap the e xce ption
in an
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onExce ption
The s tale conne ction
che cke r prope rtie s
Whe the r to che ck for
unclos e d
s tate me nts whe n a
conne ction is
re turne d to the pool,
re s ult s e ts are
clos e d, a s tate me nt
is clos e d or re turn
to the pre pare d
s tate me nt cache .
Valid value s are :
'fals e ' - do not track
s tate me nts , 'true ' track s tate me nts
and re s ult s e ts and
warn whe n the y are
not clos e d, 'nowarn'
- track s tate me nts
but do not warn
about the m be ing
unclos e d. The
de fault value is
'NOWARN'.
no
s hare -pre pare ds tate me nts
no
s py
no
s tale -conne ctionche cke r-clas s -name
no
s tale -conne ctionche cke r-prope rtie s
track-s tate me nts
Spy
Stale Conne ction
Che cke r Clas s
Name
Stale Conne ction
Che cke r Prope rtie s
Track State me nts
no
603
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Trans action Is olation
Se t the
java.s ql.Conne ction
trans action is olation
le ve l. Valid value s
are :
TRANSACTION_READ
_UNCOMMITTED,
TRANSACTION_READ
_COMMITTED,
TRANSACTION_REPE
ATABLE_READ,
TRANSACTION_SERIA
LIZABLE and
TRANSACTION_NONE
Spe cifie s the
de lime te r for URLs
in conne ction-url for
HA datas ource s
A clas s that
imple me nts
org.jbos s .jca.adapte r
s .jdbc.URLSe le ctorSt
rate gy
Enable the us e of a
cache d conne ction
manage r. The
de fault value is true .
Whe the r to fail a
conne ction allocation
on the firs t try if it is
invalid (true ) or ke e p
trying until the pool
is e xhaus te d of all
pote ntial
conne ctions (fals e ).
The de fault value is
fals e .
Se tting this to fals e
will bind the
datas ource into
global JNDI. The
de fault value is true .
Any configure d
time out for inte rnal
locks on the
re s ource adapte r
obje cts in s e conds
Spe cify the us e r
name us e d whe n
cre ating a ne w
conne ction
no
trans action-is olation
no
url-de limite r
no
url-s e le ctors trate gy-clas s -name
no
us e -ccm
no
us e -fas t-fail
no
us e -java-conte xt
no
us e -try-lock
no
us e r-name
Url De limite r
Url Se le ctor
Strate gy Clas s
Name
Us e Ccm
Us e Fas t Fail
Us e Java Conte xt
Us e Try Lock
Us e r Name
604
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Valid Conne ction
Che cke r Clas s
Name
An
org.jbos s .jca.adapte r
s .jdbc.ValidConne ctio
nChe cke r that
provide s an
is ValidConne ction(Co
nne ction) me thod to
validate a
conne ction. If an
e xce ption is
re turne d that me ans
the conne ction is
invalid. This
ove rride s the che ckvalid-conne ction-s ql
e le me nt
The valid conne ction
che cke r prope rtie s
The validate -onmatch e le me nt
s pe cifie s if
conne ction validation
s hould be done
whe n a conne ction
factory atte mpts to
match a manage d
conne ction. This is
typically e xclus ive to
the us e of
background
validation. The
de fault value is
fals e .
Should the
XARe s ource
ins tance s be
wrappe d in a
org.jbos s .tm.XARe s o
urce Wrappe r
ins tance . The de fault
value is true .
The fully qualife d
name of the
javax.s ql.XADataSou
rce imple me ntation
The value is pas s e d
to
XARe s ource .s e tTran
s actionTime out(), in
s e conds . De fault is
z e ro
no
valid-conne ctionche cke r-clas s -name
no
no
valid-conne ctionche cke r-prope rtie s
validate -on-match
no
wrap-xa-re s ource
no
xa-datas ource -clas s
no
xa-re s ource -time out
Valid Conne ction
Che cke r Prope rtie s
Validate On Match
Wrap Xa Re s ource
Xa Datas ource
Clas s
Xa Re s ource
Time out
605
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.549. Met rics
Name
Descript io n
Subs ys te m:flus h All Conne ction In Pool
Subs ys te m:flus h Idle Conne ction In Pool
Subs ys te m:te s t Conne ction In Pool
Flus he s all conne ctions in the pool
Flus he s all idle conne ctions in the pool
Te s t if a conne ction can be obtaine d
Package T ypes
none
3.3.12.6.2. JBo ss AS 7 and EAP 6 - Dat aso urce Runt ime Service
Overview
T able 3.550 . Overview
De s cription:
Single ton:
Plugin:
A JDBC data-s ource configuration
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.551.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.552. Met rics
606
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Pre pare d State me nt
Cache Curre nt Siz e
me as ure me nt
Pre pare dState me ntC
ache Curre ntSiz e
Pre pare d State me nt
Cache Mis s Count
me as ure me nt
Pre pare d State me nt
Cache Mis s Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Add Count
me as ure me nt
Pre pare d State me nt
Cache Acce s s Count
me as ure me nt
Pre pare d State me nt
Cache Acce s s Count
pe r Minute
Pre pare d State me nt
Cache De le te Count
me as ure me nt
Pre pare d State me nt
Cache De le te Count
pe r Minute
me as ure me nt
Pre pare d State me nt
Cache Hit Count
me as ure me nt
Pre pare d State me nt
Cache Hit Count pe r
Minute
me as ure me nt
Active Count
Available Count
Ave rage Blocking
Time
me as ure me nt
me as ure me nt
me as ure me nt
Ave rage Cre ation
Time
me as ure me nt
Cre ate d Count
me as ure me nt
The numbe r of
pre pare d and
callable s tate me nts
curre ntly cache d in
the s tate me nt cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of time s
that a s tate me nt
re que s t could not be
s atis fie d with a
s tate me nt from the
cache
The numbe r of
s tate me nts adde d to
the s tate me nt cache
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of time s
that the s tate me nt
cache was acce s s e d
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of
s tate me nts
dis carde d from the
cache
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The numbe r of time s
that s tate me nts
from the cache we re
us e d
The active count
The available count
The ave rage time
s pe nt blocking for a
conne ction
The ave rage time
s pe nt cre ating a
phys ical conne ction
The cre ate d count
me as ure me nt
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache Mis s Count
Pre pare dState me ntC
ache AddCount
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache Acce s s Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache De le te Count
Pre pare dState me ntC
ache HitCount
Pre pare dState me ntC
ache HitCount
Active Count
Available Count
Ave rage BlockingTim
e
Ave rage Cre ationTim
e
Cre ate dCount
607
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Cre ate d Count pe r
Minute
De s troye d Count
De s troye d Count
pe r Minute
Max Cre ation Time
me as ure me nt
The cre ate d count
Cre ate dCount
me as ure me nt
me as ure me nt
The de s troye d count
The de s troye d count
De s troye dCount
De s troye dCount
me as ure me nt
MaxCre ationTime
Max Us e d Count
me as ure me nt
Max Wait Time
me as ure me nt
Time d Out
Time d Out pe r
Minute
Total Cre ation Time
me as ure me nt
me as ure me nt
The maximum time
for cre ating a
phys ical conne ction
The maximum
numbe r of
conne ctions us e d
The maximum wait
time for a conne ction
The time d out count
The time d out count
TotalCre ationTime
Total Cre ation Time
pe r Minute
me as ure me nt
Total Blocking Time
me as ure me nt
The total time s pe nt
cre ating phys ical
conne ctions
The total time s pe nt
cre ating phys ical
conne ctions
The total blocking
time
The total blocking
time
Conne ction
Available ?
The min pool s iz e
s e tting
The max pool s iz e
s e tting
me as ure me nt
Total Blocking Time
me as ure me nt
pe r Minute
Conne ction
trait
Available ?
Min Pool Siz e s e tting me as ure me nt
Max Pool Siz e
s e tting
me as ure me nt
MaxUs e dCount
MaxWaitTime
Time dOut
Time dOut
TotalCre ationTime
TotalBlockingTime
TotalBlockingTime
conne ctionAvailable
min-pool-s iz e
max-pool-s iz e
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.553.
Name
Conne ction Prope rty
608
Descript io n
Required
Int ernal Name
no
*1
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Allocation Re try
The allocation re try
e le me nt indicate s
the numbe r of time s
that allocating a
conne ction s hould
be trie d be fore
throwing an
e xce ption
The allocation re try
wait millis e le me nt
s pe cifie s the
amount of time , in
millis e conds , to wait
be twe e n re trying to
allocate a conne ction
An e le me nt to
s pe cify that
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Changing this
value can be done
only on dis able d
datas ource , re quire s
a s e rve r re s tart
othe rwis e . The
de fault value is
fals e .
The backgroundvalidation-millis
e le me nt s pe cifie s
the amount of time ,
in millis e conds , that
background
validation will run.
Changing this value
can be done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e
no
allocation-re try
no
allocation-re try-waitmillis
no
backgroundvalidation
no
backgroundvalidation-millis
Allocation Re try Wait
Millis
Background
Validation
Background
Validation Millis
609
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Blocking Time out
Wait Millis
The blockingtime out-millis
e le me nt s pe cifie s
the maximum time ,
in millis e conds , to
block while waiting
for a conne ction
be fore throwing an
e xce ption. Note that
this blocks only
while waiting for
locking a conne ction,
and will ne ve r throw
an e xce ption if
cre ating a ne w
conne ction take s an
inordinate ly long
time
Spe cify an SQL
s tate me nt to che ck
validity of a pool
conne ction. This may
be calle d whe n
manage d conne ction
is obtaine d from the
pool
The JDBC drive r
conne ction URL
The fully qualife d
name of the JDBC
datas ource clas s
The fully qualife d
name of the JDBC
drive r clas s
De fine s the JDBC
drive r the
datas ource s hould
us e . It is a s ymbolic
name matching the
the name of
ins talle d drive r. In
cas e the drive r is
de ploye d as jar, the
name is the name of
de ployme nt unit
Spe cifie s if the
datas ource s hould
be e nable d
no
blocking-time outwait-millis
no
che ck-validconne ction-s ql
no
conne ction-url
no
datas ource -clas s
no
drive r-clas s
no
drive r-name
no
e nable d
Che ck Valid
Conne ction Sql
Conne ction Url
Datas ource Clas s
Drive r Clas s
Drive r Name
Enable d
610
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Exce ption Sorte r
Clas s Name
An
org.jbos s .jca.adapte r
s .jdbc.Exce ptionSort
e r that provide s an
is Exce ptionFatal(SQL
Exce ption) me thod
to validate if an
e xce ption s hould
broadcas t an e rror
The e xce ption
s orte r prope rtie s
Spe cifie s how the
pool s hould be flus h
in cas e of an e rror.
The idle -time outminute s e le me nts
s pe cifie s the
maximum time , in
minute s , a
conne ction may be
idle be fore be ing
clos e d. The actual
maximum time
de pe nds als o on the
Idle Re move r s can
time , which is half of
the s malle s t idle time out-minute s
value of any pool.
Changing this value
can be done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e .
Spe cifie s the JNDI
name for the
datas ource
Enable JTA
inte gration. The
de fault value is true .
The max-pool-s iz e
e le me nt s pe cifie s
the maximum
numbe r of
conne ctions for a
pool. No more
conne ctions will be
cre ate d in e ach s ubpool. The de fault
value is 20.
no
e xce ption-s orte rclas s -name
no
no
e xce ption-s orte rprope rtie s
flus h-s trate gy
no
idle -time out-minute s
no
jndi-name
no
jta
no
max-pool-s iz e
Exce ption Sorte r
Prope rtie s
Flus h Strate gy
Idle Time out Minute s
Jndi Name
Jta
Max Pool Siz e
611
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Min Pool Siz e
The min-pool-s iz e
e le me nt s pe cifie s
the minimum
numbe r of
conne ctions for a
pool. The de fault
value is 0.
Spe cifie s an SQL
s tate me nt to
e xe cute whe ne ve r a
conne ction is adde d
to the conne ction
pool
Spe cifie s the
pas s word us e d
whe n cre ating a ne w
conne ction
Should the pool be
pre fille d. Changing
this value can be
done only on
dis able d datas ource ,
re quire s a s e rve r
re s tart othe rwis e .
The de fault value is
fals e .
Spe cifie s if the minpool-s iz e s hould be
cons ide re d s trictly.
The de fault value is
fals e .
The numbe r of
pre pare d
s tate me nts pe r
conne ction in an LRU
cache
Any configure d
que ry time out in
s e conds . If not
provide d no time out
will be s e t
The fully qualifie d
clas s name of the
re authe ntication
plugin
imple me ntation
The prope rtie s for
the re authe ntication
plugin
no
min-pool-s iz e
no
ne w-conne ction-s ql
no
pas s word
no
pool-pre fill
no
pool-us e -s trict-min
no
pre pare ds tate me nts -cache s iz e
no
que ry-time out
no
re auth-plugin-clas s name
no
re auth-pluginprope rtie s
Ne w Conne ction Sql
Pas s word
Pool Pre fill
Pool Us e Strict Min
Pre pare d
State me nts Cache
Siz e
Que ry Time out
Re auth Plugin Clas s
Name
Re auth Plugin
Prope rtie s
612
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Se curity Domain
Spe cifie s the
s e curity domain
which de fine s the
javax.s e curity.auth.S
ubje ct that are us e d
to dis tinguis h
conne ctions in the
pool
Whe the r to s e t the
que ry time out bas e d
on the time
re maining until
trans action time out.
Any configure d
que ry time out will
be us e d if the re is
no trans action. The
de fault value is
fals e .
Whe the r to s hare
pre pare d
s tate me nts , i.e .
whe the r as king for
s ame s tate me nt
twice without clos ing
us e s the s ame
unde rlying pre pare d
s tate me nt. The
de fault value is
fals e .
Enable s pying of
SQL s tate me nts .
The de fault value is
fals e .
An
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onChe cke r that
provide s an
is Stale Conne ction(S
QLExce ption)
me thod which if it
re turns true will
wrap the e xce ption
in an
org.jbos s .jca.adapte r
s .jdbc.Stale Conne cti
onExce ption
The s tale conne ction
che cke r prope rtie s
no
s e curity-domain
no
s e t-tx-que ry-time out
no
s hare -pre pare ds tate me nts
no
s py
no
s tale -conne ctionche cke r-clas s -name
no
s tale -conne ctionche cke r-prope rtie s
Se t Tx Que ry
Time out
Share Pre pare d
State me nts
Spy
Stale Conne ction
Che cke r Clas s
Name
Stale Conne ction
Che cke r Prope rtie s
613
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Track State me nts
Whe the r to che ck for
unclos e d
s tate me nts whe n a
conne ction is
re turne d to the pool,
re s ult s e ts are
clos e d, a s tate me nt
is clos e d or re turn
to the pre pare d
s tate me nt cache .
Valid value s are :
'fals e ' - do not track
s tate me nts , 'true ' track s tate me nts
and re s ult s e ts and
warn whe n the y are
not clos e d, 'nowarn'
- track s tate me nts
but do not warn
about the m be ing
unclos e d. The
de fault value is
'NOWARN'.
Se t the
java.s ql.Conne ction
trans action is olation
le ve l. Valid value s
are :
TRANSACTION_READ
_UNCOMMITTED,
TRANSACTION_READ
_COMMITTED,
TRANSACTION_REPE
ATABLE_READ,
TRANSACTION_SERIA
LIZABLE and
TRANSACTION_NONE
Spe cifie s the
de lime te r for URLs
in conne ction-url for
HA datas ource s
A clas s that
imple me nts
org.jbos s .jca.adapte r
s .jdbc.URLSe le ctorSt
rate gy
Enable the us e of a
cache d conne ction
manage r. The
de fault value is true .
no
track-s tate me nts
no
trans action-is olation
no
url-de limite r
no
url-s e le ctors trate gy-clas s -name
no
us e -ccm
Trans action Is olation
Url De limite r
Url Se le ctor
Strate gy Clas s
Name
Us e Ccm
614
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Us e Fas t Fail
Whe the r to fail a
conne ction allocation
on the firs t try if it is
invalid (true ) or ke e p
trying until the pool
is e xhaus te d of all
pote ntial
conne ctions (fals e ).
The de fault value is
fals e .
Se tting this to fals e
will bind the
datas ource into
global JNDI. The
de fault value is true .
Any configure d
time out for inte rnal
locks on the
re s ource adapte r
obje cts in s e conds
Spe cify the us e r
name us e d whe n
cre ating a ne w
conne ction
An
org.jbos s .jca.adapte r
s .jdbc.ValidConne ctio
nChe cke r that
provide s an
is ValidConne ction(Co
nne ction) me thod to
validate a
conne ction. If an
e xce ption is
re turne d that me ans
the conne ction is
invalid. This
ove rride s the che ckvalid-conne ction-s ql
e le me nt
The valid conne ction
che cke r prope rtie s
no
us e -fas t-fail
no
us e -java-conte xt
no
us e -try-lock
no
us e r-name
no
valid-conne ctionche cke r-clas s -name
no
valid-conne ctionche cke r-prope rtie s
Us e Java Conte xt
Us e Try Lock
Us e r Name
Valid Conne ction
Che cke r Clas s
Name
Valid Conne ction
Che cke r Prope rtie s
615
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Validate On Match
The validate -onno
match e le me nt
s pe cifie s if
conne ction validation
s hould be done
whe n a conne ction
factory atte mpts to
match a manage d
conne ction. This is
typically e xclus ive to
the us e of
background
validation. The
de fault value is
fals e .
Int ernal Name
validate -on-match
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.554. Met rics
Name
Descript io n
Subs ys te m:flus h All Conne ction In Pool
Subs ys te m:flus h Idle Conne ction In Pool
Subs ys te m:te s t Conne ction In Pool
Flus he s all conne ctions in the pool
Flus he s all idle conne ctions in the pool
Te s t if a conne ction can be obtaine d
Package T ypes
none
3.3.12.7. JBoss AS 7 and EAP 6 - EJB3 Runt ime Service
Overview
T able 3.555. Overview
De s cription:
Single ton:
Plugin:
Runtime re s ource s e xpos e d by EJBs
compone nts include d in this de ployme nt.
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.12.7.1, “JBos s AS 7 and EAP 6 - Me s s age Drive n Be an Runtime Se rvice ”
Se ction 3.3.12.7.2, “JBos s AS 7 and EAP 6 - Single ton Be an Runtime Se rvice ”
616
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Se ction 3.3.12.7.3, “JBos s AS 7 and EAP 6 - State le s s Se s s ion Be an Runtime Se rvice ”
Se ction 3.3.12.7.4, “JBos s AS 7 and EAP 6 - Entity Be an Runtime Se rvice ”
Se ction 3.3.12.7.5, “JBos s AS 7 and EAP 6 - State ful Se s s ion Be an Runtime Se rvice ”
Co nnect io n Pro pert ies
T able 3.556.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.7.1. JBo ss AS 7 and EAP 6 - Message Driven Bean Runt ime Service
Overview
T able 3.557. Overview
De s cription:
Single ton:
Plugin:
Be an compone nt include d in the
de ployme nt.
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.558.
617
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.559. Met rics
Name
T ype
Descript io n
Int ernal Name
Pool Available Count
me as ure me nt
pool-available -count
Pool Cre ate Count
me as ure me nt
Pool Curre nt Siz e
me as ure me nt
Pool Max Siz e
me as ure me nt
Pool Re move Count
me as ure me nt
Pe ak concurre nt
invocations
Invocations
me as ure me nt
Invocations pe r
Minute
me as ure me nt
Wait Time
me as ure me nt
Exe cution Time
me as ure me nt
Exe cution Time pe r
Minute
Me thod Exe cution
Time
me as ure me nt
The numbe r of
available (i.e . not in
us e ) ins tance s in the
pool.
The numbe r of be an
ins tance s that have
be e n cre ate d.
The curre nt s iz e of
the pool.
The maximum s iz e
of the pool.
The numbe r of be an
ins tance s that have
be e n re move d.
Pe ak concurre nt
invocations .
Numbe r of
invocations
proce s s e d.
Numbe r of
invocations
proce s s e d.
Time s pe nt waiting
to obtain an
ins tance .
Time s pe nt within a
be an me thod
Time s pe nt within a
be an me thod
The e xe cution time s
of individual
me thods on a be an.
Note that you ne e d
to e nable s tatis tics
at s e rve r le ve l in
the e jb3 s ubs ys te m
618
me as ure me nt
calltime
pool-cre ate -count
pool-curre nt-s iz e
pool-max-s iz e
pool-re move -count
pe ak-concurre ntinvocations
invocations
invocations
wait-time
e xe cution-time
e xe cution-time
__calltime :e xe cutiontime
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.560 .
Name
Descript io n
Required
Int ernal Name
Compone nt Clas s
Name
De clare d Role s
The compone nt's
clas s name .
The role s de clare d
(via @De clare Role s )
on this EJB
compone nt.
The run-as role (if
any) for this EJB
compone nt.
The s e curity domain
for this EJB
compone nt.
EJB time rs
as s ociate d with the
compone nt.
no
ye s
compone nt-clas s name
de clare d-role s
no
run-as -role
no
s e curity-domain
ye s
time rs
Run As Role
Se curity Domain
Time rs
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.12.7.2. JBo ss AS 7 and EAP 6 - Singlet o n Bean Runt ime Service
Overview
T able 3.561. Overview
De s cription:
Single ton:
Plugin:
Single ton be an compone nt include d in the
de ployme nt.
no
JBos s AS7
619
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.562.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.563. Met rics
Name
T ype
Descript io n
Int ernal Name
Pe ak concurre nt
invocations
Invocations
me as ure me nt
pe ak-concurre ntinvocations
invocations
Invocations pe r
Minute
me as ure me nt
Wait Time
me as ure me nt
Exe cution Time
me as ure me nt
Exe cution Time pe r
Minute
Me thod Exe cution
Time
me as ure me nt
Pe ak concurre nt
invocations .
Numbe r of
invocations
proce s s e d.
Numbe r of
invocations
proce s s e d.
Time s pe nt waiting
to obtain an
ins tance .
Time s pe nt within a
be an me thod
Time s pe nt within a
be an me thod
The e xe cution time s
of individual
me thods on a be an.
Note that you ne e d
to e nable s tatis tics
at s e rve r le ve l in
the e jb3 s ubs ys te m
me as ure me nt
calltime
invocations
wait-time
e xe cution-time
e xe cution-time
__calltime :e xe cutiontime
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
620
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Co nf igurat io n Pro pert ies
T able 3.564.
Name
Descript io n
Required
Int ernal Name
Compone nt Clas s
Name
De clare d Role s
The compone nt's
clas s name .
The role s de clare d
(via @De clare Role s )
on this EJB
compone nt.
The run-as role (if
any) for this EJB
compone nt.
The s e curity domain
for this EJB
compone nt.
EJB time rs
as s ociate d with the
compone nt.
no
ye s
compone nt-clas s name
de clare d-role s
no
run-as -role
no
s e curity-domain
ye s
time rs
Run As Role
Se curity Domain
Time rs
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.12.7.3. JBo ss AS 7 and EAP 6 - St at eless Sessio n Bean Runt ime Service
Overview
T able 3.565. Overview
De s cription:
Single ton:
Plugin:
State le s s s e s s ion be an compone nt
include d in the de ployme nt.
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.566.
621
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.567. Met rics
Name
T ype
Descript io n
Int ernal Name
Pool Available Count
me as ure me nt
pool-available -count
Pool Cre ate Count
me as ure me nt
Pool Curre nt Siz e
me as ure me nt
Pool Max Siz e
me as ure me nt
Pool Re move Count
me as ure me nt
Pe ak concurre nt
invocations
Invocations
me as ure me nt
Invocations pe r
Minute
me as ure me nt
Wait Time
me as ure me nt
Exe cution Time
me as ure me nt
Exe cution Time pe r
Minute
Me thod Exe cution
Time
me as ure me nt
The numbe r of
available (i.e . not in
us e ) ins tance s in the
pool.
The numbe r of be an
ins tance s that have
be e n cre ate d.
The curre nt s iz e of
the pool.
The maximum s iz e
of the pool.
The numbe r of be an
ins tance s that have
be e n re move d.
Pe ak concurre nt
invocations .
Numbe r of
invocations
proce s s e d.
Numbe r of
invocations
proce s s e d.
Time s pe nt waiting
to obtain an
ins tance .
Time s pe nt within a
be an me thod
Time s pe nt within a
be an me thod
The e xe cution time s
of individual
me thods on a be an.
Note that you ne e d
to e nable s tatis tics
at s e rve r le ve l in
the e jb3 s ubs ys te m
622
me as ure me nt
calltime
pool-cre ate -count
pool-curre nt-s iz e
pool-max-s iz e
pool-re move -count
pe ak-concurre ntinvocations
invocations
invocations
wait-time
e xe cution-time
e xe cution-time
__calltime :e xe cutiontime
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.568.
Name
Descript io n
Required
Int ernal Name
Compone nt Clas s
Name
De clare d Role s
The compone nt's
clas s name .
The role s de clare d
(via @De clare Role s )
on this EJB
compone nt.
The run-as role (if
any) for this EJB
compone nt.
The s e curity domain
for this EJB
compone nt.
EJB time rs
as s ociate d with the
compone nt.
no
ye s
compone nt-clas s name
de clare d-role s
no
run-as -role
no
s e curity-domain
ye s
time rs
Run As Role
Se curity Domain
Time rs
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.12.7.4. JBo ss AS 7 and EAP 6 - Ent it y Bean Runt ime Service
Overview
T able 3.569. Overview
De s cription:
Single ton:
Plugin:
Entity be an compone nt include d in the
de ployme nt.
no
JBos s AS7
623
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.570 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.571. Met rics
Name
T ype
Descript io n
Int ernal Name
Pool Available Count
me as ure me nt
pool-available -count
Pool Cre ate Count
me as ure me nt
Pool Curre nt Siz e
me as ure me nt
Pool Max Siz e
me as ure me nt
Pool Re move Count
me as ure me nt
Pe ak concurre nt
invocations
Invocations
me as ure me nt
Invocations pe r
Minute
me as ure me nt
Wait Time
me as ure me nt
Exe cution Time
me as ure me nt
Exe cution Time pe r
Minute
me as ure me nt
The numbe r of
available (i.e . not in
us e ) ins tance s in the
pool.
The numbe r of be an
ins tance s that have
be e n cre ate d.
The curre nt s iz e of
the pool.
The maximum s iz e
of the pool.
The numbe r of be an
ins tance s that have
be e n re move d.
Pe ak concurre nt
invocations .
Numbe r of
invocations
proce s s e d.
Numbe r of
invocations
proce s s e d.
Time s pe nt waiting
to obtain an
ins tance .
Time s pe nt within a
be an me thod
Time s pe nt within a
be an me thod
624
me as ure me nt
pool-cre ate -count
pool-curre nt-s iz e
pool-max-s iz e
pool-re move -count
pe ak-concurre ntinvocations
invocations
invocations
wait-time
e xe cution-time
e xe cution-time
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Me thod Exe cution
Time
calltime
The e xe cution time s
of individual
me thods on a be an.
Note that you ne e d
to e nable s tatis tics
at s e rve r le ve l in
the e jb3 s ubs ys te m
__calltime :e xe cutiontime
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.572.
Name
Descript io n
Required
Int ernal Name
Compone nt Clas s
Name
De clare d Role s
The compone nt's
clas s name .
The role s de clare d
(via @De clare Role s )
on this EJB
compone nt.
The run-as role (if
any) for this EJB
compone nt.
The s e curity domain
for this EJB
compone nt.
no
ye s
compone nt-clas s name
de clare d-role s
no
run-as -role
no
s e curity-domain
Run As Role
Se curity Domain
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.12.7.5. JBo ss AS 7 and EAP 6 - St at ef ul Sessio n Bean Runt ime Service
Overview
625
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.573. Overview
De s cription:
State ful s e s s ion be an compone nt include d
in the de ployme nt.
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.574.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.575. Met rics
Name
T ype
Descript io n
Int ernal Name
Pe ak concurre nt
invocations
Invocations
me as ure me nt
pe ak-concurre ntinvocations
invocations
Invocations pe r
Minute
me as ure me nt
Wait Time
me as ure me nt
Exe cution Time
me as ure me nt
Exe cution Time pe r
Minute
Me thod Exe cution
Time
me as ure me nt
Pe ak concurre nt
invocations .
Numbe r of
invocations
proce s s e d.
Numbe r of
invocations
proce s s e d.
Time s pe nt waiting
to obtain an
ins tance .
Time s pe nt within a
be an me thod
Time s pe nt within a
be an me thod
The e xe cution time s
of individual
me thods on a be an.
Note that you ne e d
to e nable s tatis tics
at s e rve r le ve l in
the e jb3 s ubs ys te m
626
me as ure me nt
calltime
invocations
wait-time
e xe cution-time
e xe cution-time
__calltime :e xe cutiontime
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.576.
Name
Descript io n
Required
Int ernal Name
Compone nt Clas s
Name
De clare d Role s
The compone nt's
clas s name .
The role s de clare d
(via @De clare Role s )
on this EJB
compone nt.
The run-as role (if
any) for this EJB
compone nt.
The s e curity domain
for this EJB
compone nt.
no
ye s
compone nt-clas s name
de clare d-role s
no
run-as -role
no
s e curity-domain
Run As Role
Se curity Domain
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.12.8. JBoss AS 7 and EAP 6 - Resource Adapt ers Runt ime Service
Overview
T able 3.577. Overview
De s cription:
Single ton:
Plugin:
Configuration of the re s ource adapte rs
s ubs ys te m.
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.12.8.1, “JBos s AS 7 and EAP 6 - Conne ction De finition Runtime Se rvice ”
627
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Co nnect io n Pro pert ies
T able 3.578.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.12.8.1. JBo ss AS 7 and EAP 6 - Co nnect io n Def init io n Runt ime Service
Overview
T able 3.579. Overview
De s cription:
Single ton:
Plugin:
Spe cifie s the conne ction de finitions .
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.580 .
Name
Path
628
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.581. Met rics
Name
T ype
Descript io n
Int ernal Name
Active Count
Available Count
Ave rage Blocking
Time
me as ure me nt
me as ure me nt
me as ure me nt
Active Count
Available Count
Ave rage BlockingTim
e
Ave rage Cre ation
Time
me as ure me nt
Cre ate d Count
De s troye d Count
Max Cre ation Time
me as ure me nt
me as ure me nt
me as ure me nt
Max Us e d Count
me as ure me nt
Max Wait Time
me as ure me nt
Time d Out
Total Blocking Time
me as ure me nt
me as ure me nt
Total Cre ation Time
me as ure me nt
The active count
The available count
The ave rage time
s pe nt blocking for a
conne ction
The ave rage time
s pe nt cre ating a
phys ical conne ction
The cre ate d count
The de s troye d count
The maximum time
for cre ating a
phys ical conne ction
The maximum
numbe r of
conne ctions us e d
The maximum wait
time for a conne ction
The time d out count
The total blocking
time
The total time s pe nt
cre ating phys ical
conne ctions
Ave rage Cre ationTim
e
Cre ate dCount
De s troye dCount
MaxCre ationTime
MaxUs e dCount
MaxWaitTime
Time dOut
TotalBlockingTime
TotalCre ationTime
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
629
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
3.3.13. JBoss AS 7 and EAP 6 - Deployment Scanner Service
Overview
T able 3.582. Overview
De s cription:
Single ton:
Plugin:
Manage me nt of the de ployme nt s canne r
ye s
JBos s AS7
Child Resource T ypes
none
Connect ion Propert ies
T able 3.583.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.584.
Name
Descript io n
Required
Int ernal Name
Scanne rs
Lis t of s canne rs
ye s
*
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
630
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Package T ypes
none
3.3.14. JBoss AS 7 and EAP 6 - JacORB Service
Overview
T able 3.585. Overview
De s cription:
Single ton:
Plugin:
JacORB s ubs ys te m configuration
ye s
JBos s AS7
Child Resource T ypes
none
Connect ion Propert ies
T able 3.586.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.587.
Name
Descript io n
Required
Int ernal Name
Add Compone nt Via
Inte rce ptor
Indicate s whe the r
SSL compone nts
s hould be adde d by
an IOR inte rce ptor
(on) or not (off). The
de fault value is on.
Indicate s whe the r
POA name s s hould
be cache d (on) or
not (off). The de fault
value is off.
no
add-compone nt-viainte rce ptor
no
cache -poa-name s
Cache Poa Name s
631
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Cache Type code s
Indicate s whe the r
type code s s hould be
cache d (on) or not
(off). The de fault
value is off.
Indicate s whe the r
cus tom RMI
value type s s hould
be e ncode d as
chunks (on) or not
(off). The de fault
value is on.
Value that indicate s
the clie nt SSL
re quire d
parame te rs (None ,
Se rve rAuth,
Clie ntAuth,
MutualAuth). The
de fault value is
None .
Value that indicate s
the clie nt SSL
s upporte d
parame te rs (None ,
Se rve rAuth,
Clie ntAuth,
MutualAuth). The
de fault value is
MutualAuth.
The clie nt-s ide
conne ction time out
value in
millis e conds . A
value of z e ro
indicate s that the
conne ction ne ve r
time s out. The
de fault value is 0.
Indicate s whe the r
inte rope rability with
Come t's ORB is
e nable d (on) or not
(off). The de fault
value is off.
Indicate s whe the r
the root conte xt
s hould be e xporte d
as
corbaloc::addre s s :po
rt/Name Se rvice (on)
or not (off). The
de fault value is on.
no
cache -type code s
no
chunk-cus tom-rmivalue type s
no
clie nt-re quire s
no
clie nt-s upports
no
clie nt-time out
no
come t
no
e xport-corbaloc
Chunk Cus tom Rmi
Value type s
Clie nt Re quire s
Clie nt Supports
Clie nt Time out
Come t
Export Corbaloc
632
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Giop Minor Ve rs ion
The GIOP minor
ve rs ion to be us e d.
The de fault value is
2.
Indicate s whe the r
indire ction e ncoding
for re pe ate d
type code s s hould be
dis able d (on) or not
(off). The de fault
value is off.
Indicate s whe the r
inte rope rability with
IONA's ASP is
e nable d (on) or not
(off). The de fault
value is off.
Indicate s whe the r
any non-z e ro CDR
e ncode d boole an
value s hould be
inte rpre te d as true
(on) or not (off). The
de fault value is off.
The log2 of
maximum s iz e
manage d by the
inte rnal buffe r
manage r. The
de fault value is 24.
The maximum
numbe r of
conne ctions
acce pte d by the
s e rve r. The de fault
value is
2147483647.
The maximum
numbe r of active
re que s t proce s s or
thre ads . Thre ads
are firs t obtaine d
from the pool and
once the pool is
e xhaus te d ne w
thre ads are cre ate d
until the numbe r of
thre ads re ache s this
limit. Ne w re que s ts
will wait until an
active thre ad
finis he s its job. The
de fault value is 32.
no
giop-minor-ve rs ion
no
indire ction-e ncodingdis able
no
iona
no
lax-boole an-e ncoding
no
max-manage d-bufs iz e
no
max-s e rve rconne ctions
no
max-thre ads
Indire ction Encoding
Dis able
Iona
Lax Boole an
Encoding
Max Manage d Buf
Siz e
Max Se rve r
Conne ctions
Max Thre ads
633
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Monitoring
Indicate s whe the r
the monitoring GUI
s hould be dis playe d
(on) or not (off). The
de fault value is off.
The name of the
running ORB. The
de fault value is
JBos s .
The buffe r cache
time out in
millis e conds . The
de fault value is -1.
The s iz e of the
ne twork buffe rs for
outgoing me s s age s .
The de fault value is
2048.
The s iz e of the
re que s t proce s s ors
thre ad-pool. Thre ads
that finis h
proce s s ing a
re que s t are place d
back in the pool if
the pool is not full
and dis carde d
othe rwis e . The
de fault value is 5.
Indicate s whe the r
the ve rs ion numbe r
s hould be printe d
during ORB s tartup
(on) or not (off). The
de fault value is off.
A lis t of ge ne ric
ke y/value
prope rtie s .
The maximum
numbe r of re que s ts
that can be que ue d.
The de fault value is
100.
The s iz e of the
que ue for notifying
waiting re que s ts . In
othe r words , blocke d
re que s ts are only
notifie d whe n the
que ue has no more
than que ue -min
re que s ts . The
de fault value is 10.
no
monitoring
no
name
no
outbuf-cache -time out
no
outbuf-s iz e
no
pool-s iz e
no
print-ve rs ion
no
prope rtie s
no
que ue -max
no
que ue -min
Name
Outbuf Cache
Time out
Outbuf Siz e
Pool Siz e
Print Ve rs ion
Prope rtie s
Que ue Max
Que ue Min
634
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Que ue Wait
Indicate s whe the r
re que s ts that
e xce e d the
maximum que ue
s iz e s hould wait (on)
or not (off). Whe n
dis able d, a
TRANSIENT
e xce ption is thrown
if the que ue is full.
The de fault value is
off.
The numbe r of
re trie s if
conne ctions cannot
be promptly
e s tablis he d. The
de fault value is 5.
The inte rval in
millis e conds
be twe e n re trie s .
The de fault value is
500.
The naming s e rvice
root conte xt. The
de fault value is
JBos s /Naming/root.
Indicate s whe the r
the s e curity
inte rce ptors are to
be ins talle d (on) or
not (off). The de fault
value is off.
The name of the
s e curity domain that
holds the ke y and
trus t s tore s that will
be us e d to e s tablis h
SSL conne ctions .
Value that indicate s
the s e rve r SSL
re quire d
parame te rs (None ,
Se rve rAuth,
Clie ntAuth,
MutualAuth). The
de fault value is
None .
no
que ue -wait
no
re trie s
no
re try-inte rval
no
root-conte xt
no
s e curity
no
s e curity-domain
no
s e rve r-re quire s
Re trie s
Re try Inte rval
Root Conte xt
Se curity
Se curity Domain
Se rve r Re quire s
635
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Se rve r Supports
Value that indicate s
the s e rve r SSL
s upporte d
parame te rs (None ,
Se rve rAuth,
Clie ntAuth,
MutualAuth). The
de fault value is
MutualAuth.
The s e rve r-s ide
conne ction time out
value in
millis e conds . A
value of z e ro
indicate s that the
conne ction ne ve r
time s out. The
de fault value is 0.
Indicate s whe the r
the me thod
cre ate _abs tract_inte
rface _tc s hould
pe rform a validation
che ck on the name
parame te r (on) or
not (off). The de fault
value is off.
Indicate s whe the r
inte rope rability with
Sun's ORB is
e nable d (on) or not
(off). The de fault
value is on.
Indicate s whe the r
SSL is to be
s upporte d (on) or
not (off). The de fault
value is off.
Indicate s whe the r
the trans actions
inte rce ptors are to
be ins talle d (on or
s pe c) or not (off).
The value 'on'
e nable d JTS while
's pe c' e nable s a
s pe c compliant
mode (non JTS) that
re je cts incoming
trans action conte xts .
The de fault value is
off.
no
s e rve r-s upports
no
s e rve r-time out
no
s trict-che ck-on-tccre ation
no
s un
no
s upport-s s l
no
trans actions
Se rve r Time out
Strict Che ck On Tc
Cre ation
Sun
Support Ss l
Trans actions
636
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Us e Bom
Indicate s whe the r
GIOP 1.2 byte orde r
marke rs s hould be
us e d (on) or not
(off). The de fault
value is off.
Indicate s whe the r
the imple me ntation
re pos itory s hould be
us e d (on) or not
(off). The de fault
value is off.
no
us e -bom
no
us e -imr
Us e Imr
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.15. JBoss AS 7 and EAP 6 - JDR Service
Overview
T able 3.588. Overview
De s cription:
Single ton:
Plugin:
JBos s Diagnos tic Re porte r (JDR) Subs ys te m.
ye s
JBos s AS7
Child Resource T ypes
none
Connect ion Propert ies
T able 3.589.
Name
Path
Manage d Runtime
Descript io n
Required
Int ernal Name
ye s
ye s
path
manage dRuntime
637
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
T able 3.590 . Met rics
Name
Descript io n
Ge ne rate JDR Re port
Re que s t the ge ne ration of a JDR re port.
Package T ypes
none
3.3.16. JBoss AS 7 and EAP 6 - JCA Service
Overview
T able 3.591. Overview
De s cription:
The Java EE Conne ctor Archite cture (JCA)
s ubs ys te m providing ge ne ral configuration
for re s ource adapte rs
ye s
JBos s AS7
Single ton:
Plugin:
Child Resource T ypes
Se ction 3.3.16.1, “JBos s AS 7 and EAP 6 - Boots trapConte xt Se rvice ”
Se ction 3.3.16.2, “JBos s AS 7 and EAP 6 - Workmanage r Se rvice ”
Connect ion Propert ies
T able 3.592.
Name
Path
638
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.593.
Name
Descript io n
Required
Int ernal Name
Enable d
Spe cify whe the r
be an validation is
e nable d. The de fault
value is true .
Spe cify whe the r
archive validation is
e nable d. The de fault
value is true .
Should an archive
validation e rror
re port fail the
de ployme nt. The
de fault value is true .
Should an archive
validation warning
re port fail the
de ployme nt. The
de fault value is
fals e .
Enable /dis able
de bug information
logging. The de fault
value is fals e .
Enable /dis able e rror
information logging.
The de fault value is
fals e .
Enable /dis able the
cache d conne ction
manage r valve and
inte rce ptor. The
de fault value is
fals e .
no
e nable d:1
no
e nable d:2
no
fail-on-e rror
no
fail-on-warn
no
de bug
no
e rror
no
ins tall
Enable d
Fail On Error
Fail On Warn
De bug
Error
Ins tall
639
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.16.1. JBoss AS 7 and EAP 6 - Boot st rapCont ext Service
Overview
T able 3.594. Overview
De s cription:
Single ton:
Plugin:
Boots trap conte xt for re s ource adapte rs .
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.595.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.596.
Name
640
Descript io n
Required
Int ernal Name
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Name
The name of the
Boots trapConte xt
The WorkManage r
ins tance for the
Boots trapConte xt
no
name
no
workmanage r
Workmanage r
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.16.2. JBoss AS 7 and EAP 6 - Workmanager Service
Overview
T able 3.597. Overview
De s cription:
Single ton:
Plugin:
WorkManage r for re s ource adapte rs .
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.16.2.1, “JBos s AS 7 and EAP 6 - Long Running Thre ad Pool Se rvice ”
Se ction 3.3.16.2.2, “JBos s AS 7 and EAP 6 - Short Running Thre ad Pool Se rvice ”
Co nnect io n Pro pert ies
T able 3.598.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
641
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Co nf igurat io n Pro pert ies
T able 3.599.
Name
Descript io n
Required
Int ernal Name
Name
The name of the
WorkManage r
no
name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.16.2.1. JBo ss AS 7 and EAP 6 - Lo ng Running T hread Po o l Service
Overview
T able 3.60 0 . Overview
De s cription:
Long running thre ad pool e xe cutor with a
bounde d que ue whe re thre ads s ubmitting
tas ks may block.
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.60 1.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
642
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Met rics
T able 3.60 2. Met rics
Name
T ype
Descript io n
Int ernal Name
Curre nt Thre ad
Count
me as ure me nt
curre nt-thre ad-count
Large s t Thre ad
Count
me as ure me nt
Re je cte d Count
me as ure me nt
The curre nt numbe r
of thre ads in the
pool.
The large s t numbe r
of thre ads that have
e ve r s imultane ous ly
be e n in the pool.
The numbe r of tas ks
that have be e n
pas s e d to the
handoff-e xe cutor (if
one is s pe cifie d) or
dis carde d.
large s t-thre ad-count
re je cte d-count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.60 3.
Name
Descript io n
Allow Core Time out
Whe the r core
no
thre ads may time
out. The de fault
value is fals e .
The core thre ad pool no
s iz e which is
s malle r than the
maximum pool s iz e .
If unde fine d, the
core thre ad pool
s iz e is the s ame as
the maximum thre ad
pool s iz e .
An e xe cutor to
no
de le gate tas ks to in
the e ve nt that a tas k
cannot be acce pte d.
If not s pe cifie d,
tas ks that cannot be
acce pte d will be
s ile ntly dis carde d.
Core Thre ads
Handoff Exe cutor
Required
Int ernal Name
allow-core -time out
core -thre ads :e xpr
handoff-e xe cutor
643
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Ke e palive Time
Us e d to s pe cify the
amount of time that
pool thre ads s hould
be ke pt running
whe n idle ; if not
s pe cifie d, thre ads
will run until the
e xe cutor is s hut
down.
The maximum
thre ad pool s iz e .
The name of the
thre ad pool.
The que ue le ngth.
Spe cifie s the name
of a s pe cific thre ad
factory to us e to
cre ate worke r
thre ads . If not
de fine d an
appropriate de fault
thre ad factory will
be us e d.
no
ke e palive -time
ye s
max-thre ads :e xpr
no
name
ye s
no
que ue -le ngth:e xpr
thre ad-factory
Max Thre ads
Name
Que ue Le ngth
Thre ad Factory
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.16.2.2. JBo ss AS 7 and EAP 6 - Sho rt Running T hread Po o l Service
Overview
T able 3.60 4. Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
644
Short running thre ad pool e xe cutor with a
bounde d que ue whe re thre ads s ubmitting
tas ks may block.
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
Co nnect io n Pro pert ies
T able 3.60 5.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.60 6. Met rics
Name
T ype
Descript io n
Int ernal Name
Curre nt Thre ad
Count
me as ure me nt
curre nt-thre ad-count
Large s t Thre ad
Count
me as ure me nt
Re je cte d Count
me as ure me nt
The curre nt numbe r
of thre ads in the
pool.
The large s t numbe r
of thre ads that have
e ve r s imultane ous ly
be e n in the pool.
The numbe r of tas ks
that have be e n
pas s e d to the
handoff-e xe cutor (if
one is s pe cifie d) or
dis carde d.
large s t-thre ad-count
re je cte d-count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.60 7.
Name
Descript io n
Required
Int ernal Name
Allow Core Time out
Whe the r core
thre ads may time
out. The de fault
value is fals e .
no
allow-core -time out
645
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Core Thre ads
The core thre ad pool
s iz e which is
s malle r than the
maximum pool s iz e .
If unde fine d, the
core thre ad pool
s iz e is the s ame as
the maximum thre ad
pool s iz e .
An e xe cutor to
de le gate tas ks to in
the e ve nt that a tas k
cannot be acce pte d.
If not s pe cifie d,
tas ks that cannot be
acce pte d will be
s ile ntly dis carde d.
Us e d to s pe cify the
amount of time that
pool thre ads s hould
be ke pt running
whe n idle ; if not
s pe cifie d, thre ads
will run until the
e xe cutor is s hut
down.
The maximum
thre ad pool s iz e .
The name of the
thre ad pool.
The que ue le ngth.
Spe cifie s the name
of a s pe cific thre ad
factory to us e to
cre ate worke r
thre ads . If not
de fine d an
appropriate de fault
thre ad factory will
be us e d.
no
core -thre ads :e xpr
no
handoff-e xe cutor
no
ke e palive -time
ye s
max-thre ads :e xpr
no
name
ye s
no
que ue -le ngth:e xpr
thre ad-factory
Handoff Exe cutor
Ke e palive Time
Max Thre ads
Name
Que ue Le ngth
Thre ad Factory
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
646
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
3.3.17. JBoss AS 7 and EAP 6 - JAXR Service
Overview
T able 3.60 8. Overview
De s cription:
Single ton:
Plugin:
The configuration of the JAXR s ubs ys te m.
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.17.1, “JBos s AS 7 and EAP 6 - Prope rty (JAXR) Se rvice ”
Connect ion Propert ies
T able 3.60 9.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.610 .
Name
Descript io n
Required
Int ernal Name
Clas s
The JAXR
Conne ctionFactory
imple me ntation
clas s
The JNDI name
unde r which the
JAXR
Conne ctionFactory is
bound
no
clas s
no
jndi-name
Jndi Name
647
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.17.1. JBoss AS 7 and EAP 6 - Propert y (JAXR) Service
Overview
T able 3.611. Overview
De s cription:
A JAXR prope rty. The ide ntity of the
re s ource de fine s the prope rty name .
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.612.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.613.
648
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Value
The JAXR prope rty
value .
ye s
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.18. JBoss AS 7 and EAP 6 - JPA Service
Overview
T able 3.614. Overview
De s cription:
Single ton:
Plugin:
The configuration of the JPA s ubs ys te m.
ye s
JBos s AS7
Child Resource T ypes
none
Connect ion Propert ies
T able 3.615.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
649
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.616.
Name
Descript io n
Required
Int ernal Name
De fault Datas ource
The name of the
de fault global
datas ource .
no
de fault-datas ource
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.19. JBoss AS 7 and EAP 6 - CMP Service
Overview
T able 3.617. Overview
De s cription:
Single ton:
Plugin:
The configuration of the cmp s ubs ys te m.
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.19.1, “JBos s AS 7 and EAP 6 - HiloKe yge ne rator Se rvice ”
Connect ion Propert ies
T able 3.618.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
650
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.3.19.1. JBoss AS 7 and EAP 6 - HiloKeygenerat or Service
Overview
T able 3.619. Overview
De s cription:
Single ton:
Plugin:
HiLo bas e d ke y ge ne rators .
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.620 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.621.
Name
Descript io n
Required
Int ernal Name
Block Siz e
The block s iz e
no
block-s iz e
651
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Cre ate Table
Boole an to
de te rmine whe the r
to cre ate cre ate the
table s
The DDL us e d to
cre ate the table
The datas ource
us e d for s e que nce
ge ne ration
Boole an to
de te rmine whe the r
to cre ate drop the
table s
The ID column name
The DDL us e d to
s e le ct the hi value
The s e que nce
column name
The name of the
s e que nce
The table name
no
cre ate -table
no
cre ate -table -ddl
ye s
data-s ource
no
drop-table
ye s
no
id-column
s e le ct-hi-ddl
ye s
s e que nce -column
ye s
s e que nce -name
ye s
table -name
Cre ate Table Ddl
Data Source
Drop Table
Id Column
Se le ct Hi Ddl
Se que nce Column
Se que nce Name
Table Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.20. JBoss AS 7 and EAP 6 - EE Service
Overview
T able 3.622. Overview
De s cription:
Single ton:
Plugin:
Child Resource T ypes
none
652
The configuration of the EE s ubs ys te m.
ye s
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Connect ion Propert ies
T able 3.623.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.624.
Name
Descript io n
Required
Int ernal Name
Ear Subde ployme nts
Is olate d
Flag indicating
whe the r e ach of the
s ubde ployme nts
within a .e ar can
acce s s clas s e s
be longing to anothe r
s ubde ployme nt
within the s ame
.e ar. A value of fals e
me ans the
s ubde ployme nts can
s e e clas s e s
be longing to othe r
s ubde ployme nts
within the .e ar. The
de fault value is
fals e .
A lis t of module s
that s hould be made
available to all
de ployme nts .
no
e ars ubde ployme nts is olate d
no
global-module s
Global Module s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
653
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Package T ypes
none
3.3.21. JBoss AS 7 and EAP 6 - Securit y Service
Overview
T able 3.625. Overview
De s cription:
The configuration of the s e curity
s ubs ys te m.
ye s
JBos s AS7
Single ton:
Plugin:
Child Resource T ypes
Se ction 3.3.21.1, “JBos s AS 7 and EAP 6 - Se curity Domain Se rvice ”
Se ction 3.3.21.2, “JBos s AS 7 and EAP 6 - Vault Se rvice ”
Connect ion Propert ies
T able 3.626.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.627.
Name
654
Descript io n
Required
Int ernal Name
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
De e p Copy Subje ct
Mode
Se ts the copy mode
of s ubje cts done by
the s e curity
manage rs to be
de e p copie s that
make s copie s of the
s ubje ct principals
and cre de ntials if
the y are clone able .
It s hould be s e t to
true if s ubje ct
include mutable
conte nt that can be
corrupte d whe n
multiple thre ads
have the s ame
ide ntity and cache
flus he s /logout
cle aring the s ubje ct
in one thre ad
re s ults in s ubje ct
re fe re nce s affe cting
othe r thre ads . The
de fault value is
fals e .
no
de e p-copy-s ubje ctmode
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.21.1. JBoss AS 7 and EAP 6 - Securit y Domain Service
Overview
T able 3.628. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
655
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Se ction 3.3.21.1.1, “JBos s AS 7 and EAP 6 - ACL Se rvice ”
Se ction 3.3.21.1.2, “JBos s AS 7 and EAP 6 - Audit Se rvice ”
Se ction 3.3.21.1.3, “JBos s AS 7 and EAP 6 - Authe ntication (Clas s ic) Se rvice ”
Se ction 3.3.21.1.4, “JBos s AS 7 and EAP 6 - Authe ntication (Jas pi) Se rvice ”
Se ction 3.3.21.1.5, “JBos s AS 7 and EAP 6 - Authoriz ation Se rvice ”
Se ction 3.3.21.1.6, “JBos s AS 7 and EAP 6 - Ide ntity Trus t Se rvice ”
Se ction 3.3.21.1.7, “JBos s AS 7 and EAP 6 - JSSE Se rvice ”
Se ction 3.3.21.1.8, “JBos s AS 7 and EAP 6 - Mapping Se rvice ”
Co nnect io n Pro pert ies
T able 3.629.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.630 .
Name
Descript io n
Required
Int ernal Name
Cache Type
Adds a cache to
s pe e d up
authe ntication
che cks . Allowe d
value s are 'de fault'
to us e s imple map
as the cache and
'infinis pan' to us e an
Infinis pan cache .
no
cache -type
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
656
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Operat io ns
T able 3.631. Met rics
Name
Descript io n
Flus h Cache
Re move e ntrie s s tore d in the
authe ntication cache for this s e curity
domain. A s ingle e ntry can be flus he d by
us ing the principal argume nt with the
us e rname as the value . If no argume nt is
pas s e d to the ope ration, all e ntrie s are
flus he d.
Lis ts the principals s tore d in the
authe ntication cache for this s e curity
domain.
Lis t Cache d Principals
Package T ypes
none
3.3.21.1.1. JBo ss AS 7 and EAP 6 - ACL Service
Overview
T able 3.632. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.21.1.1.1, “JBos s AS 7 and EAP 6 - Acl Module s Se rvice ”
Co nnect io n Pro pert ies
T able 3.633.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
657
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.634.
Name
Descript io n
Code
Clas s name of the
ye s
module to be
ins tantiate d.
The flag controls
ye s
how the module
participate s in the
ove rall proce dure .
Allowe d value s are
re quis ite , re quire d,
s ufficie nt or optional.
Flag
Required
Int ernal Name
code
flag
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.21.1.1.1. JBo ss AS 7 and EAP 6 - Acl Mo dules Service
Ove rvie w
T able 3.635. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
Se ction 3.3.21.1.1.1.1, “JBos s AS 7 and EAP 6 - Module Options (Acl) Se rvice ”
Conne ction Prope rtie s
T able 3.636.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
658
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Me trics
none
Configuration Prope rtie s
T able 3.637.
Name
Descript io n
Code
Clas s name of the
ye s
module to be
ins tantiate d.
The flag controls
ye s
how the module
participate s in the
ove rall proce dure .
Allowe d value s are
re quis ite , re quire d,
s ufficie nt or optional.
Flag
Required
Int ernal Name
code
flag
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.1.1.1. JBo ss AS 7 and EAP 6 - Mo dule Opt io ns (Acl) Service
Ove rvie w
T able 3.638. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
ye s
JBos s AS7
none
Conne ction Prope rtie s
T able 3.639.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
659
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.640 .
Name
Descript io n
Module Options
Required
Int ernal Name
no
Module Options
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.2. JBo ss AS 7 and EAP 6 - Audit Service
Overview
T able 3.641. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.21.1.2.1, “JBos s AS 7 and EAP 6 - Provide r Module s Se rvice ”
Co nnect io n Pro pert ies
T able 3.642.
Name
Path
660
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.643.
Name
Descript io n
Required
Int ernal Name
Code
Clas s name of the
module to be
ins tantiate d.
ye s
code
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.21.1.2.1. JBo ss AS 7 and EAP 6 - Pro vider Mo dules Service
Ove rvie w
T able 3.644. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
Se ction 3.3.21.1.2.1.1, “JBos s AS 7 and EAP 6 - Module Options (Provide r Module s )
Se rvice ”
Conne ction Prope rtie s
T able 3.645.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
661
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.646.
Name
Descript io n
Required
Int ernal Name
Code
Clas s name of the
module to be
ins tantiate d.
ye s
code
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.2.1.1. JBo ss AS 7 and EAP 6 - Mo dule Opt io ns (Pro vider Mo dules)
Service
Ove rvie w
T able 3.647. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
ye s
JBos s AS7
none
Conne ction Prope rtie s
T able 3.648.
Name
Path
662
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.649.
Name
Descript io n
Module Options
Required
Int ernal Name
no
Module Options
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.3. JBo ss AS 7 and EAP 6 - Aut hent icat io n (Classic) Service
Overview
T able 3.650 . Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.21.1.3.1, “JBos s AS 7 and EAP 6 - Login Module s (Clas s ic) Se rvice ”
Co nnect io n Pro pert ies
T able 3.651.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
663
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.652.
Name
Descript io n
Code
Clas s name of the
ye s
module to be
ins tantiate d.
The flag controls
ye s
how the module
participate s in the
ove rall proce dure .
Allowe d value s are
re quis ite , re quire d,
s ufficie nt or optional.
Flag
Required
Int ernal Name
code
flag
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.21.1.3.1. JBo ss AS 7 and EAP 6 - Lo gin Mo dules (Classic) Service
Ove rvie w
T able 3.653. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
Se ction 3.3.21.1.3.1.1, “JBos s AS 7 and EAP 6 - Module Options (Clas s ic) Se rvice ”
664
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Conne ction Prope rtie s
T able 3.654.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.655.
Name
Descript io n
Code
Clas s name of the
ye s
module to be
ins tantiate d.
The flag controls
ye s
how the module
participate s in the
ove rall proce dure .
Allowe d value s are
re quis ite , re quire d,
s ufficie nt or optional.
Flag
Required
Int ernal Name
code
flag
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.3.1.1. JBo ss AS 7 and EAP 6 - Mo dule Opt io ns (Classic) Service
Ove rvie w
T able 3.656. Overview
De s cription:
665
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Single ton:
Plugin:
Child Re s ource Type s
ye s
JBos s AS7
none
Conne ction Prope rtie s
T able 3.657.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.658.
Name
Descript io n
Module Options
Required
Int ernal Name
no
Module Options
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.4. JBo ss AS 7 and EAP 6 - Aut hent icat io n (Jaspi) Service
Overview
T able 3.659. Overview
De s cription:
Single ton:
Plugin:
666
ye s
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Child Reso urce T ypes
Se ction 3.3.21.1.4.1, “JBos s AS 7 and EAP 6 - Login Module Stack Se rvice ”
Co nnect io n Pro pert ies
T able 3.660 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.661.
Name
Descript io n
Code
Clas s name of the
ye s
module to be
ins tantiate d.
The flag controls
ye s
how the module
participate s in the
ove rall proce dure .
Allowe d value s are
re quis ite , re quire d,
s ufficie nt or optional.
Flag
Required
Int ernal Name
code
flag
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.21.1.4.1. JBo ss AS 7 and EAP 6 - Lo gin Mo dule St ack Service
667
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Ove rvie w
T able 3.662. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
Se ction 3.3.21.1.4.1.1, “JBos s AS 7 and EAP 6 - Module Options (Login Module Stack)
Se rvice ”
Conne ction Prope rtie s
T able 3.663.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.664.
Name
Descript io n
Code
Clas s name of the
ye s
module to be
ins tantiate d.
The flag controls
ye s
how the module
participate s in the
ove rall proce dure .
Allowe d value s are
re quis ite , re quire d,
s ufficie nt or optional.
Flag
Required
Int ernal Name
code
flag
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
668
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
Package Type s
none
3.3.21.1.4.1.1. JBo ss AS 7 and EAP 6 - Mo dule Opt io ns (Lo gin Mo dule St ack)
Service
Ove rvie w
T able 3.665. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
ye s
JBos s AS7
none
Conne ction Prope rtie s
T able 3.666.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.667.
Name
Descript io n
Module Options
Required
Int ernal Name
no
Module Options
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
669
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Package Type s
none
3.3.21.1.5. JBo ss AS 7 and EAP 6 - Aut ho rizat io n Service
Overview
T able 3.668. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.21.1.5.1, “JBos s AS 7 and EAP 6 - Authoriz ation Module s Se rvice ”
Co nnect io n Pro pert ies
T able 3.669.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.670 .
Name
Descript io n
Code
Clas s name of the
ye s
module to be
ins tantiate d.
The flag controls
ye s
how the module
participate s in the
ove rall proce dure .
Allowe d value s are
re quis ite , re quire d,
s ufficie nt or optional.
Flag
670
Required
Int ernal Name
code
flag
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.21.1.5.1. JBo ss AS 7 and EAP 6 - Aut ho rizat io n Mo dules Service
Ove rvie w
T able 3.671. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
Se ction 3.3.21.1.5.1.1, “JBos s AS 7 and EAP 6 - Module Options (Authoriz ation) Se rvice ”
Conne ction Prope rtie s
T able 3.672.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.673.
Name
Descript io n
Required
Int ernal Name
Code
Clas s name of the
module to be
ins tantiate d.
ye s
code
671
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Flag
The flag controls
ye s
how the module
participate s in the
ove rall proce dure .
Allowe d value s are
re quis ite , re quire d,
s ufficie nt or optional.
Int ernal Name
flag
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.5.1.1. JBo ss AS 7 and EAP 6 - Mo dule Opt io ns (Aut ho rizat io n) Service
Ove rvie w
T able 3.674. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
ye s
JBos s AS7
none
Conne ction Prope rtie s
T able 3.675.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
672
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.676.
Name
Descript io n
Module Options
Required
Int ernal Name
no
Module Options
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.6. JBo ss AS 7 and EAP 6 - Ident it y T rust Service
Overview
T able 3.677. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.21.1.6.1, “JBos s AS 7 and EAP 6 - Ide ntity Trus t Module s Se rvice ”
Co nnect io n Pro pert ies
T able 3.678.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
673
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.679.
Name
Descript io n
Code
Clas s name of the
ye s
module to be
ins tantiate d.
The flag controls
ye s
how the module
participate s in the
ove rall proce dure .
Allowe d value s are
re quis ite , re quire d,
s ufficie nt or optional.
Flag
Required
Int ernal Name
code
flag
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.21.1.6.1. JBo ss AS 7 and EAP 6 - Ident it y T rust Mo dules Service
Ove rvie w
T able 3.680 . Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
Se ction 3.3.21.1.6.1.1, “JBos s AS 7 and EAP 6 - Module Options (Ide ntity Trus t) Se rvice ”
Conne ction Prope rtie s
T able 3.681.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
674
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Me trics
none
Configuration Prope rtie s
T able 3.682.
Name
Descript io n
Code
Clas s name of the
ye s
module to be
ins tantiate d.
The flag controls
ye s
how the module
participate s in the
ove rall proce dure .
Allowe d value s are
re quis ite , re quire d,
s ufficie nt or optional.
Flag
Required
Int ernal Name
code
flag
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.6.1.1. JBo ss AS 7 and EAP 6 - Mo dule Opt io ns (Ident it y T rust ) Service
Ove rvie w
T able 3.683. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
ye s
JBos s AS7
none
Conne ction Prope rtie s
T able 3.684.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
675
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.685.
Name
Descript io n
Module Options
Required
Int ernal Name
no
Module Options
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.7. JBo ss AS 7 and EAP 6 - JSSE Service
Overview
T able 3.686. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.687.
Name
Path
676
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.688.
Name
Descript io n
Required
Int ernal Name
Ciphe r Suite s
Comma s e parate d
lis t of ciphe r s uite s
to e nable on
SSLSocke ts .
Pre fe rre d alias to
us e whe n the
Ke yManage r
choos e s the clie nt
alias .
Boole an attribute to
indicate if clie nt's
ce rtificate s s hould
als o be
authe nticate d on the
s e rve r s ide .
JSEE Ke y Manage r
factory
Configure s a JSSE
ke y s tore
Comma s e parate d
lis t of protocols to
e nable on
SSLSocke ts .
Pre fe rre d alias to
us e whe n the
Ke yManage r
choos e s the s e rve r
alias .
Toke n to re trie ve
Private Ke ys from
the Ke yStore .
JSEE Trus t Manage r
factory
Configure s a JSSE
trus t s tore
no
ciphe r-s uite s
no
clie nt-alias
no
clie nt-auth
no
ke y-manage r
no
ke ys tore
no
protocols
no
s e rve r-alias
no
s e rvice -auth-toke n
no
trus t-manage r
no
trus ts tore
Clie nt Alias
Clie nt Auth
Ke y Manage r
Ke ys tore
Protocols
Se rve r Alias
Se rvice Auth Toke n
Trus t Manage r
Trus ts tore
677
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.21.1.8. JBo ss AS 7 and EAP 6 - Mapping Service
Overview
T able 3.689. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.21.1.8.1, “JBos s AS 7 and EAP 6 - Mapping Module s Se rvice ”
Co nnect io n Pro pert ies
T able 3.690 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.691.
Name
678
Descript io n
Required
Int ernal Name
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Code
Clas s name of the
module to be
ins tantiate d.
Type of mapping this
module pe rforms .
Allowe d value s are
principal, role ,
attribute or
cre de ntial..
ye s
code
ye s
type
Type
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.21.1.8.1. JBo ss AS 7 and EAP 6 - Mapping Mo dules Service
Ove rvie w
T able 3.692. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
Se ction 3.3.21.1.8.1.1, “JBos s AS 7 and EAP 6 - Module Options (Mapping) Se rvice ”
Conne ction Prope rtie s
T able 3.693.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
679
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Configuration Prope rtie s
T able 3.694.
Name
Descript io n
Required
Int ernal Name
Code
Clas s name of the
module to be
ins tantiate d.
Type of mapping this
module pe rforms .
Allowe d value s are
principal, role ,
attribute or
cre de ntial..
ye s
code
ye s
type
Type
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.1.8.1.1. JBo ss AS 7 and EAP 6 - Mo dule Opt io ns (Mapping) Service
Ove rvie w
T able 3.695. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
ye s
JBos s AS7
none
Conne ction Prope rtie s
T able 3.696.
Name
Path
680
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.697.
Name
Descript io n
Module Options
Required
Int ernal Name
no
Module Options
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.21.2. JBoss AS 7 and EAP 6 - Vault Service
Overview
T able 3.698. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.699.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
681
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.70 0 .
Name
Descript io n
Required
Int ernal Name
Code
Fully Qualifie d Name
of the Se curity Vault
Imple me ntation.
no
code
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.22. JBoss AS 7 and EAP 6 - T hreads Service
Overview
T able 3.70 1. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.22.1, “JBos s AS 7 and EAP 6 - Thre adFactory Se rvice ”
Se ction 3.3.22.2, “JBos s AS 7 and EAP 6 - Thre adPool Se rvice ”
Connect ion Propert ies
682
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.70 2.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.3.22.1. JBoss AS 7 and EAP 6 - T hreadFact ory Service
Overview
T able 3.70 3. Overview
De s cription:
A thre ad factory (imple me nting
java.util.concurre nt.Thre adFactory).
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.70 4.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
683
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.70 5.
Name
Descript io n
Required
Int ernal Name
Group Name
Spe cifie s the name
of a thre ad group to
cre ate for this
thre ad factory.
The name of the
cre ate d thre ad
factory.
May be us e d to
s pe cify the thre ad
priority of cre ate d
thre ads . The de fault
value is -1.
The te mplate us e d
to cre ate name s for
thre ads . The
following patte rns
may be us e d: %% e mit a pe rce nt s ign
%t - e mit the pe rfactory thre ad
s e que nce numbe r
%g - e mit the global
thre ad s e que nce
numbe r %f - e mit
the factory
s e que nce numbe r
%i - e mit the thre ad
ID.
no
group-name
no
name
no
priority:e xpr
no
thre ad-name -patte rn
Name
Priority
Thre ad Name
Patte rn
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
684
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Package T ypes
none
3.3.22.2. JBoss AS 7 and EAP 6 - T hreadPool Service
Overview
T able 3.70 6. Overview
De s cription:
Single ton:
Plugin:
A thre ad pool e xe cutor
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.70 7.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.70 8. Met rics
Name
T ype
Descript io n
Int ernal Name
Active Count
me as ure me nt
active -count
Comple te d Tas k
Count
me as ure me nt
Curre nt Thre ad
Count
me as ure me nt
Large s t Thre ad
Count
me as ure me nt
The approximate
numbe r of thre ads
that are active ly
e xe cuting tas ks .
The approximate
total numbe r of
tas ks that have
comple te d
e xe cution.
The curre nt numbe r
of thre ads in the
pool.
The large s t numbe r
of thre ads that have
e ve r s imultane ous ly
be e n in the pool.
comple te d-tas kcount
curre nt-thre ad-count
large s t-thre ad-count
685
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Re je cte d Count
me as ure me nt
re je cte d-count
Tas k Count
me as ure me nt
The numbe r of tas ks
that have be e n
re je cte d.
The approximate
total numbe r of
tas ks that have e ve r
be e n s che dule d for
e xe cution.
tas k-count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.70 9.
Name
Descript io n
Required
Int ernal Name
Ke e palive Time
Us e d to s pe cify the
amount of time that
pool thre ads s hould
be ke pt running
whe n idle ; if not
s pe cifie d, thre ads
will run until the
e xe cutor is s hut
down.
The maximum
thre ad pool s iz e .
The name of the
thre ad pool.
The que ue le ngth.
Re quire d only for
Bounde d and
Blocking Bounde d
Thre ad Pools .
Spe cifie s the name
of a s pe cific thre ad
factory to us e to
cre ate worke r
thre ads . If not
de fine d an
appropriate de fault
thre ad factory will
be us e d.
Whe the r core
thre ads may time
out. The de fault
value is fals e .
no
ke e palive -time
ye s
max-thre ads :e xpr
no
name
no
que ue -le ngth:e xpr
no
thre ad-factory
no
allow-core -time out
Max Thre ads
Name
Que ue Le ngth
Thre ad Factory
Allow Core Time out
686
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Core Thre ads
The core thre ad pool no
s iz e which is
s malle r than the
maximum pool s iz e .
If unde fine d, the
core thre ad pool
s iz e is the s ame as
the maximum thre ad
pool s iz e .
An e xe cutor to
no
de le gate tas ks to in
the e ve nt that a tas k
cannot be acce pte d.
If not s pe cifie d,
tas ks that cannot be
acce pte d will be
s ile ntly dis carde d.
Thre ad pool type
ye s
Handoff Exe cutor
Thre ad Pool Type
Required
Int ernal Name
core -thre ads :e xpr
handoff-e xe cutor
__type
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.23. JBoss AS 7 and EAP 6 - EJB3 Service
Overview
T able 3.710 . Overview
De s cription:
Single ton:
Plugin:
The configuration of the e jb3 s ubs ys te m.
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.23.1, “JBos s AS 7 and EAP 6 - EJB3 Thre ad Pool Se rvice ”
Se ction 3.3.23.2, “JBos s AS 7 and EAP 6 - File Pas s ivation Store Se rvice ”
Se ction 3.3.23.3, “JBos s AS 7 and EAP 6 - Strict Max Be an Ins tance Pool Se rvice ”
Se ction 3.3.23.4, “JBos s AS 7 and EAP 6 - SFSB Cache Se rvice ”
687
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Se ction 3.3.23.5, “JBos s AS 7 and EAP 6 - Clus te r Pas s ivation Store Se rvice ”
Se ction 3.3.23.6, “JBos s AS 7 and EAP 6 - As ync Se rvice ”
Se ction 3.3.23.7, “JBos s AS 7 and EAP 6 - IIOP Se rvice ”
Se ction 3.3.23.8, “JBos s AS 7 and EAP 6 - Re mote Se rvice ”
Se ction 3.3.23.9, “JBos s AS 7 and EAP 6 - Time r Se rvice ”
Connect ion Propert ies
T able 3.711.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.712.
Name
Descript io n
Required
Int ernal Name
De fault Clus te re d
Sfs b Cache
Name of the de fault
s tate ful be an cache ,
which will be
applicable to all
clus te re d s tate ful
EJBs , unle s s
ove rridde n at the
de ployme nt or be an
le ve l
Name of the de fault
e ntity be an ins tance
pool, which will be
applicable to all
e ntity be ans , unle s s
ove rridde n at the
de ployme nt or be an
le ve l
If s e t to true e ntity
be ans will us e
optimis tic locking by
de fault
no
de fault-clus te re ds fs b-cache
no
de fault-e ntity-be anins tance -pool
no
de fault-e ntity-be anoptimis tic-locking
De fault Entity Be an
Ins tance Pool
De fault Entity Be an
Optimis tic Locking
688
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
De fault Mdb
Ins tance Pool
Name of the de fault
MDB ins tance pool,
which will be
applicable to all
MDBs , unle s s
ove rridde n at the
de ployme nt or be an
le ve l
Name of the de fault
re s ource adapte r
name that will be
us e d by MDBs ,
unle s s ove rridde n at
the de ployme nt or
be an le ve l. The
de fault value is
horne tq-ra.
Name of the de fault
s tate ful be an cache ,
which will be
applicable to all
s tate ful EJBs , unle s s
ove rridde n at the
de ployme nt or be an
le ve l
The de fault acce s s
time out for s ingle ton
be ans . The de fault
value is 5000.
Name of the de fault
s tate le s s be an
ins tance pool, which
will be applicable to
all s tate le s s EJBs ,
unle s s ove rridde n at
the de ployme nt or
be an le ve l
The de fault acce s s
time out for s tate ful
be ans . The de fault
value is 5000.
If s e t to fals e , the
parame te rs to
invocations on
re mote inte rface of
an EJB, will be
pas s e d by
re fe re nce . Els e , the
parame te rs will be
pas s e d by value .
The de fault value is
true .
no
de fault-mdbins tance -pool
no
de fault-re s ource adapte r-name
no
de fault-s fs b-cache
no
de fault-s ingle tonbe an-acce s s time out:e xpr
no
de fault-s ls bins tance -pool
no
de fault-s tate fulbe an-acce s s time out:e xpr
no
in-vm-re mote inte rface -invocationpas s -by-value
De fault Re s ource
Adapte r Name
De fault Sfs b Cache
De fault Single ton
Be an Acce s s
Time out
De fault Sls b
Ins tance Pool
De fault State ful
Be an Acce s s
Time out
In Vm Re mote
Inte rface Invocation
Pas s By Value
689
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Enable Statis tics
If s e t to true , e nable
the colle ction of
invocation s tatis tics .
no
e nable -s tatis tics
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.23.1. JBoss AS 7 and EAP 6 - EJB3 T hread Pool Service
Overview
T able 3.713. Overview
De s cription:
A thre ad pool e xe cutor with an unbounde d
que ue . Such a thre ad pool has a core s iz e
and a que ue with no uppe r bound. Whe n a
tas k is s ubmitte d, if the numbe r of running
thre ads is le s s than the core s iz e , a ne w
thre ad is cre ate d. Othe rwis e , the tas k is
place d in que ue . If too many tas ks are
allowe d to be s ubmitte d to this type of
e xe cutor, an out of me mory condition may
occur.
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.714.
Name
Path
690
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.715. Met rics
Name
T ype
Descript io n
Int ernal Name
Active Count
me as ure me nt
active -count
Comple te d Tas k
Count
me as ure me nt
Curre nt Thre ad
Count
me as ure me nt
Large s t Thre ad
Count
me as ure me nt
Re je cte d Count
me as ure me nt
Tas k Count
me as ure me nt
The approximate
numbe r of thre ads
that are active ly
e xe cuting tas ks .
The approximate
total numbe r of
tas ks that have
comple te d
e xe cution.
The curre nt numbe r
of thre ads in the
pool.
The large s t numbe r
of thre ads that have
e ve r s imultane ous ly
be e n in the pool.
The numbe r of tas ks
that have be e n
re je cte d.
The approximate
total numbe r of
tas ks that have e ve r
be e n s che dule d for
e xe cution.
comple te d-tas kcount
curre nt-thre ad-count
large s t-thre ad-count
re je cte d-count
tas k-count
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.716.
Name
Descript io n
Required
Int ernal Name
691
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Ke e palive Time
Us e d to s pe cify the
amount of time that
pool thre ads s hould
be ke pt running
whe n idle ; if not
s pe cifie d, thre ads
will run until the
e xe cutor is s hut
down.
The maximum
thre ad pool s iz e .
The name of the
thre ad pool.
Spe cifie s the name
of a s pe cific thre ad
factory to us e to
cre ate worke r
thre ads . If not
de fine d an
appropriate de fault
thre ad factory will
be us e d.
no
ke e palive -time
no
max-thre ads :e xpr
no
name
no
thre ad-factory
Max Thre ads
Name
Thre ad Factory
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.23.2. JBoss AS 7 and EAP 6 - File Passivat ion St ore Service
Overview
T able 3.717. Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
692
A file s ys te m bas e d pas s ivation s tore .
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.718.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.719.
Name
Descript io n
Groups Path
Idle Time out
Idle Time out Unit
Max Siz e
Re lative To
Se s s ions Path
Subdire ctory count
The time out in units
s pe cifie d by idle time out-unit, afte r
which a be an will
pas s ivate . The
de fault value is 300.
The unit of idle time out. The de fault
value is SECONDS.
The maximum
numbe r of be ans
this cache s hould
s tore be fore forcing
old be ans to
pas s ivate . The
de fault value is
10000.
Required
Int ernal Name
no
no
groups -path
idle -time out:e xpr
no
idle -time out-unit
no
max-s iz e :e xpr
no
no
no
re lative -to
s e s s ions -path
s ubdire ctorycount:e xpr
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
693
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Package T ypes
none
3.3.23.3. JBoss AS 7 and EAP 6 - St rict Max Bean Inst ance Pool Service
Overview
T able 3.720 . Overview
De s cription:
A be an ins tance pool with a s trict uppe r
limit
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.721.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.722.
Name
Descript io n
Required
Int ernal Name
Max Pool Siz e
The maximum
numbe r of be an
ins tance s that the
pool can hold at a
give n point in time .
The de fault value is
20.
no
max-pool-s iz e :e xpr
694
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Time out
The maximum
amount of time to
wait for a be an
ins tance to be
available from the
pool. The de fault
value is 5.
The ins tance
acquis ition time out
unit. The de fault
value is MINUTES.
no
time out:e xpr
no
time out-unit
Time out Unit
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.23.4. JBoss AS 7 and EAP 6 - SFSB Cache Service
Overview
T able 3.723. Overview
De s cription:
Single ton:
Plugin:
A SFSB cache .
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.724.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
695
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.725.
Name
Descript io n
Alias e s
The alias e s by which ye s
this cache may als o
be re fe re nce d
The pas s ivation
no
s tore us e d by this
cache
Pas s ivation Store
Required
Int ernal Name
alias e s
pas s ivation-s tore
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.23.5. JBoss AS 7 and EAP 6 - Clust er Passivat ion St ore Service
Overview
T able 3.726. Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.727.
696
A clus te re d pas s ivation s tore .
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.727.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.728.
Name
Descript io n
Required
Int ernal Name
Be an Cache
The name of the
cache us e d to s tore
be an ins tance s .
The name of the
cache containe r
us e d for the be an
and clie nt-mappings
cache s . The de fault
value is e jb.
The name of the
cache us e d to s tore
clie nt-mappings of
the EJB re moting
conne ctor's s ocke tbindings . The de fault
value is re mote conne ctor-clie ntmappings .
The time out in units
s pe cifie d by idle time out-unit, afte r
which a be an will
pas s ivate . The
de fault value is 300.
The unit of idle time out. The de fault
value is SECONDS.
no
be an-cache
no
cache -containe r
no
clie nt-mappings cache
no
idle -time out:e xpr
no
idle -time out-unit
Cache Containe r
Clie nt Mappings
Cache
Idle Time out
Idle Time out Unit
697
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Max Siz e
The maximum
numbe r of be ans
this cache s hould
s tore be fore forcing
old be ans to
pas s ivate . The
de fault value is
10000.
Pas s ivate Eve nts On Indicate s whe the r
Re plicate
re plication s hould
trigge r pas s ivation
e ve nts on the be an.
The de fault value is
true .
Required
Int ernal Name
no
max-s iz e :e xpr
no
pas s ivate -e ve nts on-re plicate
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.23.6. JBoss AS 7 and EAP 6 - Async Service
Overview
T able 3.729. Overview
De s cription:
Single ton:
Plugin:
The EJB3 As ynchronous Invocation Se rvice
ye s
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.730 .
Name
Path
698
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.731.
Name
Descript io n
Required
Int ernal Name
Thre ad Pool Name
The name of the
thre ad pool which
handle s
as ynchronous
invocations
no
thre ad-pool-name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.23.7. JBoss AS 7 and EAP 6 - IIOP Service
Overview
T able 3.732. Overview
De s cription:
Single ton:
Plugin:
The IIOP s e rvice
ye s
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.733.
699
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.734.
Name
Descript io n
Required
Int ernal Name
Enable By De fault
If this is true EJB's
will be e xpos e d
ove r IIOP by de fault,
othe rwis e it ne e ds
to be e xplicitly
e nable d in the
de ployme nt
de s criptor
If true EJB name s
will be bound into
the naming s e rvice
with the application
and module name
pre pe nde d to the
name (e .g.
myapp/mymodule /M
yEjb)
no
e nable -by-de fault
no
us e -qualifie d-name
Us e Qualifie d Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.23.8. JBoss AS 7 and EAP 6 - Remot e Service
700
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Overview
T able 3.735. Overview
De s cription:
Single ton:
Plugin:
The EJB3 re mote s e rvice
ye s
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.23.8.1, “JBos s AS 7 and EAP 6 - Channe l Cre ation Options Se rvice ”
Co nnect io n Pro pert ies
T able 3.736.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.737.
Name
Descript io n
Required
Int ernal Name
Conne ctor Re f
The name of the
conne ctor on which
the EJB3 re moting
channe l is
re gis te re d
The name of the
thre ad pool that
handle s re mote
invocations
no
conne ctor-re f
no
thre ad-pool-name
Thre ad Pool Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
701
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Package T ypes
none
3.3.23.8.1. JBo ss AS 7 and EAP 6 - Channel Creat io n Opt io ns Service
Overview
T able 3.738. Overview
De s cription:
The options that will be us e d during the EJB
re mote channe l cre ation
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.739.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.740 .
Name
Descript io n
Required
Int ernal Name
Type
The type of the
channe l cre ation
option
The value for the
EJB re mote channe l
cre ation option
no
type
no
value
Value
702
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.23.9. JBoss AS 7 and EAP 6 - T imer Service
Overview
T able 3.741. Overview
De s cription:
Single ton:
Plugin:
The EJB time r s e rvice
ye s
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.742.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.743.
Name
Descript io n
Required
Int ernal Name
703
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Path
The dire ctory to
s tore pe rs is te nt
time r information in
The re lative path
that is us e d to
re s olve the time r
data s tore location
The name of the
thre ad pool us e d to
run time r s e rvice
invocations
no
path
no
re lative -to
no
thre ad-pool-name
Re lative To
Thre ad Pool Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.24. JBoss AS 7 and EAP 6 - JMX Service
Overview
T able 3.744. Overview
De s cription:
Single ton:
Plugin:
The configuration of the JMX s ubs ys te m.
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.24.1, “JBos s AS 7 and EAP 6 - Re moting Conne ctor Se rvice ”
Connect ion Propert ies
T able 3.745.
Name
Path
704
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.746.
Name
Descript io n
Required
Int ernal Name
Show Mode l
Se t to 'true ' to
include MBe ans for
the mode l controlle r
re s ource s
no
s how-mode l
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.24.1. JBoss AS 7 and EAP 6 - Remot ing Connect or Service
Overview
T able 3.747. Overview
De s cription:
Single ton:
Plugin:
The configuration of a re s ource adapte r.
ye s
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.748.
705
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.749.
Name
Descript io n
Required
Int ernal Name
Us e Manage me nt
Endpoint
If true the conne ctor
will us e the
manage me nt
e ndpoint, othe rwis e
it will us e the
re moting s ubs ys te m
one . The de fault
value is true .
no
us e -manage me nte ndpoint
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.25. JBoss AS 7 and EAP 6 - Resource Adapt ers Service
Overview
T able 3.750 . Overview
De s cription:
Single ton:
Plugin:
706
Configuration of the re s ource adapte rs
s ubs ys te m.
ye s
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Child Resource T ypes
Se ction 3.3.25.1, “JBos s AS 7 and EAP 6 - Re s ource Adapte r Se rvice ”
Connect ion Propert ies
T able 3.751.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.3.25.1. JBoss AS 7 and EAP 6 - Resource Adapt er Service
Overview
T able 3.752. Overview
De s cription:
Single ton:
Plugin:
The configuration of a re s ource adapte r.
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.25.1.1, “JBos s AS 7 and EAP 6 - Admin Obje cts Se rvice ”
Se ction 3.3.25.1.2, “JBos s AS 7 and EAP 6 - Conne ction De finitions Se rvice ”
Se ction 3.3.25.1.3, “JBos s AS 7 and EAP 6 - Config Prope rtie s Se rvice ”
Co nnect io n Pro pert ies
707
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
T able 3.753.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.754.
Name
Descript io n
Required
Int ernal Name
Archive
Spe cifie s the
re s ource adapte r
archive
Spe cifie s the be an
validation groups
that s hould be us e d
Spe cifie s the unique
name of the
boots trap conte xt
that s hould be us e d
Spe cifie s the
trans action s upport
le ve l of the
re s ource adapte r
ye s
archive
no
be anvalidationgroup
s
no
boots trapconte xt
ye s
trans action-s upport
Be anvalidationgroup
s
Boots trapconte xt
Trans action Support
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.25.1.1. JBo ss AS 7 and EAP 6 - Admin Object s Service
Overview
708
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.755. Overview
De s cription:
Single ton:
Plugin:
Spe cifie s the adminis tration obje cts .
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.756.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.757.
Name
Descript io n
Required
Int ernal Name
Clas s Name
Spe cifie s the fully
qualifie d clas s name
of a manage d
conne ction factory or
admin obje ct
Spe cifie s if the
re s ource adapte r
s hould be e nable d.
The de fault value is
true .
Spe cifie s the JNDI
name for the
conne ction factory or
admin obje ct
Se tting this to fals e
will bind the obje ct
into global JNDI. The
de fault value is true .
ye s
clas s -name
no
e nable d
no
jndi-name
no
us e -java-conte xt
Enable d
Jndi Name
Us e Java Conte xt
709
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.25.1.2. JBo ss AS 7 and EAP 6 - Co nnect io n Def init io ns Service
Overview
T able 3.758. Overview
De s cription:
Single ton:
Plugin:
Spe cifie s the conne ction de finitions .
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.25.1.2.1, “JBos s AS 7 and EAP 6 - Config Prope rtie s Se rvice ”
Co nnect io n Pro pert ies
T able 3.759.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.760 .
Name
710
Descript io n
Required
Int ernal Name
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Allocation Re try
The allocation re try
e le me nt indicate s
the numbe r of time s
that allocating a
conne ction s hould
be trie d be fore
throwing an
e xce ption
The allocation re try
wait millis e le me nt
s pe cifie s the
amount of time , in
millis e conds , to wait
be twe e n re trying to
allocate a conne ction
An e le me nt to
s pe cify that
conne ctions s hould
be validate d on a
background thre ad
ve rs us be ing
validate d prior to
us e . Changing this
value re quire s a
s e rve r re s tart. The
de fault value is
fals e .
The backgroundvalidation-millis
e le me nt s pe cifie s
the amount of time ,
in millis e conds , that
background
validation will run.
Changing this value
re quire s a s e rve r
re s tart
no
allocation-re try:e xpr
no
allocation-re try-waitmillis :e xpr
no
backgroundvalidation
no
backgroundvalidation-millis :e xpr
Allocation Re try Wait
Millis
Background
Validation
Background
Validation Millis
711
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Blocking Time out
Wait Millis
The blockingtime out-millis
e le me nt s pe cifie s
the maximum time ,
in millis e conds , to
block while waiting
for a conne ction
be fore throwing an
e xce ption. Note that
this blocks only
while waiting for
locking a conne ction,
and will ne ve r throw
an e xce ption if
cre ating a ne w
conne ction take s an
inordinate ly long
time
Spe cifie s the fully
qualifie d clas s name
of a manage d
conne ction factory or
admin obje ct
Spe cifie s if the
re s ource adapte r
s hould be e nable d.
The de fault value is
true .
Spe cifie s how the
pool s hould be flus h
in cas e of an e rror.
The idle -time outminute s e le me nts
s pe cifie s the
maximum time , in
minute s , a
conne ction may be
idle be fore be ing
clos e d. The actual
maximum time
de pe nds als o on the
Idle Re move r s can
time , which is half of
the s malle s t idle time out-minute s
value of any pool.
Changing this value
re quire s a s e rve r
re s tart.
An e le me nt to
e nable inte rle aving
for XA conne ctions .
The de fault value is
fals e .
no
blocking-time outwait-millis :e xpr
ye s
clas s -name
no
e nable d
no
flus h-s trate gy
no
idle -time outminute s :e xpr
no
inte rle aving
Clas s Name
Enable d
Flus h Strate gy
Idle Time out Minute s
Inte rle aving
712
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Jndi Name
Spe cifie s the JNDI
name for the
conne ction factory or
admin obje ct
The max-pool-s iz e
e le me nt s pe cifie s
the maximum
numbe r of
conne ctions for a
pool. No more
conne ctions will be
cre ate d in e ach s ubpool. The de fault
value is 20.
The min-pool-s iz e
e le me nt s pe cifie s
the minimum
numbe r of
conne ctions for a
pool. The de fault
value is 0.
Spe cifie s if the
conne ction pool
s hould be e xclude d
from re cove ry
Oracle doe s not like
XA conne ctions
ge tting us e d both
ins ide and outs ide a
JTA trans action. To
workaround the
proble m you can
cre ate s e parate
s ub-pools for the
diffe re nt conte xts .
The de fault value is
fals e .
Should the Xid be
padde d. The de fault
value is fals e .
Should the pool be
pre fille d. Changing
this value re quire s a
s e rve r re s tart. The
de fault value is
fals e .
Spe cifie s if the minpool-s iz e s hould be
cons ide re d s trictly.
The de fault value is
fals e .
The pas s word us e d
for re cove ry
no
jndi-name
no
max-pool-s iz e :e xpr
no
min-pool-s iz e :e xpr
no
no-re cove ry
no
no-tx-s e parate -pool
no
pad-xid
no
pool-pre fill
no
pool-us e -s trict-min
no
re cove ry-pas s word
Max Pool Siz e
Min Pool Siz e
No Re cove ry
No Tx Se parate Pool
Pad Xid
Pool Pre fill
Pool Us e Strict Min
Re cove ry Pas s word
713
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Re cove ry Plugin
Clas s Name
Descript io n
The fully qualifie d
clas s name of the
re cove ry plugin
imple me ntation
Re cove ry Plugin
The prope rtie s for
Prope rtie s
the re cove ry plugin
Re cove ry Se curity
The s e curity domain
Domain
us e d for re cove ry
Re cove ry Us e rname The us e r name
us e d for re cove ry
Same Rm Ove rride
The is -s ame -rmove rride e le me nt
allows one to
unconditionally s e t
whe the r the
javax.trans action.xa.
XARe s ource .is Same
RM(XARe s ource )
re turns true or fals e
Se curity Application
Indicate s that app
s upplie d parame te rs
(s uch as from
ge tConne ction(us e r,
pw)) are us e d to
dis tinguis h
conne ctions in the
pool
Se curity Domain
Spe cifie s the
s e curity domain
which de fine s the
javax.s e curity.auth.S
ubje ct that are us e d
to dis tinguis h
conne ctions in the
pool
Se curity Domain and Indicate s that e ithe r
Application
app s upplie d
parame te rs (s uch as
from
ge tConne ction(us e r,
pw)) or Subje ct (from
s e curity domain) are
us e d to dis tinguis h
conne ctions in the
pool
Us e Ccm
Enable the us e of a
cache d conne ction
manage r. The
de fault value is true .
714
Required
Int ernal Name
no
re cove ry-pluginclas s -name
no
no
re cove ry-pluginprope rtie s
re cove ry-s e curitydomain
re cove ry-us e rname
no
s ame -rm-ove rride
no
s e curity-application
no
s e curity-domain
no
s e curity-domain-andapplication
no
us e -ccm
no
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Us e Fas t Fail
Whe the r to fail a
conne ction allocation
on the firs t try if it is
invalid (true ) or ke e p
trying until the pool
is e xhaus te d of all
pote ntial
conne ctions (fals e ).
The de fault value is
fals e .
Se tting this to fals e
will bind the obje ct
into global JNDI. The
de fault value is true .
Any configure d
time out for inte rnal
locks on the
re s ource adapte r
obje cts in s e conds
Should the
XARe s ource
ins tance s be
wrappe d in a
org.jbos s .tm.XARe s o
urce Wrappe r
ins tance . The de fault
value is true .
The value is pas s e d
to
XARe s ource .s e tTran
s actionTime out(), in
s e conds . De fault is
z e ro
no
us e -fas t-fail
no
us e -java-conte xt
no
us e -try-lock:e xpr
no
wrap-xa-re s ource
no
xa-re s ource time out:e xpr
Us e Java Conte xt
Us e Try Lock
Wrap Xa Re s ource
XA Re s ource
Time out
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.761. Met rics
Name
Descript io n
Flus h All Conne ctions in Pool
Flus h Idle Conne ctions in Pool
Te s t Conne ction in Pool
Flus he s all conne ctions in the pool
Flus he s all idle conne ctions in the pool
Te s t if a conne ction can be obtaine d
Package T ypes
none
715
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
3.3.25.1.2.1. JBo ss AS 7 and EAP 6 - Co nf ig Pro pert ies Service
Ove rvie w
T able 3.762. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
Cus tom de fine d config prope rtie s .
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.763.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.764.
Name
Descript io n
Required
Int ernal Name
Value
Cus tom de fine d
config prope rty
value
no
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.25.1.3. JBo ss AS 7 and EAP 6 - Co nf ig Pro pert ies Service
716
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Overview
T able 3.765. Overview
De s cription:
Single ton:
Plugin:
Cus tom de fine d config prope rtie s .
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.766.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.767.
Name
Descript io n
Required
Int ernal Name
Value
Cus tom de fine d
config prope rty
value
no
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
717
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
3.3.26. JBoss AS 7 and EAP 6 - Inf inispan Service
Overview
T able 3.768. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.26.1, “JBos s AS 7 and EAP 6 - Cache Containe r Se rvice ”
Connect ion Propert ies
T able 3.769.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.3.26.1. JBoss AS 7 and EAP 6 - Cache Cont ainer Service
Overview
T able 3.770 . Overview
De s cription:
Single ton:
718
no
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Plugin:
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.26.1.1, “JBos s AS 7 and EAP 6 - Cache Se rvice ”
Se ction 3.3.26.1.2, “JBos s AS 7 and EAP 6 - Dis tribute d Cache Se rvice ”
Se ction 3.3.26.1.3, “JBos s AS 7 and EAP 6 - Local Cache Se rvice ”
Se ction 3.3.26.1.4, “JBos s AS 7 and EAP 6 - Trans port Se rvice ”
Co nnect io n Pro pert ies
T able 3.771.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.772.
Name
Descript io n
Required
Int ernal Name
De fault Cache
The de fault
infinis pan cache
The lis t of alias e s
for this cache
containe r
The jndi name to
which to bind this
cache containe r
The cache containe r
s tart mode , which
can be EAGER
(imme diate s tart) or
LAZY (on-de mand
s tart).
The e xe cutor us e d
for the re plication
que ue
no
de fault-cache
no
alias e s
no
jndi-name
no
s tart
no
lis te ne r-e xe cutor
Alias e s
Jndi Name
Start
Lis te ne r Exe cutor
719
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Eviction Exe cutor
The s che dule d
e xe cutor us e d for
e viction
The module whos e
clas s loade r s hould
be us e d whe n
building this cache
containe r's
configuration. The
de fault value is
org.jbos s .as .clus te ri
ng.infinis pan.
The e xe cutor us e d
for as ynchronous
cache ope rations
no
e viction-e xe cutor
no
module
no
re plication-que ue e xe cutor
Module
Re plication Que ue
Exe cutor
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.26.1.1. JBo ss AS 7 and EAP 6 - Cache Service
Overview
T able 3.773. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.774.
Name
Path
720
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.775.
Name
Descript io n
Required
Int ernal Name
Start
The cache s tart
mode , which can be
EAGER (imme diate
s tart) or LAZY (onde mand s tart).
If e nable d, the
invocation batching
API will be made
available for this
cache .
If e nable d, e ntrie s
will be inde xe d
whe n the y are
adde d to the cache .
Inde xe s will be
update d as e ntrie s
change or are
re move d.
The jndi-name to
which to bind this
cache ins tance .
Se ts the clus te re d
cache mode , ASYNC
for as ynchronous
ope ration, or SYNC
for s ynchronous
ope ration.
In ASYNC mode , this
attribute can be
us e d to trigge r
flus hing of the
que ue whe n it
re ache s a s pe cific
thre s hold.
no
s tart
no
batching
no
inde xing
no
jndi-name
ye s
mode
no
que ue -s iz e
Batching
Inde xing
Jndi Name
Mode
Que ue Siz e
721
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Que ue Flus h Inte rval In ASYNC mode , this
attribute controls
how ofte n the
as ynchronous
thre ad us e d to flus h
the re plication
que ue runs . This
s hould be a pos itive
inte ge r which
re pre s e nts thre ad
wake up time in
millis e conds .
Re mote Time out
In SYNC mode , the
time out (in ms ) us e d
to wait for an
acknowle dgme nt
whe n making a
re mote call, afte r
which the call is
aborte d and an
e xce ption is thrown.
As ync Mars halling
If e nable d, this will
caus e mars halling of
e ntrie s to be
pe rforme d
as ynchronous ly. The
de fault value is
fals e .
Module
The module whos e
clas s loade r s hould
be us e d whe n
building this cache 's
configuration.
Type of cache
Type of cache
Required
Int ernal Name
no
que ue -flus h-inte rval
no
re mote -time out
no
as ync-mars halling
no
module
ye s
__type
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.26.1.2. JBo ss AS 7 and EAP 6 - Dist ribut ed Cache Service
Overview
722
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.776. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.777.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.778.
Name
Descript io n
Required
Int ernal Name
Start
The cache s tart
mode , which can be
EAGER (imme diate
s tart) or LAZY (onde mand s tart).
If e nable d, the
invocation batching
API will be made
available for this
cache .
If e nable d, e ntrie s
will be inde xe d
whe n the y are
adde d to the cache .
Inde xe s will be
update d as e ntrie s
change or are
re move d.
The jndi-name to
which to bind this
cache ins tance .
no
s tart
no
batching
no
inde xing
no
jndi-name
Batching
Inde xing
Jndi Name
723
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Mode
Descript io n
Se ts the clus te re d
cache mode , ASYNC
for as ynchronous
ope ration, or SYNC
for s ynchronous
ope ration.
Que ue Siz e
In ASYNC mode , this
attribute can be
us e d to trigge r
flus hing of the
que ue whe n it
re ache s a s pe cific
thre s hold.
Que ue Flus h Inte rval In ASYNC mode , this
attribute controls
how ofte n the
as ynchronous
thre ad us e d to flus h
the re plication
que ue runs . This
s hould be a pos itive
inte ge r which
re pre s e nts thre ad
wake up time in
millis e conds .
Re mote Time out
In SYNC mode , the
time out (in ms ) us e d
to wait for an
acknowle dgme nt
whe n making a
re mote call, afte r
which the call is
aborte d and an
e xce ption is thrown.
As ync Mars halling
If e nable d, this will
caus e mars halling of
e ntrie s to be
pe rforme d
as ynchronous ly. The
de fault value is
fals e .
L 1 Life s pan
Maximum life s pan of
an e ntry place d in
the L1 cache . This
e le me nt configure s
the L1 cache
be havior in
'dis tribute d' cache s
ins tance s . In any
othe r cache mode s ,
this e le me nt is
ignore d. The de fault
value is 600000.
724
Required
Int ernal Name
ye s
mode
no
que ue -s iz e
no
que ue -flus h-inte rval
no
re mote -time out
no
as ync-mars halling
no
l1-life s pan
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Module
The module whos e
clas s loade r s hould
be us e d whe n
building this cache 's
configuration.
Numbe r of clus te rwide re plicas for
e ach cache e ntry.
The de fault value is
2.
Controls the numbe r
of virtual node s pe r
're al' node . If
numVirtualNode s is
1, the n virtual node s
are dis able d. The
topology aware
cons is te nt has h
mus t be us e d if you
wis h to take
advantage of virtual
node s . A de fault of 1
is us e d. The de fault
value is 1.
no
module
no
owne rs
no
virtual-node s
Owne rs
Virtual Node s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.26.1.3. JBo ss AS 7 and EAP 6 - Lo cal Cache Service
Overview
T able 3.779. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
725
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Co nnect io n Pro pert ies
T able 3.780 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.781.
Name
Descript io n
Required
Int ernal Name
Start
The cache s tart
mode , which can be
EAGER (imme diate
s tart) or LAZY (onde mand s tart).
If e nable d, the
invocation batching
API will be made
available for this
cache .
If e nable d, e ntrie s
will be inde xe d
whe n the y are
adde d to the cache .
Inde xe s will be
update d as e ntrie s
change or are
re move d.
The jndi-name to
which to bind this
cache ins tance .
The module whos e
clas s loade r s hould
be us e d whe n
building this cache 's
configuration.
no
s tart
no
batching
no
inde xing
no
jndi-name
no
module
Batching
Inde xing
Jndi Name
Module
726
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.26.1.4. JBo ss AS 7 and EAP 6 - T ranspo rt Service
Overview
T able 3.782. Overview
De s cription:
The de s cription of the trans port us e d by
this cache containe r
ye s
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.783.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.784.
Name
Descript io n
Required
Int ernal Name
727
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Clus te r
The name of the
group
communication
clus te r
The e xe cutor to us e
for the trans port
The time out for
locks for the
trans port. The
de fault value is
240000.
The jgroups s tack to
us e for the trans port
no
clus te r
no
e xe cutor
no
lock-time out
no
s tack
Exe cutor
Lock Time out
Stack
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.27. JBoss AS 7 and EAP 6 - JGroups Service
Overview
T able 3.785. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Resource T ypes
none
Connect ion Propert ies
T able 3.786.
Name
Path
728
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.787.
Name
Descript io n
Required
Int ernal Name
De fault Stack
De fault s tack to us e
ye s
de fault-s tack
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.28. JBoss AS 7 and EAP 6 - Remot ing Service
Overview
T able 3.788. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Resource T ypes
none
Connect ion Propert ies
T able 3.789.
729
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.790 .
Name
Descript io n
Required
Int ernal Name
Worke r Re ad
Thre ads
The numbe r of re ad
thre ads to cre ate for
the re moting worke r.
The de fault value is
1.
The numbe r of core
thre ads for the
re moting worke r
tas k thre ad pool.
The de fault value is
4.
The numbe r of
millis e conds to ke e p
non-core re moting
worke r tas k thre ads
alive . The de fault
value is 60.
The maximum
numbe r of re moting
worke r tas ks to
allow be fore
re je cting. The
de fault value is
16384.
The maximum
numbe r of thre ads
for the re moting
worke r tas k thre ad
pool. The de fault
value is 16.
no
worke r-re ad-thre ads
no
worke r-tas k-core thre ads
no
worke r-tas kke e palive
no
worke r-tas k-limit
no
worke r-tas k-maxthre ads
Worke r Tas k Core
Thre ads
Worke r Tas k
Ke e palive
Worke r Tas k Limit
Worke r Tas k Max
Thre ads
730
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Worke r Write
Thre ads
The numbe r of write no
thre ads to cre ate for
the re moting worke r.
The de fault value is
1.
Int ernal Name
worke r-write -thre ads
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
none
Package T ypes
none
3.3.29. JBoss AS 7 and EAP 6 - Osgi Service
Overview
T able 3.791. Overview
De s cription:
Single ton:
Plugin:
The OSGi s ubs ys te m configuration.
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.29.1, “JBos s AS 7 and EAP 6 - Capability Se rvice ”
Se ction 3.3.29.2, “JBos s AS 7 and EAP 6 - Bundle Se rvice ”
Se ction 3.3.29.3, “JBos s AS 7 and EAP 6 - Prope rty Se rvice ”
Connect ion Propert ies
T able 3.792.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
731
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
T able 3.793.
Name
Descript io n
Required
Int ernal Name
Activation
Activation flag for
the OSGi
s ubs ys te m. Pos s ible
value s : laz y, e age r.
The de fault value is
LAZY.
The curre nt Start
Le ve l of the OSGi
Frame work.
Changing this value
will change the Start
Le ve l of the
Frame work
accordingly.
no
activation
no
s tartle ve l
Startle ve l
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat ions
T able 3.794. Met rics
Name
Descript io n
Activate
Activate the OSGi s ubs ys te m.
Package T ypes
none
3.3.29.1. JBoss AS 7 and EAP 6 - Capabilit y Service
Overview
732
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.795. Overview
De s cription:
A frame work capability. A capability maps
to a JBos s Module in the module s dire ctory
or an OSGi bundle in the bundle s dire ctory.
The ide ntity maps to the re s ource
ide ntifie r of the module or bundle .
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.796.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.797.
Name
Descript io n
Required
Int ernal Name
Startle ve l
The s tartle ve l for
the capability. Can
only be s pe cifie d for
OSGi bundle s .
no
s tartle ve l
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
733
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
3.3.29.2. JBoss AS 7 and EAP 6 - Bundle Service
Overview
T able 3.798. Overview
De s cription:
Single ton:
Plugin:
Runtime bundle information.
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.799.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.80 0 .
Name
Descript io n
Required
Int ernal Name
Id
Startle ve l
The bundle ID.
The bundle 's s tart
le ve l.
The bundle s ymbolic
name .
The bundle ve rs ion.
no
no
id
s tartle ve l
no
s ymbolic-name
no
ve rs ion
Symbolic Name
Ve rs ion
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
734
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Operat io ns
T able 3.80 1. Met rics
Name
Descript io n
Start
Stop
Starts the bundle .
Stops the bundle .
Package T ypes
none
3.3.29.3. JBoss AS 7 and EAP 6 - Propert y Service
Overview
T able 3.80 2. Overview
De s cription:
Single ton:
Plugin:
A prope rty
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.80 3.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.80 4.
Name
Descript io n
Required
Int ernal Name
Value
The prope rty value .
no
value
735
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.30. JBoss AS 7 and EAP 6 - Mail Service
Overview
T able 3.80 5. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.30.1, “JBos s AS 7 and EAP 6 - Mail Se s s ion Se rvice ”
Connect ion Propert ies
T able 3.80 6.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
736
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
Package T ypes
none
3.3.30.1. JBoss AS 7 and EAP 6 - Mail Session Service
Overview
T able 3.80 7. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.30.1.1, “JBos s AS 7 and EAP 6 - SMTP Mail Se rve r Se rvice ”
Se ction 3.3.30.1.2, “JBos s AS 7 and EAP 6 - IMAP Mail Se rve r Se rvice ”
Se ction 3.3.30.1.3, “JBos s AS 7 and EAP 6 - POP3 Mail Se rve r Se rvice ”
Co nnect io n Pro pert ies
T able 3.80 8.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.80 9.
Name
Descript io n
Required
Int ernal Name
De bug
Enable s javamail
de bugging. The
de fault value is
fals e .
no
de bug
737
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
From
From addre s s that is
us e d as de fault
from, if not s e t whe n
s e nding
JNDI name to whe re
mail s e s s ion s hould
be bound
no
from
no
jndi-name
Jndi Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.30 .1.1. JBo ss AS 7 and EAP 6 - SMT P Mail Server Service
Overview
T able 3.810 . Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.811.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
738
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
Co nf igurat io n Pro pert ies
T able 3.812.
Name
Descript io n
Required
Int ernal Name
Outbound Socke t
Binding Re f
Outbound Socke t
binding to SMTP
s e rve r
Pas s word to
authe nticate on
s e rve r
Doe s s e rve r
re quire s SSL?. The
de fault value is
fals e .
Us e rname to
authe nticate on
s e rve r
ye s
outbound-s ocke tbinding-re f
no
pas s word
no
ssl
no
us e rname
Pas s word
Ss l
Us e rname
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.30 .1.2. JBo ss AS 7 and EAP 6 - IMAP Mail Server Service
Overview
T able 3.813. Overview
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.814.
739
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.815.
Name
Descript io n
Required
Int ernal Name
Outbound Socke t
Binding Re f
Outbound Socke t
binding to IMAP
s e rve r
Pas s word to
authe nticate on
s e rve r
Doe s s e rve r
re quire s SSL?. The
de fault value is
fals e .
Us e rname to
authe nticate on
s e rve r
ye s
outbound-s ocke tbinding-re f
no
pas s word
no
ssl
no
us e rname
Pas s word
Ss l
Us e rname
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.30 .1.3. JBo ss AS 7 and EAP 6 - POP3 Mail Server Service
Overview
T able 3.816. Overview
740
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
De s cription:
Single ton:
Plugin:
ye s
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.817.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.818.
Name
Descript io n
Required
Int ernal Name
Outbound Socke t
Binding Re f
Outbound Socke t
binding to POP3
s e rve r
Pas s word to
authe nticate on
s e rve r
Doe s s e rve r
re quire s SSL?. The
de fault value is
fals e .
Us e rname to
authe nticate on
s e rve r
ye s
outbound-s ocke tbinding-re f
no
pas s word
no
ssl
no
us e rname
Pas s word
Ss l
Us e rname
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
741
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
none
Package T ypes
none
3.3.31. JBoss AS 7 and EAP 6 - Messaging Service
Overview
T able 3.819. Overview
De s cription:
Single ton:
Plugin:
The me s s aging s ubs ys te ms
ye s
JBos s AS7
Child Resource T ypes
Se ction 3.3.31.1, “JBos s AS 7 and EAP 6 - Horne tQ Se rvice ”
Connect ion Propert ies
T able 3.820 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Conf igurat ion Propert ies
none
Operat ions
none
Package T ypes
none
3.3.31.1. JBoss AS 7 and EAP 6 - Hornet Q Service
742
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Overview
T able 3.821. Overview
De s cription:
Single ton:
Plugin:
The Horne tQ bas e d me s s aging s ubs ys te m
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.31.1.1, “JBos s AS 7 and EAP 6 - JMS Que ue Se rvice ”
Se ction 3.3.31.1.2, “JBos s AS 7 and EAP 6 - JMS Topic Se rvice ”
Se ction 3.3.31.1.3, “JBos s AS 7 and EAP 6 - Conne ction Factory Se rvice ”
Se ction 3.3.31.1.4, “JBos s AS 7 and EAP 6 - Poole d Conne ction Factory Se rvice ”
Se ction 3.3.31.1.5, “JBos s AS 7 and EAP 6 - Se curity Se tting Se rvice ”
Se ction 3.3.31.1.6, “JBos s AS 7 and EAP 6 - Addre s s Se tting Se rvice ”
Se ction 3.3.31.1.7, “JBos s AS 7 and EAP 6 - Grouping Handle r Se rvice ”
Se ction 3.3.31.1.8, “JBos s AS 7 and EAP 6 - Acce ptor Se rvice ”
Se ction 3.3.31.1.9, “JBos s AS 7 and EAP 6 - Conne ctor (Horne tQ) Se rvice ”
Se ction 3.3.31.1.10, “JBos s AS 7 and EAP 6 - In VM Acce ptor Se rvice ”
Se ction 3.3.31.1.11, “JBos s AS 7 and EAP 6 - In VM Conne ctor Se rvice ”
Se ction 3.3.31.1.12, “JBos s AS 7 and EAP 6 - Re mote Acce ptor Se rvice ”
Se ction 3.3.31.1.13, “JBos s AS 7 and EAP 6 - Re mote Conne ctor Se rvice ”
Se ction 3.3.31.1.14, “JBos s AS 7 and EAP 6 - Dive rt Se rvice ”
Se ction 3.3.31.1.15, “JBos s AS 7 and EAP 6 - Que ue Se rvice ”
Se ction 3.3.31.1.16, “JBos s AS 7 and EAP 6 - Core Addre s s Se rvice ”
Se ction 3.3.31.1.17, “JBos s AS 7 and EAP 6 - Clus te r Conne ction Se rvice ”
Se ction 3.3.31.1.18, “JBos s AS 7 and EAP 6 - Broadcas t Group Se rvice ”
Se ction 3.3.31.1.19, “JBos s AS 7 and EAP 6 - Path Se rvice ”
Se ction 3.3.31.1.20, “JBos s AS 7 and EAP 6 - Bridge Se rvice ”
Se ction 3.3.31.1.21, “JBos s AS 7 and EAP 6 - Dis cove ry Group Se rvice ”
Se ction 3.3.31.1.22, “JBos s AS 7 and EAP 6 - Conne ctor Se rvice ”
Co nnect io n Pro pert ies
T able 3.822.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
743
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.823. Met rics
Name
T ype
Descript io n
Int ernal Name
Starte d
trait
s tarte d
Ve rs ion
trait
Whe the r this s e rve r
is s tarte d.
The s e rve r's
ve rs ion.
ve rs ion
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.824.
Name
Descript io n
Allow Failback
Whe the r this s e rve r no
will automatically
s hutdown if the
original live s e rve r
come s back up. The
de fault value is true .
Whe the r incoming
no
packe ts on the
s e rve r s hould be
hande d off to a
thre ad from the
thre ad pool for
proce s s ing. Fals e if
the y s hould be
handle d on the
re moting thre ad.
The de fault value is
true .
Whe the r this s e rve r no
is a backup s e rve r.
The de fault value is
fals e .
As ync Conne ction
Exe cution Enable d
Backup
744
Required
Int ernal Name
allow-failback
as ync-conne ctione xe cution-e nable d
backup
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Clus te r Pas s word
The pas s word us e d
by clus te r
conne ctions to
communicate
be twe e n the
clus te re d node s .
The de fault value is
CHANGE ME!!.
The us e r us e d by
clus te r conne ctions
to communicate
be twe e n the
clus te re d node s .
The de fault value is
HORNETQ.CLUSTER.A
DMIN.USER.
Whe the r the s e rve r
is clus te re d. The
de fault value is
fals e .
If s e t, this will
ove rride how long
(in ms ) to ke e p a
conne ction alive
without re ce iving a
ping. The de fault
value is -1.
Whe the r the s e rve r
s hould cre ate the
bindings dire ctory on
s tart up. The de fault
value is true .
Whe the r the s e rve r
s hould cre ate the
journal dire ctory on
s tart up. The de fault
value is true .
How long to wait
be fore failback
occurs on live
s e rve r re s tart. The
de fault value is
5000.
Whe the r this backup
s e rve r (if it is a
backup s e rve r)
s hould come live on
a normal s e rve r
s hutdown. The
de fault value is
fals e .
no
clus te r-pas s word
no
clus te r-us e r
no
clus te re d
no
conne ction-ttlove rride
no
cre ate -bindings -dir
no
cre ate -journal-dir
no
failback-de lay
no
failove r-on-s hutdown
Clus te r Us e r
Clus te re d
Conne ction Ttl
Ove rride
Cre ate Bindings Dir
Cre ate Journal Dir
Failback De lay
Failove r On
Shutdown
745
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Id Cache Siz e
The s iz e of the
cache for pre cre ating me s s age
IDs . The de fault
value is 2000.
The JMX domain
us e d to re gis te r
inte rnal Horne tQ
MBe ans in the
MBe anSe rve r. The
de fault value is
org.horne tq.
Whe the r Horne tQ
s hould e xpos e its
inte rnal
manage me nt API via
JMX. This is not
re comme nde d, as
acce s s ing the s e
MBe ans can le ad to
incons is te nt
configuration. The
de fault value is
fals e .
The s iz e of the
inte rnal buffe r on
the journal.
The time out (in
nanos e conds ) us e d
to flus h inte rnal
buffe rs on the
journal.
The minimal numbe r
of journal data file s
be fore we can s tart
compacting. The
de fault value is 10.
The pe rce ntage of
live data on which
we cons ide r
compacting the
journal. The de fault
value is 30.
The s iz e (in byte s )
of e ach journal file .
The de fault value is
10485760.
The maximum
numbe r of write
re que s ts that can be
in the AIO que ue at
any one time .
no
id-cache -s iz e
no
jmx-domain
no
jmx-manage me nte nable d
no
journal-buffe r-s iz e
no
journal-buffe rtime out
no
journal-compact-minfile s
no
journal-compactpe rce ntage
no
journal-file -s iz e
no
journal-max-io
Jmx Domain
Jmx Manage me nt
Enable d
Journal Buffe r Siz e
Journal Buffe r
Time out
Journal Compact Min
File s
Journal Compact
Pe rce ntage
Journal File Siz e
Journal Max Io
746
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Journal Min File s
How many journal
file s to pre -cre ate .
The de fault value is
2.
Whe the r to wait for
non trans action data
to be s ynce d to the
journal be fore
re turning a
re s pons e to the
clie nt. The de fault
value is true .
Whe the r to wait for
trans action data to
be s ynchroniz e d to
the journal be fore
re turning a
re s pons e to the
clie nt. The de fault
value is true .
The type of journal
to us e . The de fault
value is ASYNCIO.
The name of the
conne ctor us e d to
conne ct to the live
conne ctor. If this
s e rve r is not a
backup that us e s
s hare d nothing HA,
it's value is
'unde fine d'.
Whe the r to
pe riodically log the
journal's write rate
and flus h rate . The
de fault value is
fals e .
Addre s s to s e nd
manage me nt
me s s age s to. The
de fault value is
jms .que ue .horne tq.
manage me nt.
The name of the
addre s s that
cons ume rs bind to
to re ce ive
manage me nt
notifications . The
de fault value is
horne tq.notifications .
no
journal-min-file s
no
journal-s ync-nontrans actional
no
journal-s ynctrans actional
no
journal-type
no
live -conne ctor-re f
no
log-journal-write -rate
no
manage me ntaddre s s
no
manage me ntnotification-addre s s
Journal Sync Non
Trans actional
Journal Sync
Trans actional
Journal Type
Live Conne ctor Re f
Log Journal Write
Rate
Manage me nt
Addre s s
Manage me nt
Notification Addre s s
747
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Me mory Me as ure
Inte rval
Fre que ncy to
s ample JVM me mory
in ms (or -1 to
dis able me mory
s ampling). The
de fault value is -1.
Pe rce ntage of
available me mory
which if e xce e de d
re s ults in a warning
log. The de fault
value is 25.
Whe the r me s s age
counte rs are
e nable d. The de fault
value is fals e .
How many days to
ke e p me s s age
counte r his tory. The
de fault value is 10.
The s ample pe riod
(in ms ) to us e for
me s s age counte rs .
The de fault value is
10000.
How ofte n (in ms ) to
s can for e xpire d
me s s age s . The
de fault value is
30000.
The priority of the
thre ad e xpiring
me s s age s . The
de fault value is 3.
The maximum
numbe r of
concurre nt re ads
allowe d on paging.
The de fault value is
5.
TODO. The de fault
value is -1.
Whe the r the
de live ry count is
pe rs is te d be fore
de live ry. Fals e
me ans that this only
happe ns afte r a
me s s age has be e n
cance lle d. The
de fault value is
fals e .
no
me mory-me as ure inte rval:e xpr
no
me mory-warningthre s hold:e xpr
no
me s s age -counte re nable d
no
me s s age -counte rmax-day-his tory
no
me s s age -counte rs ample -pe riod
no
me s s age -e xpirys can-pe riod
no
me s s age -e xpirythre ad-priority
no
page -maxconcurre nt-io
no
pe rf-blas t-page s
no
pe rs is t-de live rycount-be fore de live ry
Me mory Warning
Thre s hold
Me s s age Counte r
Enable d
Me s s age Counte r
Max Day His tory
Me s s age Counte r
Sample Pe riod
Me s s age Expiry
Scan Pe riod
Me s s age Expiry
Thre ad Priority
Page Max
Concurre nt Io
Pe rf Blas t Page s
Pe rs is t De live ry
Count Be fore
De live ry
748
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Pe rs is t Id Cache
Whe the r IDs are
pe rs is te d to the
journal. The de fault
value is true .
Whe the r the s e rve r
will us e the file
bas e d journal for
pe rs is te nce . The
de fault value is true .
The lis t of
inte rce ptor clas s e s
us e d by this s e rve r.
Whe the r on s tartup
to pe rform a
diagnos tic te s t on
how fas t your dis k
can s ync. Us e ful
whe n de te rmining
pe rformance is s ue s .
The de fault value is
fals e .
The numbe r of
thre ads that the
main s che dule d
thre ad pool has . The
de fault value is 5.
The s e curity domain
to us e to ve rify us e r
and role information.
The de fault value is
othe r.
Whe the r s e curity is
e nable d. The de fault
value is true .
How long (in ms ) to
wait be fore
invalidating the
s e curity cache . The
de fault value is
10000.
How ofte n to dump
bas ic runtime
information to the
s e rve r log. A value
le s s than 1 dis able s
this fe ature . The
de fault value is -1.
Whe the r this s e rve r
is us ing a s hare d
s tore for failove r.
The de fault value is
true .
no
pe rs is t-id-cache
no
pe rs is te nce -e nable d
no
re motinginte rce ptors :nullable
no
run-s ync-s pe e d-te s t
no
s che dule d-thre adpool-max-s iz e :e xpr
no
s e curity-domain
no
s e curity-e nable d
no
s e curity-invalidationinte rval
no
s e rve r-dumpinte rval
no
s hare d-s tore
Pe rs is te nce Enable d
Re moting
Inte rce ptors
Run Sync Spe e d
Te s t
Sche dule d Thre ad
Pool Max Siz e
Se curity Domain
Se curity Enable d
Se curity Invalidation
Inte rval
Se rve r Dump
Inte rval
Share d Store
749
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Thre ad Pool Max
Siz e
The numbe r of
thre ads that the
main thre ad pool
has . -1 me ans no
limit. The de fault
value is 30.
How long (in ms )
be fore a trans action
can be re move d
from the re s ource
manage r afte r
cre ate time . The
de fault value is
300000.
How ofte n (in ms ) to
s can for time out
trans actions . The
de fault value is
1000.
Whe the r the s e rve r
s upports wild card
routing. The de fault
value is true .
no
thre ad-pool-maxs iz e :e xpr
no
trans action-time out
no
trans action-time outs can-pe riod
no
wild-card-routinge nable d
Trans action Time out
Trans action Time out
Scan Pe riod
Wild Card Routing
Enable d
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.825. Met rics
Name
Descript io n
Clos e Conne ctions for Addre s s
Clos e s all the conne ctions of clie nts
conne cte d to this s e rve r whos e re mote
addre s s contains the s pe cifie d IP addre s s .
Re turns true if any conne ctions we re
clos e d, fals e othe rwis e .
He uris tically commits a pre pare d
trans action.
Force the me s s aging s e rve r to s top and
notify clie nts to failove r.
Re turns the addre s s s e ttings as a JSON
s tring for an addre s s match. The re turne d
String is a JSON s tring containing an array
of addre s s s e ttings de tails .
Re turns the conne ctors configure d for this
s e rve r us ing JSON s e rializ ation.
Commit Pre pare d Trans action
Force Failove r
Ge t Addre s s Se ttings as JSON
Ge t Conne ctors as JSON
750
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Ge t Las t Se nt Me s s age ID
Re turns the ID of the las t me s s age s e nt
from the give n s e s s ion to the give n
addre s s .
Ge ts the s e s s ion's cre ation time . Re turns
the cre ation time , re pre s e nte d as a s tring
s howing the numbe r of millis e conds s ince
the e poch.
Lis ts all the cons ume rs .
Lis ts the IDs of all the conne ctions
conne cte d to this s e rve r.
Lis t all JMS conne ctions .
Lis ts all the cons ume rs which be longs to
the JMS Conne ction s pe cifie d by the
conne ction-id.
Lis ts trans actions which have be e n
he uris tically committe d. Re turns a lis t of
s trings . The Strings are Bas e -64
re pre s e ntation of the trans action XID.
Lis ts trans actions which have be e n
he uris tically rolle d back. Re turns a lis t of
s trings . The Strings are Bas e -64
re pre s e ntation of the trans action XID.
Lis t all the pre pare d trans action, s orte d by
date , olde s t firs t, with de tails , in HTML
format.
Lis t all the pre pare d trans action, s orte d by
date , olde s t firs t, with de tails , in JSON
format.
Lis t all the pre pare d trans actions , s orte d
by date , olde s t firs t, with de tails in JMS, in
HTML format
Lis t all the pre pare d trans actions , s orte d
by date , olde s t firs t, with de tails in JMS
format, in JSON format
Lis t all the pre pare d trans action, s orte d by
date , olde s t firs t. Re turns a lis t of s trings .
The Strings are Bas e -64 re pre s e ntation of
the trans action XID and can be us e d to
he uris tically commit or rollback the
trans actions .
For all s e s s ions , lis ts information about
me s s age produce rs us ing JSON
s e rializ ation.
Lis ts the addre s s e s of all the clie nts
conne cte d to the give n addre s s . If an ipaddre s s argume nt is s upplie d, only thos e
clie nts whos e re mote addre s s s tring
include s the give n ip-addre s s s tring will be
re turne d.
Lis ts all the s e s s ions IDs for the s pe cifie d
conne ction ID.
Ge t Se s s ion Cre ation Time
Lis t All Cons ume rs as JSON
Lis t Conne ction IDs
Lis t Conne ctions as JSON
Lis t Cons ume rs as JSON
Lis t He uris tic Committe d Trans actions
Lis t He uris tic Rolle d Back Trans actions
Lis t Pre pare d Trans action De tails as HTML
Lis t Pre pare d Trans action De tails as JSON
Lis t Pre pare d Trans action JMS De tails as
HTML
Lis t Pre pare d Trans action JMS de tails as
JSON
Lis t Pre pare d Trans actions
Lis t Produce rs Info as JSON
Lis t Re mote Addre s s e s
Lis t Se s s ions
751
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Lis t Se s s ions as JSON
Lis ts all the s e s s ions IDs for the s pe cifie d
conne ction ID. The re turne d String is a
JSON s tring containing an array of s e s s ion
ids .
Lis ts all addre s s e s to which the de s ignate d
s e s s ion has s e nt me s s age s . The re turne d
String is a JSON s tring containing an array
of addre s s name s .
Re s e t all me s s age counte rs his tory.
Re s e t all me s s age counte rs .
He uris tically rolls back a pre pare d
trans action. Re turns true if the trans action
was s ucce s s fully rolle d back, fals e
othe rwis e .
Lis t Targe t De s tinations
Re s e t All Me s s age Counte r His torie s
Re s e t All Me s s age Counte rs
Rollback Pre pare d Trans action
Package T ypes
none
3.3.31.1.1. JBo ss AS 7 and EAP 6 - JMS Queue Service
Overview
T able 3.826. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.827.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.828. Met rics
752
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Cons ume r Count
me as ure me nt
cons ume r-count
De ad Le tte r
Addre s s
De live ring Count
trait
Expiry Addre s s
trait
Me s s age Count
me as ure me nt
Me s s age s Adde d
me as ure me nt
Paus e d
trait
Sche dule d Count
me as ure me nt
Te mporary
trait
Que ue Addre s s
trait
The numbe r of
cons ume rs
cons uming
me s s age s from this
que ue .
The addre s s to s e nd
de ad me s s age s to.
The numbe r of
me s s age s that this
que ue is curre ntly
de live ring to its
cons ume rs .
The addre s s to s e nd
e xpire d me s s age s
to.
The numbe r of
me s s age s curre ntly
in this que ue .
The numbe r of
me s s age s adde d to
this que ue s ince it
was cre ate d.
Whe the r the que ue
is paus e d.
The numbe r of
s che dule d
me s s age s in this
que ue .
Whe the r the que ue
is te mporary.
The que ue addre s s
de fine s what
addre s s is us e d for
routing me s s age s .
me as ure me nt
de ad-le tte r-addre s s
de live ring-count
e xpiry-addre s s
me s s age -count
me s s age s -adde d
paus e d
s che dule d-count
te mporary
que ue -addre s s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.829.
Name
Descript io n
Required
Int ernal Name
Durable
Whe the r the que ue
is durable or not.
The de fault value is
true .
no
durable
753
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Entrie s
The jndi name s the
que ue will be bound
to.
The que ue s e le ctor.
ye s
e ntrie s
no
s e le ctor
Se le ctor
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.830 . Met rics
Name
Descript io n
Change Me s s age Priority
Change the priority of the me s s age
corre s ponding to the give n me s s age -id.
Re turns true if the me s s age was e xpire d,
fals e othe rwis e .
Change the priority of the me s s age s
corre s ponding to the give n filte r. Re turns
the numbe r of re move d me s s age s .
Re turns the numbe r of the me s s age s in
the que ue matching the give n filte r.
Expire the me s s age corre s ponding to the
give n me s s age -id. Re turns true if the
me s s age was e xpire d, fals e othe rwis e .
Expire the me s s age s matching the give n
filte r.
A s tring in JSON format.
Lis t the me s s age counte r as a s tring in
HTML format.
Lis t the me s s age counte r as a s tring in
JSON format.
Lis t the me s s age counte r his tory.
Lis t the me s s age counte r his tory as a
s tring in JSON format.
Lis t all me s s age s in the que ue that match
the filte r
Lis t all me s s age s in the que ue that match
the filte r and re turn the m as a s tring in
JSON format.
Move the me s s age corre s ponding to the
give n me s s age -id to anothe r que ue
Move the me s s age s corre s ponding to the
give n filte r to anothe r que ue .
Paus e the que ue .
Re move the me s s age corre s ponding to the
give n me s s age -id.
Change Me s s age s Priority
Count Me s s age s
Expire Me s s age
Expire Me s s age s
Lis t Cons ume rs as JSON
Lis t Me s s age Counte r as HTML
Lis t Me s s age Counte r as JSON
Lis t Me s s age Counte r His tory as HTML
Lis t Me s s age Counte r His tory as JSON
Lis t Me s s age s
Lis t Me s s age s as JSON
Move Me s s age
Move Me s s age s
Paus e
Re move Me s s age
754
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Re move Me s s age s
Re move me s s age s matching the give n
filte r from the de s tination.
Re s e t the me s s age counte rs .
Re s ume the que ue .
Se nd the me s s age corre s ponding to the
give n me s s age -id to this que ue 's De ad
Le tte r Addre s s .
Se nd the me s s age s corre s ponding to the
give n filte r to this que ue 's De ad Le tte r
Addre s s .
Re s e t Me s s age Counte r
Re s ume
Se nd Me s s age to De ad Le tte r Addre s s
Se nd Me s s age s to De ad Le tte r Addre s s
Package T ypes
none
3.3.31.1.2. JBo ss AS 7 and EAP 6 - JMS T o pic Service
Overview
T able 3.831. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.832.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.833. Met rics
Name
T ype
Descript io n
Int ernal Name
755
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
De live ring Count
me as ure me nt
de live ring-count
Durable Me s s age
Count
me as ure me nt
The numbe r of
me s s age s that this
que ue is curre ntly
de live ring to its
cons ume rs .
The numbe r of
me s s age s for all
durable s ubs cribe rs
for this topic.
The numbe r of
durable s ubs cribe rs
for this topic.
The numbe r of
me s s age s curre ntly
in this que ue .
The numbe r of
me s s age s adde d to
this que ue s ince it
was cre ate d.
The numbe r of
me s s age s for all
non-durable
s ubs cribe rs for this
topic.
The numbe r of nondurable s ubs cribe rs
for this topic.
The numbe r of
(durable and nondurable ) s ubs cribe rs
for this topic.
Whe the r the topic is
te mporary.
The addre s s the
topic points to.
Durable Subs cription me as ure me nt
Count
Me s s age Count
me as ure me nt
Me s s age s Adde d
me as ure me nt
Non Durable
Me s s age Count
me as ure me nt
Non Durable
Subs cription Count
me as ure me nt
Subs cription Count
me as ure me nt
Te mporary
trait
Topic Addre s s
trait
durable -me s s age count
durable -s ubs criptioncount
me s s age -count
me s s age s -adde d
non-durable me s s age -count
non-durable s ubs cription-count
s ubs cription-count
te mporary
topic-addre s s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.834.
Name
Descript io n
Required
Int ernal Name
JNDI Name s
The jndi name s the
que ue will be bound
to.
ye s
e ntrie s
756
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.835. Met rics
Name
Descript io n
Count Me s s age s for Subs cription
Count the numbe r of me s s age s matching
the filte r for the give n s ubs cription.
Drop all s ubs criptions from this topic.
Drop a durable s ubs cription
Lis t all s ubs criptions .
Lis t all s ubs criptions as a s tring in JSON
format.
Lis t only the durable s ubs criptions .
Lis t only the durable s ubs criptions , as a
s tring in JSON format.
Lis t all the me s s age s for the give n
s ubs cription.
Lis t all the me s s age s for the give n
s ubs cription as a s tring in JSON format.
Lis t only the non-durable s ubs criptions .
Lis t only the non-durable s ubs criptions , as
a s tring in JSON format.
Re move me s s age s matching the give n
filte r from the de s tination.
Drop All Subs criptions
Drop Durable Subs cription
Lis t All Subs criptions
Lis t All Subs criptions as JSON
Lis t Durable Subs criptions
Lis t Durable Subs criptions as JSON
Lis t Me s s age s for Subs cription
Lis t Me s s age s for Subs cription as JSON
Lis t Non-Durable Subs criptions
Lis t Non-Durable Subs criptions as JSON
Re move Me s s age s
Package T ypes
none
3.3.31.1.3. JBo ss AS 7 and EAP 6 - Co nnect io n Fact o ry Service
Overview
T able 3.836. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.837.
757
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Include Runtime
Required
Int ernal Name
ye s
ye s
path
include Runtime
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.838.
Name
Descript io n
Required
Int ernal Name
Conne ctor
De fine s the
conne ctor to be
us e d. This is
mutually e xclus ive
with dis cove rygroup-name
The jndi name s the
conne ction factory
s hould be bound to.
Whe the r or not
me s s age grouping
is automatically
us e d. The de fault
value is fals e .
True to s e t block on
acknowle dge . The
de fault value is
fals e .
True to s e t block on
durable s e nd. The
de fault value is true .
True to s e t block on
non durable s e nd.
The de fault value is
fals e .
True to cache large
me s s age s . The
de fault value is
fals e .
The call time out.
The de fault value is
30000.
no
conne ctor:collaps e d
ye s
e ntrie s
no
auto-group
no
block-onacknowle dge
no
block-on-durable s e nd
no
block-on-nondurable -s e nd
no
cache -large me s s age -clie nt
no
call-time out
JNDI Name s
Auto Group
Block On
Acknowle dge
Block On Durable
Se nd
Block On Non
Durable Se nd
Cache Large
Me s s age Clie nt
Call Time out
758
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Clie nt Failure Che ck
Pe riod
Descript io n
The clie nt failure
che ck pe riod. The
de fault value is
30000.
Clie nt Id
The clie nt id.
Compre s s Large
Whe the r large
Me s s age s
me s s age s s hould
be compre s s e d. The
de fault value is
fals e .
Confirmation Window The confirmation
Siz e
window s iz e . The
de fault value is -1.
Conne ction Load
Name of a clas s
Balancing Policy
imple me nting a
Clas s Name
clie nt-s ide load
balancing policy that
a clie nt can us e to
load balance
s e s s ions acros s
diffe re nt node s in a
clus te r. The de fault
value is
org.horne tq.api.core .
clie nt.loadbalance .Ro
undRobinConne ctionL
oadBalancingPolicy.
Conne ction Ttl
The conne ction ttl.
The de fault value is
60000.
Cons ume r Max Rate The cons ume r max
rate . The de fault
value is -1.
Cons ume r Window
The cons ume r
Siz e
window s iz e . The
de fault value is
1048576.
Dis cove ry Group
The dis cove ry group
Name
name .
Dis cove ry Initial
The dis cove ry initial
Wait Time out
wait time out.
Dups Ok Batch Siz e
The dups ok batch
s iz e . The de fault
value is 1048576.
Factory Type
The type of
conne ction factory.
Failove r On Initial
True to fail ove r on
Conne ction
initial conne ction.
The de fault value is
fals e .
Failove r On Se rve r
True to fail ove r on
Shutdown
s e rve r s hutdown.
Group Id
The group id.
Required
Int ernal Name
no
clie nt-failure -che ckpe riod
no
no
clie nt-id
compre s s -large me s s age s
no
confirmation-windows iz e
no
conne ction-loadbalancing-policyclas s -name
no
conne ction-ttl
no
cons ume r-max-rate
no
cons ume r-windows iz e
no
no
dis cove ry-groupname
dis cove ry-initial-waittime out
dups -ok-batch-s iz e
no
factory-type
no
failove r-on-initialconne ction
no
failove r-on-s e rve rs hutdown
group-id
no
no
759
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Ha
Whe the r the
conne ction factory
s upports High
Availability. The
de fault value is
fals e .
The initial s iz e of
me s s age s cre ate d
through this factory.
The max re try
inte rval. The de fault
value is 2000.
The min large
me s s age s iz e . The
de fault value is
102400.
True to pre acknowle dge . The
de fault value is
fals e .
The produce r max
rate . The de fault
value is -1.
The produce r
window s iz e . The
de fault value is
65536.
The re conne ct
atte mpts . The
de fault value is 0.
The re try inte rval.
The de fault value is
2000.
The re try inte rval
multiplie r. The
de fault value is 1.0.
The s che dule d
thre ad pool max
s iz e . The de fault
value is 5.
The thre ad pool max
s iz e . The de fault
value is 30.
The trans action
batch s iz e . The
de fault value is
1048576.
True to us e global
pools . The de fault
value is true .
ye s
ha
ye s
initial-me s s age packe t-s iz e
no
max-re try-inte rval
no
min-large -me s s age s iz e
no
pre -acknowle dge
no
produce r-max-rate
no
produce r-windows iz e
no
re conne ct-atte mpts
no
re try-inte rval
no
re try-inte rvalmultiplie r
no
s che dule d-thre adpool-max-s iz e :e xpr
no
thre ad-pool-maxs iz e :e xpr
no
trans action-batchs iz e
no
us e -global-pools
Initial Me s s age
Packe t Siz e
Max Re try Inte rval
Min Large Me s s age
Siz e
Pre Acknowle dge
Produce r Max Rate
Produce r Window
Siz e
Re conne ct Atte mpts
Re try Inte rval
Re try Inte rval
Multiplie r
Sche dule d Thre ad
Pool Max Siz e
Thre ad Pool Max
Siz e
Trans action Batch
Siz e
Us e Global Pools
760
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.4. JBo ss AS 7 and EAP 6 - Po o led Co nnect io n Fact o ry Service
Overview
T able 3.839. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.840 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.841.
Name
Descript io n
Required
Int ernal Name
761
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Conne ctor
Descript io n
De fine s the
conne ctors . The s e
are s tore d in a map
by conne ctor name ,
with the backup
conne ctors s tore d
as the value , or an
unde fine d value if
the re is no backup
conne ctor.
JNDI Name s
The jndi name s the
conne ction factory
s hould be bound to.
Auto Group
The autogroup. The
de fault value is
fals e .
Block On
True to s e t block on
Acknowle dge
acknowle dge . The
de fault value is
fals e .
Block On Durable
True to s e t block on
Se nd
durable s e nd. The
de fault value is true .
Block On Non
True to s e t block on
Durable Se nd
non durable s e nd.
The de fault value is
fals e .
Cache Large
True to cache large
Me s s age Clie nt
me s s age s . The
de fault value is
fals e .
Call Time out
The call time out.
The de fault value is
30000.
Clie nt Failure Che ck The clie nt failure
Pe riod
che ck pe riod. The
de fault value is
30000.
Clie nt Id
The clie nt id.
Confirmation Window The confirmation
Siz e
window s iz e . The
de fault value is -1.
762
Required
Int ernal Name
no
conne ctor:collaps e d
ye s
e ntrie s
no
auto-group
no
block-onacknowle dge
no
block-on-durable s e nd
no
block-on-nondurable -s e nd
no
cache -large me s s age -clie nt
no
call-time out
no
clie nt-failure -che ckpe riod
no
no
clie nt-id
confirmation-windows iz e
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Conne ction Load
Balancing Policy
Clas s Name
Name of a clas s
imple me nting a
clie nt-s ide load
balancing policy that
a clie nt can us e to
load balance
s e s s ions acros s
diffe re nt node s in a
clus te r. The de fault
value is
org.horne tq.api.core .
clie nt.loadbalance .Ro
undRobinConne ctionL
oadBalancingPolicy.
The conne ction ttl.
The de fault value is
60000.
The cons ume r max
rate . The de fault
value is -1.
The cons ume r
window s iz e . The
de fault value is
1048576.
The dis cove ry group
name .
The dis cove ry initial
wait time out.
The dups ok batch
s iz e . The de fault
value is 1048576.
True to fail ove r on
initial conne ction.
The de fault value is
fals e .
True to fail ove r on
s e rve r s hutdown.
The group id.
Whe the r the
conne ction factory
s upports High
Availability. The
de fault value is
fals e .
The JNDI params to
us e for locating the
de s tination for
incoming
conne ctions .
The maximum s iz e
for the pool. The
de fault value is -1.
no
conne ction-loadbalancing-policyclas s -name
no
conne ction-ttl
no
cons ume r-max-rate
no
cons ume r-windows iz e
no
dis cove ry-groupname
dis cove ry-initial-waittime out
dups -ok-batch-s iz e
Conne ction Ttl
Cons ume r Max Rate
Cons ume r Window
Siz e
Dis cove ry Group
Name
Dis cove ry Initial
Wait Time out
Dups Ok Batch Siz e
Failove r On Initial
Conne ction
Failove r On Se rve r
Shutdown
Group Id
Ha
Jndi Params
Max Pool Siz e
no
no
no
failove r-on-initialconne ction
no
no
no
failove r-on-s e rve rs hutdown
group-id
ha
no
jndi-params
no
max-pool-s iz e :e xpr
763
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Max Re try Inte rval
The max re try
inte rval. The de fault
value is 2000.
The min large
me s s age s iz e . The
de fault value is
102400.
The minimum s iz e
for the pool. The
de fault value is -1.
The de fault
pas s word to us e
with this conne ction
factory. This is only
ne e de d whe n
pointing the
conne ction factory to
a re mote hos t.
True to pre acknowle dge . The
de fault value is
fals e .
The produce r max
rate . The de fault
value is -1.
The produce r
window s iz e . The
de fault value is
65536.
The re conne ct
atte mpts . The
de fault value is 0.
The re try inte rval.
The de fault value is
2000.
The re try inte rval
multiplie r. The
de fault value is 1.0.
The s che dule d
thre ad pool max
s iz e . The de fault
value is 5.
The numbe r of
time s to s e t up an
MDB e ndpoint
The inte rval
be twe e n atte mpts at
s e tting up an MDB
e ndpoint.
The thre ad pool max
s iz e . The de fault
value is 30.
no
max-re try-inte rval
no
min-large -me s s age s iz e
no
min-pool-s iz e :e xpr
no
pas s word
no
pre -acknowle dge
no
produce r-max-rate
no
produce r-windows iz e
no
re conne ct-atte mpts
no
re try-inte rval
no
re try-inte rvalmultiplie r
no
s che dule d-thre adpool-max-s iz e :e xpr
no
s e tup-atte mpts
no
s e tup-inte rval
no
thre ad-pool-maxs iz e :e xpr
Min Large Me s s age
Siz e
Min Pool Siz e
Pas s word
Pre Acknowle dge
Produce r Max Rate
Produce r Window
Siz e
Re conne ct Atte mpts
Re try Inte rval
Re try Inte rval
Multiplie r
Sche dule d Thre ad
Pool Max Siz e
Se tup Atte mpts
Se tup Inte rval
Thre ad Pool Max
Siz e
764
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Trans action
TODO. The de fault
value is trans action.
The trans action
batch s iz e . The
de fault value is
1048576.
True to us e global
pools . The de fault
value is true .
Us e JNDI to locate
the de s tination for
incoming
conne ctions
Us e a local
trans action for
incoming s e s s ions
The de fault
us e rname to us e
with this conne ction
factory. This is only
ne e de d whe n
pointing the
conne ction factory to
a re mote hos t.
no
trans action
no
trans action-batchs iz e
no
us e -global-pools
no
us e -jndi
no
us e -local-tx
no
us e r
Trans action Batch
Siz e
Us e Global Pools
Us e Jndi
Us e Local Tx
Us e r
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.5. JBo ss AS 7 and EAP 6 - Securit y Set t ing Service
Overview
T able 3.842. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.31.1.5.1, “JBos s AS 7 and EAP 6 - Role Se rvice ”
765
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Co nnect io n Pro pert ies
T able 3.843.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
none
Operat io ns
none
Package T ypes
none
3.3.31.1.5.1. JBo ss AS 7 and EAP 6 - Ro le Service
Ove rvie w
T able 3.844. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.845.
Name
Path
766
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.846.
Name
Descript io n
Required
Int ernal Name
Cons ume
his pe rmis s ion
allows the us e r to
cons ume a
me s s age from a
que ue bound to
matching addre s s e s .
The de fault value is
fals e .
This pe rmis s ion
allows the us e r to
cre ate a durable
que ue . The de fault
value is fals e .
This pe rmis s ion
allows the us e r to
cre ate a te mporary
que ue . The de fault
value is fals e .
This pe rmis s ion
allows the us e r to
de le te a durable
que ue . The de fault
value is fals e .
This pe rmis s ion
allows the us e r to
de le te a te mporary
que ue . The de fault
value is fals e .
This pe rmis s ion
allows the us e r to
invoke manage me nt
ope rations by
s e nding
manage me nt
me s s age s to the
manage me nt
addre s s . The de fault
value is fals e .
ye s
cons ume
ye s
cre ate -durable que ue
ye s
cre ate -non-durable que ue
ye s
de le te -durable que ue
ye s
de le te -non-durable que ue
ye s
manage
Cre ate Durable
Que ue
Cre ate Non Durable
Que ue
De le te Durable
Que ue
De le te Non Durable
Que ue
Manage
767
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Se nd
This pe rmis s ion
ye s
allows the us e r to
s e nd a me s s age to
matching addre s s e s .
The de fault value is
fals e .
Int ernal Name
s e nd
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.31.1.6. JBo ss AS 7 and EAP 6 - Address Set t ing Service
Overview
T able 3.847. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.848.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
768
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Co nf igurat io n Pro pert ies
T able 3.849.
Name
Descript io n
Required
Int ernal Name
Addre s s Full Policy
De te rmine s what
happe ns whe n an
addre s s whe re maxs iz e -byte s is
s pe cifie d be come s
full. (PAGE, DROP or
BLOCK). The de fault
value is PAGE.
The de ad le tte r
addre s s
De fine s whe re to
s e nd a me s s age
that has e xpire d.
De fine s whe the r a
que ue only us e s
las t value s or not.
The de fault value is
fals e .
De fine s how many
time a cance lle d
me s s age can be
re de live re d be fore
s e nding to the de adle tte r-addre s s . The
de fault value is 10.
The max byte s s iz e .
The de fault value is
-1.
Day limit for the
me s s age counte r
his tory. The de fault
value is 0.
The numbe r of page
file s to ke e p in
me mory to optimiz e
IO during paging
navigation. The
de fault value is 5.
The paging s iz e . The
de fault value is
10485760.
De fine s how long to
wait be fore
atte mpting
re de live ry of a
cance lle d me s s age .
The de fault value is
0.
no
addre s s -full-policy
no
de ad-le tte r-addre s s
no
e xpiry-addre s s
no
las t-value -que ue
no
max-de live ryatte mpts
no
max-s iz e -byte s
no
me s s age -counte rhis tory-day-limit
no
page -max-cache s iz e
no
page -s iz e -byte s
no
re de live ry-de lay
De ad Le tte r
Addre s s
Expiry Addre s s
Las t Value Que ue
Max De live ry
Atte mpts
Max Siz e Byte s
Me s s age Counte r
His tory Day Limit
Page Max Cache
Siz e
Page Siz e Byte s
Re de live ry De lay
769
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Re dis tribution De lay
De fine s how long to
wait whe n the las t
cons ume r is clos e d
on a que ue be fore
re dis tributing any
me s s age s . The
de fault value is -1.
If this parame te r is
s e t to true for that
addre s s , if the
me s s age is not
route d to any
que ue s it will
ins te ad be s e nt to
the de ad le tte r
addre s s (DLA) for
that addre s s , if it
e xis ts . The de fault
value is fals e .
no
re dis tribution-de lay
no
s e nd-to-dla-on-noroute
Se nd To Dla On No
Route
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.7. JBo ss AS 7 and EAP 6 - Gro uping Handler Service
Overview
T able 3.850 . Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.851.
770
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.852.
Name
Descript io n
Required
Int ernal Name
Grouping Handle r
Addre s s
A re fe re nce to a
clus te r conne ction
and the addre s s it
us e s .
How long to wait for
a handling de cis ion
to be made ; an
e xce ption will be
thrown during the
s e nd if this time out
is re ache d, e ns uring
that s trict orde ring is
ke pt. The de fault
value is 5000.
Whe the r the handle r
is the s ingle 'Local'
handle r for the
clus te r, which make s
handling de cis ions ,
or a 'Re mote '
handle r which
conve rs e s with the
local handle r.
ye s
grouping-handle raddre s s
no
time out
no
type
Time out
Type
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
771
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Package T ypes
none
3.3.31.1.8. JBo ss AS 7 and EAP 6 - Accept o r Service
Overview
T able 3.853. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.31.1.8.1, “JBos s AS 7 and EAP 6 - Param Se rvice ”
Co nnect io n Pro pert ies
T able 3.854.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.855. Met rics
Name
T ype
Descript io n
Int ernal Name
Starte d
trait
Whe the r this
acce ptor is s tarte d.
s tarte d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.856.
Name
Descript io n
Required
Int ernal Name
Factory Clas s
The factory clas s .
ye s
factory-clas s
772
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Socke t Binding
The s ocke t binding
re fe re nce .
no
s ocke t-binding
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.857. Met rics
Name
Descript io n
Start
Stop
Starts the acce ptor.
Stops the acce ptor.
Package T ypes
none
3.3.31.1.8.1. JBo ss AS 7 and EAP 6 - Param Service
Ove rvie w
T able 3.858. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.859.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
773
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Configuration Prope rtie s
T able 3.860 .
Name
Descript io n
Required
Int ernal Name
Value
The parame te r
value
ye s
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.31.1.9. JBo ss AS 7 and EAP 6 - Co nnect o r (Ho rnet Q) Service
Overview
T able 3.861. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.31.1.9.1, “JBos s AS 7 and EAP 6 - Param Se rvice ”
Co nnect io n Pro pert ies
T able 3.862.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
774
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Co nf igurat io n Pro pert ies
T able 3.863.
Name
Descript io n
Required
Int ernal Name
Factory Clas s
Socke t Binding
The factory clas s .
The s ocke t binding
re fe re nce .
ye s
no
factory-clas s
s ocke t-binding
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.9.1. JBo ss AS 7 and EAP 6 - Param Service
Ove rvie w
T able 3.864. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.865.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
775
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Configuration Prope rtie s
T able 3.866.
Name
Descript io n
Required
Int ernal Name
Value
The parame te r
value
ye s
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.31.1.10 . JBo ss AS 7 and EAP 6 - In VM Accept o r Service
Overview
T able 3.867. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.31.1.10.1, “JBos s AS 7 and EAP 6 - Param Se rvice ”
Co nnect io n Pro pert ies
T able 3.868.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.869. Met rics
776
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
T ype
Descript io n
Int ernal Name
Starte d
trait
Whe the r it's s toppe d
or s tarte d.
s tarte d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.870 .
Name
Descript io n
Required
Int ernal Name
Se rve r Id
The s e rve r id.
ye s
s e rve r-id
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.871. Met rics
Name
Descript io n
Start
Stop
Starts the acce ptor.
Stops the acce ptor.
Package T ypes
none
3.3.31.1.10 .1. JBo ss AS 7 and EAP 6 - Param Service
Ove rvie w
T able 3.872. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.873.
777
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.874.
Name
Descript io n
Required
Int ernal Name
Value
The parame te r
value
ye s
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.31.1.11. JBo ss AS 7 and EAP 6 - In VM Co nnect o r Service
Overview
T able 3.875. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.31.1.11.1, “JBos s AS 7 and EAP 6 - Param Se rvice ”
Co nnect io n Pro pert ies
T able 3.876.
778
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.877.
Name
Descript io n
Required
Int ernal Name
Se rve r Id
The s e rve r id.
ye s
s e rve r-id
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.11.1. JBo ss AS 7 and EAP 6 - Param Service
Ove rvie w
T able 3.878. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.879.
779
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.880 .
Name
Descript io n
Required
Int ernal Name
Value
The parame te r
value
ye s
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.31.1.12. JBo ss AS 7 and EAP 6 - Remo t e Accept o r Service
Overview
T able 3.881. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.31.1.12.1, “JBos s AS 7 and EAP 6 - Param Se rvice ”
Co nnect io n Pro pert ies
T able 3.882.
780
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.883. Met rics
Name
T ype
Descript io n
Int ernal Name
Starte d
trait
Whe the r this
acce ptor is s tarte d.
s tarte d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.884.
Name
Descript io n
Required
Int ernal Name
Socke t Binding
The s ocke t binding
re fe re nce .
no
s ocke t-binding
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.885. Met rics
Name
Descript io n
Start
Stop
Starts the acce ptor.
Stops the acce ptor.
Package T ypes
none
781
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
3.3.31.1.12.1. JBo ss AS 7 and EAP 6 - Param Service
Ove rvie w
T able 3.886. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.887.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.888.
Name
Descript io n
Required
Int ernal Name
Value
The parame te r
value
ye s
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.31.1.13. JBo ss AS 7 and EAP 6 - Remo t e Co nnect o r Service
782
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Overview
T able 3.889. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.31.1.13.1, “JBos s AS 7 and EAP 6 - Param Se rvice ”
Co nnect io n Pro pert ies
T able 3.890 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.891.
Name
Descript io n
Required
Int ernal Name
Socke t Binding
The s ocke t binding
re fe re nce .
no
s ocke t-binding
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.13.1. JBo ss AS 7 and EAP 6 - Param Service
783
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Ove rvie w
T able 3.892. Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.893.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.894.
Name
Descript io n
Required
Int ernal Name
Value
The parame te r
value
ye s
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.3.31.1.14. JBo ss AS 7 and EAP 6 - Divert Service
Overview
784
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.895. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.896.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.897.
Name
Descript io n
Dive rt Addre s s
Addre s s to dive rt
ye s
from
Whe the r the dive rt
no
is e xclus ive ,
me aning that the
me s s age is dive rte d
to the ne w addre s s ,
and doe s not go to
the old addre s s at
all. The de fault value
is fals e .
Exclus ive
Required
Int ernal Name
dive rt-addre s s
e xclus ive
785
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Filte r
An optional filte r
s tring. If s pe cifie d
the n only me s s age s
which match the
filte r e xpre s s ion
s pe cifie d will be
dive rte d. The filte r
s tring follows the
Horne tQ filte r
e xpre s s ion s yntax
de s cribe d in the
Horne tQ
docume ntation.
Addre s s to dive rt to
Routing name of the
dive rt
The name of a clas s
us e d to trans form
the me s s age 's body
or prope rtie s be fore
it is dive rte d.
no
filte r
ye s
no
forwarding-addre s s
routing-name
no
trans forme r-clas s name
Forwarding Addre s s
Routing Name
Trans forme r Clas s
Name
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.15. JBo ss AS 7 and EAP 6 - Queue Service
Overview
T able 3.898. Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.899.
786
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
T able 3.899.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.90 0 . Met rics
Name
T ype
Descript io n
Int ernal Name
Id
Paus e d
trait
trait
id
paus e d
Te mporary
trait
The id of the que ue .
Whe the r the que ue
is paus e d.
Whe the r the que ue
is te mporary.
te mporary
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.90 1.
Name
Descript io n
Required
Int ernal Name
Durable
De fine s whe the r the
que ue is durable .
The de fault value is
true .
A que ue me s s age
filte r de finition. An
unde fine d or e mpty
filte r will match all
me s s age s .
The que ue addre s s
de fine s what
addre s s is us e d for
routing me s s age s .
no
durable
no
filte r
ye s
que ue -addre s s
Filte r
Que ue Addre s s
787
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.90 2. Met rics
Name
Descript io n
Change Me s s age Priority
Change the priority of the me s s age
corre s ponding to the give n me s s age -id.
Re turns true if the me s s age was e xpire d,
fals e othe rwis e .
Change the priority of the me s s age s
corre s ponding to the give n filte r.
Re turns the numbe r of the me s s age s in
the que ue matching the give n filte r.
Expire the me s s age corre s ponding to the
give n me s s age -id. Re turns true if the
me s s age was e xpire d, fals e othe rwis e .
Expire the me s s age s matching the give n
filte r.
A s tring in JSON format.
Lis t the me s s age counte r as a s tring in
HTML format.
Lis t the me s s age counte r as a s tring in
JSON format.
Lis t the me s s age counte r his tory.
Lis t the me s s age counte r his tory as a
s tring in JSON format.
Lis t all me s s age s in the que ue that match
the filte r
Lis t all me s s age s in the que ue that match
the filte r and re turn the m as a s tring in
JSON format.
Lis t the me s s age s s che dule d for de live ry.
Lis t the me s s age s s che dule d for de live ry
as a s tring in JSON format.
Move the me s s age corre s ponding to the
give n me s s age -id to anothe r que ue
Move the me s s age s corre s ponding to the
give n filte r to anothe r que ue .
Paus e the que ue .
Re move the me s s age corre s ponding to the
give n me s s age -id.
Re move me s s age s matching the give n
filte r from the de s tination.
Re s e t the me s s age counte rs .
Re s ume the que ue .
Change Me s s age s Priority
Count Me s s age s
Expire Me s s age
Expire Me s s age s
Lis t Cons ume rs as JSON
Lis t Me s s age Counte r as HTML
Lis t Me s s age Counte r as JSON
Lis t Me s s age Counte r His tory as HTML
Lis t Me s s age Counte r His tory as JSON
Lis t Me s s age s
Lis t Me s s age s as JSON
Lis t Sche dule d Me s s age s
Lis t Sche dule d Me s s age s as JSON
Move Me s s age
Move Me s s age s
Paus e
Re move Me s s age
Re move Me s s age s
Re s e t Me s s age Counte r
Re s ume
788
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Se nd Me s s age to De ad Le tte r Addre s s
Se nd the me s s age corre s ponding to the
give n me s s age -id to this que ue 's De ad
Le tte r Addre s s .
Se nd the me s s age s corre s ponding to the
give n filte r to this que ue 's De ad Le tte r
Addre s s .
Se nd Me s s age s to De ad Le tte r Addre s s
Package T ypes
none
3.3.31.1.16. JBo ss AS 7 and EAP 6 - Co re Address Service
Overview
T able 3.90 3. Overview
De s cription:
A runtime -only re s ource re pre s e nting a
Horne tQ addre s s . Ze ro or more que ue s
can be bound to a s ingle addre s s . Whe n a
me s s age is route d, it is route d to the s e t
of que ue s bound to the me s s age 's
addre s s .
no
JBos s AS7
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.90 4.
Name
Descript io n
Path
Include Runtime
Required
Int ernal Name
ye s
ye s
path
include Runtime
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.90 5.
789
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Binding Name s
The name s of all
bindings (both
que ue s and dive rts )
bound to this
addre s s .
The numbe r of
byte s us e d by e ach
page for this
addre s s .
The numbe r of
page s us e d by this
addre s s .
The name s of the
que ue s as s ociate d
with the addre s s .
A lis t of the s e curity
role s (name and
pe rmis s ions )
as s ociate d with the
addre s s .
ye s
binding-name s
ye s
numbe r-of-byte s pe r-page
ye s
numbe r-of-page s
ye s
que ue -name s
ye s
role s
Numbe r Of Byte s
Pe r Page
Numbe r Of Page s
Que ue Name s
Role s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.17. JBo ss AS 7 and EAP 6 - Clust er Co nnect io n Service
Overview
T able 3.90 6. Overview
De s cription:
Single ton:
Plugin:
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.90 7.
790
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.90 8. Met rics
Name
T ype
Descript io n
Int ernal Name
Node Id
trait
node -id
Starte d
trait
The node ID us e d by
this clus te r
conne ction.
Whe the r the clus te r
conne ction is
s tarte d.
s tarte d
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.90 9.
Name
Descript io n
Required
Int ernal Name
Call Time out
The time out (in ms )
for re mote calls
made by the clus te r
conne ction. The
de fault value is
30000.
The pe riod (in
millis e conds )
be twe e n clie nt
failure che ck. The
de fault value is
30000.
Each clus te r
conne ction only
applie s to
me s s age s s e nt to
an addre s s that
s tarts with this
value .
no
call-time out
no
che ck-pe riod
ye s
clus te r-conne ctionaddre s s
Che ck Pe riod
Clus te r Conne ction
Addre s s
791
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Confirmation Window The confirmationSiz e
window-s iz e to us e
for the conne ction
us e d to forward
me s s age s to a
targe t node . The
de fault value is
1048576.
Conne ction Ttl
The maximum time
(in millis e conds ) for
which the
conne ctions us e d by
the clus te r
conne ctions are
cons ide re d alive (in
the abs e nce of
he artbe at). The
de fault value is
60000.
Conne ctor Re f
The confirmationwindow-s iz e to us e
for the conne ction
us e d to forward
me s s age s to a
targe t node .
Dis cove ry Group
The dis cove ry group
Name
us e d to obtain the
lis t of othe r s e rve rs
in the clus te r to
which this clus te r
conne ction will make
conne ctions . Mus t be
unde fine d (null) if
's tatic-conne ctors ' is
de fine d.
792
Required
Int ernal Name
no
confirmation-windows iz e
no
conne ction-ttl
ye s
conne ctor-re f
no
dis cove ry-groupname
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Forward Whe n No
Cons ume rs
Whe the r me s s age s
will be dis tribute d
round robin be twe e n
othe r node s of the
clus te r irre s pe ctive
of whe the r the re
are matching or
inde e d any
cons ume rs on othe r
node s . If this is s e t
to fals e (the de fault)
the n Horne tQ will
only forward
me s s age s to othe r
node s of the clus te r
if the addre s s to
which the y are be ing
forwarde d has
que ue s which have
cons ume rs , and if
thos e cons ume rs
have me s s age
filte rs (s e le ctors ) at
le as t one of thos e
s e le ctors mus t
match the me s s age .
The de fault value is
fals e .
The maximum
numbe r of time s a
me s s age can be
forwarde d. Horne tQ
can be configure d to
als o load balance
me s s age s to node s
which might be
conne cte d to it only
indire ctly with othe r
Horne tQ s e rve rs as
inte rme diate s in a
chain. The de fault
value is 1.
The maximum
inte rval of time us e d
to re try conne ctions .
The de fault value is
2000.
The minimum s iz e
(in byte s ) for a
me s s age be fore it
is cons ide re d as a
large me s s age . The
de fault value is
102400.
no
forward-whe n-nocons ume rs
no
max-hops
no
max-re try-inte rval
no
min-large -me s s age s iz e
Max Hops
Max Re try Inte rval
Min Large Me s s age
Siz e
793
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Re conne ct Atte mpts
The total numbe r of
re conne ct atte mpts
the bridge will make
be fore giving up and
s hutting down. A
value of -1 s ignifie s
an unlimite d numbe r
of atte mpts . The
de fault value is -1.
The pe riod in
millis e conds
be twe e n
s ubs e que nt
re conne ction
atte mpts , if the
conne ction to the
targe t s e rve r has
faile d. The de fault
value is 500.
A multiplie r to apply
to the time s ince the
las t re try to
compute the time to
the ne xt re try. This
allows you to
imple me nt an
e xpone ntial backoff
be twe e n re try
atte mpts . The
de fault value is 1.0.
The s tatically
de fine d lis t of
conne ctors to which
this clus te r
conne ction will make
conne ctions . Mus t be
unde fine d (null) if
'dis cove ry-groupname ' is de fine d.
Whe the r the bridge
will automatically
ins e rt a duplicate id
prope rty into e ach
me s s age that it
forwards . The
de fault value is true .
no
re conne ct-atte mpts
no
re try-inte rval
no
re try-inte rvalmultiplie r
no
s taticconne ctors :nullable
no
us e -duplicate de te ction
Re try Inte rval
Re try Inte rval
Multiplie r
Static Conne ctors
Us e Duplicate
De te ction
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
794
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Operat io ns
T able 3.910 . Met rics
Name
Descript io n
Ge t Node s
Re turns a map of the node s conne cte d to
this clus te r conne ction, whe re ke ys are
node IDs and value s are the addre s s e s
us e d to conne ct to the node s .
Starts the clus te r conne ction.
Stops the clus te r conne ction.
Start
Stop
Package T ypes
none
3.3.31.1.18. JBo ss AS 7 and EAP 6 - Bro adcast Gro up Service
Overview
T able 3.911. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.912.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.913. Met rics
Name
T ype
Descript io n
Int ernal Name
Starte d
trait
Whe the r the
broadcas t group is
s tarte d.
s tarte d
795
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.914.
Name
Descript io n
Required
Int ernal Name
Broadcas t Pe riod
The pe riod in
millis e conds
be twe e n
cons e cutive
broadcas ts . The
de fault value is
2000.
Spe cifie s the name s
of conne ctors that
will be broadcas t.
The broadcas t group
s ocke t binding.
no
broadcas t-pe riod
no
conne ctors
ye s
s ocke t-binding
Conne ctors
Socke t Binding
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.915. Met rics
Name
Descript io n
Ge t Conne ctor Pairs as JSON
Re turns the pairs of live -backup conne ctors
that are broadcas te d by this broadcas t
group us ing JSON s e rializ ation.
Starts the broadcas t group.
Stops the broadcas t group.
Start
Stop
Package T ypes
none
3.3.31.1.19. JBo ss AS 7 and EAP 6 - Pat h Service
Overview
T able 3.916. Overview
796
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.917.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.918.
Name
Descript io n
Required
Int ernal Name
797
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Path
The actual
file s ys te m path.
Tre ate d as an
abs olute path,
unle s s the 're lative to' attribute is
s pe cifie d, in which
cas e the value is
tre ate d as re lative
to that path. If
tre ate d as an
abs olute path, the
actual runtime
pathname s pe cifie d
by the value of this
attribute will be
de te rmine d as
follows : If this value
is alre ady abs olute ,
the n the value is
dire ctly us e d.
Othe rwis e the
runtime pathname is
re s olve d in a
s ys te m-de pe nde nt
way. On UNIX
s ys te ms , a re lative
pathname is made
abs olute by
re s olving it agains t
the curre nt us e r
dire ctory. On
Micros oft Windows
s ys te ms , a re lative
pathname is made
abs olute by
re s olving it agains t
the curre nt dire ctory
of the drive name d
by the pathname , if
any; if not, it is
re s olve d agains t the
curre nt us e r
dire ctory.
The name of
anothe r pre vious ly
name d path, or of
one of the s tandard
paths provide d by
the s ys te m. If
're lative -to' is
provide d, the value
of the 'path' attribute
is tre ate d as
re lative to the path
ye s
path
no
re lative -to
Re lative To
798
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
s
pe cifie d io
bynthis
Descript
attribute . The
s tandard paths
provide d by the
s ys te m include :
Required
Int ernal Name
ye s
__name
jbos s .home - the
root dire ctory of
the JBos s AS
dis tribution
us e r.home us e r's home
dire ctory
us e r.dir - us e r's
curre nt working
dire ctory
java.home - java
ins tallation
dire ctory
jbos s .s e rve r.bas
e .dir - root
dire ctory for an
individual s e rve r
ins tance
jbos s .s e rve r.data.
dir - dire ctory the
s e rve r will us e
for pe rs is te nt
data file s torage
jbos s .s e rve r.log.d
ir - dire ctory the
s e rve r will us e
for log file
s torage
jbos s .s e rve r.tmp.
dir - dire ctory the
s e rve r will us e
for te mporary file
s torage
jbos s .domain.s e r
ve rs .dir dire ctory unde r
which a hos t
controlle r will
cre ate the
working are a for
individual s e rve r
ins tance s
Path Type
Path Type
799
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.20 . JBo ss AS 7 and EAP 6 - Bridge Service
Overview
T able 3.919. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.920 .
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.921. Met rics
Name
T ype
Descript io n
Int ernal Name
Starte d
trait
Whe the r the bridge
is s tarte d.
s tarte d
800
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Co nf igurat io n Pro pert ies
T able 3.922.
Name
Che ck Pe riod
Descript io n
The pe riod (in
millis e conds )
be twe e n clie nt
failure che ck. The
de fault value is
30000.
Confirmation Window The confirmationSiz e
window-s iz e to us e
for the conne ction
us e d to forward
me s s age s to the
targe t node . The
de fault value is
1048576.
Conne ction Ttl
The maximum time
(in millis e conds ) for
which the
conne ctions us e d by
the bridge s are
cons ide re d alive (in
the abs e nce of
he artbe at). The
de fault value is
60000.
Dis cove ry Group
The name of the
Name
dis cove ry group
us e d by this bridge .
Mus t be unde fine d
(null) if 's taticconne ctors ' is
de fine d.
Failove r On Se rve r
Whe the r the bridge
Shutdown
will atte mpt to
failove r onto a
backup s e rve r (if
s pe cifie d) whe n the
targe t s e rve r is
cle anly s hutdown
rathe r than cras he d.
Required
Int ernal Name
no
che ck-pe riod
no
confirmation-windows iz e
no
conne ction-ttl
no
dis cove ry-groupname
no
failove r-on-s e rve rs hutdown
801
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Filte r
An optional filte r
s tring. If s pe cifie d
the n only me s s age s
which match the
filte r e xpre s s ion
s pe cifie d will be
forwarde d. The filte r
s tring follows the
Horne tQ filte r
e xpre s s ion s yntax
de s cribe d in the
Horne tQ
docume ntation.
The addre s s on the
targe t s e rve r that
the me s s age will be
forwarde d to. If a
forwarding addre s s
is not s pe cifie d the n
the original
de s tination of the
me s s age will be
re taine d.
Whe the r or not this
bridge s hould
s upport high
availability. True
me ans it will conne ct
to any available
s e rve r in a clus te r
and s upport failove r.
The de fault value is
fals e .
The maximum
inte rval of time us e d
to re try conne ctions .
The de fault value is
2000.
The minimum s iz e
(in byte s ) for a
me s s age be fore it
is cons ide re d as a
large me s s age . The
de fault value is
102400.
no
filte r
no
forwarding-addre s s
no
ha
no
max-re try-inte rval
no
min-large -me s s age s iz e
Forwarding Addre s s
Ha
Max Re try Inte rval
Min Large Me s s age
Siz e
802
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Pas s word
The pas s word to
us e whe n cre ating
the bridge
conne ction to the
re mote s e rve r. If it
is not s pe cifie d the
de fault clus te r
pas s word s pe cifie d
by the clus te rpas s word attribute
in the root
me s s aging
s ubs ys te m re s ource
will be us e d. The
de fault value is
CHANGE ME!!.
The unique name of
the local que ue that
the bridge
cons ume s from.
The total numbe r of
re conne ct atte mpts
the bridge will make
be fore giving up and
s hutting down. A
value of -1 s ignifie s
an unlimite d numbe r
of atte mpts . The
de fault value is -1.
The pe riod in
millis e conds
be twe e n
s ubs e que nt
re conne ction
atte mpts , if the
conne ction to the
targe t s e rve r has
faile d. The de fault
value is 2000.
A multiplie r to apply
to the time s ince the
las t re try to
compute the time to
the ne xt re try. This
allows you to
imple me nt an
e xpone ntial backoff
be twe e n re try
atte mpts . The
de fault value is 1.0.
no
pas s word
ye s
que ue -name
no
re conne ct-atte mpts
no
re try-inte rval
no
re try-inte rvalmultiplie r
Que ue Name
Re conne ct Atte mpts
Re try Inte rval
Re try Inte rval
Multiplie r
803
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Static Conne ctors
A lis t of name s of
s tatically de fine d
conne ctors us e d by
this bridge . Mus t be
unde fine d (null) if
'dis cove ry-groupname ' is de fine d.
The name of a us e rde fine d clas s which
imple me nts the
org.horne tq.core .s e r
ve r.clus te r.Trans for
me r inte rface .
Whe the r the bridge
will automatically
ins e rt a duplicate id
prope rty into e ach
me s s age that it
forwards . The
de fault value is true .
The us e r name to
us e whe n cre ating
the bridge
conne ction to the
re mote s e rve r. If it
is not s pe cifie d the
de fault clus te r us e r
s pe cifie d by the
clus te r-us e r
attribute in the root
me s s aging
s ubs ys te m re s ource
will be us e d. The
de fault value is
HORNETQ.CLUSTER.A
DMIN.USER.
no
s taticconne ctors :nullable
no
trans forme r-clas s name
no
us e -duplicate de te ction
no
us e r
Trans forme r Clas s
Name
Us e Duplicate
De te ction
Us e r
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
T able 3.923. Met rics
Name
Descript io n
Start
Stop
Starts the bridge .
Stops the bridge .
Package T ypes
804
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
none
3.3.31.1.21. JBo ss AS 7 and EAP 6 - Disco very Gro up Service
Overview
T able 3.924. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
none
Co nnect io n Pro pert ies
T able 3.925.
Name
Descript io n
Path
Required
Int ernal Name
ye s
path
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.926.
Name
Descript io n
Required
Initial Wait Time out
Pe riod, in ms , to wait no
for an initial
broadcas t to give us
at le as t one node in
the clus te r. The
de fault value is
10000.
Int ernal Name
initial-wait-time out
805
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Re fre s h Time out
Pe riod the dis cove ry
group waits afte r
re ce iving the las t
broadcas t from a
particular s e rve r
be fore re moving
that s e rve r's
conne ctor pair e ntry
from its lis t. The
de fault value is
10000.
The dis cove ry group
s ocke t binding.
no
re fre s h-time out
ye s
s ocke t-binding
Socke t Binding
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.22. JBo ss AS 7 and EAP 6 - Co nnect o r Service
Overview
T able 3.927. Overview
De s cription:
Single ton:
Plugin:
no
JBos s AS7
Child Reso urce T ypes
Se ction 3.3.31.1.22.1, “JBos s AS 7 and EAP 6 - Param Se rvice ”
Co nnect io n Pro pert ies
T able 3.928.
Name
Path
806
Descript io n
Required
Int ernal Name
ye s
path
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
none
Co nf igurat io n Pro pert ies
T able 3.929.
Name
Descript io n
Required
Int ernal Name
Factory Clas s
Clas s name of the
factory clas s that
can ins tantiate the
conne ctor s e rvice .
ye s
factory-clas s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Operat io ns
none
Package T ypes
none
3.3.31.1.22.1. JBo ss AS 7 and EAP 6 - Param Service
Ove rvie w
T able 3.930 . Overview
De s cription:
Single ton:
Plugin:
Child Re s ource Type s
no
JBos s AS7
none
Conne ction Prope rtie s
T able 3.931.
Name
Path
Descript io n
Required
Int ernal Name
ye s
path
807
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Me trics
none
Configuration Prope rtie s
T able 3.932.
Name
Descript io n
Required
Int ernal Name
Value
The parame te r
value
ye s
value
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Ope rations
none
Package Type s
none
3.4. JBoss AS 7 and EAP 6 - Host Cont roller Server
Overview
T able 3.933. Overview
De s cription:
Single ton:
Plugin:
808
Domain controlle r (de le gate ) for this hos t
no
JBos s AS7
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
No te
The s e rve r can be s tarte d, re s tarte d, or s toppe d via the Start, Re s tart, and
Shutdown ope rations . The Start and Re s tart ope rations s tart the s e rve r by
e xe cuting the s e rve r s tart s cript, typically domain.s h on UNIX or domain.bat on
Windows . The following conne ction s e ttings can be us e d to configure the s tart s cript
e xe cution: * Start Script - the abs olute path of the s tart s cript (e .g. "/opt/jbos s -as 7.1.1.Final/bin/domain.s h") * Start Script Pre fix - a pre fix command line to be
pre pe nde d to the s tart s cript command line (e .g. "nohup s udo -u jbos s -g jbos s ") *
Start Script Argume nts - argume nts to be pas s e d to the s tart s cript (e .g. "--hos tconfig=hos t-mas te r.xml") * Start Script Environme nt - e nvironme nt variable s to be
s e t in the s tart s cript's e nvironme nt (e .g. "JAVA_HOME=/us r/java/jdk1.6.0_30") The s e
s e ttings are automatically initializ e d by the JBos s AS7 plugin dis cove ry code to match
the curre ntly running s e rve r proce s s ' command line and e nvironme nt. The s e ttings
are not us e d by the Stop ope ration, s ince it s tops the s e rve r via the manage me nt
inte rface , not via a s cript. For more de taile d de s criptions of the s e ttings , s e e the
Conne ction Se ttings s e ction be low.
Child Resource T ypes
Se ction 3.4.1, “JBos s AS 7 and EAP 6 - Se rve rGroup Se rvice ”
Se ction 3.4.2, “JBos s AS 7 and EAP 6 - Hos t Se rvice ”
Se ction 3.4.3, “JBos s AS 7 and EAP 6 - DomainDe ployme nt Se rvice ”
Se ction 3.4.4, “JBos s AS 7 and EAP 6 - Manage d Se rve r”
Se ction 3.4.5, “JBos s AS 7 and EAP 6 - Profile Se rvice ”
Se ction 3.4.6, “JBos s AS 7 and EAP 6 - Ne twork Inte rface Se rvice ”
Se ction 3.4.7, “JBos s AS 7 and EAP 6 - Socke tBindingGroup Se rvice ”
Aut odiscovery Process Scans
T able 3.934. Met rics
Name
Query
Hos tControlle r
proce s s |bas e name |match=^java.*,arg|org.j
bos s .as .hos t-controlle r|match=.*
Connect ion Propert ies
T able 3.935.
Name
Descript io n
Required
Int ernal Name
809
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Start Script Path
The path to the
no
s cript that the Start
and Re s tart
ope rations s hould
us e to s tart the
s e rve r. If the path is
not abs olute , it is
re s olve d re lative to
the s e rve r home
dire ctory (e .g.
"bin/s tandalone .s h",
"bin/domain.s h").
A pre fix command
no
line that s hould be
pre pe nde d to the
s tart s cript
command line by the
Start and Re s tart
ope rations ; the
pre fix command
mus t be an abs olute
path (e .g.
"/us r/bin/s udo"). This
prope rty is mos t
commonly us e d to
run the AS7 proce s s
as a diffe re nt us e r
than the RHQ Age nt
(e .g. "s udo -u jbos s g jbos s " could be
us e d to run AS7 as
us e r "jbos s " and
group "jbos s ". It is
als o pos s ible to
chain pre fix
commands (e .g.
"nohup s udo -u
jbos s " could be us e d
to make AS7 ignore
HUP s ignals and to
run as us e r "jbos s ").
Start Script Pre fix
810
Required
Int ernal Name
s tartScript
s tartScriptPre fix
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Start Script
Environme nt
Variable s
The variable s that
no
the Start and Re s tart
ope rations will add
to the e nvironme nt
of the s e rve r s tart
s cript. Each
name =value pair
s hould be on a ne w
line . Variable value s
s hould *not* be
e nclos e d in quote s
(e .g. JAVA_OPTS=Xms 512M Xmx1024M). On UNIX
s ys te ms , the typical
minimum s e t of
e nvironme nt
variable s is :
PATH=/us r/bin:/bin .
And on Windows the
typical minimum s e t
is :
PATH=C:\Windows \S
ys te m32;C:\Windows
, OS=Windows _NT ,
SYSTEMROOT=C:\Wi
ndows . In addition, it
is good practice to
s e t JAVA_HOME to
the abs olute path of
the ins tall dire ctory
of the JRE or JDK you
wis h to us e to run
the AS7 ins tance .
Howe ve r, if
JAVA_HOME is not
s pe cifie d, the s tart
s cript will atte mpt to
find java in the
PATH. The re is
curre ntly a 2000
characte r limit for
this value .
Int ernal Name
s tartScriptEnv
811
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Start Script
Argume nts
The argume nts that
no
the Start and Re s tart
ope rations will pas s
to the s e rve r s tart
s cript. Each
argume nt s hould be
on a ne w line - for
e xample : --s e rve rconfig=s tandalone ha-full.xml. As an
e xce ption, the value
of a s pace -de limite d
option can optionally
be on the s ame line
as the option - for
e xample : -c
s tandalone -hafull.xml. The re is
curre ntly a 2000
characte r limit for
this value .
Native manage me nt ye s
API hos t
Native manage me nt ye s
API port
ye s
De fine s the trus t
ye s
s trate gy to us e
whe n re ading the
s e rve r ce rtificate :
Native Hos t
Native Port
Log Eve nt Source s
Trus t Strate gy
Standard:
s tandard
ve rification us ing
a trus ts tore
Trus t Se lf-s igne d:
trus t s e lf-s igne d
ce rtificate s
(ce rtification chain
s iz e e quals to 1)
Trus t Any: trus t
any s e rve r
ce rtificate
812
Required
Int ernal Name
s tartScriptArgs
native Hos t
native Port
logEve ntSource s
trus tStrate gy
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Hos tname
Ve rification
De fine s the
hos tname
ve rification logic:
ye s
hos tname Ve rification
no
trus ts tore
no
trus ts tore Type
no
trus ts tore Pas s word
ye s
no
clie ntce rtAuthe nticati
on
ke ys tore
no
ke ys tore Type
Strict: The
hos tname mus t
match e ithe r the
firs t CN, or any of
the Subje ct
Alte rnative s . A
wildcard can
occur in the CN,
and in any of the
Subje ct
Alte rnative s .
Brows e rcompatible : s ame
as Strict, e xce pt
that it allows
ne s te d
s ubdomains
validation with
wildcards .
Skip: no
hos tname
ve rification
Trus ts tore
Path to a trus ts tore
file . If unde fine d, the
JVM de fault
trus ts tore is us e d.
Trus ts tore Type
Trus ts tore file
format (re quire d
whe n the Truststore
prope rty is s e t). All
ce rtifie d JVMs
s upport jks (Java
Ke yStore ) or pkcs12
formats .
Trus ts tore Pas s word Pas s word prote cting
the trus ts tore file .
Clie nt Ce rtificate
Authe ntication
Ke ys tore
Path to a ke ys tore
file . Re quire d whe n
Client Certificate
Authentication is on.
Ke ys tore Type
Ke ys tore file format
(re quire d whe n the
Keystore prope rty is
s e t). All ce rtifie d
JVMs s upport jks
(Java Ke yStore ) or
pkcs12 formats .
813
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
Descript io n
Required
Int ernal Name
Ke ys tore Pas s word
Pas s word prote cting
the ke ys tore file .
Pas s word prote cting
the s e cre t ke y in
the ke ys tore file .
Hos t name of the
domain API
Port of the domain
API
Encrypte d trans port
indicator
Manage me nt us e r
for a s e cure d Hos t
controlle r
Pas s word for the
manage me nt us e r
Maximum time in
millis e conds to ke e p
alive an idle
manage me nt
conne ction. Ze ro and
ne gative value s will
dis able conne ction
pe rs is te nce .
De faults to 5000
ms .
Root dire ctory of the
s e rve r ins tallation
Bas e dire ctory for
s e rve r conte nt
Bas e configuration
dire ctory
the dire ctory whe re
log file s will be
writte n for this hos t
controlle r
Hos t name within
the AS7 domain
(De pre cate d, us e
'name ' trait)
Se rve r product type
(e .g. AS or EAP)
no
ke ys tore Pas s word
no
ke yPas s word
ye s
hos tname
ye s
port
ye s
s e cure
no
us e r
no
pas s word
no
manage me ntConne c
tionTime out
no
home Dir
no
bas e Dir
no
configDir
no
logDir
no
domainHos t
no
productType
Ke y Pas s word
Hos tname
Port
Se cure
Us e r
Pas s word
Manage me nt
Conne ction Time out
Home Dire ctory
Bas e Dire ctory
Configuration
Dire ctory
Log Dire ctory
Domain Hos t
Product Type
814
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Supports Patching
Whe the r this EAP
ye s
s e rve r s upports
patching. This s hould
be automatically
de duce d by the
age nt. It is highly
re comme nde d to
le ave this with the
dis cove re d value .
Howe ve r, you will
ne e d to manually
update this value if
you manually
upgrade your s e rve r
from a ve rs ion that
doe s not s upport
patching to a ve rs ion
that doe s .
Int ernal Name
s upports Patching
No te
You mus t us e the inte rnal name to re fe re nce Configuration Prope rtie s in Dynamic
Group De finition e xpre s s ions .
Met rics
T able 3.936. Met rics
Name
T ype
Descript io n
Int ernal Name
Numbe r of
manage me nt
re que s ts
Numbe r of
manage me nt
re que s ts pe r Minute
Time us e d for
manage me nt
re que s ts
Time us e d for
manage me nt
re que s ts pe r Minute
Maximum re que s t
time
me as ure me nt
Numbe r of re que s ts _inte rnal:mgmtRe que
s e nt to the controlle r s ts
me as ure me nt
Numbe r of re que s ts _inte rnal:mgmtRe que
s e nt to the controlle r s ts
me as ure me nt
Total time for
re que s ts
_inte rnal:re que s tTim
e
me as ure me nt
Total time for
re que s ts
_inte rnal:re que s tTim
e
me as ure me nt
_inte rnal:maxTime
Se rve r Code Name
trait
Max time for a
re que s t s ince las t
me tric ge t
Se rve r Code Name
Se rve r Ve rs ion
trait
Se rve r Ve rs ion
Product Name
trait
Product Name
_s km:re le as e code name
_s km:re le as e ve rs ion
_s km:product-name
815
Co mple t e Re s o ur c e Re f e r e nc e f o r Me t r ic s , O pe r at io ns , and Co nf igur at io n Pr o pe r t ie s
Name
T ype
Descript io n
Int ernal Name
Product Ve rs ion
trait
Product Ve rs ion
Start time of the
s e rve r
Domain Config File
trait
Hos t Config File
trait
Domain Hos t Name
trait
Domain Name
trait
Te mporary
Dire ctory
trait
Active Patche s
trait
Start time of the
s e rve r
The name of the
domain configuration
file this hos t
controlle r is us ing
The name of the
hos t configuration
file this hos t
controlle r is us ing
The name of the
hos t in domain this
hos t controlle r is
us ing
The name of the
manage d domain
this Hos t Controlle r
be longs to.
The te mporary
dire ctory (us ually
'domain/tmp'). May
s e rve as
de ployme nt
dire ctory for
handove r bundle s '
The commas e parate d lis t of
patche s that are
curre ntly applie d to
the s e rve r. The firs t
e ntry is always the
cumulative patch,
followe d by 0 or
more one -off
patche s .
_s km:productve rs ion
s tartTime
trait
domain-config-file
hos t-config-file
domain-hos t-name
domain-name
domain-te mp-dir
active -patche s
No te
You mus t us e the inte rnal name to re fe re nce Traits in Dynamic Group De finition
e xpre s s ions .
Conf igurat ion Propert ies
T able 3.937.
Name
Prope rtie s
816
Descript io n
Required
Int ernal Name
no
*2
⁠C hapt e r 3. Ent e r pr is e Applic at io n Plat f o r m Re s o ur c e s
Name
Descript io n
Required
Int ernal Name
Path
The