Builds on the AbstractMBeanInfoAssembler superclass to
add a basic algorithm for building metadata based on the
reflective metadata of the MBean class.
The logic for creating MBean metadata from the reflective metadata
is contained in this class, but this class makes no decisions as to
which methods and properties are to be exposed. Instead it gives
subclasses a chance to 'vote' on each property or method through
the includeXXX methods.
Subclasses are also given the opportunity to populate attribute
and operation metadata with additional descriptors once the metadata
is assembled through the populateXXXDescriptor methods.
public void setDefaultCurrencyTimeLimit(@Nullable
java.lang.Integer defaultCurrencyTimeLimit)
Set the default for the JMX field "currencyTimeLimit".
The default will usually indicate to never cache attribute values.
Default is none, not explicitly setting that field, as recommended by the
JMX 1.2 specification. This should result in "never cache" behavior, always
reading attribute values freshly (which corresponds to a "currencyTimeLimit"
of -1 in JMX 1.2).
However, some JMX implementations (that do not follow the JMX 1.2 spec
in that respect) might require an explicit value to be set here to get
"never cache" behavior: for example, JBoss 3.2.x.
Note that the "currencyTimeLimit" value can also be specified on a
managed attribute or operation. The default value will apply if not
overridden with a "currencyTimeLimit" value >= 0 there:
a metadata "currencyTimeLimit" value of -1 indicates
to use the default; a value of 0 indicates to "always cache"
and will be translated to Integer.MAX_VALUE; a positive
value indicates the number of cache seconds.
Return default value for the JMX field "currencyTimeLimit", if any.
setUseStrictCasing
public void setUseStrictCasing(boolean useStrictCasing)
Set whether to use strict casing for attributes. Enabled by default.
When using strict casing, a JavaBean property with a getter such as
getFoo() translates to an attribute called Foo.
With strict casing disabled, getFoo() would translate to just
foo.
isUseStrictCasing
protected boolean isUseStrictCasing()
Return whether strict casing for attributes is enabled.
setExposeClassDescriptor
public void setExposeClassDescriptor(boolean exposeClassDescriptor)
Set whether to expose the JMX descriptor field "class" for managed operations.
Default is "false", letting the JMX implementation determine the actual class
through reflection.
Set this property to true for JMX implementations that
require the "class" field to be specified, for example WebLogic's.
In that case, Spring will expose the target class name there, in case of
a plain bean instance or a CGLIB proxy. When encountering a JDK dynamic
proxy, the first interface implemented by the proxy will be specified.
WARNING: Review your proxy definitions when exposing a JDK dynamic
proxy through JMX, in particular with this property turned to true:
the specified interface list should start with your management interface in
this case, with all other interfaces following. In general, consider exposing
your target bean directly or a CGLIB proxy for it instead.
Iterate through all properties on the MBean class and gives subclasses
the chance to vote on the inclusion of both the accessor and mutator.
If a particular accessor or mutator is voted for inclusion, the appropriate
metadata is assembled and passed to the subclass for descriptor population.
Iterate through all methods on the MBean class and gives subclasses the chance
to vote on their inclusion. If a particular method corresponds to the accessor
or mutator of an attribute that is included in the management interface, then
the corresponding operation is exposed with the "role" descriptor
field set to the appropriate value.
protected void applyCurrencyTimeLimit(javax.management.Descriptor desc,
int currencyTimeLimit)
Apply the given JMX "currencyTimeLimit" value to the given descriptor.
The default implementation sets a value >0 as-is (as number of cache seconds),
turns a value of 0 into Integer.MAX_VALUE ("always cache")
and sets the "defaultCurrencyTimeLimit" (if any, indicating "never cache") in case of
a value <0. This follows the recommendation in the JMX 1.2 specification.
Parameters:
desc - the JMX attribute or operation descriptor
currencyTimeLimit - the "currencyTimeLimit" value to apply