|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.management.relation.RoleInfo
A RoleInfo object summarises a role in a relation type.
Field Summary | |
static int |
ROLE_CARDINALITY_INFINITY
To specify an unlimited cardinality. |
Constructor Summary | |
RoleInfo(RoleInfo theRoleInfo)
Copy constructor. |
|
RoleInfo(String theName,
String theRefMBeanClassName)
Constructor. |
|
RoleInfo(String theName,
String theRefMBeanClassName,
boolean theIsReadable,
boolean theIsWritable)
Constructor. |
|
RoleInfo(String theName,
String theRefMBeanClassName,
boolean theIsReadable,
boolean theIsWritable,
int theMinDegree,
int theMaxDegree,
String theDescription)
Constructor. |
Method Summary | |
boolean |
checkMaxDegree(int theValue)
Returns a boolean to specify if given value is less or equal than expected maximum degree (true if yes). |
boolean |
checkMinDegree(int theValue)
Returns a boolean to specify if given value is greater or equal than expected minimum degree (true if yes). |
String |
getDescription()
Returns description text for the role. |
int |
getMaxDegree()
Returns maximum degree for corresponding role reference. |
int |
getMinDegree()
Returns minimum degree for corresponding role reference. |
String |
getName()
Returns the name of the role. |
String |
getRefMBeanClassName()
Returns name of type of MBean expected to be referenced in corresponding role. |
boolean |
isReadable()
Returns read access mode for the role (true if it is readable). |
boolean |
isWritable()
Returns write access mode for the role (true if it is writable). |
String |
toString()
Returns a string describing the role info. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static int ROLE_CARDINALITY_INFINITY
Constructor Detail |
public RoleInfo(String theName, String theRefMBeanClassName, boolean theIsReadable, boolean theIsWritable, int theMinDegree, int theMaxDegree, String theDescription) throws IllegalArgumentException, InvalidRoleInfoException, ClassNotFoundException, NotCompliantMBeanException
theName
- name of the role.theRefMBeanClassName
- 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, theRefMBeanClassName)
.theIsReadable
- flag to indicate if the corresponding role
can be readtheIsWritable
- flag to indicate if the corresponding role
can be settheMinDegree
- minimum degree for role, i.e. minimum number of
MBeans to provide in corresponding role
Must be less or equal than theMaxDegree.
(ROLE_CARDINALITY_INFINITY for unlimited)theMaxDegree
- maximum degree for role, i.e. maximum number of
MBeans to provide in corresponding role
Must be greater or equal than theMinDegree
(ROLE_CARDINALITY_INFINITY for unlimited)theDescription
- description of the role (can be null)
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 theRefMBeanClassName
is not a MBean class.public RoleInfo(String theName, String theRefMBeanClassName, boolean theIsReadable, boolean theIsWritable) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException
theName
- name of the roletheRefMBeanClassName
- 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, theRefMBeanClassName)
.theIsReadable
- flag to indicate if the corresponding role
can be readtheIsWritable
- flag to indicate if the corresponding role
can be set
Minimum and maximum degrees defaulted to 1.
Description of role defaulted to null.
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.public RoleInfo(String theName, String theRefMBeanClassName) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException
theName
- name of the roletheRefMBeanClassName
- 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, theRefMBeanClassName)
.
IsReadable and IsWritable defaulted to true.
Minimum and maximum degrees defaulted to 1.
Description of role defaulted to null.
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.public RoleInfo(RoleInfo theRoleInfo) throws IllegalArgumentException
theRoleInfo
- the RoleInfo to be copied.
IllegalArgumentException
- if null parameterMethod Detail |
public String getName()
public boolean isReadable()
public boolean isWritable()
public String getDescription()
public int getMinDegree()
public int getMaxDegree()
public String getRefMBeanClassName()
Returns name of type of MBean expected to be referenced in corresponding role.
public boolean checkMinDegree(int theValue)
theValue
- value
public boolean checkMaxDegree(int theValue)
theValue
- value
public String toString()
|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2003 Sun Microsystems, Inc. All rights reserved.