User Documentation

One Minute Introduction

Two Minute Introduction

Your own plugin

Coffee Break Introduction

Property substitution

FAQ

IDE Integration

Doclipse

Maven Integration

Maven2 Plugin

Maven1 Plugin

Plugins

Project Information

Mailing lists

Source Repositories

Open Issues

Team

Developer Documentation

Feeds
Print
JmxTags

@jmx tags

@jmx.managed-attribute

Defines a jmx managed attribute. This method will be included in a

standard mbean interface and an attribute based on its name will be

included as a managed atribute in xmbean metadata. This must be included

on any getter or setter you want exposed in a standard mbean. For xmbeans,

the methods with these tags will be identified as the getMethod and setMethod

for the attribute.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
access false read-only, write-only, read-write   no   Specifies the access to the managed-attribute: read-only, write-only or read-write.
description false Any value   no   Specifies a description for the managed attribute that can be used in mbean infos.
persist-policy false OnUpdate, NoMoreOftenThan, Never, OnTimer   no   Specifies the persistence policy for this mbean
persist-period false Any value   no   Specifies when the mbean state will be saved.
persist-location false Any value   no   Specifies the location for the mbean's state to be saved.
persist-name false Any value   no   Specifies the name to identify the mbeans saved state with.
currency-time-limit false Any value   no   Specifies how long the mbeans state may be considered valid.
state-action-on-update false Any value   no   Specifies what the jboss state management should do when an attribute is updated

on a started mbean. (jboss specific).
value false Any value   no   Specifies the (initial) value for the managed attribute. This is

used in the jboss *-service.xml file and the xmbean descriptor.

In both cases the result is the value is set as the initial value

of the newly deployed mbean.
descriptor false Any value   no   Specifies an additional custom descriptor for the mbean that can be used in mbean infos.

This should be of the form name="name" value="value". To make this work as an xdoclet

parameter, you need to escape the double quotes: descriptor="name=\"name\" value=\"value\""

@jmx.managed-constructor

Defines a jmx managed constructor.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
description false Any value   no   Specifies a description for the constructor.
servicefile false Any value   no   If we are generating a JBoss *-service.xml file, if the * matches the parameter value this constructor will be used with the managed-parameter values provided.

@jmx.managed-operation

Defines a jmx managed operation. This method will be included in a

standard mbean interface and marked as a managed operation in xmbean metadata.

jmx.managed-parameter tags must be used to describe the parameters.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
impact false ACTION, INFO, ACTION_INFO   no   Specifies the impact of the operation.
description false Any value   no   Specifies a description for the managed operation that can be used in mbean infos.

@jmx.managed-parameter

Defines an argument for a managed operation or managed constructor.

NOTE: this tag is somewhat defective in that some of the info (type) can be

determined automatically and there is no check that the number of parameters

or their types specified actually match the method. You should expect the

usage of this tag to change without notice.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   Specifies a name for the operation or constructor argument. This can be different from the name used in java code.
description false Any value   no   Specifies a description for the operation or constructor argument.
type true Any value   no   The type of the argument. This should be determined from the method signature.
value false Any value   no   A string representation of the value for the managed argument. Only useful for constructor arguments.

@jmx.mbean

The jmx.mbean tag identifies the class as an mbean. It can be used to

generate the interface for a standard mbean and the jboss specific

xmbean xml descriptor and service.xml file format.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
extends false Any value   no   Specifies the superclass for the standard mbean interface.
name false Any value   no   Specifies the object name for mlet or it can be used as a default in an extension template.
description false Any value   no   Specifies a description for the mbean that can be used in mbean infos.
persist-policy false OnUpdate, NoMoreOftenThan, Never, OnTimer   no   Specifies the persistence policy for this mbean
persist-period false Any value   no   Specifies when the mbean state will be saved.
persist-location false Any value   no   Specifies the location for the mbean's state to be saved.
persist-name false Any value   no   Specifies the name to identify the mbeans saved state with.
persistence-manager false Any value   no   Specifies the fully qualified class name of a persistence manager for this mbean (JBoss specific).
currency-time-limit false Any value   no   Specifies how long the mbeans state may be considered valid.
state-action-on-update false Any value   no   Specifies what the jboss state management should do when an attribute is updated

on a started mbean. (jboss specific).
descriptor false Any value   no   Specifies an additional custom descriptor for the mbean that can be used in mbean infos.

To make this work as an xdoclet parameter, you need to escape the double quotes:

descriptor="name=\"name\" value=\"value\""

@jmx.mlet-entry

The jmx.mlet-entry tag allows you to specify entries for a generated mlet.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
archive false Any value   no   Specifies the ARCHIVE property for an mlet configuration.
codebase false Any value   no   Specifies the path to the package for the mbean class.

@jmx.notification

Defines a jmx notification.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
description false Any value   no   Specifies the description for the notification.
name true Any value   no   Specifies the name for the notification.
persist-policy false OnUpdate, NoMoreOftenThan, Never, OnTimer   no   Specifies the persistence policy for this mbean
persist-period false Any value   no   Specifies when the mbean state will be saved. Not sure how this applies to notifications.
persist-location false Any value   no   Specifies the location for the mbean's state to be saved. Not sure how this applies to notifications.
persist-name false Any value   no   Specifies the name to identify the mbeans saved state with. Not sure how this applies to notifications.
currency-time-limit false Any value   no   Specifies how long the mbeans state may be considered valid. Not sure how this applies to notifications.
descriptor false Any value   no   Specifies an additional custom descriptor for the mbean that can be used in mbean infos.

This should be of the form name="name" value="value". To make this work as an xdoclet

parameter, you need to escape the double quotes: descriptor="name=\"name\" value=\"value\""
Copyright 2003-2006 - The Codehaus. All rights reserved unless otherwise noted.
Powered by Atlassian Confluence