OpenJDK 1.23 · javax.management.relation.RoleInfo · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private static boolean	compat
private String	description
private boolean	isReadable
private boolean	isWritable
private int	maxDegree
private int	minDegree
private String	name
private static final ObjectStreamField[]	newSerialPersistentFields
private static final long	newSerialVersionUID
private static final ObjectStreamField[]	oldSerialPersistentFields
private static final long	oldSerialVersionUID
private String	referencedMBeanClassName
public static final int	ROLE_CARDINALITY_INFINITY To specify an unlimited cardinality.
private static final ObjectStreamField[]	serialPersistentFields
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	RoleInfo(String name of the role. roleName, String 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)`. mbeanClassName, boolean flag to indicate if the corresponding role can be read read, boolean flag to indicate if the corresponding role can be set write, int 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) min, int 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) max, String description of the role (can be null) descr) Constructor.
public	RoleInfo(String name of the role roleName, String 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)`. mbeanClassName, boolean flag to indicate if the corresponding role can be read read, boolean flag to indicate if the corresponding role can be set Minimum and maximum degrees defaulted to 1. Description of role defaulted to null. write) Constructor.
public	RoleInfo(String name of the role roleName, String 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. mbeanClassName) Constructor.
public	RoleInfo(RoleInfo the `RoleInfo` instance to be copied. roleInfo) Copy constructor.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if lower than or equal to maximum degree, false otherwise. checkMaxDegree(int the value to be checked value) Returns true if the `value` parameter is lower than or equal to the expected maximum degree, false otherwise.
public boolean	Returns: true if greater than or equal to minimum degree, false otherwise. checkMinDegree(int the value to be checked value) Returns true if the `value` parameter is greater than or equal to the expected minimum degree, false otherwise.
public String	Returns: the description of the role. getDescription() Returns description text for the role.
public int	Returns: the maximum degree. getMaxDegree() Returns maximum degree for corresponding role reference.
public int	Returns: the minimum degree. getMinDegree() Returns minimum degree for corresponding role reference.
public String	Returns: the name of the role. getName() Returns the name of the role.
public String	Returns: the name of the referenced type. getRefMBeanClassName() Returns name of type of MBean expected to be referenced in corresponding role.
private void	init(String roleName, String mbeanClassName, boolean read, boolean write, int min, int max, String descr)
public boolean	Returns: true if the role is readable. isReadable() Returns read access mode for the role (true if it is readable).
public boolean	Returns: true if the role is writable. isWritable() Returns write access mode for the role (true if it is writable).
private void	readObject(ObjectInputStream in) Deserializes a `RoleInfo` from an `ObjectInputStream`.
public String	Returns: a description of the role info. toString() Overrides java.lang.Object.toString. Returns a string describing the role info.
private void	writeObject(ObjectOutputStream out) Serializes a `RoleInfo` to an `ObjectOutputStream`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

compat	back to summary
private static boolean compat

description	back to summary
private String description

isReadable	back to summary
private boolean isReadable

isWritable	back to summary
private boolean isWritable

maxDegree	back to summary
private int maxDegree

minDegree	back to summary
private int minDegree

name	back to summary
private String name

newSerialPersistentFields	back to summary
private static final ObjectStreamField[] newSerialPersistentFields

newSerialVersionUID	back to summary
private static final long newSerialVersionUID

oldSerialPersistentFields	back to summary
private static final ObjectStreamField[] oldSerialPersistentFields

oldSerialVersionUID	back to summary
private static final long oldSerialVersionUID

referencedMBeanClassName	back to summary
private String referencedMBeanClassName

ROLE_CARDINALITY_INFINITY	back to summary
public static final int ROLE_CARDINALITY_INFINITY To specify an unlimited cardinality.

serialPersistentFields back to summary

serialPersistentFields	back to summary
private static final ObjectStreamField[] serialPersistentFields Serial Fields: name:`String` Role name isReadable:boolean Read access mode: `true` if role is readable isWritable:boolean Write access mode: `true` if role is writable description:`String` Role description minDegree:int Minimum degree (i.e. minimum number of referenced MBeans in corresponding role) maxDegree:int Maximum degree (i.e. maximum number of referenced MBeans in corresponding role) referencedMBeanClassName:`String` Name of class of MBean(s) expected to be referenced in corresponding role

private static final ObjectStreamField[] serialPersistentFields

Serial Fields:

name:String: Role name
isReadable:boolean: Read access mode: true if role is readable
isWritable:boolean: Write access mode: true if role is writable
description:String: Role description
minDegree:int: Minimum degree (i.e. minimum number of referenced MBeans in corresponding role)
maxDegree:int: Maximum degree (i.e. maximum number of referenced MBeans in corresponding role)
referencedMBeanClassName:String: Name of class of MBean(s) expected to be referenced in corresponding role

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

RoleInfo back to summary

