Returns all roles present in the relation.

  Returns all roles present in the relation.
Returns: a RoleResult object, including a RoleList (for roles successfully retrieved) and a RoleUnresolvedList (for roles not readable).
Throws:
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server

  Retrieves MBeans referenced in the various roles of the relation.

  Retrieves MBeans referenced in the various roles of the relation.
Returns: a HashMap mapping:

ObjectName -> ArrayList of String (role names)

  Returns relation identifier (used to uniquely identify the relation inside the Relation Service).

  Returns relation identifier (used to uniquely identify the relation
inside the Relation Service).
Returns: the relation id.

  Returns ObjectName of the Relation Service handling the relation.

  Returns ObjectName of the Relation Service handling the relation.
Returns: the ObjectName of the Relation Service.

  Returns name of associated relation type.

  Returns name of associated relation type.
Returns: the name of the relation type.

  Retrieves role value for given role name.

  Retrieves role value for given role name.

Checks if the role exists and is readable according to the relation type.
Returns: the ArrayList of ObjectName objects being the role value
Parameters:
- roleName - name of role
Throws:
- IllegalArgumentException - if null role name
- RoleNotFoundException - if:

- there is no role with given name

- the role is not readable.
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
See Also: Relation.setRole(javax.management.relation.Role),

  Returns the number of MBeans currently referenced in the given role.

  Returns the number of MBeans currently referenced in the given role.
Returns: the number of currently referenced MBeans in that role
Parameters:
- roleName - name of role
Throws:
- IllegalArgumentException - if null role name
- RoleNotFoundException - if there is no role with given name

  Retrieves values of roles with given names.

  Retrieves values of roles with given names.

Checks for each role if it exists and is readable according to the relation type.
Returns: a RoleResult object, including a RoleList (for roles successfully retrieved) and a RoleUnresolvedList (for roles not retrieved).
Parameters:
- roleNameArray - array of names of roles to be retrieved
Throws:
- IllegalArgumentException - if null role name
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
See Also: Relation.setRoles(javax.management.relation.RoleList),

  Callback used by the Relation Service when a MBean referenced in a role is unregistered.

  Callback used by the Relation Service when a MBean referenced in a role is unregistered.

The Relation Service will call this method to let the relation take action to reflect the impact of such unregistration.

BEWARE. the user is not expected to call this method.

Current implementation is to set the role with its current value (list of ObjectNames of referenced MBeans) without the unregistered one.
Parameters:
- objectName - ObjectName of unregistered MBean
- roleName - name of role where the MBean is referenced
Throws:
- IllegalArgumentException - if null parameter
- RoleNotFoundException - if role does not exist in the relation or is not writable
- InvalidRoleValueException - if role value does not conform to the associated role info (this will never happen when called from the Relation Service)
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
- RelationTypeNotFoundException - if the relation type has not been declared in the Relation Service.
- RelationNotFoundException - if this method is called for a relation MBean not added in the Relation Service.

  Returns all roles in the relation without checking read mode.

  Returns all roles in the relation without checking read mode.
Returns: a RoleList.

  Sets the given role.

  Sets the given role.

Will check the role according to its corresponding role definition provided in relation's relation type

Will send a notification (RelationNotification with type RELATION_BASIC_UPDATE or RELATION_MBEAN_UPDATE, depending if the relation is a MBean or not).
Parameters:
- role - role to be set (name and new value)
Throws:
- IllegalArgumentException - if null role
- RoleNotFoundException - if there is no role with the supplied role's name or if the role is not writable (no test on the write access mode performed when initializing the role)
- InvalidRoleValueException - if value provided for role is not valid, i.e.:

- the number of referenced MBeans in given value is less than expected minimum degree

- the number of referenced MBeans in provided value exceeds expected maximum degree

- one referenced MBean in the value is not an Object of the MBean class expected for that role

- a MBean provided for that role does not exist.
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
- RelationTypeNotFoundException - if the relation type has not been declared in the Relation Service.
- RelationNotFoundException - if the relation has not been added in the Relation Service.
See Also: Relation.getRole(java.lang.String),

  Sets the given roles.

  Sets the given roles.

Will check the role according to its corresponding role definition provided in relation's relation type

Will send one notification (RelationNotification with type RELATION_BASIC_UPDATE or RELATION_MBEAN_UPDATE, depending if the relation is a MBean or not) per updated role.
Returns: a RoleResult object, including a RoleList (for roles successfully set) and a RoleUnresolvedList (for roles not set).
Parameters:
- roleList - list of roles to be set
Throws:
- IllegalArgumentException - if null role list
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
- RelationTypeNotFoundException - if the relation type has not been declared in the Relation Service.
- RelationNotFoundException - if the relation MBean has not been added in the Relation Service.
See Also: Relation.getRoles(java.lang.String[]),