Класс 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 |
Конструктор. |
RoleInfo |
Конструктор. |
RoleInfo |
Конструктор. |
RoleInfo |
Конструктор копирования. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
boolean |
checkMaxDegree |
Возвращает true, если параметр value меньше или равен ожидаемой максимальной степени, иначе false. |
boolean |
checkMinDegree |
Возвращает true, если параметр value больше или равен ожидаемой минимальной степени, иначе false. |
String |
getDescription() |
Возвращает текстовое описание роли. |
int |
getMaxDegree() |
Возвращает максимальную степень для соответствующей ссылки на роль. |
int |
getMinDegree() |
Возвращает минимальную степень для соответствующей ссылки на роль. |
String |
getName() |
Возвращает имя роли. |
String |
getRefMBeanClassName() |
Возвращает имя типа MBean, ожидаемого для ссылки в соответствующей роли. |
boolean |
isReadable() |
Возвращает режим доступа для чтения роли (true, если она читаема). |
boolean |
isWritable() |
Возвращает режим доступа для записи роли (true, если она записываема). |
String |
toString() |
Возвращает строку, описывающую информацию о роли. |
Подробное описание полей
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()
Возвращает имя типа 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, 2021, 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/17/docs/api/java.management/javax/management/relation/RoleInfo.html
