| java.lang.Object | |
| ↳ | javax.management.relation.RoleInfo |
Class Overview
A RoleInfo object summarises a role in a relation type.
The serialVersionUID of this class is 2504952983494636987L.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | ROLE_CARDINALITY_INFINITY | To specify an unlimited cardinality. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructor.
| |||||||||||
Constructor.
| |||||||||||
Constructor.
| |||||||||||
Copy constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Returns true if the value parameter is lower than or equal to
the expected maximum degree, false otherwise.
| |||||||||||
Returns true if the value parameter is greater than or equal to
the expected minimum degree, false otherwise.
| |||||||||||
Returns description text for the role.
| |||||||||||
Returns maximum degree for corresponding role reference.
| |||||||||||
Returns minimum degree for corresponding role reference.
| |||||||||||
Returns the name of the role.
| |||||||||||
Returns name of type of MBean expected to be referenced in corresponding role. | |||||||||||
Returns read access mode for the role (true if it is readable).
| |||||||||||
Returns write access mode for the role (true if it is writable).
| |||||||||||
Returns a string describing the role info.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final int ROLE_CARDINALITY_INFINITY
To specify an unlimited cardinality.
Constant Value:
-1
(0xffffffff)
Public Constructors
public RoleInfo (String roleName, String mbeanClassName, boolean read, boolean write, int min, int max, String descr)
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. |
public RoleInfo (String roleName, String mbeanClassName, boolean read, boolean write)
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. |
public RoleInfo (String roleName, String mbeanClassName)
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. |
public RoleInfo (RoleInfo roleInfo)
Copy constructor.
Parameters
| roleInfo | the RoleInfo instance to be copied. |
|---|
Throws
| IllegalArgumentException | if null parameter |
|---|
Public Methods
public boolean checkMaxDegree (int value)
Returns true if the value parameter is lower than or equal to the expected maximum degree, false otherwise.
Parameters
| value | the value to be checked |
|---|
Returns
- true if lower than or equal to 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.
Parameters
| value | the value to be checked |
|---|
Returns
- true if greater than or equal to minimum degree, false otherwise.
public String getDescription ()
Returns description text for the role.
Returns
- the description of the role.
public int getMaxDegree ()
Returns maximum degree for corresponding role reference.
Returns
- the maximum degree.
public int getMinDegree ()
Returns minimum degree for corresponding role reference.
Returns
- the minimum degree.
public String getRefMBeanClassName ()
Returns name of type of MBean expected to be referenced in corresponding role.
Returns
- the name of the referenced type.
public boolean isReadable ()
Returns read access mode for the role (true if it is readable).
Returns
- true if the role is readable.
public boolean isWritable ()
Returns write access mode for the role (true if it is writable).
Returns
- true if the role is writable.
public String toString ()
Returns a string describing the role info.
Returns
- a description of the role info.