compact3

javax.management.relation

Класс RelationSupport

java.lang. Объект

javax.management.relation.RelationSupport

Все Реализованные Интерфейсы:

MBeanRegistration, Отношение, RelationSupportMBean

public class RelationSupport
extends Object
implements RelationSupportMBean, MBeanRegistration

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

RelationSupport class соответствует шаблонам разработки стандартного MBean. Таким образом, пользователь может решить инстанцировать объекта RelationSupport непосредственно как MBean (поскольку это следует за шаблонами разработки MBean), чтобы зарегистрировать это в Сервере MBean, и затем добавить это в Службе Отношения.

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

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

RelationSupport реализует интерфейс Отношения (чтобы быть обработанным Службой Отношения).

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

С тех пор:

1.5

Сводка конструктора

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

Конструктор и Описание
RelationSupport(String relationId, ObjectName relationServiceName, MBeanServer relationServiceMBeanServer, String relationTypeName, RoleList list) Создает a RelationSupport объект.
RelationSupport(String relationId, ObjectName relationServiceName, String relationTypeName, RoleList list) Создает a RelationSupport объект.

Сводка метода

Модификатор и Тип	Метод и Описание
RoleResult	getAllRoles() Возвраты все роли, существующие в отношении.
Map<ObjectName,List<String>>	getReferencedMBeans() Получает MBeans, на который ссылаются в различных ролях отношения.
Строка	getRelationId() Идентификатор отношения возвратов (имел обыкновение однозначно определять отношение в Службе Отношения).
ObjectName	getRelationServiceName() Возвраты ObjectName Службы Отношения, обрабатывающей отношение.
Строка	getRelationTypeName() Имя возвратов связанного типа отношения.
List<ObjectName>	getRole(String roleName) Получает ролевое значение для данного ролевого имени.
Целое число	getRoleCardinality(String roleName) Возвращает число MBeans, на который в настоящий момент ссылаются в данной роли.
RoleResult	getRoles(String[] roleNameArray) Получает значения ролей с именами.
void	handleMBeanUnregistration(ObjectName objectName, String roleName) Обратный вызов, используемый Службой Отношения, когда MBean, на который ссылаются в роли, незарегистрирован.
Булев	isInRelationService() Возвращает внутренний флаг, определяющий, обрабатывается ли объект все еще Службой Отношения.
void	postDeregister() Позволяет MBean выполнять любые операции, необходимые будучи незарегистрированным в сервере MBean.
void	postRegister(Boolean registrationDone) Позволяет MBean выполнять любые операции, необходимые, будучи зарегистрированным в сервере MBean или после того, как регистрация перестала работать.
void	preDeregister() Позволяет MBean выполнять любые операции, в которых он нуждается перед стать незарегистрированным сервером MBean.
ObjectName	preRegister(MBeanServer server, ObjectName name) Позволяет MBean выполнять любые операции, в которых он нуждается прежде, чем быть зарегистрированным в Сервере MBean.
RoleList	retrieveAllRoles() Возвраты все роли в отношении, не проверяя режим чтения.
void	setRelationServiceManagementFlag(Boolean flag) Определяет, обрабатывается ли это отношение Службой Отношения.
void	setRole(Role role) Устанавливает данную роль.
RoleResult	setRoles(RoleList list) Устанавливает данные роли.

Методы, наследованные от class java.lang. Объект

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

Деталь конструктора

RelationSupport

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

Создает a RelationSupport объект.

Этот конструктор должен использоваться, когда объект RelationSupport будет зарегистрирован как MBean пользователем, или создавая пользовательское отношение MBean, class которого расширяет RelationSupport.

Ничто не делается в Уровне обслуживания Отношения, то есть RelationSupport объект не добавляется к RelationService и никакие проверки не выполняются, чтобы видеть, корректны ли обеспеченные значения. Объект всегда создается, КРОМЕ если:

- любой из обязательных параметров null.

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

Быть обработанным как отношение, RelationSupport объект должен быть добавлен к Службе Отношения, используя метод Relation Service addRelation ().

Параметры:

relationId - идентификатор отношения, чтобы идентифицировать отношение в Службе Отношения.

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

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

Этот параметр требуется, поскольку это - Служба Отношения, которая знает об определении типа отношения данного отношения, так, чтобы был в состоянии проверить операции обновления (набор).

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

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

list - список ролей (Ролевые объекты), чтобы инициализировать отношение. Может быть null.

Ожидаемый соответствовать информации отношения в связанном типе отношения.

Броски:

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

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

RelationSupport

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

Создает a RelationSupport объект.

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

