compact3

javax.management.relation

Отношение интерфейса

Все Известные Подынтерфейсы:

RelationSupportMBean

Все Известные Классы с реализацией:

RelationSupport

public interface Relation

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

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

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

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

С тех пор:

1.5

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

Модификатор и Тип	Метод и Описание
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, на который ссылаются в роли, незарегистрирован.
RoleList	retrieveAllRoles() Возвраты все роли в отношении, не проверяя режим чтения.
void	setRole(Role role) Устанавливает данную роль.
RoleResult	setRoles(RoleList roleList) Устанавливает данные роли.

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

getRole

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

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

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

Параметры:

roleName - имя роли

Возвраты:

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

Броски:

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

RoleNotFoundException - если:

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

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

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

См. Также:

setRole(javax.management.relation.Role)

getRoles

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

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

См. Также:

setRoles(javax.management.relation.RoleList)

getRoleCardinality

Integer getRoleCardinality(String roleName)
                    throws IllegalArgumentException,
                           RoleNotFoundException

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

Параметры:

roleName - имя роли

Возвраты:

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

Броски:

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

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

getAllRoles

RoleResult getAllRoles()
                throws RelationServiceNotRegisteredException

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

Возвраты:

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

Броски:

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

retrieveAllRoles

RoleList retrieveAllRoles()

Возвраты все роли в отношении, не проверяя режим чтения.

Возвраты:

RoleList.

setRole

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

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

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

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

Параметры:

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

Броски:

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

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

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

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

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

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

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

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

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

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

См. Также:

getRole(java.lang.String)

setRoles

RoleResult setRoles(RoleList roleList)
             throws IllegalArgumentException,
                    RelationServiceNotRegisteredException,
                    RelationTypeNotFoundException,
                    RelationNotFoundException

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

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

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

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

См. Также:

getRoles(java.lang.String[])

handleMBeanUnregistration

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

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

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

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

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

Параметры:

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

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

Броски:

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

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

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

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

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

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

getReferencedMBeans

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

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

Возвраты:

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

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

getRelationTypeName

String getRelationTypeName()

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

Возвраты:

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

getRelationServiceName

ObjectName getRelationServiceName()

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

Возвраты:

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

getRelationId

String getRelationId()

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

Возвраты:

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