To be added as a relation, the MBean must conform to the following:

- implement the Relation interface

- have for RelationService ObjectName the ObjectName of current Relation Service

- have a relation id unique and unused in current Relation Service

- have for relation type a relation type created in the Relation Service

- have roles conforming to the role info provided in the relation type.
Parameters:
- relationObjectName - ObjectName of the relation MBean to be added.
Throws:
- IllegalArgumentException - if null parameter
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
- NoSuchMethodException - If the MBean does not implement the Relation interface
- InvalidRelationIdException - if:

- no relation identifier in MBean

- the relation identifier is already used in the Relation Service
- InstanceNotFoundException - if the MBean for given ObjectName has not been registered
- InvalidRelationServiceException - if:

- no Relation Service name in MBean

- the Relation Service name in the MBean is not the one of the current Relation Service
- RelationTypeNotFoundException - if:

- no relation type name in MBean

- the relation type name in MBean does not correspond to a relation type created in the Relation Service
- InvalidRoleValueException - if:

- the number of referenced MBeans in a role is less than expected minimum degree

- the number of referenced MBeans in a role exceeds expected maximum degree

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

- an MBean provided for a role does not exist
- RoleNotFoundException - if a value is provided for a role that does not exist in the relation type

- the same name has been used for two different roles

- no role info provided

- one null role info provided

- there is already a relation type with that name

- 0 if role can be read

- integer corresponding to RoleStatus.NO_ROLE_WITH_NAME

- integer corresponding to RoleStatus.ROLE_NOT_READABLE
Parameters:
- roleName - name of role to be checked
- relationTypeName - name of the relation type
Throws:
- IllegalArgumentException - if null parameter
- RelationTypeNotFoundException - if the relation type is not known in the Relation Service

- 0 if role can be set

- integer corresponding to RoleStatus.NO_ROLE_WITH_NAME

- integer for RoleStatus.ROLE_NOT_WRITABLE

- integer for RoleStatus.LESS_THAN_MIN_ROLE_DEGREE

- integer for RoleStatus.MORE_THAN_MAX_ROLE_DEGREE

- integer for RoleStatus.REF_MBEAN_OF_INCORRECT_CLASS

- integer for RoleStatus.REF_MBEAN_NOT_REGISTERED
Parameters:
- role - role to be checked
- relationTypeName - name of relation type
- initFlag - flag to specify that the checking is done for the initialization of a role, write access shall not be verified.
Throws:
- IllegalArgumentException - if null parameter
- RelationTypeNotFoundException - if unknown relation type

Roles are initialized according to the role list provided in parameter. The ones not initialized in this way are set to an empty ArrayList of ObjectNames.

A RelationNotification, with type RELATION_BASIC_CREATION, is sent.
Parameters:
- relationId - relation identifier, to identify uniquely the relation inside the Relation Service
- relationTypeName - name of the relation type (has to be created in the Relation Service)
- roleList - role list to initialize roles of the relation (can be null).
Throws:
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
- IllegalArgumentException - if null parameter, except the role list which can be null if no role initialization
- RoleNotFoundException - if a value is provided for a role that does not exist in the relation type
- InvalidRelationIdException - if relation id already used
- RelationTypeNotFoundException - if relation type not known in Relation Service
- InvalidRoleValueException - if:

- the same role name is used for two different roles

- 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

- an MBean provided for that role does not exist

- there is already a relation type with that name

- the same name has been used for two different role infos

- no role info provided

- one null role info provided

This corresponds to CIM Associators and AssociatorNames operations.
Returns: an HashMap, where the keys are the ObjectNames of the MBeans associated to given MBean, and the value is, for each key, an ArrayList of the relation ids of the relations where the key MBean is associated to given one (as they can be associated in several different relations).
Parameters:
- mbeanName - ObjectName of MBean
- relationTypeName - can be null; if specified, only the relations of that type will be considered in the search. Else all relation types are considered.
- roleName - can be null; if specified, only the relations where the MBean is referenced in that role will be considered. Else all roles are considered.
Throws:
- IllegalArgumentException - if null parameter

This corresponds to the CIM "References" and "ReferenceNames" operations.
Returns: an HashMap, where the keys are the relation ids of the relations where the MBean is referenced, and the value is, for each key, an ArrayList of role names (as an MBean can be referenced in several roles in the same relation).
Parameters:
- mbeanName - ObjectName of MBean
- relationTypeName - can be null; if specified, only the relations of that type will be considered in the search. Else all relation types are considered.
- roleName - can be null; if specified, only the relations where the MBean is referenced in that role will be returned. Else all roles are considered.
Throws:
- IllegalArgumentException - if null parameter

true is immediate purge.
Returns: true if purges are automatic.
See Also: RelationService.setPurgeFlag(boolean),

ObjectName -> ArrayList of String (role names)
Parameters:
- relationId - relation id
Throws:
- IllegalArgumentException - if null parameter
- RelationNotFoundException - if no relation for given relation id

- there is no role with given name

or

- the role is not readable.
See Also: RelationService.setRole(java.lang.String, javax.management.relation.Role),

