|
J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.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.
| Constructor Summary | |
RelationService(boolean theImmediatePurgeFlg)
Constructor. |
|
| Method Summary | |
void |
addRelation(ObjectName theRelObjectName)
Adds an MBean created by the user (and registered by him in the MBean Server) as a relation in the Relation Service. |
void |
addRelationType(RelationType theRelTypeObj)
Adds given object as a relation type. |
java.lang.Integer |
checkRoleReading(java.lang.String theRoleName,
java.lang.String theRelTypeName)
Checks if given Role can be read in a relation of the given type. |
java.lang.Integer |
checkRoleWriting(Role theRole,
java.lang.String theRelTypeName,
java.lang.Boolean theInitFlg)
Checks if given Role can be set in a relation of given type. |
void |
createRelation(java.lang.String theRelId,
java.lang.String theRelTypeName,
RoleList theRoleList)
Creates a simple relation (represented by a RelationSupport object) of given relation type, and adds it in the Relation Service. |
void |
createRelationType(java.lang.String theRelTypeName,
RoleInfo[] theRoleInfoArray)
Creates a relation type (a RelationTypeSupport object) with given role infos (provided by the RoleInfo objects), and adds it in the Relation Service. |
java.util.Map |
findAssociatedMBeans(ObjectName theMBeanName,
java.lang.String theRelTypeName,
java.lang.String theRoleName)
Retrieves the MBeans associated to given one in a relation. |
java.util.Map |
findReferencingRelations(ObjectName theMBeanName,
java.lang.String theRelTypeName,
java.lang.String theRoleName)
Retrieves the relations where a given MBean is referenced. |
java.util.List |
findRelationsOfType(java.lang.String theRelTypeName)
Returns the relation ids for relations of the given type. |
java.util.List |
getAllRelationIds()
Returns all the relation ids for all the relations handled by the Relation Service. |
java.util.List |
getAllRelationTypeNames()
Retrieves names of all known relation types. |
RoleResult |
getAllRoles(java.lang.String theRelId)
Returns all roles present in the relation. |
MBeanNotificationInfo[] |
getNotificationInfo()
Returns a NotificationInfo object containing the name of the Java class of the notification and the notification types sent. |
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. |
java.util.Map |
getReferencedMBeans(java.lang.String theRelId)
Retrieves MBeans referenced in the various roles of the relation. |
java.lang.String |
getRelationTypeName(java.lang.String theRelId)
Returns name of associated relation type for given relation. |
java.util.List |
getRole(java.lang.String theRelId,
java.lang.String theRoleName)
Retrieves role value for given role name in given relation. |
java.lang.Integer |
getRoleCardinality(java.lang.String theRelId,
java.lang.String theRoleName)
Retrieves the number of MBeans currently referenced in the given role. |
RoleInfo |
getRoleInfo(java.lang.String theRelTypeName,
java.lang.String theRoleInfoName)
Retrieves role info for given role name of a given relation type. |
java.util.List |
getRoleInfos(java.lang.String theRelTypeName)
Retrieves list of role infos (RoleInfo objects) of a given relation type. |
RoleResult |
getRoles(java.lang.String theRelId,
java.lang.String[] theRoleNameArray)
Retrieves values of roles with given names in given relation. |
void |
handleNotification(Notification theNtf,
java.lang.Object theHandback)
Invoked when a JMX notification occurs. |
java.lang.Boolean |
hasRelation(java.lang.String theRelId)
Checks if there is a relation identified in Relation Service with given relation id. |
void |
isActive()
Checks if the Relation Service is active. |
java.lang.String |
isRelation(ObjectName theObjName)
Returns the relation id associated to the given ObjectName if the MBean has been added as a relation in the Relation Service. |
ObjectName |
isRelationMBean(java.lang.String theRelId)
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. |
void |
postDeregister()
Allows the MBean to perform any operations needed after having been unregistered in the MBean server. |
void |
postRegister(java.lang.Boolean registrationDone)
Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed. |
void |
preDeregister()
Allows the MBean to perform any operations it needs before being unregistered by the MBean server. |
ObjectName |
preRegister(MBeanServer server,
ObjectName name)
Allows the MBean to perform any operations it needs before being registered in the MBean server. |
void |
purgeRelations()
Purges the relations. |
void |
removeRelation(java.lang.String theRelId)
Removes given relation from the Relation Service. |
void |
removeRelationType(java.lang.String theRelTypeName)
Removes given relation type from Relation Service. |
void |
sendRelationCreationNotification(java.lang.String theRelId)
Sends a notification (RelationNotification) for a relation creation. |
void |
sendRelationRemovalNotification(java.lang.String theRelId,
java.util.List theUnregMBeanList)
Sends a notification (RelationNotification) for a relation removal. |
void |
sendRoleUpdateNotification(java.lang.String theRelId,
Role theNewRole,
java.util.List theOldRoleValue)
Sends a notification (RelationNotification) for a role update in the given relation. |
void |
setPurgeFlag(boolean thePurgeFlg)
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. |
void |
setRole(java.lang.String theRelId,
Role theRole)
Sets the given role in given relation. |
RoleResult |
setRoles(java.lang.String theRelId,
RoleList theRoleList)
Sets the given roles in given relation. |
void |
updateRoleMap(java.lang.String theRelId,
Role theNewRole,
java.util.List theOldRoleValue)
Handles update of the Relation Service role map for the update of given role in given relation. |
| Methods inherited from class javax.management.NotificationBroadcasterSupport |
addNotificationListener, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public RelationService(boolean theImmediatePurgeFlg)
theImmediatePurgeFlg - 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.
| Method Detail |
public void isActive()
throws RelationServiceNotRegisteredException
isActive in interface RelationServiceMBeanRelationServiceNotRegisteredException - if it is not
registered
public ObjectName preRegister(MBeanServer server,
ObjectName name)
throws java.lang.Exception
MBeanRegistration
preRegister in interface MBeanRegistrationserver - 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.
java.lang.Exception - This exception will be caught by
the MBean server and re-thrown as an MBeanRegistrationException.public void postRegister(java.lang.Boolean registrationDone)
MBeanRegistration
postRegister in interface MBeanRegistrationregistrationDone - Indicates whether or not the MBean has
been successfully registered in the MBean server. The value
false means that the registration phase has failed.
public void preDeregister()
throws java.lang.Exception
MBeanRegistration
preDeregister in interface MBeanRegistrationjava.lang.Exception - This exception will be caught by
the MBean server and re-thrown as an MBeanRegistrationException.public void postDeregister()
MBeanRegistration
postDeregister in interface MBeanRegistrationpublic boolean getPurgeFlag()
true is immediate purge.
getPurgeFlag in interface RelationServiceMBeansetPurgeFlag(boolean)public void setPurgeFlag(boolean thePurgeFlg)
true is immediate purge.
setPurgeFlag in interface RelationServiceMBeanthePurgeFlg - flaggetPurgeFlag()
public void createRelationType(java.lang.String theRelTypeName,
RoleInfo[] theRoleInfoArray)
throws java.lang.IllegalArgumentException,
InvalidRelationTypeException
createRelationType in interface RelationServiceMBeantheRelTypeName - name of the relation typetheRoleInfoArray - array of role infos
java.lang.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
public void addRelationType(RelationType theRelTypeObj)
throws java.lang.IllegalArgumentException,
InvalidRelationTypeException
addRelationType in interface RelationServiceMBeantheRelTypeObj - relation type object (implementing the
RelationType interface)
java.lang.IllegalArgumentException - if null parameter
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
public java.util.List getAllRelationTypeNames()
getAllRelationTypeNames in interface RelationServiceMBean
public java.util.List getRoleInfos(java.lang.String theRelTypeName)
throws java.lang.IllegalArgumentException,
RelationTypeNotFoundException
getRoleInfos in interface RelationServiceMBeantheRelTypeName - name of relation type
java.lang.IllegalArgumentException - if null parameter
RelationTypeNotFoundException - if there is no relation type
with that name.
public RoleInfo getRoleInfo(java.lang.String theRelTypeName,
java.lang.String theRoleInfoName)
throws java.lang.IllegalArgumentException,
RelationTypeNotFoundException,
RoleInfoNotFoundException
getRoleInfo in interface RelationServiceMBeantheRelTypeName - name of relation typetheRoleInfoName - name of role
java.lang.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.
public void removeRelationType(java.lang.String theRelTypeName)
throws RelationServiceNotRegisteredException,
java.lang.IllegalArgumentException,
RelationTypeNotFoundException
The relation objects of that type will be removed from the Relation Service.
removeRelationType in interface RelationServiceMBeantheRelTypeName - name of the relation type to be removed
RelationServiceNotRegisteredException - if the Relation
Service is not registered in the MBean Server
java.lang.IllegalArgumentException - if null parameter
RelationTypeNotFoundException - If there is no relation type
with that name
public void createRelation(java.lang.String theRelId,
java.lang.String theRelTypeName,
RoleList theRoleList)
throws RelationServiceNotRegisteredException,
java.lang.IllegalArgumentException,
RoleNotFoundException,
InvalidRelationIdException,
RelationTypeNotFoundException,
InvalidRoleValueException
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.
createRelation in interface RelationServiceMBeantheRelId - relation identifier, to identify uniquely the relation
inside the Relation ServicetheRelTypeName - name of the relation type (has to be created
in the Relation Service)theRoleList - role list to initialize roles of the relation (can
be null).
RelationServiceNotRegisteredException - if the Relation
Service is not registered in the MBean Server
java.lang.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
public void addRelation(ObjectName theRelObjectName)
throws java.lang.IllegalArgumentException,
RelationServiceNotRegisteredException,
java.lang.NoSuchMethodException,
InvalidRelationIdException,
InstanceNotFoundException,
InvalidRelationServiceException,
RelationTypeNotFoundException,
RoleNotFoundException,
InvalidRoleValueException
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.
addRelation in interface RelationServiceMBeantheRelObjectName - ObjectName of the relation MBean to be added.
java.lang.IllegalArgumentException - if null parameter
RelationServiceNotRegisteredException - if the Relation
Service is not registered in the MBean Server
java.lang.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
public ObjectName isRelationMBean(java.lang.String theRelId)
throws java.lang.IllegalArgumentException,
RelationNotFoundException
isRelationMBean in interface RelationServiceMBeantheRelId - relation id identifying the relation
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - there is no relation associated
to that id
public java.lang.String isRelation(ObjectName theObjName)
throws java.lang.IllegalArgumentException
isRelation in interface RelationServiceMBeantheObjName - ObjectName of supposed relation
java.lang.IllegalArgumentException - if null parameter
public java.lang.Boolean hasRelation(java.lang.String theRelId)
throws java.lang.IllegalArgumentException
hasRelation in interface RelationServiceMBeantheRelId - relation id identifying the relation
java.lang.IllegalArgumentException - if null parameterpublic java.util.List getAllRelationIds()
getAllRelationIds in interface RelationServiceMBean
public java.lang.Integer checkRoleReading(java.lang.String theRoleName,
java.lang.String theRelTypeName)
throws java.lang.IllegalArgumentException,
RelationTypeNotFoundException
checkRoleReading in interface RelationServiceMBeantheRoleName - name of role to be checkedtheRelTypeName - 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
java.lang.IllegalArgumentException - if null parameter
RelationTypeNotFoundException - if the relation type is not
known in the Relation Service
public java.lang.Integer checkRoleWriting(Role theRole,
java.lang.String theRelTypeName,
java.lang.Boolean theInitFlg)
throws java.lang.IllegalArgumentException,
RelationTypeNotFoundException
checkRoleWriting in interface RelationServiceMBeantheRole - role to be checkedtheRelTypeName - name of relation typetheInitFlg - 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
java.lang.IllegalArgumentException - if null parameter
RelationTypeNotFoundException - if unknown relation type
public void sendRelationCreationNotification(java.lang.String theRelId)
throws java.lang.IllegalArgumentException,
RelationNotFoundException
- 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.
sendRelationCreationNotification in interface RelationServiceMBeantheRelId - relation identifier of the updated relation
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - if there is no relation for given
relation id
public void sendRoleUpdateNotification(java.lang.String theRelId,
Role theNewRole,
java.util.List theOldRoleValue)
throws java.lang.IllegalArgumentException,
RelationNotFoundException
- 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.
sendRoleUpdateNotification in interface RelationServiceMBeantheRelId - relation identifier of the updated relationtheNewRole - new role (name and new value)theOldRoleValue - old role value (List of ObjectName objects)
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - if there is no relation for given
relation id
public void sendRelationRemovalNotification(java.lang.String theRelId,
java.util.List theUnregMBeanList)
throws java.lang.IllegalArgumentException,
RelationNotFoundException
- 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.
sendRelationRemovalNotification in interface RelationServiceMBeantheRelId - relation identifier of the updated relationtheUnregMBeanList - List of ObjectNames of MBeans expected
to be unregistered due to relation removal (can be null)
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - if there is no relation for given
relation id
public void updateRoleMap(java.lang.String theRelId,
Role theNewRole,
java.util.List theOldRoleValue)
throws java.lang.IllegalArgumentException,
RelationServiceNotRegisteredException,
RelationNotFoundException
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.
updateRoleMap in interface RelationServiceMBeantheRelId - relation identifier of the updated relationtheNewRole - new role (name and new value)theOldRoleValue - old role value (List of ObjectName objects)
java.lang.IllegalArgumentException - if null parameter
RelationServiceNotRegisteredException - if the Relation
Service is not registered in the MBean Server
RelationNotFoundException - if no relation for given id.
public void removeRelation(java.lang.String theRelId)
throws RelationServiceNotRegisteredException,
java.lang.IllegalArgumentException,
RelationNotFoundException
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,
removeRelation in interface RelationServiceMBeantheRelId - relation id of the relation to be removed
RelationServiceNotRegisteredException - if the Relation
Service is not registered in the MBean Server
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - if no relation corresponding to
given relation id
public void purgeRelations()
throws RelationServiceNotRegisteredException
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.
purgeRelations in interface RelationServiceMBeanRelationServiceNotRegisteredException - if the Relation
Service is not registered in the MBean Server.
public java.util.Map findReferencingRelations(ObjectName theMBeanName,
java.lang.String theRelTypeName,
java.lang.String theRoleName)
throws java.lang.IllegalArgumentException
This corresponds to the CIM "References" and "ReferenceNames" operations.
findReferencingRelations in interface RelationServiceMBeantheMBeanName - ObjectName of MBeantheRelTypeName - can be null; if specified, only the relations
of that type will be considered in the search. Else all relation types
are considered.theRoleName - can be null; if specified, only the relations
where the MBean is referenced in that role will be returned. Else all
roles are considered.
java.lang.IllegalArgumentException - if null parameter
public java.util.Map findAssociatedMBeans(ObjectName theMBeanName,
java.lang.String theRelTypeName,
java.lang.String theRoleName)
throws java.lang.IllegalArgumentException
This corresponds to CIM Associators and AssociatorNames operations.
findAssociatedMBeans in interface RelationServiceMBeantheMBeanName - ObjectName of MBeantheRelTypeName - can be null; if specified, only the relations
of that type will be considered in the search. Else all
relation types are considered.theRoleName - can be null; if specified, only the relations
where the MBean is referenced in that role will be considered. Else all
roles are considered.
java.lang.IllegalArgumentException - if null parameter
public java.util.List findRelationsOfType(java.lang.String theRelTypeName)
throws java.lang.IllegalArgumentException,
RelationTypeNotFoundException
findRelationsOfType in interface RelationServiceMBeantheRelTypeName - relation type name
java.lang.IllegalArgumentException - if null parameter
RelationTypeNotFoundException - if there is no relation type
with that name.
public java.util.List getRole(java.lang.String theRelId,
java.lang.String theRoleName)
throws RelationServiceNotRegisteredException,
java.lang.IllegalArgumentException,
RelationNotFoundException,
RoleNotFoundException
getRole in interface RelationServiceMBeantheRelId - relation idtheRoleName - name of role
RelationServiceNotRegisteredException - if the Relation
Service is not registered
java.lang.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.
setRole(java.lang.String, javax.management.relation.Role)
public RoleResult getRoles(java.lang.String theRelId,
java.lang.String[] theRoleNameArray)
throws RelationServiceNotRegisteredException,
java.lang.IllegalArgumentException,
RelationNotFoundException
getRoles in interface RelationServiceMBeantheRelId - relation idtheRoleNameArray - array of names of roles to be retrieved
RelationServiceNotRegisteredException - if the Relation
Service is not registered in the MBean Server
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - if no relation with given idsetRoles(java.lang.String, javax.management.relation.RoleList)
public RoleResult getAllRoles(java.lang.String theRelId)
throws java.lang.IllegalArgumentException,
RelationNotFoundException,
RelationServiceNotRegisteredException
getAllRoles in interface RelationServiceMBeantheRelId - relation id
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - if no relation for given id
RelationServiceNotRegisteredException - if the Relation
Service is not registered in the MBean Server
public java.lang.Integer getRoleCardinality(java.lang.String theRelId,
java.lang.String theRoleName)
throws java.lang.IllegalArgumentException,
RelationNotFoundException,
RoleNotFoundException
getRoleCardinality in interface RelationServiceMBeantheRelId - relation idtheRoleName - name of role
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - if no relation with given id
RoleNotFoundException - if there is no role with given name
public void setRole(java.lang.String theRelId,
Role theRole)
throws RelationServiceNotRegisteredException,
java.lang.IllegalArgumentException,
RelationNotFoundException,
RoleNotFoundException,
InvalidRoleValueException
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.
setRole in interface RelationServiceMBeantheRelId - relation idtheRole - role to be set (name and new value)
RelationServiceNotRegisteredException - if the Relation
Service is not registered in the MBean Server
java.lang.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
getRole(java.lang.String, java.lang.String)
public RoleResult setRoles(java.lang.String theRelId,
RoleList theRoleList)
throws RelationServiceNotRegisteredException,
java.lang.IllegalArgumentException,
RelationNotFoundException
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.
setRoles in interface RelationServiceMBeantheRelId - relation idtheRoleList - list of roles to be set
RelationServiceNotRegisteredException - if the Relation
Service is not registered in the MBean Server
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - if no relation with given idgetRoles(java.lang.String, java.lang.String[])
public java.util.Map getReferencedMBeans(java.lang.String theRelId)
throws java.lang.IllegalArgumentException,
RelationNotFoundException
getReferencedMBeans in interface RelationServiceMBeantheRelId - relation id
ObjectName -> ArrayList of String (role names)
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - if no relation for given
relation id
public java.lang.String getRelationTypeName(java.lang.String theRelId)
throws java.lang.IllegalArgumentException,
RelationNotFoundException
getRelationTypeName in interface RelationServiceMBeantheRelId - relation id
java.lang.IllegalArgumentException - if null parameter
RelationNotFoundException - if no relation for given
relation id
public void handleNotification(Notification theNtf,
java.lang.Object theHandback)
handleNotification in interface NotificationListenertheNtf - The notification.theHandback - An opaque object which helps the listener to
associate information regarding the MBean emitter (can be null).public MBeanNotificationInfo[] getNotificationInfo()
getNotificationInfo in interface NotificationBroadcastergetNotificationInfo in class NotificationBroadcasterSupport
|
J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.