Home » openjdk-7 » javax » management » relation » [javadoc | source]
javax.management.relation
public class: RoleInfo [javadoc | source]
java.lang.Object
   javax.management.relation.RoleInfo

All Implemented Interfaces:
    java$io$Serializable

A RoleInfo object summarises a role in a relation type.

The serialVersionUID of this class is 2504952983494636987L.

Field Summary
public static final  int ROLE_CARDINALITY_INFINITY    To specify an unlimited cardinality. 
Constructor:
 public RoleInfo(RoleInfo roleInfo) throws IllegalArgumentException 
    Copy constructor.
    Parameters:
    roleInfo - the RoleInfo instance to be copied.
    Throws:
    IllegalArgumentException - if null parameter
    exception: IllegalArgumentException - if null parameter
 public RoleInfo(String roleName,
    String mbeanClassName) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException 
    Constructor.
    Parameters:
    roleName - name of the role
    mbeanClassName - name of the class of MBean(s) expected to be referenced in corresponding role. If an MBean M is in this role, then the MBean server must return true for isInstanceOf(M, mbeanClassName) .

    IsReadable and IsWritable defaulted to true.

    Minimum and maximum degrees defaulted to 1.

    Description of role defaulted to null.

    Throws:
    IllegalArgumentException - if null parameter
    ClassNotFoundException - As of JMX 1.2, this exception can no longer be thrown. It is retained in the declaration of this class for compatibility with existing code.
    NotCompliantMBeanException - As of JMX 1.2, this exception can no longer be thrown. It is retained in the declaration of this class for compatibility with existing code.
    exception: IllegalArgumentException - if null parameter
    exception: ClassNotFoundException - As of JMX 1.2, this exception can no longer be thrown. It is retained in the declaration of this class for compatibility with existing code.
    exception: NotCompliantMBeanException - As of JMX 1.2, this exception can no longer be thrown. It is retained in the declaration of this class for compatibility with existing code.
 public RoleInfo(String roleName,
    String mbeanClassName,
    boolean read,
    boolean write) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException 
    Constructor.
    Parameters:
    roleName - name of the role
    mbeanClassName - name of the class of MBean(s) expected to be referenced in corresponding role. If an MBean M is in this role, then the MBean server must return true for isInstanceOf(M, mbeanClassName) .
    read - flag to indicate if the corresponding role can be read
    write - flag to indicate if the corresponding role can be set

    Minimum and maximum degrees defaulted to 1.

    Description of role defaulted to null.

    Throws:
    IllegalArgumentException - if null parameter
    ClassNotFoundException - As of JMX 1.2, this exception can no longer be thrown. It is retained in the declaration of this class for compatibility with existing code.
    NotCompliantMBeanException - As of JMX 1.2, this exception can no longer be thrown. It is retained in the declaration of this class for compatibility with existing code.
    exception: IllegalArgumentException - if null parameter
    exception: ClassNotFoundException - As of JMX 1.2, this exception can no longer be thrown. It is retained in the declaration of this class for compatibility with existing code.
    exception: NotCompliantMBeanException - As of JMX 1.2, this exception can no longer be thrown. It is retained in the declaration of this class for compatibility with existing code.
 public RoleInfo(String roleName,
    String mbeanClassName,
    boolean read,
    boolean write,
    int min,
    int max,
    String descr) throws IllegalArgumentException, InvalidRoleInfoException, ClassNotFoundException, NotCompliantMBeanException 
    Constructor.
    Parameters:
    roleName - name of the role.
    mbeanClassName - name of the class of MBean(s) expected to be referenced in corresponding role. If an MBean M is in this role, then the MBean server must return true for isInstanceOf(M, mbeanClassName) .
    read - flag to indicate if the corresponding role can be read
    write - flag to indicate if the corresponding role can be set
    min - minimum degree for role, i.e. minimum number of MBeans to provide in corresponding role Must be less than or equal to max. (ROLE_CARDINALITY_INFINITY for unlimited)
    max - maximum degree for role, i.e. maximum number of MBeans to provide in corresponding role Must be greater than or equal to min (ROLE_CARDINALITY_INFINITY for unlimited)
    descr - description of the role (can be null)
    Throws:
    IllegalArgumentException - if null parameter
    InvalidRoleInfoException - if the minimum degree is greater than the maximum degree.
    ClassNotFoundException - As of JMX 1.2, this exception can no longer be thrown. It is retained in the declaration of this class for compatibility with existing code.
    NotCompliantMBeanException - if the class mbeanClassName is not a MBean class.
    exception: IllegalArgumentException - if null parameter
    exception: InvalidRoleInfoException - if the minimum degree is greater than the maximum degree.
    exception: ClassNotFoundException - As of JMX 1.2, this exception can no longer be thrown. It is retained in the declaration of this class for compatibility with existing code.
    exception: NotCompliantMBeanException - if the class mbeanClassName is not a MBean class.
Method from javax.management.relation.RoleInfo Summary:
checkMaxDegree,   checkMinDegree,   getDescription,   getMaxDegree,   getMinDegree,   getName,   getRefMBeanClassName,   isReadable,   isWritable,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.management.relation.RoleInfo Detail:
 public boolean checkMaxDegree(int value) 
    Returns true if the value parameter is lower than or equal to the expected maximum degree, false otherwise.
 public boolean checkMinDegree(int value) 
    Returns true if the value parameter is greater than or equal to the expected minimum degree, false otherwise.
 public String getDescription() 
    Returns description text for the role.
 public int getMaxDegree() 
    Returns maximum degree for corresponding role reference.
 public int getMinDegree() 
    Returns minimum degree for corresponding role reference.
 public String getName() 
    Returns the name of the role.
 public String getRefMBeanClassName() 

    Returns name of type of MBean expected to be referenced in corresponding role.

 public boolean isReadable() 
    Returns read access mode for the role (true if it is readable).
 public boolean isWritable() 
    Returns write access mode for the role (true if it is writable).
 public String toString() 
    Returns a string describing the role info.