Depending on the purgeFlag value, this method is either called automatically when a notification is received for the unregistration of an MBean referenced in a relation (if the flag is set to true), or not (if the flag is set to false).

In that case it is up to the user to call it to maintain the consistency of the relations. To be kept in mind that if an MBean is unregistered and the purge not done immediately, if the ObjectName is reused and assigned to another MBean referenced in a relation, calling manually this purgeRelations() method will cause trouble, as will consider the ObjectName as corresponding to the unregistered MBean, not seeing the new one.

The behavior depends on the cardinality of the role where the unregistered MBean is referenced:

- if removing one MBean reference in the role makes its number of references less than the minimum degree, the relation has to be removed.

- if the remaining number of references after removing the MBean reference is still in the cardinality range, keep the relation and update it calling its handleMBeanUnregistration() callback.
Throws:
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server.

A RelationNotification notification is sent, its type being:

- RelationNotification.RELATION_BASIC_REMOVAL if the relation was only internal to the Relation Service

- RelationNotification.RELATION_MBEAN_REMOVAL if the relation is registered as an MBean.

For MBeans referenced in such relation, nothing will be done,
Parameters:
- relationId - relation id of the relation to be removed
Throws:
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
- IllegalArgumentException - if null parameter
- RelationNotFoundException - if no relation corresponding to given relation id

The relation objects of that type will be removed from the Relation Service.
Parameters:
- relationTypeName - name of the relation type to be removed
Throws:
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
- IllegalArgumentException - if null parameter
- RelationTypeNotFoundException - If there is no relation type with that name

- RelationNotification.RELATION_BASIC_CREATION if the relation is an object internal to the Relation Service

- RelationNotification.RELATION_MBEAN_CREATION if the relation is a MBean added as a relation.

The source object is the Relation Service itself.

It is called in Relation Service createRelation() and addRelation() methods.
Parameters:
- relationId - relation identifier of the updated relation
Throws:
- IllegalArgumentException - if null parameter
- RelationNotFoundException - if there is no relation for given relation id

- RelationNotification.RELATION_BASIC_REMOVAL if the relation is an object internal to the Relation Service

- RelationNotification.RELATION_MBEAN_REMOVAL if the relation is a MBean added as a relation.

The source object is the Relation Service itself.

It is called in Relation Service removeRelation() method.
Parameters:
- relationId - relation identifier of the updated relation
- unregMBeanList - List of ObjectNames of MBeans expected to be unregistered due to relation removal (can be null)
Throws:
- IllegalArgumentException - if null parameter
- RelationNotFoundException - if there is no relation for given relation id

- RelationNotification.RELATION_BASIC_UPDATE if the relation is an object internal to the Relation Service

- RelationNotification.RELATION_MBEAN_UPDATE if the relation is a MBean added as a relation.

The source object is the Relation Service itself.

It is called in relation MBean setRole() (for given role) and setRoles() (for each role) methods (implementation provided in RelationSupport class).

It is also called in Relation Service setRole() (for given role) and setRoles() (for each role) methods.
Parameters:
- relationId - relation identifier of the updated relation
- newRole - new role (name and new value)
- oldValue - old role value (List of ObjectName objects)
Throws:
- IllegalArgumentException - if null parameter
- RelationNotFoundException - if there is no relation for given relation id

true is immediate purge.
Parameters:
- purgeFlag - flag
See Also: RelationService.getPurgeFlag(),

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

The Relation Service will keep track of the change to keep the consistency of relations by handling referenced MBean unregistrations.
Parameters:
- relationId - relation id
- role - role to be set (name and new value)
Throws:
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
- IllegalArgumentException - if null parameter
- RelationNotFoundException - if no relation with given id
- RoleNotFoundException - if the role does not exist or is not writable
- InvalidRoleValueException - if value provided for role is not valid:

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

or

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

or

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

or

- an MBean provided for that role does not exist
See Also: RelationService.getRole(java.lang.String, java.lang.String),

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

The Relation Service keeps track of the changes to keep the consistency of relations by handling referenced MBean unregistrations.
Returns: a RoleResult object, including a RoleList (for roles successfully set) and a RoleUnresolvedList (for roles not set).
Parameters:
- relationId - relation id
- roleList - list of roles to be set
Throws:
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
- IllegalArgumentException - if null parameter
- RelationNotFoundException - if no relation with given id
See Also: RelationService.getRoles(java.lang.String, java.lang.String[]),

It is called in relation MBean setRole() (for given role) and setRoles() (for each role) methods (implementation provided in RelationSupport class).

It is also called in Relation Service setRole() (for given role) and setRoles() (for each role) methods.

To allow the Relation Service to maintain the consistency (in case of MBean unregistration) and to be able to perform queries, this method must be called when a role is updated.
Parameters:
- relationId - relation identifier of the updated relation
- newRole - new role (name and new value)
- oldValue - old role value (List of ObjectName objects)
Throws:
- IllegalArgumentException - if null parameter
- RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
- RelationNotFoundException - if no relation for given id.