Этот объект должен знать Службу Отношения, которая, как ожидают, обработает отношение. Таким образом, это должно знать Сервер MBean, где Служба Отношения регистрируется.

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

Ничто не делается в Уровне обслуживания Отношения, то есть RelationSupport объект не добавляется к RelationService и никакие проверки не выполняются, чтобы видеть, корректны ли обеспеченные значения. Объект всегда создается, КРОМЕ если:

- любой из обязательных параметров null.

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

Быть обработанным как отношение, RelationSupport объект должен быть добавлен к Службе Отношения, используя метод Relation Service addRelation ().

Параметры:

relationId - идентификатор отношения, чтобы идентифицировать отношение в Службе Отношения.

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

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

Этот параметр требуется, поскольку это - Служба Отношения, которая знает об определении типа отношения данного отношения, так, чтобы был в состоянии проверить операции обновления (набор).

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

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

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

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

list - список ролей (Ролевые объекты), чтобы инициализировать отношение. Может быть null.

Ожидаемый соответствовать информации отношения в связанном типе отношения.

Броски:

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

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

Деталь метода

getRole

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

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

Проверки, если роль существует и читаема согласно типу отношения.

Определенный:

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

Параметры:

roleName - имя роли

Возвраты:

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

Броски:

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

RoleNotFoundException - если:

- нет никакой роли с именем

- роль не читаема.

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

См. Также:

setRole(javax.management.relation.Role)

getRoles

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

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

Проверки на каждую роль, если это существует и читаемо согласно типу отношения.

Определенный:

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

Параметры:

roleNameArray - массив имен ролей, которые будут получены

Возвраты:

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

Броски:

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

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

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

Определенный:

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

Параметры:

roleName - имя роли

Возвраты:

число MBeans, на который в настоящий момент ссылаются, в той роли

Броски:

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

RoleNotFoundException - если нет никакой роли с именем

setRole

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

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

Проверит роль согласно ее соответствующему ролевому определению, обеспеченному в типе отношения отношения

Отправит уведомление (RelationNotification с типом RELATION_BASIC_UPDATE или RELATION_MBEAN_UPDATE, завися, если отношение будет MBean или не).

Определенный:

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

Параметры:

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

Броски:

IllegalArgumentException - если нулевая роль

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

InvalidRoleValueException - если значение, предусмотренное роль, не допустимо, то есть:

- число MBeans, на который ссылаются, в данном значении менее чем ожидается минимальный градус

- число MBeans, на который ссылаются, в обеспеченном значении превышает ожидаемый максимальный градус

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

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

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

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

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

См. Также:

getRole(java.lang.String)

setRoles

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

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

Проверит роль согласно ее соответствующему ролевому определению, обеспеченному в типе отношения отношения

Отправит одно уведомление (RelationNotification с типом RELATION_BASIC_UPDATE или RELATION_MBEAN_UPDATE, завися, если отношение будет MBean или не) на обновленную роль.

Определенный:

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

Параметры:

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

Возвраты:

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

Броски:

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

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

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

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

См. Также:

getRoles(java.lang.String[])

handleMBeanUnregistration

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

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

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

ОСТЕРЕГАТЬСЯ. пользователь, как ожидают, не вызовет этот метод.

Текущая реализация должна установить роль со своей текущей стоимостью (список ObjectNames MBeans, на который ссылаются) без незарегистрированного.

Определенный:

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

Параметры:

objectName - ObjectName незарегистрированного MBean

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

Броски:

IllegalArgumentException - если нулевой параметр

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

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

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

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

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

getReferencedMBeans

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

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

Определенный:

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

Возвраты:

отображение HashMap:

ObjectName-> ArrayList Строки (ролевые имена)

getRelationTypeName

public String getRelationTypeName()

Имя возвратов связанного типа отношения.

Определенный:

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

Возвраты:

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

getRelationServiceName

public ObjectName getRelationServiceName()

Возвраты ObjectName Службы Отношения, обрабатывающей отношение.

Определенный:

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

Возвраты:

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

getRelationId

public String getRelationId()

Идентификатор отношения возвратов (имел обыкновение однозначно определять отношение в Службе Отношения).

Определенный:

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

Возвраты:

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

предварительный регистр

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

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

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

Определенный:

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

Параметры:

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

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

Возвраты:

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

Броски:

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

пострегистр

public void postRegister(Boolean registrationDone)

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

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

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

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

Определенный:

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

Параметры:

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

предварительно вычеркнуть из списка

public void preDeregister()
                   throws Exception

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

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

Определенный:

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

Броски:

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

поствычеркнуть из списка

public void postDeregister()

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

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

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

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

Определенный:

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 - если нулевой параметр