public interface Relation
此接口必须由任何 MBean 类(期望表示为一种使用 Relation Service 管理的关系)来实现。
简单的关系(即只有角色,没有属性或方法)可以由 Relation Service 直接创建(表示为 RelationSupport 对象,由 Relation Service 内部处理)。
如果用户希望表示更复杂的关系(包括属性和/或方法),则其必须提供自己实现 Relation 接口的类。这可以通过从 RelationSupport 类继承得到,也可以通过实现该接口得到(全权或者委托给 RelationSupport 对象成员)。
指定这样的用户关系类是为了引入属性和/或方法。这些都要向远程管理公开。因此,这意味着任何用户关系类都必须是一个 MBean 类。
方法摘要 | |
---|---|
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) 设置给定的角色。 |
方法详细信息 |
---|
List<ObjectName> getRole(String roleName) throws IllegalArgumentException, RoleNotFoundException, RelationServiceNotRegisteredException
按照关系类型检查角色是否存在及是否可读。
roleName
- 角色名称
IllegalArgumentException
- 如果为 null 角色名称
RoleNotFoundException
- 如果:
- 不存在具有给定名称的角色
- 角色不可读。
RelationServiceNotRegisteredException
- 如果 Relation Service 未在 MBean Server 中注册
setRole(javax.management.relation.Role)
RoleResult getRoles(String[] roleNameArray) throws IllegalArgumentException, RelationServiceNotRegisteredException
按照关系类型检查每个角色是否存在及是否可读。
roleNameArray
- 要检索的角色名称的数组
IllegalArgumentException
- 如果是 null 角色名称
RelationServiceNotRegisteredException
- 如果 Relation Service 未在 MBean Server 中注册。
setRoles(javax.management.relation.RoleList)
Integer getRoleCardinality(String roleName) throws IllegalArgumentException, RoleNotFoundException
roleName
- 角色名称
IllegalArgumentException
- 如果是 null 角色名称
RoleNotFoundException
- 如果不存在具有给定名称的角色
RoleResult getAllRoles() throws RelationServiceNotRegisteredException
RelationServiceNotRegisteredException
- 如果 Relation Service 未在 MBean Server 中注册
RoleList retrieveAllRoles()
void setRole(Role role) throws IllegalArgumentException, RoleNotFoundException, RelationTypeNotFoundException, InvalidRoleValueException, RelationServiceNotRegisteredException, RelationNotFoundException
将按照其在关系的关系类型中提供的相应角色定义检查角色
将发送通知(带类型 RELATION_BASIC_UPDATE 或 RELATION_MBEAN_UPDATE 的 RelationNotification,具体取决于该关系是否为 MBean)
role
- 要设置的角色(名称和新值)
IllegalArgumentException
- 如果是 null 角色。
RoleNotFoundException
- 如果不存在具有指定名称的角色,或者该角色不可写(初始化角色时未执行写入访问模式测试)。
InvalidRoleValueException
- 如果为角色提供的值无效,例如:
- 给定值中引用的 MBean 数小于期望的最小程度;
- 提供的值中引用的 MBean 数超过期望的最大程度;
- 该值中引用的 MBean 的一个对象不是该角色期望的 MBean 类的对象;
- 如果不存在为该角色提供的 MBean。
RelationServiceNotRegisteredException
- 如果 Relation Service 未在 MBean Server 中注册。
RelationTypeNotFoundException
- 如果在 Relation Service 中尚未声明该关系类型。
RelationNotFoundException
- 如果尚未在 Relation Service 中添加关系。
getRole(java.lang.String)
RoleResult setRoles(RoleList roleList) throws IllegalArgumentException, RelationServiceNotRegisteredException, RelationTypeNotFoundException, RelationNotFoundException
将按照其在关系的关系类型中提供的相应角色定义检查角色
每个更新的角色将发送一个通知(带类型 RELATION_BASIC_UPDATE 或 RELATION_MBEAN_UPDATE 的 RelationNotification,具体取决于该关系是否为 MBean)。
roleList
- 要设置的角色列表
IllegalArgumentException
- 如果是 null 角色列表;
RelationServiceNotRegisteredException
- 如果 Relation Service 未在 MBean Server 中注册;
RelationTypeNotFoundException
- 如果在 Relation Service 中尚未声明该关系类型;
RelationNotFoundException
- 如果尚未在 Relation Service 中添加关系 MBean。
getRoles(java.lang.String[])
void handleMBeanUnregistration(ObjectName objectName, String roleName) throws IllegalArgumentException, RoleNotFoundException, InvalidRoleValueException, RelationServiceNotRegisteredException, RelationTypeNotFoundException, RelationNotFoundException
Relation Service 将调用此方法,以让该关系采取行动来反映这种注销的影响。
小心,不期望用户调用此方法。
当前实现是为了用其当前值(引用的 MBean 的 ObjectName 列表)而不用注销的值设置角色。
objectName
- 注销的 MBean 的 ObjectName
roleName
- 在其中引用 MBean 的角色名称
IllegalArgumentException
- 如果是 null 参数;
RoleNotFoundException
- 如果角色不在关系中或不可写;
InvalidRoleValueException
- 如果角色值不遵循相关角色信息(这永远不会在从 Relation Service 中调用时发生);
RelationServiceNotRegisteredException
- 如果 Relation Service 未在 MBean Server 注册;
RelationTypeNotFoundException
- 如果在 Relation Service 中尚未声明该关系类型;
RelationNotFoundException
- 如果未在 Relation Service 中添加的关系 MBean 调用此方法。
Map<ObjectName,List<String>> getReferencedMBeans()
ObjectName -> ArrayList of String(角色名)
String getRelationTypeName()
ObjectName getRelationServiceName()
String getRelationId()