模块 java.management

软件包 javax.management.relation

Interface Relation

All Known Subinterfaces:

RelationSupportMBean

所有已知实现类：

RelationSupport

public interface Relation

此接口必须由期望表示使用Relation Service管理的关系的任何MBean类实现。

简单关系，即只有角色，没有属性或方法，可以由Relation Service直接创建（表示为RelationSupport对象，由Relation Service内部处理）。

如果用户想要表示更复杂的关系，涉及属性和/或方法，他必须提供自己的实现Relation接口的类。 这可以通过继承RelationSupport类，或通过实现接口（完全或委托给RelationSupport对象成员）来实现。

指定这样的用户关系类是引入属性和/或方法。 这些必须暴露在远程管理之下。 所以这意味着任何用户关系类都必须是MBean类。

从以下版本开始：

1.5

方法摘要

变量和类型	方法	描述
RoleResult	getAllRoles()	返回关系中存在的所有角色。
Map<ObjectName,List<String>>	getReferencedMBeans()	检索在关系的各种角色中引用的MBean。
String	getRelationId()	返回关系标识符（用于唯一标识Relation Service内的关系）。
ObjectName	getRelationServiceName()	返回处理关系的Relation Service的ObjectName。
String	getRelationTypeName()	返回关联关系类型的名称。
List<ObjectName>	getRole(String roleName)	检索给定角色名称的角色值。
Integer	getRoleCardinality(String roleName)	返回给定角色中当前引用的MBean数。
RoleResult	getRoles(String[] roleNameArray)	检索具有给定名称的角色的值。
void	handleMBeanUnregistration(ObjectName objectName, String roleName)	当取消注册角色中引用的MBean时，Relation Service使用的回调。
RoleList	retrieveAllRoles()	返回关系中的所有角色而不检查读取模式。
void	setRole(Role role)	设置给定角色。
RoleResult	setRoles(RoleList roleList)	设置给定的角色。

方法详细信息

getRole

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

检索给定角色名称的角色值。

根据关系类型检查角色是否存在且可读。

参数

roleName - 角色名称

结果

ObjectName对象的ArrayList是角色值

异常

IllegalArgumentException - 如果为null角色名称

RoleNotFoundException - 如果：

- 给定名称没有任何作用

- 角色不可读。

RelationServiceNotRegisteredException - 如果未在MBean Server中注册Relation Service

另请参见：

setRole(javax.management.relation.Role)

getRoles

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

检索具有给定名称的角色的值。

检查每个角色是否存在，并根据关系类型进行读取。

参数

roleNameArray - 要检索的角色名称数组

结果

RoleResult对象，包括RoleList（用于成功检索的角色）和RoleUnresolvedList（用于未检索的角色）。

异常

IllegalArgumentException - 如果为null角色名称

RelationServiceNotRegisteredException - 如果未在MBean Server中注册Relation Service

另请参见：

setRoles(javax.management.relation.RoleList)

getRoleCardinality

Integer getRoleCardinality(String roleName)                    throws IllegalArgumentException,                           RoleNotFoundException

返回给定角色中当前引用的MBean数。

参数

roleName - 角色名称

结果

该角色中当前引用的MBean的数量

异常

IllegalArgumentException - 如果为null角色名称

RoleNotFoundException - 如果没有给定名称的角色

getAllRoles

RoleResult getAllRoles()                throws RelationServiceNotRegisteredException

返回关系中存在的所有角色。

结果

RoleResult对象，包括RoleList（用于成功检索的角色）和RoleUnresolvedList（用于不可读的角色）。

异常

RelationServiceNotRegisteredException - 如果未在MBean Server中注册Relation Service

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 - 如果为null角色

RoleNotFoundException - 如果提供的角色名称没有角色，或者角色不可写（初始化角色时未对写入访问模式进行测试）

InvalidRoleValueException - 如果为角色提供的值无效，即：

- 给定值中引用的MBean数小于预期的最小程度

- 提供值中引用的MBean数超过预期的最大程度

- 值中一个引用的MBean不是该角色所期望的MBean类的Object

- 不存在为该角色提供的MBean。

RelationServiceNotRegisteredException - 如果未在MBean Server中注册Relation Service

RelationTypeNotFoundException - 如果尚未在Relation Service中声明关系类型。

RelationNotFoundException - 如果尚未在Relation Service中添加关系。

另请参见：

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 - 如果为null角色列表

RelationServiceNotRegisteredException - 如果未在MBean Server中注册Relation Service

RelationTypeNotFoundException - 如果尚未在Relation Service中声明关系类型。

RelationNotFoundException - 如果尚未在Relation Service中添加关系MBean。

另请参见：

getRoles(java.lang.String[])

handleMBeanUnregistration

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

当取消注册角色中引用的MBean时，Relation Service使用的回调。

Relation Service将调用此方法让关系采取措施以反映此类注销的影响。

谨防。 不希望用户调用此方法。

当前实现是使用其当前值（引用的MBean的ObjectNames列表）设置角色，而不使用未注册的角色。

参数

objectName - 未注册的MBean的ObjectName

roleName - 引用MBean的角色的名称

异常

IllegalArgumentException - 如果为null参数

RoleNotFoundException - 如果关系中不存在角色或者不可写

InvalidRoleValueException - 如果角色值不符合关联的角色信息（从Relation Service调用时，这将永远不会发生）

RelationServiceNotRegisteredException - 如果未在MBean Server中注册Relation Service

RelationTypeNotFoundException - 如果尚未在Relation Service中声明关系类型。

RelationNotFoundException - 如果为未在Relation Service中添加的关系MBean调用此方法。

getReferencedMBeans

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

检索在关系的各种角色中引用的MBean。

结果

一个HashMap映射：

ObjectName - > String的StringList（角色名称）

getRelationTypeName

String getRelationTypeName()

返回关联关系类型的名称。

结果

关系类型的名称。

getRelationServiceName

ObjectName getRelationServiceName()

返回处理关系的Relation Service的ObjectName。

结果

Relation Service的ObjectName。

getRelationId

String getRelationId()

返回关系标识符（用于唯一标识Relation Service内的关系）。

结果

the relation id.