RequiredModelMBean JDK 1.6)

public void addAttributeChangeNotificationListener (NotificationListener inlistener, String inAttributeName, Object inhandback) throws MBeanException RuntimeOperationsException IllegalArgumentException

public void addNotificationListener (NotificationListener listener, NotificationFilter filter, Object handback) throws IllegalArgumentException

Registers an object which implements the NotificationListener interface as a listener.

public Object getAttribute (String attrName) throws AttributeNotFoundException MBeanException ReflectionException

Returns the value of a specific attribute defined for this ModelMBean.

Returns the value of a specific attribute defined for this ModelMBean. The last value returned by an attribute may be cached in the attribute's descriptor. The valid value will be in the 'value' field if there is one. If the 'currencyTimeLimit' field in the descriptor is:

<0 Then the value is not cached and is never valid. The getter method is invoked for the attribute. The 'value' and 'lastUpdatedTimeStamp' fields are cleared.
=0 Then the value is always cached and always valid. The 'value' field is returned. If there is no'value' field then the getter method is invoked for the attribute. The 'lastUpdatedTimeStamp' field and `value' fields are set to the attribute's value and the current time stamp.
>0 Represents the number of seconds that the 'value' field is valid. The 'value' field is no longer valid when 'lastUpdatedTimeStamp' + 'currencyTimeLimit' > Now.
- When 'value' is valid, 'value' is returned.
- When 'value' is no longer valid then the getter method is invoked for the attribute. The 'lastUpdatedTimeStamp' field and `value' fields are updated.

Note: because of inconsistencies in previous versions of this specification, it is recommended not to use negative or zero values for currencyTimeLimit. To indicate that a cached value is never valid, omit the currencyTimeLimit field. To indicate that it is always valid, use a very large number for this field.

If the 'getMethod' field contains the name of a valid operation descriptor, then the method described by the operation descriptor is executed. The response from the method is returned as the value of the attribute. If the operation fails or the returned value is not compatible with the declared type of the attribute, an exception will be thrown.

If no 'getMethod' field is defined then the default value of the attribute is returned. If the returned value is not compatible with the declared type of the attribute, an exception will be thrown.

The declared type of the attribute is the String returned by MBeanAttributeInfo.getType(). A value is compatible with this type if one of the following is true:

the value is null;
the declared name is a primitive type name (such as "int") and the value is an instance of the corresponding wrapper type (such as java.lang.Integer);
the name of the value's class is identical to the declared name;
the declared name can be loaded by the value's class loader and produces a class to which the value can be assigned.

In this implementation, in every case where the getMethod needs to be called, because the method is invoked through the standard "invoke" method and thus needs operationInfo, an operation must be specified for that getMethod so that the invocation works correctly.

Returns: The value of the retrieved attribute from the descriptor 'value' field or from the invocation of the operation in the 'getMethod' field of the descriptor.
Parameters:
- attrName - A String specifying the name of the attribute to be retrieved. It must match the name of a ModelMBeanAttributeInfo.
Throws:
- AttributeNotFoundException - The specified attribute is not accessible in the MBean. The following cases may result in an AttributeNotFoundException:

No ModelMBeanInfo was found for the Model MBean.
No ModelMBeanAttributeInfo was found for the specified attribute name.
The ModelMBeanAttributeInfo isReadable method returns 'false'.

- MBeanException - Wraps one of the following Exceptions:

{@link InvalidAttributeValueException}: A wrong value type was received from the attribute's getter method or no 'getMethod' field defined in the descriptor for the attribute and no default value exists.
{@link ServiceNotFoundException}: No ModelMBeanOperationInfo defined for the attribute's getter method or no descriptor associated with the ModelMBeanOperationInfo or the managed resource is null.
{@link InvalidTargetObjectTypeException} The 'targetType' field value is not 'objectReference'.
An Exception thrown by the managed object's getter.

- ReflectionException - Wraps an {@link java.lang.Exception} thrown while trying to invoke the getter.
- RuntimeOperationsException - Wraps an {@link IllegalArgumentException}: The attribute name in parameter is null.
See Also: RequiredModelMBean.setAttribute(javax.management.Attribute),

public AttributeList getAttributes (String attrNames)

Returns the values of several attributes in the ModelMBean.

protected ClassLoaderRepository getClassLoaderRepository ()

Return the Class Loader Repository used to perform class loading.

