Класс RelationSupport

public class RelationSupport
extends Object
implements RelationSupportMBean, MBeanRegistration

Объект RelationSupport используется внутри службы Relation для представления простых отношений (только роли, без свойств или методов), с неограниченным количеством ролей любого типа отношения. Как внутреннее представление, он не предоставляется пользователю.

Класс RelationSupport соответствует паттернам проектирования стандартного MBean. Поэтому пользователь может сам создать объект RelationSupport в качестве MBean (так как он соответствует паттернам проектирования MBean), зарегистрировать его в сервере MBean, а затем добавить его в службу Relation.

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

Также возможно, что в пользовательском классе MBean отношения будет член, являющийся объектом RelationSupport, и реализовать необходимые интерфейсы, делегировав все этому члену.

RelationSupport реализует интерфейс Relation (для обработки службой Relation).

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

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

RelationSupport

public RelationSupport(String relationId,
                       ObjectName relationServiceName,
                       String relationTypeName,
                       RoleList list)
                throws InvalidRoleValueException,
                       IllegalArgumentException

Параметры:

relationId - идентификатор отношения, для идентификации отношения в службе отношений.

Ожидается, что он будет уникальным в данной службе отношений.

relationServiceName - ObjectName службы отношений, где будет зарегистрировано отношение.

Этот параметр требуется, так как именно служба отношений осведомлена о определении типа отношения данного отношения, поэтому она сможет проверять операции обновления (set).

relationTypeName - Имя типа отношения.

Ожидается, что оно было создано в данной службе отношений.

list - список ролей (объекты Role) для инициализации отношения. Может быть null.

Ожидается, что он будет соответствовать информации об отношении в связанном типе отношения.

Исключения:

InvalidRoleValueException - если для двух ролей используется одно и то же имя.

IllegalArgumentException - если любой из необходимых параметров (идентификатор отношения, ObjectName службы отношений или имя типа отношения) null.

RelationSupport

public RelationSupport(String relationId,
                       ObjectName relationServiceName,
                       MBeanServer relationServiceMBeanServer,
                       String relationTypeName,
                       RoleList list)
                throws InvalidRoleValueException,
                       IllegalArgumentException

Параметры:

relationId - идентификатор отношения, для идентификации отношения в службе отношений.

Ожидается, что он будет уникальным в данной службе отношений.

relationServiceName - ObjectName службы отношений, где будет зарегистрировано отношение.

Этот параметр требуется, так как именно служба отношений осведомлена о определении типа отношения данного отношения, поэтому она сможет проверять операции обновления (set).

relationServiceMBeanServer - MBean сервер, где зарегистрирован или будет зарегистрирован обертывающий MBean.

Ожидается, что это MBean сервер, где зарегистрирована или будет зарегистрирована служба отношений.

relationTypeName - Имя типа отношения.

Ожидается, что оно было создано в данной службе отношений.

list - список ролей (объекты Role) для инициализации отношения. Может быть null.

Ожидается, что он будет соответствовать информации об отношении в связанном типе отношения.

Исключения:

InvalidRoleValueException - если для двух ролей используется одно и то же имя.

IllegalArgumentException - если любой из необходимых параметров (идентификатор отношения, ObjectName службы отношений, MBean сервер службы отношений или имя типа отношения) null.

Методы

getRole

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

Унаследовано от:

getRole в интерфейсе Relation

Параметры:

roleName - имя роли

Возвращает:

ArrayList объектов ObjectName, представляющих значение роли

Исключения:

IllegalArgumentException - если имя роли null

RoleNotFoundException - если:

- нет роли с данным именем

- роль недоступна для чтения.

RelationServiceNotRegisteredException - если служба отношений не зарегистрирована в MBean сервере

См. также:

setRole(javax.management.relation.Role)

getRoles

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

Унаследовано от:

getRoles в интерфейсе Relation

Параметры:

roleNameArray - массив имён ролей для получения

Возвращает:

объект RoleResult, содержащий RoleList (для успешно полученных ролей) и RoleUnresolvedList (для ролей, не полученных).

Исключения:

IllegalArgumentException - если имя роли null

RelationServiceNotRegisteredException - если служба отношений не зарегистрирована в MBean сервере

См. также:

setRoles(javax.management.relation.RoleList)

getAllRoles

public RoleResult getAllRoles()
                       throws RelationServiceNotRegisteredException

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

Унаследовано от:

getAllRoles в интерфейсе Relation

Возвращает:

объект RoleResult, содержащий RoleList (для успешно полученных ролей) и RoleUnresolvedList (для ролей, недоступных для чтения).

Исключения:

RelationServiceNotRegisteredException - если служба отношений не зарегистрирована в MBean сервере

retrieveAllRoles

public RoleList retrieveAllRoles()

Возвращает все роли в отношении без проверки режима чтения.

Унаследовано от:

retrieveAllRoles в интерфейсе Relation

Возвращает:

RoleList

getRoleCardinality

public Integer getRoleCardinality(String roleName)
                           throws IllegalArgumentException,
                                  RoleNotFoundException

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

Унаследовано от:

getRoleCardinality в интерфейсе Relation

Параметры:

roleName - имя роли

Возвращает:

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

Исключения:

IllegalArgumentException - если имя роли null

RoleNotFoundException - если нет роли с данным именем

setRole

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

Унаследовано от:

setRole в интерфейсе Relation

Параметры:

role - роль для установки (имя и новое значение)

Исключения:

IllegalArgumentException - если роль null

RoleNotFoundException - если нет роли с заданным именем или роль не доступна для записи (проверка доступа на запись при инициализации роли не выполняется).

InvalidRoleValueException - если предоставленное значение для роли неверно, т.е.:

