Класс RelationService

public RelationService(boolean immediatePurgeFlag)

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

public void isActive() throws RelationServiceNotRegisteredException

Проверяет, активна ли служба отношений. Текущее условие состоит в том, что служба отношений должна быть зарегистрирована в сервере MBean.

public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception

Позволяет MBean выполнять любые операции, необходимые перед регистрацией в сервере MBean. Если имя MBean не указано, MBean может предоставить имя для своей регистрации. Если возникает какое-либо исключение, MBean не будет зарегистрирован в сервере MBean.

public void postRegister(Boolean registrationDone)

Позволяет MBean выполнить любые необходимые операции после регистрации в сервере MBean или после того, как регистрация завершилась неудачно.

Если реализация этого метода выбрасывает RuntimeException или Error, сервер MBean перебросит их внутри RuntimeMBeanException или RuntimeErrorException соответственно. Однако выбрасывание исключения в postRegister не изменит состояние MBean: если MBean уже был зарегистрирован (registrationDone равно true), MBean останется зарегистрированным.

Это может быть неоднозначно для кода, вызывающего createMBean() или registerMBean(), так как такой код может предположить, что регистрация MBean завершилась неудачей, когда возникает такое исключение. Поэтому рекомендуется, чтобы реализации postRegister не выбрасывали исключений Runtime или ошибок, если это возможно.

public void preDeregister() throws Exception

Позволяет MBean выполнить любые необходимые операции перед его отвязкой от сервера MBean.

public void postDeregister()

Позволяет MBean выполнить любые необходимые операции после его отвязки от сервера MBean.

Если реализация этого метода выбрасывает RuntimeException или Error, сервер MBean перебросит их внутри RuntimeMBeanException или RuntimeErrorException соответственно. Однако выбрасывание исключения в postDeregister не изменит состояние MBean: MBean уже успешно дезагрегирован и останется таким.

Это может быть неоднозначно для кода, вызывающего unregisterMBean(), так как он может предположить, что дезагрегация MBean завершилась неудачей. Поэтому рекомендуется, чтобы реализации postDeregister не выбрасывали исключений Runtime или ошибок, если это возможно.

public boolean getPurgeFlag()

Возвращает флаг, указывающий, нужно ли при получении уведомления об отмене регистрации MBean, связанного с отношением, выполнять немедленное «очищение» отношений (поиск отношений, которые больше недействительны), или это будет выполнено только при явном вызове метода purgeRelations.

true — немедленное очищение.

public void setPurgeFlag(boolean purgeFlag)

Устанавливает флаг, указывающий, нужно ли при получении уведомления об отмене регистрации MBean, связанного с отношением, выполнять немедленное «очищение» отношений (поиск отношений, которые больше недействительны), или это будет выполнено только при явном вызове метода purgeRelations.

true — немедленное очищение.