public MBeanInfo getMBeanInfo ()

Returns the attributes, operations, constructors and notifications that this RequiredModelMBean exposes for management.

public MBeanNotificationInfo getNotificationInfo ()

Returns the array of Notifications always generated by the RequiredModelMBean.

public Object invoke (String opName, Object opArgs, String sig) throws MBeanException ReflectionException

Invokes a method on or through a RequiredModelMBean and returns the result of the method execution.

If the given method to be invoked, together with the provided signature, matches one of RequiredModelMbean accessible methods, this one will be call. Otherwise the call to the given method will be tried on the managed resource.

The last value returned by an operation may be cached in the operation's descriptor which is in the ModelMBeanOperationInfo's descriptor. The valid value will be in the 'value' field if there is one. If the 'currencyTimeLimit' field in the descriptor is:

<0 Then the value is not cached and is never valid. The operation method is invoked. The 'value' and 'lastUpdatedTimeStamp' fields are cleared.
=0 Then the value is always cached and always valid. The 'value' field is returned. If there is no 'value' field then the operation method is invoked for the attribute. The 'lastUpdatedTimeStamp' field and `value' fields are set to the operation's return value and the current time stamp.
>0 Represents the number of seconds that the 'value' field is valid. The 'value' field is no longer valid when 'lastUpdatedTimeStamp' + 'currencyTimeLimit' > Now.
- When 'value' is valid, 'value' is returned.
- When 'value' is no longer valid then the operation method is invoked. The 'lastUpdatedTimeStamp' field and `value' fields are updated.

Note: because of inconsistencies in previous versions of this specification, it is recommended not to use negative or zero values for currencyTimeLimit. To indicate that a cached value is never valid, omit the currencyTimeLimit field. To indicate that it is always valid, use a very large number for this field.

Returns: The object returned by the method, which represents the result of invoking the method on the specified managed resource.
Parameters:
- opName - The name of the method to be invoked. The name can be the fully qualified method name including the classname, or just the method name if the classname is defined in the 'class' field of the operation descriptor.
- opArgs - An array containing the parameters to be set when the operation is invoked
- sig - An array containing the signature of the operation. The class objects will be loaded using the same class loader as the one used for loading the MBean on which the operation was invoked.
Throws:
- MBeanException - Wraps one of the following Exceptions:

An Exception thrown by the managed object's invoked method.
{@link ServiceNotFoundException}: No ModelMBeanOperationInfo or no descriptor defined for the specified operation or the managed resource is null.
{@link InvalidTargetObjectTypeException}: The 'targetType' field value is not 'objectReference'.

- ReflectionException - Wraps an {@link java.lang.Exception} thrown while trying to invoke the method.
- RuntimeOperationsException - Wraps an {@link IllegalArgumentException} Method name is null.

public void load () throws MBeanException RuntimeOperationsException InstanceNotFoundException

Instantiates this MBean instance with the data found for the MBean in the persistent store.

public void postDeregister () [Specified in MBeanRegistration]

Allows the MBean to perform any operations needed after having been unregistered in the MBean server.

public void postRegister (Boolean registrationDone) [Specified in MBeanRegistration]

Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.

public void preDeregister () throws Exception [Specified in MBeanRegistration]

Allows the MBean to perform any operations it needs before being unregistered by the MBean server.

public ObjectName preRegister (MBeanServer server, ObjectName name) throws Exception [Specified in MBeanRegistration]

Allows the MBean to perform any operations it needs before being registered in the MBean server.

public void removeAttributeChangeNotificationListener (NotificationListener inlistener, String inAttributeName) throws MBeanException RuntimeOperationsException ListenerNotFoundException

public void removeNotificationListener (NotificationListener listener) throws ListenerNotFoundException

Removes a listener for Notifications from the RequiredModelMBean.

public void removeNotificationListener (NotificationListener listener, NotificationFilter filter, Object handback) throws ListenerNotFoundException [Specified in NotificationEmitter]

public void sendAttributeChangeNotification (Attribute inOldVal, Attribute inNewVal) throws MBeanException RuntimeOperationsException

public void sendAttributeChangeNotification (AttributeChangeNotification ntfyObj) throws MBeanException RuntimeOperationsException

public void sendNotification (Notification ntfyObj) throws MBeanException RuntimeOperationsException

public void sendNotification (String ntfyText) throws MBeanException RuntimeOperationsException

