...
This handler provides JMX management of component instance. It could be useful to manage instance remotely. As the handler exposes MBeans, you must have a MBean server running on your platform (as the platform MBean server or the MOSGi MBean Server).
| Div |
|---|
|
|
| Wiki Markup |
|---|
| {div:class=toc}
{toc:maxLevel=4|minLevel=2}
{div} |
Features
The handler allows to:
...
Global handler attributes
| Div |
|---|
|
Attribute name | Required | Description |
|---|
objectName | NO | The complete object name of the managed component. The syntax of this attribute must be compliant with the ObjectName syntax, detailed in the JMX specification.
If neither domain nor name attributes are specified, the default value is determined by the package, the type and the instance name of the component. This attribute overrides the domain and name attributes.
Example: |
|
| Wiki Markup |
|---|
{div:class=borderedTable}
||Attribute name || Required || Description||
|objectName|NO|The complete object name of the managed component. The syntax of this attribute must be compliant with the ObjectName syntax, detailed in the JMX specification.
If neither domain nor name attributes are specified, the default value is determined by the package, the type and the instance name of the component. This attribute overrides the domain and name attributes.
_Example:_ "my.domain:type=myType,name=myName" |
|
Properties attributes
| Wiki Markup |
|---|
{div:class=borderedTable}
||Attribute name||Required||Description||
|field|YES|The name of the component's field to expose.|
|name|NO|The name of the property as it will appear in JMX. If unspecified, the default value is the name of the exposed field.|
|rights|NO|Specify the access permission of the exposed field. The accepted values are :
* "r" : read-only access, the default value.
* "w" : read and write access.|
|notification|NO|Enable or disable attribute change notification sending for this property. If set to "true", a notification is sent each time the value of the field changes.|
{div} |
Methods attributes
| Div |
|---|
|
Attribute name | Required | Description |
|---|
field | YES | The name of the component's field to expose. | name | NO | The name of the property as it will appear in JMX. If unspecified, the default value is the name of the exposed field. | rights | NO | Specify the access permission of the exposed field. The accepted values are : - "r" : read-only access, the default value.
- "w" : read and write access.
| notification | NO | Enable or disable attribute change notification sending for this property. If set to "true", a notification is sent each time the value of the field changes. |
|
Methods attributes
| Div |
|---|
|
Attribute name | Required | Description |
|---|
name | YES | The name of the method to expose. If multiple methods have the same name, all of them are exposed. | description | NO | The description of the exposed method, as it will appear in JMX. |
|
| Wiki Markup |
|---|
| {div:class=borderedTable}
||Attribute name||Required||Description||
|name|YES|The name of the method to expose. If multiple methods have the same name, all of them are exposed.|
|description|NO|The description of the exposed method, as it will appear in JMX.|
{div} |
Examples
In this part, we will give you a complete example of a component managed with JMX, using the JConsole provided by the SUN JDK.
...
