Класс RoleInfo

java.lang.Object

javax.management.relation.RoleInfo

Все реализуемые интерфейсы:: Serializable

public class RoleInfo extends Object implements Serializable

Объект RoleInfo обобщает роль в типе отношения.

serialVersionUID этого класса — 2504952983494636987L.

С:

1.5

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`ROLE_CARDINALITY_INFINITY`	Для указания неограниченной кардинальности.

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

Конструктор	Описание
`RoleInfo(String roleName, String mbeanClassName)`	Конструктор.
`RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write)`	Конструктор.
`RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write, int min, int max, String descr)`	Конструктор.
`RoleInfo(RoleInfo roleInfo)`	Конструктор копирования.

Краткое описание методов

Модификатор и тип	Метод	Описание
`boolean`	`checkMaxDegree(int value)`	Возвращает true, если параметр `value` меньше или равен ожидаемой максимальной степени, в противном случае — false.
`boolean`	`checkMinDegree(int value)`	Возвращает true, если параметр `value` больше или равен ожидаемой минимальной степени, в противном случае — false.
`String`	`getDescription()`	Возвращает текстовое описание роли.
`int`	`getMaxDegree()`	Возвращает максимальную степень для соответствующей ссылки на роль.
`int`	`getMinDegree()`	Возвращает минимальную степень для соответствующей ссылки на роль.
`String`	`getName()`	Возвращает имя роли.
`String`	`getRefMBeanClassName()`	Возвращает имя типа MBean, ожидаемого для ссылки в соответствующей роли.
`boolean`	`isReadable()`	Возвращает режим чтения для роли (true, если она читаема).
`boolean`	`isWritable()`	Возвращает режим записи для роли (true, если она записываема).
`String`	`toString()`	Возвращает строку, описывающую информацию о роли.

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание полей

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 - имя роли

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

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

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

Исключения:

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

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()

Возвращает имя типа MBean, ожидаемого для ссылки в соответствующей роли.

Возвращает:: имя ссылаемого типа.

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
Возвращает:: описание информации о роли.

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.management/javax/management/relation/RoleInfo.html