RoleInfo	back to summary
public RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write, int min, int max, String descr) throws IllegalArgumentException, InvalidRoleInfoException, ClassNotFoundException, NotCompliantMBeanException Constructor. Parameters roleName:String name of the role. mbeanClassName:String 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:boolean flag to indicate if the corresponding role can be read write:boolean flag to indicate if the corresponding role can be set min:int 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:int 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:String description of the role (can be null) Exceptions 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, int min, int max, String descr) throws IllegalArgumentException, InvalidRoleInfoException, ClassNotFoundException, NotCompliantMBeanException

Constructor.

Parameters

roleName:String: name of the role.
mbeanClassName:String: 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:boolean: flag to indicate if the corresponding role can be read
write:boolean: flag to indicate if the corresponding role can be set
min:int: 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:int: 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:String: description of the role (can be null)

Exceptions

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.

RoleInfo back to summary

RoleInfo	back to summary
public RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException Constructor. Parameters roleName:String name of the role mbeanClassName:String 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:boolean flag to indicate if the corresponding role can be read write:boolean flag to indicate if the corresponding role can be set Minimum and maximum degrees defaulted to 1. Description of role defaulted to null. Exceptions 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, boolean read, boolean write) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException

Constructor.

Parameters

roleName:String

name of the role

mbeanClassName:String

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:boolean

flag to indicate if the corresponding role can be read

write:boolean

flag to indicate if the corresponding role can be set

Minimum and maximum degrees defaulted to 1.

Description of role defaulted to null.

Exceptions

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.

RoleInfo back to summary

RoleInfo	back to summary
public RoleInfo(String roleName, String mbeanClassName) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException Constructor. Parameters roleName:String name of the role mbeanClassName:String 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. Exceptions 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) throws IllegalArgumentException, ClassNotFoundException, NotCompliantMBeanException

Constructor.

Parameters

roleName:String

name of the role

mbeanClassName:String

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.

Exceptions

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.

RoleInfo back to summary

RoleInfo	back to summary
public RoleInfo(RoleInfo roleInfo) throws IllegalArgumentException Copy constructor. Parameters roleInfo:RoleInfo the `RoleInfo` instance to be copied. Exceptions IllegalArgumentException: if null parameter

public RoleInfo(RoleInfo roleInfo) throws IllegalArgumentException

Copy constructor.

Parameters

roleInfo:RoleInfo: the RoleInfo instance to be copied.

Exceptions

IllegalArgumentException:: if null parameter

Method Detail

checkMaxDegree back to summary

checkMaxDegree	back to summary
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:int the value to be checked Returns:boolean true if lower than or equal to maximum degree, false otherwise.

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:int: the value to be checked

Returns:boolean

true if lower than or equal to maximum degree, false otherwise.

checkMinDegree back to summary

checkMinDegree	back to summary
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:int the value to be checked Returns:boolean true if greater than or equal to minimum 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:int: the value to be checked

Returns:boolean

true if greater than or equal to minimum degree, false otherwise.

getDescription	back to summary
public String getDescription() Returns description text for the role. Returns:String the description of the role.

getDescription

back to summary

public String getDescription()

Returns description text for the role.

Returns:String: the description of the role.

getMaxDegree	back to summary
public int getMaxDegree() Returns maximum degree for corresponding role reference. Returns:int the maximum degree.

getMaxDegree

back to summary

public int getMaxDegree()

Returns maximum degree for corresponding role reference.

Returns:int: the maximum degree.

getMinDegree	back to summary
public int getMinDegree() Returns minimum degree for corresponding role reference. Returns:int the minimum degree.

getMinDegree

back to summary

public int getMinDegree()

Returns minimum degree for corresponding role reference.

Returns:int: the minimum degree.

getName	back to summary
public String getName() Returns the name of the role. Returns:String the name of the role.

getName

back to summary

public String getName()

Returns the name of the role.

Returns:String: the name of the role.

getRefMBeanClassName	back to summary
public String getRefMBeanClassName() Returns name of type of MBean expected to be referenced in corresponding role. Returns:String the name of the referenced type.

getRefMBeanClassName

back to summary

public String getRefMBeanClassName()

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

Returns:String: the name of the referenced type.

init	back to summary
private void init(String roleName, String mbeanClassName, boolean read, boolean write, int min, int max, String descr) throws IllegalArgumentException, InvalidRoleInfoException

isReadable	back to summary
public boolean isReadable() Returns read access mode for the role (true if it is readable). Returns:boolean true if the role is readable.

isReadable

back to summary

public boolean isReadable()

Returns read access mode for the role (true if it is readable).

Returns:boolean: true if the role is readable.

isWritable	back to summary
public boolean isWritable() Returns write access mode for the role (true if it is writable). Returns:boolean true if the role is writable.

isWritable

back to summary

public boolean isWritable()

Returns write access mode for the role (true if it is writable).

Returns:boolean: true if the role is writable.

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException Deserializes a `RoleInfo` from an `ObjectInputStream`.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string describing the role info. Returns:String a description of the role info.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string describing the role info.

Returns:String: a description of the role info.

writeObject	back to summary
private void writeObject(ObjectOutputStream out) throws IOException Serializes a `RoleInfo` to an `ObjectOutputStream`.

public Class RoleInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail