API Overview API Index Package Overview Direct link to this page
JDK 1.6
  javax.management.relation. RelationServiceMBean View Source
Author(s)
Since
1.5
Version
Serial
Hierarchy
 RelationServiceMBean
Subinterfaces
Description
public interface RelationServiceMBean
  The Relation Service is in charge of creating and deleting relation types and relations, of handling the consistency and of providing query mechanisms.
See also:   
Methods
Hide/Show inherited methods
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.
public void addRelationType (RelationType relationTypeObj) throws IllegalArgumentException InvalidRelationTypeException
  Adds given object as a relation type.
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.
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<ObjectName, List<String>> findAssociatedMBeans (ObjectName mbeanName, String relationTypeName, String roleName) throws IllegalArgumentException
  Retrieves the MBeans associated to given one in a relation.
public Map<String, List<String>> findReferencingRelations (ObjectName mbeanName, String relationTypeName, String roleName) throws IllegalArgumentException
  Retrieves the relations where a given MBean is referenced.
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.
public Map<ObjectName, List<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.
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.
public void removeRelation (String relationId) throws RelationServiceNotRegisteredException IllegalArgumentException RelationNotFoundException
  Removes given relation from the Relation Service.
public void removeRelationType (String relationTypeName) throws RelationServiceNotRegisteredException IllegalArgumentException RelationTypeNotFoundException
  Removes given relation type from Relation Service.
public void sendRelationCreationNotification (String relationId) throws IllegalArgumentException RelationNotFoundException
  Sends a notification (RelationNotification) for a relation creation.
public void sendRelationRemovalNotification (String relationId, List<ObjectName> unregMBeanList) throws IllegalArgumentException RelationNotFoundException
  Sends a notification (RelationNotification) for a relation removal.
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.
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.
public void setRole (String relationId, Role role) throws RelationServiceNotRegisteredException IllegalArgumentException RelationNotFoundException RoleNotFoundException InvalidRoleValueException RelationTypeNotFoundException
  Sets the given role in given relation.
public RoleResult setRoles (String relationId, RoleList roleList) throws RelationServiceNotRegisteredException IllegalArgumentException RelationNotFoundException
  Sets the given roles in given relation.
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.
Fields
Hide/Show inherited fields
Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar