Класс 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.

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.

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

Определен в:

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

Параметры:

roleName - имя роли

Возвращает:

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

Исключения:

IllegalArgumentException - если имя роли равно null

RoleNotFoundException - если:

- роли с заданным именем не существует

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

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

См. также:

• setRole(Role)

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

Определен в:

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

Параметры:

roleNameArray - массив имен возвращаемых ролей

Возвращает:

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

Исключения:

IllegalArgumentException - если имя роли равно null

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

См. также:

• setRoles(RoleList)

public RoleResult getAllRoles() throws RelationServiceNotRegisteredException

Определен в:

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

Возвращает:

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

Исключения:

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

public RoleList retrieveAllRoles()

Определен в:

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

Возвращает:

объект RoleList

public Integer getRoleCardinality(String roleName) throws IllegalArgumentException, RoleNotFoundException

Определен в:

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

Параметры:

roleName - имя роли

Возвращает:

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

Исключения:

IllegalArgumentException - если имя роли равно null

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

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

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

Определен в:

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

Параметры:

list - список задаваемых ролей

Возвращает:

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

Исключения:

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

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

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

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

См. также:

• getRoles(String[])

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

Определен в:

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

Параметры:

objectName - ObjectName MBean, регистрация которого отменена

roleName - имя роли, в которой указан MBean

Исключения:

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

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

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

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

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

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

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

Определен в:

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

Возвращает:

HashMap, содержащий соответствия:

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

public String getRelationTypeName()

Определен в:

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

Возвращает:

имя типа отношения.

public ObjectName getRelationServiceName()

Определен в:

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

Возвращает:

ObjectName Службы отношений.

public String getRelationId()

Определен в:

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

Возвращает:

идентификатор отношения.

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

Определен в:

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

Параметры:

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

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

Возвращает:

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

Исключения:

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

public void postRegister(Boolean registrationDone)

Определен в:

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

Параметры:

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

public void preDeregister() throws Exception

Определен в:

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

Исключения:

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

public void postDeregister()

Определен в:

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

public Boolean isInRelationService()

Определен в:

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

Возвращает:

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

public void setRelationServiceManagementFlag(Boolean flag) throws IllegalArgumentException

Определен в:

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

Параметры:

flag - указывает, обрабатывается ли отношение Службой отношений.

Исключения:

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