public void setAttribute (Attribute attribute) throws AttributeNotFoundException InvalidAttributeValueException MBeanException ReflectionException

Sets the value of a specific attribute of a named ModelMBean.

Sets the value of a specific attribute of a named ModelMBean. If the 'setMethod' field of the attribute's descriptor contains the name of a valid operation descriptor, then the method described by the operation descriptor is executed. In this implementation, the operation descriptor must be specified correctly and assigned to the modelMBeanInfo so that the 'setMethod' works correctly. The response from the method is set as the value of the attribute in the descriptor.

If currencyTimeLimit is > 0, then the new value for the attribute is cached in the attribute descriptor's 'value' field and the 'lastUpdatedTimeStamp' field is set to the current time stamp.

If the persist field of the attribute's descriptor is not null then Persistence policy from the attribute descriptor is used to guide storing the attribute in a persistent store.
Store the MBean if 'persistPolicy' field is:

!= "never"
= "always"
= "onUpdate"
= "onTimer" and now > 'lastPersistTime' + 'persistPeriod'
= "NoMoreOftenThan" and now > 'lastPersistTime' + 'persistPeriod'

Do not store the MBean if 'persistPolicy' field is:

= "never"
= "onTimer" && now < 'lastPersistTime' + 'persistPeriod'
= "onUnregister"
= "NoMoreOftenThan" and now < 'lastPersistTime' + 'persistPeriod'

The ModelMBeanInfo of the Model MBean is stored in a file.
Parameters:
- attribute - The Attribute instance containing the name of the attribute to be set and the value it is to be set to.
Throws:
- AttributeNotFoundException - The specified attribute is not accessible in the MBean.
The following cases may result in an AttributeNotFoundException:

No ModelMBeanAttributeInfo is found for the specified attribute.
The ModelMBeanAttributeInfo's isWritable method returns 'false'.

- InvalidAttributeValueException - No descriptor is defined for the specified attribute.
- MBeanException - Wraps one of the following Exceptions:

An Exception thrown by the managed object's setter.
A {@link ServiceNotFoundException} if a setMethod field is defined in the descriptor for the attribute and the managed resource is null; or if no setMethod field is defined and caching is not enabled for the attribute. Note that if there is no getMethod field either, then caching is automatically enabled.
{@link InvalidTargetObjectTypeException} The 'targetType' field value is not 'objectReference'.
An Exception thrown by the managed object's getter.

- ReflectionException - Wraps an {@link java.lang.Exception} thrown while trying to invoke the setter.
- RuntimeOperationsException - Wraps an {@link IllegalArgumentException}: The attribute in parameter is null.
See Also: RequiredModelMBean.getAttribute(java.lang.String),

public AttributeList setAttributes (AttributeList attributes)

Sets the values of an array of attributes of this ModelMBean.

public void setManagedResource (Object mr, String mr_type) throws MBeanException RuntimeOperationsException InstanceNotFoundException InvalidTargetObjectTypeException [Specified in ModelMBean]

Sets the instance handle of the object against which to execute all methods in this ModelMBean management interface (MBeanInfo and Descriptors).

public void setModelMBeanInfo (ModelMBeanInfo mbi) throws MBeanException RuntimeOperationsException [Specified in ModelMBean]

Initializes a ModelMBean object using ModelMBeanInfo passed in.

public void store () throws MBeanException RuntimeOperationsException InstanceNotFoundException

Captures the current state of this MBean instance and writes it out to the persistent store.

Captures the current state of this MBean instance and writes it out to the persistent store. The state stored could include attribute and operation values.

If the implementation of this class does not support persistence, an MBeanException wrapping a ServiceNotFoundException is thrown.

Persistence policy from the MBean and attribute descriptor is used to guide execution of this method. The MBean should be stored if 'persistPolicy' field is:

  != "never"
   = "always"
   = "onTimer" and now > 'lastPersistTime' + 'persistPeriod'
   = "NoMoreOftenThan" and now > 'lastPersistTime' + 'persistPeriod'
   = "onUnregister"

Do not store the MBean if 'persistPolicy' field is:

    = "never"
    = "onUpdate"
    = "onTimer" && now < 'lastPersistTime' + 'persistPeriod'

Throws:
- MBeanException - Wraps another exception, or persistence is not supported
- RuntimeOperationsException - Wraps exceptions from the persistence mechanism
- InstanceNotFoundException - Could not find/access the persistent store