org.jsesoft.mmbi
Annotation Type JMX

@Documented
@Retention(value=RUNTIME)
@Target(value={TYPE,FIELD,METHOD,CONSTRUCTOR,PARAMETER})
public @interface JMX

Provides additional information for JMX Model MBean Instrumentation.

The information provided for class members with this annotation is used by the ModelMBeanInstrumentor for instrumenting an instance of the class as Model MBean.

This annotation is dedicated to the customiziation of the JMX instrumentation produced by ReflectionInspector with the ModelMBeanInstrumentor. The annotation interface JMX provides accessors for all the fields which can be specified in Model MBean descriptors.

"Fields have two uses. First, field values are used internally by the JMX implementation-- for example, to determine when to retrieve the value of an attribute from the internal cache or when to invoke the getter for that attribute. The second use of Descriptor fields is to provide more information to the agent level or management application about an MBean or one of its features." ^{Java Management Extensions -J.Steven Perry- O'Reilly}

Version:

1.0

Author:

JSESoft

Optional Element Summary

java.lang.String	currencyTimeLimit Provides the number of seconds that the value field of an attribute or the lastReturnedValue field of an operation is valid.
java.lang.String	description Provides a description for the member.
java.lang.String	displayName Provides the display name of the member.
java.lang.String	export Provides the fully qualified class name of an object that is capable of making the MBaean locateable.
java.lang.String	getMethod Provides the name of the method on the managed resource that acts as the getter for the attribute.
boolean	hide Tells whether or not to hide the meber from JMX management.
int	impact Provides the impact of an operation.
java.lang.String	log Tells wether or not to log notifications.
java.lang.String	logFile Provides the full path of the log file.
java.lang.String	managed Provides the class of the managed resource.
java.lang.String	name Provides the name of the managed resource.
java.lang.String	persistPeriod Provides the number of seconds that should elapse before the attribure value is written to oersistent storage.
java.lang.String	persistPolicy Provides a string specifying the persist policy.
java.lang.String	setMethod Provides the name of the method on the managed resource that acts as the setter for the attribute.
int	severity Provides a severity number for notifications.
int	visibility Provides a visibility number for MBeans.
java.lang.String	xml Provides an XML representation of a descriptor's fields.

name

public abstract java.lang.String name

Provides the name of the managed resource.

Applies only to parameters.

Returns:

the name of the managed resource

Default:

""

managed

public abstract java.lang.String managed

Provides the class of the managed resource.

Applies only to operations.

Returns:

the class of the managed resource

Default:

""

currencyTimeLimit

public abstract java.lang.String currencyTimeLimit

Provides the number of seconds that the value field of an attribute or the lastReturnedValue field of an operation is valid.

Applies only to attributes and operations.

Returns:

number of seconds

Default:

"0"

description

public abstract java.lang.String description

Provides a description for the member.

Returns:

the description

Default:

""

displayName

public abstract java.lang.String displayName

Provides the display name of the member.

Returns:

display name

Default:

""

export

public abstract java.lang.String export

Provides the fully qualified class name of an object that is capable of making the MBaean locateable.

Returns:

the export class

Default:

"F"

getMethod

public abstract java.lang.String getMethod

Provides the name of the method on the managed resource that acts as the getter for the attribute.

Applies only to attributes.

Returns:

the getter

See Also:

setMethod()

Default:

""

hide

public abstract boolean hide

Tells whether or not to hide the meber from JMX management.

Returns:

true if member is hidden

Default:

false

impact

public abstract int impact

Provides the impact of an operation.

Applies only to operations.

Returns:

the impact

Default:

3

log

public abstract java.lang.String log

Tells wether or not to log notifications.

Returns:

true if notifications shall be logged

Default:

"F"

logFile

public abstract java.lang.String logFile

Provides the full path of the log file.

Returns:

log file path

Default:

""

persistPeriod

public abstract java.lang.String persistPeriod

Provides the number of seconds that should elapse before the attribure value is written to oersistent storage.

Returns:

String

Default:

"0"

persistPolicy

public abstract java.lang.String persistPolicy

Provides a string specifying the persist policy.

• Never
• OnTimer
• OnUpdate
• NoMoreOftenThan

Returns:

String

Default:

"Never"

setMethod

public abstract java.lang.String setMethod

Provides the name of the method on the managed resource that acts as the setter for the attribute.

Returns:

String method name

See Also:

getMethod()

Default:

""

severity

public abstract int severity

Provides a severity number for notifications.

Returns:

severity

Default:

0

visibility

public abstract int visibility

Provides a visibility number for MBeans.

Returns:

visibility int

Default:

0

xml

public abstract java.lang.String xml

Provides an XML representation of a descriptor's fields.

Returns:

XML string

Default:

""