- количество ссылающихся MBean в данном значении меньше ожидаемого минимального степеня

- количество ссылающихся MBean в предоставленном значении превышает ожидаемый максимальный степеня

- один из ссылающихся MBean в значении не является объектом класса MBean, ожидаемого для данной роли

- MBean, предоставленный для данной роли, не существует

RelationServiceNotRegisteredException - если служба отношений не зарегистрирована в MBean сервере

RelationTypeNotFoundException - если тип отношения не объявлен в службе отношений

RelationNotFoundException - если отношение не добавлено в службу отношений.

См. также:

getRole(java.lang.String)

setRoles

public RoleResult setRoles(RoleList list)
                    throws IllegalArgumentException,
                           RelationServiceNotRegisteredException,
                           RelationTypeNotFoundException,
                           RelationNotFoundException

Унаследовано от:

setRoles в интерфейсе Relation

Параметры:

list - список ролей для установки

Возвращает:

объект RoleResult, содержащий RoleList (для успешно установленных ролей) и RoleUnresolvedList (для ролей, не установленных).

Исключения:

IllegalArgumentException - если список ролей null

RelationServiceNotRegisteredException - если служба отношений не зарегистрирована в MBean сервере

RelationTypeNotFoundException - если тип отношения не объявлен в службе отношений.

RelationNotFoundException - если MBean отношения не добавлен в службу отношений.

См. также:

getRoles(java.lang.String[])

handleMBeanUnregistration

public void handleMBeanUnregistration(ObjectName objectName,
                                      String roleName)
                               throws IllegalArgumentException,
                                      RoleNotFoundException,
                                      InvalidRoleValueException,
                                      RelationServiceNotRegisteredException,
                                      RelationTypeNotFoundException,
                                      RelationNotFoundException

Указывается:

handleMBeanUnregistration в интерфейсе Relation

Параметры:

objectName - Имя объекта неучтенного MBean

roleName - имя роли, где ссылается на MBean

Исключения:

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

RoleNotFoundException - если роли не существует в связи или она недоступна для записи

InvalidRoleValueException - если значение роли не соответствует информации о связанной роли (это никогда не произойдёт при вызове из сервиса связи)

RelationServiceNotRegisteredException - если служба связи не зарегистрирована в сервере MBean

RelationTypeNotFoundException - если тип связи не объявлен в службе связи.

RelationNotFoundException - если этот метод вызывается для объекта MBean связи, не добавленного в службу связи.

getReferencedMBeans

public Map<ObjectName,List<String>> getReferencedMBeans()

Извлекает MBeans, на которые ссылаются в различных ролях связи.

Указывается:

getReferencedMBeans в интерфейсе Relation

Возвращает:

a HashMap, отображающий:

ObjectName -> ArrayList строк (имена ролей)

getRelationTypeName

public String getRelationTypeName()

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

Указывается:

getRelationTypeName в интерфейсе Relation

Возвращает:

имя типа связи.

getRelationServiceName

public ObjectName getRelationServiceName()

Возвращает ObjectName службы связи, обрабатывающей связь.

Указывается:

getRelationServiceName в интерфейсе Relation

Возвращает:

ObjectName службы связи.

getRelationId

public String getRelationId()

Возвращает идентификатор связи (используется для уникальной идентификации связи внутри службы связи).

Указывается:

getRelationId в интерфейсе Relation

Возвращает:

идентификатор связи.

preRegister

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

Описание скопировано из интерфейса: MBeanRegistration

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

Указывается:

preRegister в интерфейсе MBeanRegistration

Параметры:

server - Сервер MBean, в котором будет зарегистрирован MBean.

name - Имя объекта MBean. Это имя равно null, если параметр name для одного из createMBean или registerMBean методов в интерфейсе MBeanServer равен null. В этом случае этот метод должен вернуть не null ObjectName для нового MBean.

Возвращает:

Имя, под которым MBean должен быть зарегистрирован. Это значение не должно быть null. Если параметр name не равен null, обычно, но не обязательно, это возвращаемое значение.

Исключения:

Exception - Это исключение будет перехвачено сервером MBean и повторно выброшено как MBeanRegistrationException.

postRegister

public void postRegister(Boolean registrationDone)

Описание скопировано из интерфейса: MBeanRegistration

Указывается:

postRegister в интерфейсе MBeanRegistration

Параметры:

registrationDone - Указывает, был ли MBean успешно зарегистрирован в сервере MBean. Значение false означает, что фаза регистрации завершилась неудачно.

preDeregister

public void preDeregister()
                   throws Exception

Описание скопировано из интерфейса: MBeanRegistration

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

Указывается:

preDeregister в интерфейсе MBeanRegistration

Исключения:

Exception - Это исключение будет перехвачено сервером MBean и повторно выброшено как MBeanRegistrationException.

postDeregister

public void postDeregister()

Описание скопировано из интерфейса: MBeanRegistration

Указывается:

postDeregister в интерфейсе MBeanRegistration

isInRelationService

public Boolean isInRelationService()

Возвращает внутренний флаг, указывающий, обрабатывается ли объект службой связи.

Указывается:

isInRelationService в интерфейсе RelationSupportMBean

Возвращает:

булево значение, равное Boolean.TRUE, если объект по-прежнему обрабатывается службой связи, и Boolean.FALSE в противном случае.

setRelationServiceManagementFlag

public void setRelationServiceManagementFlag(Boolean flag)
                                      throws IllegalArgumentException

Описание скопировано из интерфейса: RelationSupportMBean

Указывается:

setRelationServiceManagementFlag в интерфейсе RelationSupportMBean

Параметры:

flag - обрабатывается ли связь службой связи.

Исключения:

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