| java.lang.Object
 javax.management.relation.RoleInfo
| RoleInfo | | public class RoleInfo implements Serializable(Code) | | This class contains information about a role. For example the
number of mbean class name of the role, how many mbeans
are part of the role, whether the role is read/write, etc.
author:
Adrian Brock.
author:
Thomas Diesler.
version:
$Revision: 57200 $ |
| Constructor Summary | |
| public | RoleInfo(RoleInfo other)
Copies the role info. | | public | RoleInfo(String name, String className)
Construct a role info with the given name and class name. | | public | RoleInfo(String name, String className, boolean readable, boolean writable)
Construct a role info with the given name, class name and
read/write attributes. | | public | RoleInfo(String name, String className, boolean readable, boolean writable, int minDegree, int maxDegree, String description)
Construct a role info with the given name, class name,
read/write attributes, minimum/maximum degree and description. |
| Method Summary | |
| public boolean | checkMaxDegree(int value)
Check to see whether a given value is less than or equal to the
maximum degree.
Parameters:
value - the value to check. | | public boolean | checkMinDegree(int value)
Check to see whether a given value is greater than or equal to the
minimum degree.
Parameters:
value - the value to check. | | public String | getDescription()
Retrieve the description of the role. | | public int | getMaxDegree()
Retrieve the maximum degree. | | public int | getMinDegree()
Retrieve the minimum degree. | | public String | getName()
Retrieve the name of the role. | | public String | getRefMBeanClassName()
Retrieve the class name of MBeans in this role. | | public boolean | isReadable()
Retrieve the readable attribute. | | public boolean | isWritable()
Retrieve the writable attribute. | | public String | toString()
Retrieve a string description of the role info. |
| ROLE_CARDINALITY_INFINITY | | public static int ROLE_CARDINALITY_INFINITY(Code) | | A value used to specify an infinite number of mbeans are allowed
in the role
|
| description | | String description(Code) | | The description of the role
|
| isReadable | | boolean isReadable(Code) | | The readable attribute of the role.
|
| isWritable | | boolean isWritable(Code) | | The writable attribute of the role.
|
| maxDegree | | int maxDegree(Code) | | The maximum degree of the role.
|
| minDegree | | int minDegree(Code) | | The minimum degree of the role.
|
| RoleInfo | | public RoleInfo(String name, String className, boolean readable, boolean writable, int minDegree, int maxDegree, String description) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException, InvalidRoleInfoException(Code) | | Construct a role info with the given name, class name,
read/write attributes, minimum/maximum degree and description.
The description can be null.
Pass ROLE_CARDINALITY_INFINITY for an unlimited degree.
The minimum must be less than or equal to the maximum.
Parameters:
name - the name of the role.
Parameters:
className - the name of the MBean class.
Parameters:
readable - true for readable, false otherwise.
Parameters:
writable - true for writable, false otherwise.
Parameters:
minDegree - the minimum degree.
Parameters:
maxDegree - the maximum degree.
Parameters:
description - the description.
exception:
IllegalArgumentException - for a null value.
exception:
ClassNotFoundException - when the className does not exist.
exception:
NotCompliantMBeanException - when the className is not anmbean class.
exception:
InvalidRoleInfoException - when the minimum degree isgreater than the maximum. |
| checkMaxDegree | | public boolean checkMaxDegree(int value)(Code) | | Check to see whether a given value is less than or equal to the
maximum degree.
Parameters:
value - the value to check. true when it is less than or equal to the maximum degree,false otherwise. |
| checkMinDegree | | public boolean checkMinDegree(int value)(Code) | | Check to see whether a given value is greater than or equal to the
minimum degree.
Parameters:
value - the value to check. true when it is greater than or equal to the minimum degree,false otherwise. |
| getDescription | | public String getDescription()(Code) | | Retrieve the description of the role.
the description |
| getMaxDegree | | public int getMaxDegree()(Code) | | Retrieve the maximum degree.
the maximum degree |
| getMinDegree | | public int getMinDegree()(Code) | | Retrieve the minimum degree.
the minimum degree |
| getName | | public String getName()(Code) | | Retrieve the name of the role.
the name |
| getRefMBeanClassName | | public String getRefMBeanClassName()(Code) | | Retrieve the class name of MBeans in this role.
the class name |
| isReadable | | public boolean isReadable()(Code) | | Retrieve the readable attribute.
true for readable, false otherwise |
| isWritable | | public boolean isWritable()(Code) | | Retrieve the writable attribute.
true for writable, false otherwise |
| toString | | public String toString()(Code) | | Retrieve a string description of the role info.
|
|
|