| javax.management.relation.Relation
| Relation | | public interface Relation (Code) | | This interface is implemented by an MBean that represents a relation.
Relations with only roles can be created by the relation service using
a
RelationSupport object.
More complicated relations have to implemented manually. The
RelationSupport can be used to help in the implementation.
Any properties or methods must be exposed for management by the
implementing MBean.
author:
Adrian Brock.
version:
$Revision: 57200 $ |
| Method Summary | |
| public RoleResult | getAllRoles()
Retrieves all the roles in this relation. | | public Map | getReferencedMBeans()
Retrieves MBeans referenced by roles of this relation.
The return value is a map keyed by MBean object names. | | public String | getRelationId()
Retrieves the relation id used to identify the relation within
the relation service. | | public ObjectName | getRelationServiceName()
Retrieves the object name of the relation service this relation
is registered with. | | public String | getRelationTypeName()
Retrieves the relation type for this relation. | | public List | getRole(String roleName)
Retrieves the role for the passed role name. | | public Integer | getRoleCardinality(String roleName)
Retrieves the number of MBeans in a given role.
Parameters:
roleName - the role name. | | public RoleResult | getRoles(String[] roleNames)
Retrieves the roles in this relation with the passed names. | | public void | handleMBeanUnregistration(ObjectName objectName, String roleName)
| | public RoleList | retrieveAllRoles()
Retrieve all the roles in this relation without checking the role mode. | | public void | setRole(Role role)
Sets the passed role for this relation.
The role is checked according to its role definition in the relation type. | | public RoleResult | setRoles(RoleList roleList)
Sets the roles.
The roles are checked according to its role definition in the relation type.
The role is not valid if there are the wrong number of MBeans, an MBean
is of an incorrect class or an MBean does not exist.
A notification RELATION_BASIC_UPDATE is sent when the relation is
not an MBean or RELATION_MBEAN_UPDATE when it is for every updated
role.
The return role result has a role list for successfully updated roles and
an unresolved list for roles not set.
Parameters:
roleList - the new roles. |
| getReferencedMBeans | | public Map getReferencedMBeans()(Code) | | Retrieves MBeans referenced by roles of this relation.
The return value is a map keyed by MBean object names. The objects
are associated with an ArrayList that contains all the role names
the MBean has within this relation.
the map of object names and their roles. |
| getRelationId | | public String getRelationId()(Code) | | Retrieves the relation id used to identify the relation within
the relation service.
the unique id. |
| getRelationServiceName | | public ObjectName getRelationServiceName()(Code) | | Retrieves the object name of the relation service this relation
is registered with.
the relation service object name. |
| getRelationTypeName | | public String getRelationTypeName()(Code) | | Retrieves the relation type for this relation.
the relation type. |
| retrieveAllRoles | | public RoleList retrieveAllRoles()(Code) | | Retrieve all the roles in this relation without checking the role mode.
the list of roles. |
|
|