java.lang.Object | ||
↳ | javax.management.NotificationBroadcasterSupport | |
↳ | javax.management.relation.RelationService |
The Relation Service is in charge of creating and deleting relation types and relations, of handling the consistency and of providing query mechanisms.
It implements the NotificationBroadcaster by extending NotificationBroadcasterSupport to send notifications when a relation is removed from it.
It implements the NotificationListener interface to be able to receive notifications concerning unregistration of MBeans referenced in relation roles and of relation MBeans.
It implements the MBeanRegistration interface to be able to retrieve its ObjectName and MBean Server.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructor.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds an MBean created by the user (and registered by him in the MBean
Server) as a relation in the Relation Service.
| |||||||||||
Adds given object as a relation type.
| |||||||||||
Checks if given Role can be read in a relation of the given type.
| |||||||||||
Checks if given Role can be set in a relation of given type.
| |||||||||||
Creates a simple relation (represented by a RelationSupport object) of
given relation type, and adds it in the Relation Service.
| |||||||||||
Creates a relation type (a RelationTypeSupport object) with given
role infos (provided by the RoleInfo objects), and adds it in the
Relation Service.
| |||||||||||
Retrieves the MBeans associated to given one in a relation.
| |||||||||||
Retrieves the relations where a given MBean is referenced.
| |||||||||||
Returns the relation ids for relations of the given type.
| |||||||||||
Returns all the relation ids for all the relations handled by the
Relation Service.
| |||||||||||
Retrieves names of all known relation types.
| |||||||||||
Returns all roles present in the relation.
| |||||||||||
Returns a NotificationInfo object containing the name of the Java class
of the notification and the notification types sent.
| |||||||||||
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 will be explicitly called.
| |||||||||||
Retrieves MBeans referenced in the various roles of the relation.
| |||||||||||
Returns name of associated relation type for given relation.
| |||||||||||
Retrieves role value for given role name in given relation.
| |||||||||||
Retrieves the number of MBeans currently referenced in the given role.
| |||||||||||
Retrieves role info for given role name of a given relation type.
| |||||||||||
Retrieves list of role infos (RoleInfo objects) of a given relation
type.
| |||||||||||
Retrieves values of roles with given names in given relation.
| |||||||||||
Invoked when a JMX notification occurs.
| |||||||||||
Checks if there is a relation identified in Relation Service with given
relation id.
| |||||||||||
Checks if the Relation Service is active.
| |||||||||||
Returns the relation id associated to the given ObjectName if the
MBean has been added as a relation in the Relation Service.
| |||||||||||
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.
| |||||||||||
Allows the MBean to perform any operations needed after having been
unregistered in the MBean server.
| |||||||||||
Allows the MBean to perform any operations needed after having been
registered in the MBean server or after the registration has failed.
| |||||||||||
Allows the MBean to perform any operations it needs before
being unregistered by the MBean server.
| |||||||||||
Allows the MBean to perform any operations it needs before
being registered in the MBean server.
| |||||||||||
Purges the relations.
| |||||||||||
Removes given relation from the Relation Service.
| |||||||||||
Removes given relation type from Relation Service.
| |||||||||||
Sends a notification (RelationNotification) for a relation creation.
| |||||||||||
Sends a notification (RelationNotification) for a relation removal.
| |||||||||||
Sends a notification (RelationNotification) for a role update in the
given relation.
| |||||||||||
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 will be explicitly called.
| |||||||||||
Sets the given role in given relation.
| |||||||||||
Sets the given roles in given relation.
| |||||||||||
Handles update of the Relation Service role map for the update of given
role in given relation.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
Constructor.
immediatePurgeFlag | flag to indicate 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 will be explicitly called.
true is immediate purge. |
---|
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 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.
relationObjectName | ObjectName of the relation MBean to be added. |
---|
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 |
Adds given object as a relation type. The object is expected to implement the RelationType interface.
relationTypeObj | relation type object (implementing the RelationType interface) |
---|
IllegalArgumentException | if null parameter or if
relationTypeObj.getRelationTypeName() returns null. |
---|---|
InvalidRelationTypeException | if:
- 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 |
Checks if given Role can be read in a relation of the given type.
roleName | name of role to be checked |
---|---|
relationTypeName | name of the relation type |
- 0 if role can be read
- integer corresponding to RoleStatus.NO_ROLE_WITH_NAME
- integer corresponding to RoleStatus.ROLE_NOT_READABLE
IllegalArgumentException | if null parameter |
---|---|
RelationTypeNotFoundException | if the relation type is not known in the Relation Service |
Checks if given Role can be set in a relation of given type.
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. |
- 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
IllegalArgumentException | if null parameter |
---|---|
RelationTypeNotFoundException | if unknown relation type |
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.
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). |
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 |
Creates a relation type (a RelationTypeSupport object) with given role infos (provided by the RoleInfo objects), and adds it in the Relation Service.
relationTypeName | name of the relation type |
---|---|
roleInfoArray | array of role infos |
IllegalArgumentException | if null parameter |
---|---|
InvalidRelationTypeException | If:
- 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 |
Retrieves the MBeans associated to given one in a relation.
This corresponds to CIM Associators and AssociatorNames operations.
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. |
IllegalArgumentException | if null parameter |
---|
Retrieves the relations where a given MBean is referenced.
This corresponds to the CIM "References" and "ReferenceNames" operations.
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. |
IllegalArgumentException | if null parameter |
---|
Returns the relation ids for relations of the given type.
relationTypeName | relation type name |
---|
IllegalArgumentException | if null parameter |
---|---|
RelationTypeNotFoundException | if there is no relation type with that name. |
Returns all the relation ids for all the relations handled by the Relation Service.
Retrieves names of all known relation types.
Returns all roles present in the relation.
relationId | relation id |
---|
IllegalArgumentException | if null parameter |
---|---|
RelationNotFoundException | if no relation for given id |
RelationServiceNotRegisteredException | if the Relation Service is not registered in the MBean Server |
Returns a NotificationInfo object containing the name of the Java class of the notification and the notification types sent.
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 will be explicitly called.
true is immediate purge.
Retrieves MBeans referenced in the various roles of the relation.
relationId | relation id |
---|
ObjectName -> ArrayList of String (role names)
IllegalArgumentException | if null parameter |
---|---|
RelationNotFoundException | if no relation for given relation id |
Returns name of associated relation type for given relation.
relationId | relation id |
---|
IllegalArgumentException | if null parameter |
---|---|
RelationNotFoundException | if no relation for given relation id |
Retrieves role value for given role name in given relation.
relationId | relation id |
---|---|
roleName | name of role |
RelationServiceNotRegisteredException | if the Relation Service is not registered |
---|---|
IllegalArgumentException | if null parameter |
RelationNotFoundException | if no relation with given id |
RoleNotFoundException | if:
- there is no role with given name or - the role is not readable. |
Retrieves the number of MBeans currently referenced in the given role.
relationId | relation id |
---|---|
roleName | name of role |
IllegalArgumentException | if null parameter |
---|---|
RelationNotFoundException | if no relation with given id |
RoleNotFoundException | if there is no role with given name |
Retrieves role info for given role name of a given relation type.
relationTypeName | name of relation type |
---|---|
roleInfoName | name of role |
IllegalArgumentException | if null parameter |
---|---|
RelationTypeNotFoundException | if the relation type is not known in the Relation Service |
RoleInfoNotFoundException | if the role is not part of the relation type. |
Retrieves list of role infos (RoleInfo objects) of a given relation type.
relationTypeName | name of relation type |
---|
IllegalArgumentException | if null parameter |
---|---|
RelationTypeNotFoundException | if there is no relation type with that name. |
Retrieves values of roles with given names in given relation.
relationId | relation id |
---|---|
roleNameArray | array of names of roles to be retrieved |
RelationServiceNotRegisteredException | if the Relation Service is not registered in the MBean Server |
---|---|
IllegalArgumentException | if null parameter |
RelationNotFoundException | if no relation with given id |
Invoked when a JMX notification occurs. Currently handles notifications for unregistration of MBeans, either referenced in a relation role or being a relation itself.
notif | The notification. |
---|---|
handback | An opaque object which helps the listener to associate information regarding the MBean emitter (can be null). |
Checks if there is a relation identified in Relation Service with given relation id.
relationId | relation id identifying the relation |
---|
IllegalArgumentException | if null parameter |
---|
Checks if the Relation Service is active. Current condition is that the Relation Service must be registered in the MBean Server
RelationServiceNotRegisteredException | if it is not registered |
---|
Returns the relation id associated to the given ObjectName if the MBean has been added as a relation in the Relation Service.
objectName | ObjectName of supposed relation |
---|
IllegalArgumentException | if null parameter |
---|
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.
relationId | relation id identifying the relation |
---|
IllegalArgumentException | if null parameter |
---|---|
RelationNotFoundException | there is no relation associated to that id |
Allows the MBean to perform any operations needed after having been unregistered in the MBean server.
Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.
registrationDone | Indicates whether or not the MBean has been successfully registered in the MBean server. The value false means that the registration phase has failed. |
---|
Allows the MBean to perform any operations it needs before being unregistered by the MBean server.
Exception |
---|
Allows the MBean to perform any operations it needs before being registered in the MBean server. If the name of the MBean is not specified, the MBean can provide a name for its registration. If any exception is raised, the MBean will not be registered in the MBean server.
server | The MBean server in which the MBean will be registered. |
---|---|
name | The object name of the MBean. This name is null if
the name parameter to one of the createMBean or
registerMBean methods in the MBeanServer
interface is null. In that case, this method must return a
non-null ObjectName for the new MBean. |
name
parameter is not null, it will usually but not necessarily be
the returned value.Exception |
---|
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.
RelationServiceNotRegisteredException | if the Relation Service is not registered in the MBean Server. |
---|
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,
relationId | relation id of the relation to be removed |
---|
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 |
Removes given relation type from Relation Service.
The relation objects of that type will be removed from the Relation Service.
relationTypeName | name of the relation type to be removed |
---|
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 |
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.
relationId | relation identifier of the updated relation |
---|
IllegalArgumentException | if null parameter |
---|---|
RelationNotFoundException | if there is no relation for given relation id |
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.
relationId | relation identifier of the updated relation |
---|---|
unregMBeanList | List of ObjectNames of MBeans expected to be unregistered due to relation removal (can be null) |
IllegalArgumentException | if null parameter |
---|---|
RelationNotFoundException | if there is no relation for given relation id |
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.
relationId | relation identifier of the updated relation |
---|---|
newRole | new role (name and new value) |
oldValue | old role value (List of ObjectName objects) |
IllegalArgumentException | if null parameter |
---|---|
RelationNotFoundException | if there is no relation for given relation id |
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 will be explicitly called.
true is immediate purge.
purgeFlag | flag |
---|
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.
relationId | relation id |
---|---|
role | role to be set (name and new value) |
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 |
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.
relationId | relation id |
---|---|
roleList | list of roles to be set |
RelationServiceNotRegisteredException | if the Relation Service is not registered in the MBean Server |
---|---|
IllegalArgumentException | if null parameter |
RelationNotFoundException | if no relation with given id |
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.
relationId | relation identifier of the updated relation |
---|---|
newRole | new role (name and new value) |
oldValue | old role value (List of ObjectName objects) |
IllegalArgumentException | if null parameter |
---|---|
RelationServiceNotRegisteredException | if the Relation Service is not registered in the MBean Server |
RelationNotFoundException | if no relation for given id. |