| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectName service = …;
MBeanServer server = …;
RoleList rolesB = …;
RelationSupport support = new RelationSupport("id", service, server, "relationTypeB", rolesB);
Based on 6 examples
public class RelationSupport extends Object implements RelationSupportMBean, MBeanRegistration
A RelationSupport object is used internally by the Relation Service to represent simple relations (only roles, no properties or methods), with an unlimited number of roles, of any relation type. As internal representation, it is not exposed to the user.
RelationSupport class conforms to the design patterns of standard MBean. So the user can decide to instantiate a RelationSupport object himself as a MBean (as it follows the MBean design patterns), to register it in the MBean Server, and then to add it in the Relation Service.
The user can also, when creating his own MBean relation class, have it extending RelationSupport, to retrieve the implementations of required interfaces (see below).
It is also possible to have in a user relation MBean class a member being a RelationSupport object, and to implement the required interfaces by delegating all to this member.
RelationSupport implements the Relation interface (to be handled by the Relation Service).
It implements also the MBeanRegistration interface to be able to retrieve the MBean Server where it is registered (if registered as a MBean) to access to its Relation Service.
Constructor Summary | |
---|---|
RelationSupport(String relationId, ObjectName relationServiceName, MBeanServer relationServiceMBeanServer, String relationTypeName, RoleList list) Creates a object. |
|
RelationSupport(String relationId, ObjectName relationServiceName, String relationTypeName, RoleList list) Creates a object. |
Method Summary | |
---|---|
RoleResult |
Returns all roles present in the relation. |
Map |
Retrieves MBeans referenced in the various roles of the relation. |
String |
Returns relation identifier (used to uniquely identify the relation inside the Relation Service). |
ObjectName |
Returns ObjectName of the Relation Service handling the relation. |
String |
Returns name of associated relation type. |
List |
Retrieves role value for given role name. |
Integer |
getRoleCardinality(String roleName) Returns the number of MBeans currently referenced in the given role. |
RoleResult |
Retrieves values of roles with given names. |
void |
handleMBeanUnregistration(ObjectName objectName, String roleName) Callback used by the Relation Service when a MBean referenced in a role is unregistered. |
Boolean |
Returns an internal flag specifying if the object is still handled by the Relation Service. |
void |
|
void |
postRegister(Boolean registrationDone) |
void |
|
ObjectName |
preRegister(MBeanServer server, ObjectName name) |
RoleList |
Returns all roles in the relation without checking read mode. |
void |
|
void |
Sets the given role. |
RoleResult |
Sets the given roles. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RelationSupport(String relationId, ObjectName relationServiceName, MBeanServer relationServiceMBeanServer, String relationTypeName, RoleList list) throws InvalidRoleValueException, IllegalArgumentException
This constructor has to be used when the user relation MBean implements the interfaces expected to be supported by a relation by delegating to a RelationSupport object.
This object needs to know the Relation Service expected to handle the relation. So it has to know the MBean Server where the Relation Service is registered.
According to a limitation, a relation MBean must be registered in the same MBean Server as the Relation Service expected to handle it. So the user relation MBean has to be created and registered, and then the wrapped RelationSupport object can be created within the identified MBean Server.
Nothing is done at the Relation Service level, i.e. the {@code RelationSupport} object is not added to the {@code RelationService} and no checks are performed to see if the provided values are correct. The object is always created, EXCEPT if:
- any of the required parameters is {@code null}.
- the same name is used for two roles.
To be handled as a relation, the {@code RelationSupport} object has to be added to the Relation Service using the Relation Service method addRelation().
relationId
- relation identifier, to identify the relation in the
Relation Service.
Expected to be unique in the given Relation Service.
relationServiceName
- ObjectName of the Relation Service where
the relation will be registered.
This parameter is required as it is the Relation Service that is aware of the definition of the relation type of the given relation, so that will be able to check update operations (set).
relationServiceMBeanServer
- MBean Server where the wrapping MBean
is or will be registered.
Expected to be the MBean Server where the Relation Service is or will be registered.
relationTypeName
- Name of relation type.
Expected to have been created in the given Relation Service.
list
- list of roles (Role objects) to initialize the
relation. Can be {@code null}.
Expected to conform to relation info in associated relation type.
InvalidRoleValueException
- if the same name is used for two
roles.IllegalArgumentException
- if any of the required parameters
(relation id, relation service ObjectName, relation service MBeanServer,
or relation type name) is {@code null}.public RelationSupport(String relationId, ObjectName relationServiceName, String relationTypeName, RoleList list) throws InvalidRoleValueException, IllegalArgumentException
This constructor has to be used when the RelationSupport object will be registered as a MBean by the user, or when creating a user relation MBean whose class extends RelationSupport.
Nothing is done at the Relation Service level, i.e. the {@code RelationSupport} object is not added to the {@code RelationService} and no checks are performed to see if the provided values are correct. The object is always created, EXCEPT if:
- any of the required parameters is {@code null}.
- the same name is used for two roles.
To be handled as a relation, the {@code RelationSupport} object has to be added to the Relation Service using the Relation Service method addRelation().
relationId
- relation identifier, to identify the relation in the
Relation Service.
Expected to be unique in the given Relation Service.
relationServiceName
- ObjectName of the Relation Service where
the relation will be registered.
This parameter is required as it is the Relation Service that is aware of the definition of the relation type of the given relation, so that will be able to check update operations (set).
relationTypeName
- Name of relation type.
Expected to have been created in the given Relation Service.
list
- list of roles (Role objects) to initialize the
relation. Can be {@code null}.
Expected to conform to relation info in associated relation type.
InvalidRoleValueException
- if the same name is used for two
roles.IllegalArgumentException
- if any of the required parameters
(relation id, relation service ObjectName, or relation type name) is
{@code null}.Method Detail |
---|
public RoleResult getAllRoles() throws RelationServiceNotRegisteredException
RelationServiceNotRegisteredException
- if the Relation
Service is not registered in the MBean Serverpublic Map getReferencedMBeans()
ObjectName -> ArrayList of String (role names)
public String getRelationId()
public ObjectName getRelationServiceName()
public String getRelationTypeName()
public List getRole(String roleName) throws IllegalArgumentException, RoleNotFoundException, RelationServiceNotRegisteredException
Checks if the role exists and is readable according to the relation type.
roleName
- name of roleIllegalArgumentException
- if null role nameRoleNotFoundException
- if:
- there is no role with given name
- the role is not readable.
RelationServiceNotRegisteredException
- if the Relation
Service is not registered in the MBean Serverpublic Integer getRoleCardinality(String roleName) throws IllegalArgumentException, RoleNotFoundException
roleName
- name of roleIllegalArgumentException
- if null role nameRoleNotFoundException
- if there is no role with given namepublic RoleResult getRoles(String[] roleNameArray) throws IllegalArgumentException, RelationServiceNotRegisteredException
Checks for each role if it exists and is readable according to the relation type.
roleNameArray
- array of names of roles to be retrievedIllegalArgumentException
- if null role nameRelationServiceNotRegisteredException
- if the Relation
Service is not registered in the MBean Serverpublic void handleMBeanUnregistration(ObjectName objectName, String roleName) throws IllegalArgumentException, RoleNotFoundException, InvalidRoleValueException, RelationServiceNotRegisteredException, RelationTypeNotFoundException, RelationNotFoundException
The Relation Service will call this method to let the relation take action to reflect the impact of such unregistration.
BEWARE. the user is not expected to call this method.
Current implementation is to set the role with its current value (list of ObjectNames of referenced MBeans) without the unregistered one.
objectName
- ObjectName of unregistered MBeanroleName
- name of role where the MBean is referencedIllegalArgumentException
- if null parameterRoleNotFoundException
- if role does not exist in the
relation or is not writableInvalidRoleValueException
- if role value does not conform to
the associated role info (this will never happen when called from the
Relation Service)RelationServiceNotRegisteredException
- if the Relation
Service is not registered in the MBean ServerRelationTypeNotFoundException
- if the relation type has not
been declared in the Relation Service.RelationNotFoundException
- if this method is called for a
relation MBean not added in the Relation Service.public Boolean isInRelationService()
public void postDeregister()
public void postRegister(Boolean registrationDone)
registrationDone
public void preDeregister() throws Exception
Exception
public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception
server
name
Exception
public RoleList retrieveAllRoles()
public void setRelationServiceManagementFlag(Boolean flag) throws IllegalArgumentException
flag
IllegalArgumentException
public void setRole(Role role) throws IllegalArgumentException, RoleNotFoundException, RelationTypeNotFoundException, InvalidRoleValueException, RelationServiceNotRegisteredException, RelationNotFoundException
Will check the role according to its corresponding role definition provided in relation's relation type
Will send a notification (RelationNotification with type RELATION_BASIC_UPDATE or RELATION_MBEAN_UPDATE, depending if the relation is a MBean or not).
role
- role to be set (name and new value)IllegalArgumentException
- if null roleRoleNotFoundException
- if there is no role with the supplied
role's name or if the role is not writable (no test on the write access
mode performed when initializing the role)RelationTypeNotFoundException
- if the relation type has not
been declared in the Relation ServiceInvalidRoleValueException
- if value provided for
role is not valid, i.e.:
- 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
- a MBean provided for that role does not exist
RelationServiceNotRegisteredException
- if the Relation
Service is not registered in the MBean ServerRelationNotFoundException
- if the relation has not been
added in the Relation Service.public RoleResult setRoles(RoleList list) throws IllegalArgumentException, RelationServiceNotRegisteredException, RelationTypeNotFoundException, RelationNotFoundException
Will check the role according to its corresponding role definition provided in relation's relation type
Will send one notification (RelationNotification with type RELATION_BASIC_UPDATE or RELATION_MBEAN_UPDATE, depending if the relation is a MBean or not) per updated role.
list
- list of roles to be setIllegalArgumentException
- if null role listRelationServiceNotRegisteredException
- if the Relation
Service is not registered in the MBean ServerRelationTypeNotFoundException
- if the relation type has not
been declared in the Relation Service.RelationNotFoundException
- if the relation MBean has not been
added in the Relation Service.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |