Describes an Open MBean: an Open MBean is recognized as such if * its {@link javax.management.DynamicMBean#getMBeanInfo() * getMBeanInfo()} method returns an instance of a class which * implements the {@link OpenMBeanInfo} interface, typically {@link * OpenMBeanInfoSupport}.
* *This interface declares the same methods as the class {@link * javax.management.MBeanInfo}. A class implementing this interface * (typically {@link OpenMBeanInfoSupport}) should extend {@link * javax.management.MBeanInfo}.
* *The {@link #getAttributes()}, {@link #getOperations()} and
* {@link #getConstructors()} methods of the implementing class should
* return at runtime an array of instances of a subclass of {@link
* MBeanAttributeInfo}, {@link MBeanOperationInfo} or {@link
* MBeanConstructorInfo} respectively which implement the {@link
* OpenMBeanAttributeInfo}, {@link OpenMBeanOperationInfo} or {@link
* OpenMBeanConstructorInfo} interface respectively.
*
*
* @since 1.5
*/
public interface OpenMBeanInfo {
// Re-declares the methods that are in class MBeanInfo of JMX 1.0
// (methods will be removed when MBeanInfo is made a parent interface of this interface)
/**
* Returns the fully qualified Java class name of the open MBean
* instances this OpenMBeanInfo describes.
*
* @return the class name.
*/
public String getClassName() ;
/**
* Returns a human readable description of the type of open MBean
* instances this OpenMBeanInfo describes.
*
* @return the description.
*/
public String getDescription() ;
/**
* Returns an array of OpenMBeanAttributeInfo instances
* describing each attribute in the open MBean described by this
* OpenMBeanInfo instance. Each instance in the returned
* array should actually be a subclass of
* MBeanAttributeInfo which implements the
* OpenMBeanAttributeInfo interface (typically {@link
* OpenMBeanAttributeInfoSupport}).
*
* @return the attribute array.
*/
public MBeanAttributeInfo[] getAttributes() ;
/**
* Returns an array of OpenMBeanOperationInfo instances
* describing each operation in the open MBean described by this
* OpenMBeanInfo instance. Each instance in the returned
* array should actually be a subclass of
* MBeanOperationInfo which implements the
* OpenMBeanOperationInfo interface (typically {@link
* OpenMBeanOperationInfoSupport}).
*
* @return the operation array.
*/
public MBeanOperationInfo[] getOperations() ;
/**
* Returns an array of OpenMBeanConstructorInfo instances
* describing each constructor in the open MBean described by this
* OpenMBeanInfo instance. Each instance in the returned
* array should actually be a subclass of
* MBeanConstructorInfo which implements the
* OpenMBeanConstructorInfo interface (typically {@link
* OpenMBeanConstructorInfoSupport}).
*
* @return the constructor array.
*/
public MBeanConstructorInfo[] getConstructors() ;
/**
* Returns an array of MBeanNotificationInfo instances
* describing each notification emitted by the open MBean
* described by this OpenMBeanInfo instance.
*
* @return the notification array.
*/
public MBeanNotificationInfo[] getNotifications() ;
// commodity methods
//
/**
* Compares the specified obj parameter with this OpenMBeanInfo instance for equality.
*
* Returns true if and only if all of the following statements are true: *
OpenMBeanInfo interface,OpenMBeanInfo interface.
* OpenMBeanInfo instance;
*
* @return true if the specified object is equal to this OpenMBeanInfo instance.
*/
public boolean equals(Object obj);
/**
* Returns the hash code value for this OpenMBeanInfo instance.
*
* The hash code of an OpenMBeanInfo instance is the sum of the hash codes
* of all elements of information used in equals comparisons
* (ie: its class name, and its infos on attributes, constructors, operations and notifications,
* where the hashCode of each of these arrays is calculated by a call to
* new java.util.HashSet(java.util.Arrays.asList(this.getSignature)).hashCode()).
*
* This ensures that t1.equals(t2) implies that t1.hashCode()==t2.hashCode()
* for any two OpenMBeanInfo instances t1 and t2,
* as required by the general contract of the method
* {@link Object#hashCode() Object.hashCode()}.
*
*
* @return the hash code value for this OpenMBeanInfo instance
*/
public int hashCode();
/**
* Returns a string representation of this OpenMBeanInfo instance.
*
* The string representation consists of the name of this class (ie javax.management.openmbean.OpenMBeanInfo),
* the MBean class name,
* and the string representation of infos on attributes, constructors, operations and notifications of the described MBean.
*
* @return a string representation of this OpenMBeanInfo instance
*/
public String toString();
}