public void createRelationType(String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException

Создает тип отношения (объект RelationTypeSupport) с заданными информацией о ролях (предоставленной объектами RoleInfo) и добавляет его в службу отношений.

public void addRelationType(RelationType relationTypeObj) throws IllegalArgumentException, InvalidRelationTypeException

Добавляет заданный объект как тип отношения. Ожидается, что объект реализует интерфейс RelationType.

public List<String> getAllRelationTypeNames()

Получает имена всех известных типов отношений.

public List<RoleInfo> getRoleInfos(String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException

Получает список информации о ролях (объекты RoleInfo) заданного типа отношения.

public RoleInfo getRoleInfo(String relationTypeName, String roleInfoName) throws IllegalArgumentException, RelationTypeNotFoundException, RoleInfoNotFoundException

Извлекает информацию о роли для заданного имени роли определённого типа отношения.

public void removeRelationType(String relationTypeName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationTypeNotFoundException

Удаляет заданный тип отношения из службы отношений.

Объекты отношений этого типа будут удалены из службы отношений.

public void createRelation(String relationId, String relationTypeName, RoleList roleList) throws RelationServiceNotRegisteredException, IllegalArgumentException, RoleNotFoundException, InvalidRelationIdException, RelationTypeNotFoundException, InvalidRoleValueException

Создаёт простое отношение (представленное объектом RelationSupport) заданного типа отношения и добавляет его в службу отношений.

Роли инициализируются в соответствии с предоставленным в параметре списком ролей. Те, которые не инициализированы таким образом, устанавливаются в пустой ArrayList ObjectNames.

Отправка уведомления RelationNotification с типом RELATION_BASIC_CREATION.

public void addRelation(ObjectName relationObjectName) throws IllegalArgumentException, RelationServiceNotRegisteredException, NoSuchMethodException, InvalidRelationIdException, InstanceNotFoundException, InvalidRelationServiceException, RelationTypeNotFoundException, RoleNotFoundException, InvalidRoleValueException

Добавляет MBean, созданный пользователем (и зарегистрированный им в сервере MBean), как отношение в службе отношений.

Для добавления в качестве отношения MBean должен соответствовать следующим требованиям:

- реализовывать интерфейс Relation

- иметь для RelationService ObjectName ObjectName текущей службы отношений

- иметь уникальный и неиспользованный идентификатор отношения в текущей службе отношений

- иметь для типа отношения тип отношения, созданный в службе отношений

- иметь роли, соответствующие информации о роли, предоставленной в типе отношения.

public ObjectName isRelationMBean(String relationId) throws IllegalArgumentException, RelationNotFoundException

Если отношение представлено MBean (созданным пользователем и добавленным в качестве отношения в службу отношений), возвращает ObjectName MBean.

public String isRelation(ObjectName objectName) throws IllegalArgumentException

Возвращает идентификатор отношения, связанный с заданным ObjectName, если MBean был добавлен в качестве отношения в службу отношений.

public Boolean hasRelation(String relationId) throws IllegalArgumentException

Проверяет, существует ли отношение, идентифицируемое в службе отношений, с заданным идентификатором отношения.

public List<String> getAllRelationIds()

Возвращает все идентификаторы отношений для всех отношений, обрабатываемых службой отношений.

public Integer checkRoleReading(String roleName, String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException

Проверяет, может ли заданная роль быть прочитана в отношении заданного типа.

public Integer checkRoleWriting(Role role, String relationTypeName, Boolean initFlag) throws IllegalArgumentException, RelationTypeNotFoundException

Проверяет, может ли заданная роль быть установлена в отношении заданного типа.

public void sendRelationCreationNotification(String relationId) throws IllegalArgumentException, RelationNotFoundException

Отправляет уведомление (RelationNotification) о создании отношения. Тип уведомления:

- RelationNotification.RELATION_BASIC_CREATION, если отношение является внутренним объектом службы отношений

- RelationNotification.RELATION_MBEAN_CREATION, если отношение является добавленным MBean.

Источник — сама служба отношений.

Вызывается в методах createRelation() и addRelation() службы отношений.

public void sendRoleUpdateNotification(String relationId, Role newRole, List<ObjectName> oldValue) throws IllegalArgumentException, RelationNotFoundException

Отправляет уведомление (RelationNotification) об обновлении роли в заданном отношении. Тип уведомления:

- RelationNotification.RELATION_BASIC_UPDATE, если отношение является объектом, внутренним для Relation Service

- RelationNotification.RELATION_MBEAN_UPDATE, если отношение добавляется как MBean.

Источник объекта — сам Relation Service.

Вызывается в методах setRole() (для заданной роли) и setRoles() (для каждой роли) MBean отношения (реализация предоставлена в классе RelationSupport).

Также вызывается в методах Relation Service setRole() (для заданной роли) и setRoles() (для каждой роли).

public void sendRelationRemovalNotification(String relationId, List<ObjectName> unregMBeanList) throws IllegalArgumentException, RelationNotFoundException

Отправляет уведомление (RelationNotification) об удалении отношения. Тип уведомления:

- RelationNotification.RELATION_BASIC_REMOVAL, если отношение было только внутренним для Relation Service

- RelationNotification.RELATION_MBEAN_REMOVAL, если отношение зарегистрировано как MBean.

Для MBeans, на которые ссылается такое отношение, ничего не будет сделано.

Вызывается в методе Relation Service removeRelation().

public void updateRoleMap(String relationId, Role newRole, List<ObjectName> oldValue) throws IllegalArgumentException, RelationServiceNotRegisteredException, RelationNotFoundException

Обрабатывает обновление карты ролей Relation Service для обновления заданной роли в данном отношении.

Вызывается в методах setRole() (для заданной роли) и setRoles() (для каждой роли) MBean отношения (реализация предоставлена в классе RelationSupport).

Также вызывается в методах Relation Service setRole() (для заданной роли) и setRoles() (для каждой роли).

Чтобы разрешить Relation Service поддерживать согласованность (в случае отмены регистрации MBean) и для возможности выполнения запросов, этот метод должен быть вызван при обновлении роли.

public void removeRelation(String relationId) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException

Удаляет заданное отношение из Relation Service.

Отправляется уведомление RelationNotification, тип которого:

- RelationNotification.RELATION_BASIC_REMOVAL, если отношение было только внутренним для Relation Service

- RelationNotification.RELATION_MBEAN_REMOVAL, если отношение зарегистрировано как MBean.

Для MBeans, на которые ссылается такое отношение, ничего не будет сделано.

public void purgeRelations() throws RelationServiceNotRegisteredException

Очищает отношения.

В зависимости от значения purgeFlag, этот метод вызывается либо автоматически при получении уведомления об отмене регистрации MBean, на который ссылается отношение (если флаг установлен в true), либо нет (если флаг установлен в false).

В этом случае пользователь должен вызвать его для поддержания согласованности отношений. Следует помнить, что если MBean отменен и очистка не выполняется немедленно, если ObjectName повторно используется и назначен другому MBean, на который ссылается отношение, вызов метода purgeRelations() вручную приведет к проблемам, так как он будет рассматривать ObjectName как соответствующий отмененному MBean, а не новому.

Поведение зависит от мощности роли, где отмененный MBean ссылается:

- если удаление одной ссылки на MBean в роли делает количество ссылок меньше минимальной степени, отношение должно быть удалено.

- если оставшееся количество ссылок после удаления ссылки на MBean все еще находится в диапазоне мощности, сохраняйте отношение и обновляйте его, вызывая обратный вызов handleMBeanUnregistration().

public Map<String,List<String>> findReferencingRelations(ObjectName mbeanName, String relationTypeName, String roleName) throws IllegalArgumentException

Возвращает отношения, где указанный MBean ссылается.

Это соответствует операциям CIM «Ссылки» и «Имена ссылок».

public Map<ObjectName,List<String>> findAssociatedMBeans(ObjectName mbeanName, String relationTypeName, String roleName) throws IllegalArgumentException

Возвращает MBeans, связанные с заданным в отношении.

Это соответствует операциям CIM «Ассоциированные» и «Имена ассоциатов».

public List<String> findRelationsOfType(String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException

Возвращает идентификаторы отношений для отношений заданного типа.

public List<ObjectName> getRole(String relationId, String roleName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException, RoleNotFoundException

Получает значение роли для заданного имени роли в заданном отношении.

public RoleResult getRoles(String relationId, String[] roleNameArray) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException

Получает значения ролей с заданными именами в заданном отношении.

public RoleResult getAllRoles(String relationId) throws IllegalArgumentException, RelationNotFoundException, RelationServiceNotRegisteredException

Возвращает все роли, присутствующие в отношении.

public Integer getRoleCardinality(String relationId, String roleName) throws IllegalArgumentException, RelationNotFoundException, RoleNotFoundException

Получает количество MBean, в настоящее время ссылающихся на заданную роль.

public void setRole(String relationId, Role role) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException, RoleNotFoundException, InvalidRoleValueException

Устанавливает заданную роль в заданном отношении.

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

Служба отношений будет отслеживать изменения для поддержания согласованности отношений, обрабатывая отмены регистрации ссылающихся MBean.

public RoleResult setRoles(String relationId, RoleList roleList) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException

Устанавливает заданные роли в заданном отношении.

Будет проверять роли в соответствии с их определением в типе отношения.

Служба отношений отслеживает изменения для поддержания согласованности отношений, обрабатывая отмены регистрации ссылающихся MBean.

public Map<ObjectName,List<String>> getReferencedMBeans(String relationId) throws IllegalArgumentException, RelationNotFoundException

Получает MBean, ссылающиеся на различные роли отношения.

public String getRelationTypeName(String relationId) throws IllegalArgumentException, RelationNotFoundException

Возвращает имя связанного типа отношения для данного отношения.

public void handleNotification(Notification notif, Object handback)

Вызывается при возникновении уведомления JMX. В настоящее время обрабатывает уведомления об отмене регистрации MBean, которые либо ссылаются на роль в отношении, либо являются самим отношением.

public MBeanNotificationInfo[] getNotificationInfo()

Возвращает объект NotificationInfo, содержащий имя Java-класса уведомления и типы уведомлений, которые отправляются.