Класс RoleInfo

Поля

ROLE_CARDINALITY_INFINITY

public static final int ROLE_CARDINALITY_INFINITY

Для указания неограниченной мощности.

См. также:

Значения константных полей

Конструкторы

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName,
                boolean read,
                boolean write,
                int min,
                int max,
                String descr)
         throws IllegalArgumentException,
                InvalidRoleInfoException,
                ClassNotFoundException,
                NotCompliantMBeanException

Конструктор.

Параметры:

roleName - имя роли.

mbeanClassName - имя класса MBean(ов), ожидаемых для ссылки в соответствующей роли. Если MBean M находится в этой роли, то сервер MBean должен вернуть true для isInstanceOf(M, mbeanClassName).

read - флаг, указывающий, может ли соответствующая роль читаться

write - флаг, указывающий, может ли соответствующая роль устанавливаться

min - минимальная степень роли, т.е. минимальное количество MBean для предоставления в соответствующей роли. Должна быть меньше или равна max. (ROLE_CARDINALITY_INFINITY для неограниченной).

max - максимальная степень роли, т.е. максимальное количество MBean для предоставления в соответствующей роли. Должна быть больше или равна min (ROLE_CARDINALITY_INFINITY для неограниченной).

descr - описание роли (может быть null)

Исключения:

IllegalArgumentException - если параметр null

InvalidRoleInfoException - если минимальная степень больше максимальной степени.

ClassNotFoundException - Начиная с JMX 1.2, эта исключение больше не может быть выброшено. Оно сохраняется в объявлении этого класса для совместимости со старым кодом.

NotCompliantMBeanException - если имя класса mbeanClassName не является классом MBean.

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName,
                boolean read,
                boolean write)
         throws IllegalArgumentException,
                ClassNotFoundException,
                NotCompliantMBeanException

Конструктор.

Параметры:

roleName - имя роли

mbeanClassName - имя класса MBean(ов), ожидаемых для ссылки в соответствующей роли. Если MBean M находится в этой роли, то сервер MBean должен вернуть true для isInstanceOf(M, mbeanClassName).

read - флаг, указывающий, может ли соответствующая роль читаться

write - флаг, указывающий, может ли соответствующая роль устанавливаться

Минимальная и максимальная степени по умолчанию равны 1.

Описание роли по умолчанию равно null.

Исключения:

IllegalArgumentException - если параметр null

ClassNotFoundException - Начиная с JMX 1.2, эта исключение больше не может быть выброшено. Оно сохраняется в объявлении этого класса для совместимости со старым кодом.

NotCompliantMBeanException - Начиная с JMX 1.2, эта исключение больше не может быть выброшено. Оно сохраняется в объявлении этого класса для совместимости со старым кодом.

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName)
         throws IllegalArgumentException,
                ClassNotFoundException,
                NotCompliantMBeanException

Конструктор.

Параметры:

roleName - имя роли

mbeanClassName - имя класса MBean(ов), ожидаемых для ссылки в соответствующей роли. Если MBean M находится в этой роли, то сервер MBean должен вернуть true для isInstanceOf(M, mbeanClassName).

IsReadable и IsWritable по умолчанию равны true.

Минимальная и максимальная степени по умолчанию равны 1.

Описание роли по умолчанию равно null.

Исключения:

IllegalArgumentException - если параметр null

ClassNotFoundException - Начиная с JMX 1.2, эта исключение больше не может быть выброшено. Оно сохраняется в объявлении этого класса для совместимости со старым кодом.

NotCompliantMBeanException - Начиная с JMX 1.2, эта исключение больше не может быть выброшено. Оно сохраняется в объявлении этого класса для совместимости со старым кодом.

RoleInfo

public RoleInfo(RoleInfo roleInfo)
         throws IllegalArgumentException

Конструктор копирования.

Параметры:

roleInfo - экземпляр RoleInfo для копирования.

Исключения:

IllegalArgumentException - если параметр null

Методы

getName

public String getName()

Возвращает имя роли.

Возвращает:

имя роли.

isReadable

public boolean isReadable()

Возвращает режим чтения для роли (true, если она читаема).

Возвращает:

true, если роль читаема.

isWritable

public boolean isWritable()

Возвращает режим записи для роли (true, если она записываема).

Возвращает:

true, если роль записываема.

getDescription

public String getDescription()

Возвращает текстовое описание роли.

Возвращает:

описание роли.

getMinDegree

public int getMinDegree()

Возвращает минимальную степень для соответствующей ссылки на роль.

Возвращает:

минимальную степень.

getMaxDegree

public int getMaxDegree()

Возвращает максимальную степень для соответствующей ссылки на роль.

Возвращает:

максимальную степень.

getRefMBeanClassName

public String getRefMBeanClassName()

Возвращает:

имя указанного типа.

checkMinDegree

public boolean checkMinDegree(int value)

Возвращает true, если параметр value больше или равен ожидаемой минимальной степени, иначе false.

Параметры:

value - значение для проверки

Возвращает:

true, если больше или равно минимальной степени, иначе false.

checkMaxDegree

public boolean checkMaxDegree(int value)

Возвращает true, если параметр value меньше или равен ожидаемой максимальной степени, иначе false.

Параметры:

value - значение для проверки

Возвращает:

true, если меньше или равно максимальной степени, иначе false.

toString

public String toString()

Возвращает строку, описывающую информацию о роли.

Переопределяет:

toString в классе Object

Возвращает:

описание информации о роли.