javax.management.relation
Class RoleInfo

java.lang.Object
  javax.management.relation.RoleInfo

All Implemented Interfaces:

java.io.Serializable

public class RoleInfo

extends java.lang.Object

implements java.io.Serializable

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.

See Also:

Serialized Form

ROLE_CARDINALITY_INFINITY

public static int ROLE_CARDINALITY_INFINITY

A value used to specify an infinite number of mbeans are allowed in the role

RoleInfo

public RoleInfo(RoleInfo (src)  other)
         throws java.lang.IllegalArgumentException

Copies the role info.

Parameters:

other - the role to copy.

Throws:

java.lang.IllegalArgumentException - for a null value.

RoleInfo

public RoleInfo(java.lang.String name,
                java.lang.String className)
         throws java.lang.IllegalArgumentException,
                java.lang.ClassNotFoundException,
                NotCompliantMBeanException (src) 

Construct a role info with the given name and class name. It is set to read/writable with a minimum and maximum degree of 1. The description is null.

Parameters:

name - the name of the role.

className - the name of the MBean class.

Throws:

java.lang.IllegalArgumentException - for a null value.

java.lang.ClassNotFoundException - when the className does not exist.

NotCompliantMBeanException (src) - when the className is not an mbean class.

RoleInfo

public RoleInfo(java.lang.String name,
                java.lang.String className,
                boolean readable,
                boolean writable)
         throws java.lang.IllegalArgumentException,
                java.lang.ClassNotFoundException,
                NotCompliantMBeanException (src) 

Construct a role info with the given name, class name and read/write attributes. It has a minimum and maximum degree of 1. The description is null.

Parameters:

name - the name of the role.

className - the name of the MBean class.

readable - true for readable, false otherwise.

writable - true for writable, false otherwise.

Throws:

java.lang.IllegalArgumentException - for a null value.

java.lang.ClassNotFoundException - when the className does not exist.

NotCompliantMBeanException (src) - when the className is not an mbean class.

RoleInfo

public RoleInfo(java.lang.String name,
                java.lang.String className,
                boolean readable,
                boolean writable,
                int minDegree,
                int maxDegree,
                java.lang.String description)
         throws java.lang.IllegalArgumentException,
                java.lang.ClassNotFoundException,
                NotCompliantMBeanException (src) ,
                InvalidRoleInfoException (src) 

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.

className - the name of the MBean class.

readable - true for readable, false otherwise.

writable - true for writable, false otherwise.

minDegree - the minimum degree.

maxDegree - the maximum degree.

description - the description.

Throws:

java.lang.IllegalArgumentException - for a null value.

java.lang.ClassNotFoundException - when the className does not exist.

NotCompliantMBeanException (src) - when the className is not an mbean class.

InvalidRoleInfoException (src) - when the minimum degree is greater than the maximum.

checkMinDegree

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.

Returns:

true when it is greater than or equal to the minimum degree, false otherwise.

checkMaxDegree

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.

Returns:

true when it is less than or equal to the maximum degree, false otherwise.

getDescription

public java.lang.String getDescription()

Retrieve the description of the role.

Returns:

the description

getMinDegree

public int getMinDegree()

Retrieve the minimum degree.

Returns:

the minimum degree

getMaxDegree

public int getMaxDegree()

Retrieve the maximum degree.

Returns:

the maximum degree

getName

public java.lang.String getName()

Retrieve the name of the role.

Returns:

the name

getRefMBeanClassName

public java.lang.String getRefMBeanClassName()

Retrieve the class name of MBeans in this role.

Returns:

the class name

isReadable

public boolean isReadable()

Retrieve the readable attribute.

Returns:

true for readable, false otherwise

isWritable

public boolean isWritable()

Retrieve the writable attribute.

Returns:

true for writable, false otherwise

toString

public java.lang.String toString()

Retrieve a string description of the role info.