• root
• java
• j2se
• 1.6
• javax.management.relation
• RelationService

Methods

• RelationServicetop

  public RelationService(boolean immediatePurgeFlag)
  Constructor.

  Parameters:

  @param 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.

  Related Links:

  Google Code Search

  Stack Overflow

• addRelationtop

  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 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:

  @param relationObjectName ObjectName of the relation MBean to be added.

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered in the MBean Server

  @exception NoSuchMethodException If the MBean does not implement the Relation interface

  @exception InvalidRelationIdException if:

  - no relation identifier in MBean

  - the relation identifier is already used in the Relation Service

  @exception InstanceNotFoundException if the MBean for given ObjectName has not been registered

  @exception InvalidRelationServiceException if:

  - no Relation Service name in MBean

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

  @exception 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

  @exception 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

  @exception RoleNotFoundException if a value is provided for a role that does not exist in the relation type

  Specified by:

  addRelation from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• addRelationTypetop

  public void addRelationType(RelationType relationTypeObj) throws IllegalArgumentException, InvalidRelationTypeException
  Adds given object as a relation type. The object is expected to implement the RelationType interface.

  Parameters:

  @param relationTypeObj relation type object (implementing the RelationType interface)

  Exceptions:

  @exception IllegalArgumentException if null parameter or if relationTypeObj.getRelationTypeName() returns null.

  @exception 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

  Specified by:

  addRelationType from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• checkRoleReadingtop

  public Integer checkRoleReading(String roleName, String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException
  Checks if given Role can be read in a relation of the given type.

  Parameters:

  @param roleName name of role to be checked

  @param relationTypeName name of the relation type

  Return:

  @return an Integer wrapping an integer corresponding to possible problems represented as constants in RoleUnresolved:

  - 0 if role can be read

  - integer corresponding to RoleStatus.NO_ROLE_WITH_NAME

  - integer corresponding to RoleStatus.ROLE_NOT_READABLE

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationTypeNotFoundException if the relation type is not known in the Relation Service

  Specified by:

  checkRoleReading from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• checkRoleWritingtop

  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.

  Parameters:

  @param role role to be checked

  @param relationTypeName name of relation type

  @param initFlag flag to specify that the checking is done for the initialization of a role, write access shall not be verified.

  Return:

  @return an Integer wrapping an integer corresponding to possible problems represented as constants in RoleUnresolved:

  - 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

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationTypeNotFoundException if unknown relation type

  Specified by:

  checkRoleWriting from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• createRelationtop

  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.

  Parameters:

  @param relationId relation identifier, to identify uniquely the relation inside the Relation Service

  @param relationTypeName name of the relation type (has to be created in the Relation Service)

  @param roleList role list to initialize roles of the relation (can be null).

  Exceptions:

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered in the MBean Server

  @exception IllegalArgumentException if null parameter, except the role list which can be null if no role initialization

  @exception RoleNotFoundException if a value is provided for a role that does not exist in the relation type

  @exception InvalidRelationIdException if relation id already used

  @exception RelationTypeNotFoundException if relation type not known in Relation Service

  @exception 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

  Specified by:

  createRelation from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• createRelationTypetop

  public void createRelationType(String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException
  Creates a relation type (a RelationTypeSupport object) with given role infos (provided by the RoleInfo objects), and adds it in the Relation Service.

  Parameters:

  @param relationTypeName name of the relation type

  @param roleInfoArray array of role infos

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception 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

  Specified by:

  createRelationType from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• findAssociatedMBeanstop

  public Map<ObjectName, List<String>> findAssociatedMBeans(ObjectName mbeanName, String relationTypeName, String roleName) throws IllegalArgumentException
  Retrieves the MBeans associated to given one in a relation.

  This corresponds to CIM Associators and AssociatorNames operations.

  Parameters:

  @param mbeanName ObjectName of MBean

  @param relationTypeName can be null; if specified, only the relations of that type will be considered in the search. Else all relation types are considered.

  @param 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.

  Return:

  @return 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).

  Exceptions:

  @exception IllegalArgumentException if null parameter

  Specified by:

  findAssociatedMBeans from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• findReferencingRelationstop

  public Map<String, List<String>> findReferencingRelations(ObjectName mbeanName, String relationTypeName, String roleName) throws IllegalArgumentException
  Retrieves the relations where a given MBean is referenced.

  This corresponds to the CIM "References" and "ReferenceNames" operations.

  Parameters:

  @param mbeanName ObjectName of MBean

  @param relationTypeName can be null; if specified, only the relations of that type will be considered in the search. Else all relation types are considered.

  @param 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.

  Return:

  @return 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).

  Exceptions:

  @exception IllegalArgumentException if null parameter

  Specified by:

  findReferencingRelations from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• findRelationsOfTypetop

  public List<String> findRelationsOfType(String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException
  Returns the relation ids for relations of the given type.

  Parameters:

  @param relationTypeName relation type name

  Return:

  @return an ArrayList of relation ids.

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationTypeNotFoundException if there is no relation type with that name.

  Specified by:

  findRelationsOfType from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getAllRelationIdstop

  public List<String> getAllRelationIds()
  Returns all the relation ids for all the relations handled by the Relation Service.

  Return:

  @return ArrayList of String

  Specified by:

  getAllRelationIds from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getAllRelationTypeNamestop

  public List<String> getAllRelationTypeNames()
  Retrieves names of all known relation types.

  Return:

  @return ArrayList of relation type names (Strings)

  Specified by:

  getAllRelationTypeNames from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getAllRolestop

  public RoleResult getAllRoles(String relationId) throws IllegalArgumentException, RelationNotFoundException, RelationServiceNotRegisteredException
  Returns all roles present in the relation.

  Parameters:

  @param relationId relation id

  Return:

  @return a RoleResult object, including a RoleList (for roles successfully retrieved) and a RoleUnresolvedList (for roles not readable).

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if no relation for given id

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered in the MBean Server

  Specified by:

  getAllRoles from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getNotificationInfotop

  public MBeanNotificationInfo[] getNotificationInfo()
  Returns a NotificationInfo object containing the name of the Java class of the notification and the notification types sent.

  Return:

  @return the array of possible notifications.

  Specified by:

  getNotificationInfo from NotificationBroadcaster

  Override hierarchy:

  getNotificationInfo from NotificationBroadcasterSupport

  Related Links:

  Google Code Search

  Stack Overflow

• getPurgeFlagtop

  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 will be explicitly called.

  true is immediate purge.

  Return:

  @return true if purges are automatic.

  See:

  @see javax.management.relation.RelationService.setPurgeFlag(boolean)

  Specified by:

  getPurgeFlag from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getReferencedMBeanstop

  public Map<ObjectName, List<String>> getReferencedMBeans(String relationId) throws IllegalArgumentException, RelationNotFoundException
  Retrieves MBeans referenced in the various roles of the relation.

  Parameters:

  @param relationId relation id

  Return:

  @return a HashMap mapping:

  ObjectName -> ArrayList of String (role names)

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if no relation for given relation id

  Specified by:

  getReferencedMBeans from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getRelationTypeNametop

  public String getRelationTypeName(String relationId) throws IllegalArgumentException, RelationNotFoundException
  Returns name of associated relation type for given relation.

  Parameters:

  @param relationId relation id

  Return:

  @return the name of the associated relation type.

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if no relation for given relation id

  Specified by:

  getRelationTypeName from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getRoletop

  public List<ObjectName> getRole(String relationId, String roleName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException, RoleNotFoundException
  Retrieves role value for given role name in given relation.

  Parameters:

  @param relationId relation id

  @param roleName name of role

  Return:

  @return the ArrayList of ObjectName objects being the role value

  Exceptions:

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if no relation with given id

  @exception RoleNotFoundException if:

  - there is no role with given name

  or

  - the role is not readable.

  See:

  @see javax.management.relation.RelationService.setRole(java.lang.String, javax.management.relation.Role)

  Specified by:

  getRole from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getRoleCardinalitytop

  public Integer getRoleCardinality(String relationId, String roleName) throws IllegalArgumentException, RelationNotFoundException, RoleNotFoundException
  Retrieves the number of MBeans currently referenced in the given role.

  Parameters:

  @param relationId relation id

  @param roleName name of role

  Return:

  @return the number of currently referenced MBeans in that role

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if no relation with given id

  @exception RoleNotFoundException if there is no role with given name

  Specified by:

  getRoleCardinality from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getRoleInfotop

  public RoleInfo getRoleInfo(String relationTypeName, String roleInfoName) throws IllegalArgumentException, RelationTypeNotFoundException, RoleInfoNotFoundException
  Retrieves role info for given role name of a given relation type.

  Parameters:

  @param relationTypeName name of relation type

  @param roleInfoName name of role

  Return:

  @return RoleInfo object.

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationTypeNotFoundException if the relation type is not known in the Relation Service

  @exception RoleInfoNotFoundException if the role is not part of the relation type.

  Specified by:

  getRoleInfo from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getRoleInfostop

  public List<RoleInfo> getRoleInfos(String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException
  Retrieves list of role infos (RoleInfo objects) of a given relation type.

  Parameters:

  @param relationTypeName name of relation type

  Return:

  @return ArrayList of RoleInfo.

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationTypeNotFoundException if there is no relation type with that name.

  Specified by:

  getRoleInfos from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• getRolestop

  public RoleResult getRoles(String relationId, String[] roleNameArray) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException
  Retrieves values of roles with given names in given relation.

  Parameters:

  @param relationId relation id

  @param roleNameArray array of names of roles to be retrieved

  Return:

  @return a RoleResult object, including a RoleList (for roles successfully retrieved) and a RoleUnresolvedList (for roles not retrieved).

  Exceptions:

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered in the MBean Server

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if no relation with given id

  See:

  @see javax.management.relation.RelationService.setRoles(java.lang.String, javax.management.relation.RoleList)

  Specified by:

  getRoles from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• handleNotificationtop

  public void handleNotification(Notification notif, Object handback)
  Invoked when a JMX notification occurs. Currently handles notifications for unregistration of MBeans, either referenced in a relation role or being a relation itself.

  Parameters:

  @param notif The notification.

  @param handback An opaque object which helps the listener to associate information regarding the MBean emitter (can be null).

  Specified by:

  handleNotification from NotificationListener

  Related Links:

  Google Code Search

  Stack Overflow

• hasRelationtop

  public Boolean hasRelation(String relationId) throws IllegalArgumentException
  Checks if there is a relation identified in Relation Service with given relation id.

  Parameters:

  @param relationId relation id identifying the relation

  Return:

  @return boolean: true if there is a relation, false else

  Exceptions:

  @exception IllegalArgumentException if null parameter

  Specified by:

  hasRelation from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• isActivetop

  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

  Exceptions:

  @exception RelationServiceNotRegisteredException if it is not registered

  Specified by:

  isActive from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• isRelationtop

  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.

  Parameters:

  @param objectName ObjectName of supposed relation

  Return:

  @return relation id (String) or null (if the ObjectName is not a relation handled by the Relation Service)

  Exceptions:

  @exception IllegalArgumentException if null parameter

  Specified by:

  isRelation from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• isRelationMBeantop

  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.

  Parameters:

  @param relationId relation id identifying the relation

  Return:

  @return ObjectName of the corresponding relation MBean, or null if the relation is not an MBean.

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException there is no relation associated to that id

  Specified by:

  isRelationMBean from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• postDeregistertop

  public void postDeregister()
  Allows the MBean to perform any operations needed after having been unregistered in the MBean server.

  Specified by:

  postDeregister from MBeanRegistration

  Related Links:

  Google Code Search

  Stack Overflow

• postRegistertop

  public void postRegister(Boolean registrationDone)
  Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.

  Parameters:

  @param 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.

  Specified by:

  postRegister from MBeanRegistration

  Related Links:

  Google Code Search

  Stack Overflow

• preDeregistertop

  public void preDeregister() throws Exception
  Allows the MBean to perform any operations it needs before being unregistered by the MBean server.

  Exceptions:

  @exception Exception This exception will be caught by the MBean server and re-thrown as an javax.management.MBeanRegistrationException .

  Specified by:

  preDeregister from MBeanRegistration

  Related Links:

  Google Code Search

  Stack Overflow

• preRegistertop

  public ObjectName preRegister(MBeanServer server, ObjectName name) throws 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.

  Parameters:

  @param server The MBean server in which the MBean will be registered.

  @param 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 javax.management.MBeanServer interface is null. In that case, this method must return a non-null ObjectName for the new MBean.

  Return:

  @return The name under which the MBean is to be registered. This value must not be null. If the name parameter is not null, it will usually but not necessarily be the returned value.

  Exceptions:

  @exception Exception This exception will be caught by the MBean server and re-thrown as an javax.management.MBeanRegistrationException .

  Specified by:

  preRegister from MBeanRegistration

  Related Links:

  Google Code Search

  Stack Overflow

• purgeRelationstop

  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.

  Exceptions:

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered in the MBean Server.

  Specified by:

  purgeRelations from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• removeRelationtop

  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,

  Parameters:

  @param relationId relation id of the relation to be removed

  Exceptions:

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered in the MBean Server

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if no relation corresponding to given relation id

  Specified by:

  removeRelation from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• removeRelationTypetop

  public void removeRelationType(String relationTypeName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationTypeNotFoundException
  Removes given relation type from Relation Service.

  The relation objects of that type will be removed from the Relation Service.

  Parameters:

  @param relationTypeName name of the relation type to be removed

  Exceptions:

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered in the MBean Server

  @exception IllegalArgumentException if null parameter

  @exception RelationTypeNotFoundException If there is no relation type with that name

  Specified by:

  removeRelationType from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• sendRelationCreationNotificationtop

  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.

  Parameters:

  @param relationId relation identifier of the updated relation

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if there is no relation for given relation id

  Specified by:

  sendRelationCreationNotification from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• sendRelationRemovalNotificationtop

  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.

  Parameters:

  @param relationId relation identifier of the updated relation

  @param unregMBeanList List of ObjectNames of MBeans expected to be unregistered due to relation removal (can be null)

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if there is no relation for given relation id

  Specified by:

  sendRelationRemovalNotification from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• sendRoleUpdateNotificationtop

  public void sendRoleUpdateNotification(String relationId, Role newRole, List<ObjectName> oldValue) 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.

  Parameters:

  @param relationId relation identifier of the updated relation

  @param newRole new role (name and new value)

  @param oldValue old role value (List of ObjectName objects)

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if there is no relation for given relation id

  Specified by:

  sendRoleUpdateNotification from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• setPurgeFlagtop

  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 will be explicitly called.

  true is immediate purge.

  Parameters:

  @param purgeFlag flag

  See:

  @see javax.management.relation.RelationService.getPurgeFlag()

  Specified by:

  setPurgeFlag from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• setRoletop

  public void setRole(String relationId, Role role) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException, RoleNotFoundException, InvalidRoleValueException
  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.

  Parameters:

  @param relationId relation id

  @param role role to be set (name and new value)

  Exceptions:

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered in the MBean Server

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if no relation with given id

  @exception RoleNotFoundException if the role does not exist or is not writable

  @exception 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:

  @see javax.management.relation.RelationService.getRole(java.lang.String, java.lang.String)

  Specified by:

  setRole from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• setRolestop

  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.

  Parameters:

  @param relationId relation id

  @param roleList list of roles to be set

  Return:

  @return a RoleResult object, including a RoleList (for roles successfully set) and a RoleUnresolvedList (for roles not set).

  Exceptions:

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered in the MBean Server

  @exception IllegalArgumentException if null parameter

  @exception RelationNotFoundException if no relation with given id

  See:

  @see javax.management.relation.RelationService.getRoles(java.lang.String, java.lang.String[])

  Specified by:

  setRoles from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow

• updateRoleMaptop

  public void updateRoleMap(String relationId, Role newRole, List<ObjectName> oldValue) 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.

  Parameters:

  @param relationId relation identifier of the updated relation

  @param newRole new role (name and new value)

  @param oldValue old role value (List of ObjectName objects)

  Exceptions:

  @exception IllegalArgumentException if null parameter

  @exception RelationServiceNotRegisteredException if the Relation Service is not registered in the MBean Server

  @exception RelationNotFoundException if no relation for given id.

  Specified by:

  updateRoleMap from RelationServiceMBean

  Related Links:

  Google Code Search

  Stack Overflow