The Relation Service is in charge of creating and deleting relation types
and relations, of handling the consistency and of providing query
mechanisms.
Method from javax.management.relation.RelationServiceMBean Detail: |
public void addRelation(ObjectName relationObjectName) throws IllegalArgumentException, RelationServiceNotRegisteredException, NoSuchMethodException, InvalidRelationIdException, InstanceNotFoundException, InvalidRelationServiceException, RelationTypeNotFoundException, RoleNotFoundException, InvalidRoleValueException
Adds an MBean created by the user (and registered by him in the MBean
Server) as a relation in the Relation Service.
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 that is 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. |
public void addRelationType(RelationType relationTypeObj) throws IllegalArgumentException, InvalidRelationTypeException
Adds given object as a relation type. The object is expected to
implement the RelationType interface. |
public Integer checkRoleReading(String roleName,
String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException
Checks if given Role can be read in a relation of the given type. |
public Integer checkRoleWriting(Role role,
String relationTypeName,
Boolean initFlag) throws IllegalArgumentException, RelationTypeNotFoundException
Checks if given Role can be set in a relation of given type. |
public void createRelation(String relationId,
String relationTypeName,
RoleList roleList) throws RelationServiceNotRegisteredException, IllegalArgumentException, RoleNotFoundException, InvalidRelationIdException, RelationTypeNotFoundException, InvalidRoleValueException
Creates a simple relation (represented by a RelationSupport object) of
given relation type, and adds it in the Relation Service.
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. |
public void createRelationType(String relationTypeName,
RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException
Creates a relation type (RelationTypeSupport object) with given
role infos (provided by the RoleInfo objects), and adds it in the
Relation Service. |
public Map<String> findAssociatedMBeans(ObjectName mbeanName,
String relationTypeName,
String roleName) throws IllegalArgumentException
|
public Map<String> findReferencingRelations(ObjectName mbeanName,
String relationTypeName,
String roleName) throws IllegalArgumentException
|
public List<String> findRelationsOfType(String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException
Returns the relation ids for relations of the given type. |
public List<String> getAllRelationIds()
Returns all the relation ids for all the relations handled by the
Relation Service. |
public List<String> getAllRelationTypeNames()
Retrieves names of all known relation types. |
public RoleResult getAllRoles(String relationId) throws IllegalArgumentException, RelationNotFoundException, RelationServiceNotRegisteredException
Returns all roles present in the relation. |
public boolean getPurgeFlag()
Returns the flag to indicate if when a notification is received for the
unregistration of an MBean referenced in a relation, if an immediate
"purge" of the relations (look for the relations no longer valid)
has to be performed, or if that will be performed only when the
purgeRelations method is explicitly called.
true is immediate purge. |
public Map<String> getReferencedMBeans(String relationId) throws IllegalArgumentException, RelationNotFoundException
Retrieves MBeans referenced in the various roles of the relation. |
public String getRelationTypeName(String relationId) throws IllegalArgumentException, RelationNotFoundException
Returns name of associated relation type for given relation. |
public List<ObjectName> getRole(String relationId,
String roleName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException, RoleNotFoundException
Retrieves role value for given role name in given relation. |
public Integer getRoleCardinality(String relationId,
String roleName) throws IllegalArgumentException, RelationNotFoundException, RoleNotFoundException
Retrieves the number of MBeans currently referenced in the
given role. |
public RoleInfo getRoleInfo(String relationTypeName,
String roleInfoName) throws IllegalArgumentException, RelationTypeNotFoundException, RoleInfoNotFoundException
Retrieves role info for given role of a given relation type. |
public List<RoleInfo> getRoleInfos(String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException
Retrieves list of role infos (RoleInfo objects) of a given relation
type. |
public RoleResult getRoles(String relationId,
String[] roleNameArray) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException
Retrieves values of roles with given names in given relation. |
public Boolean hasRelation(String relationId) throws IllegalArgumentException
Checks if there is a relation identified in Relation Service with given
relation id. |
public void isActive() throws RelationServiceNotRegisteredException
Checks if the Relation Service is active.
Current condition is that the Relation Service must be registered in the
MBean Server |
public String isRelation(ObjectName objectName) throws IllegalArgumentException
Returns the relation id associated to the given ObjectName if the
MBean has been added as a relation in the Relation Service. |
public ObjectName isRelationMBean(String relationId) throws IllegalArgumentException, RelationNotFoundException
If the relation is represented by an MBean (created by the user and
added as a relation in the Relation Service), returns the ObjectName of
the MBean. |
public void purgeRelations() throws RelationServiceNotRegisteredException
Purges the relations.
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. |
public void removeRelation(String relationId) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException
Removes given relation from the Relation Service.
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, |
public void removeRelationType(String relationTypeName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationTypeNotFoundException
|
public void sendRelationCreationNotification(String relationId) throws IllegalArgumentException, RelationNotFoundException
Sends a notification (RelationNotification) for a relation creation.
The notification type is:
- 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. |
public void sendRelationRemovalNotification(String relationId,
List<ObjectName> unregMBeanList) throws IllegalArgumentException, RelationNotFoundException
Sends a notification (RelationNotification) for a relation removal.
The notification type is:
- 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. |
public void sendRoleUpdateNotification(String relationId,
Role newRole,
List<ObjectName> oldRoleValue) throws IllegalArgumentException, RelationNotFoundException
Sends a notification (RelationNotification) for a role update in the
given relation. The notification type is:
- 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. |
public void setPurgeFlag(boolean purgeFlag)
Sets the flag to indicate if when a notification is received for the
unregistration of an MBean referenced in a relation, if an immediate
"purge" of the relations (look for the relations no longer valid)
has to be performed, or if that will be performed only when the
purgeRelations method is explicitly called.
true is immediate purge. |
public void setRole(String relationId,
Role role) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException, RoleNotFoundException, InvalidRoleValueException, RelationTypeNotFoundException
Sets the given role in given relation.
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. |
public RoleResult setRoles(String relationId,
RoleList roleList) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException
Sets the given roles in given relation.
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. |
public void updateRoleMap(String relationId,
Role newRole,
List<ObjectName> oldRoleValue) throws IllegalArgumentException, RelationServiceNotRegisteredException, RelationNotFoundException
Handles update of the Relation Service role map for the update of given
role in given relation.
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. |