RelationSupport JDK 1.6)

Constructors

public RelationSupport (String relationId, ObjectName relationServiceName, MBeanServer relationServiceMBeanServer, String relationTypeName, RoleList list) throws InvalidRoleValueException IllegalArgumentException

Creates a RelationSupport object.

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 RelationSupport object is not added to the 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 null.

- the same name is used for two roles.

To be handled as a relation, the RelationSupport object has to be added to the Relation Service using the Relation Service method addRelation().
Parameters:
- 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.
Throws:
- 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

Creates a RelationSupport object.

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.

- any of the required parameters is null.

- the same name is used for two roles.

Expected to be unique in the given Relation Service.
- relationServiceName - ObjectName of the Relation Service where the relation will be registered.

Expected to have been created in the given Relation Service.
- list - list of roles (Role objects) to initialize the relation. Can be {@code null}.

Methods

Hide/Show inherited methods

public RoleResult getAllRoles () throws RelationServiceNotRegisteredException

Returns all roles present in the relation.

pack-private RoleResult getAllRolesInt (boolean relationServCallFlg, RelationService relationServ) throws IllegalArgumentException RelationServiceNotRegisteredException

public Map<ObjectName, List<String>> getReferencedMBeans ()

Retrieves MBeans referenced in the various roles of the relation.

public String getRelationId ()

Returns relation identifier (used to uniquely identify the relation inside the Relation Service).

public ObjectName getRelationServiceName ()

Returns ObjectName of the Relation Service handling the relation.

public String getRelationTypeName ()

Returns name of associated relation type.

public List<ObjectName> getRole (String roleName) throws IllegalArgumentException RoleNotFoundException RelationServiceNotRegisteredException

Retrieves role value for given role name.

public Integer getRoleCardinality (String roleName) throws IllegalArgumentException RoleNotFoundException

Returns the number of MBeans currently referenced in the given role.

pack-private Object getRoleInt (String roleName, boolean relationServCallFlg, RelationService relationServ, boolean multiRoleFlg) throws IllegalArgumentException RoleNotFoundException RelationServiceNotRegisteredException

public RoleResult getRoles (String roleNameArray) throws IllegalArgumentException RelationServiceNotRegisteredException

Retrieves values of roles with given names.

pack-private RoleResult getRolesInt (String roleNameArray, boolean relationServCallFlg, RelationService relationServ) throws IllegalArgumentException RelationServiceNotRegisteredException

public void handleMBeanUnregistration (ObjectName objectName, String roleName) throws IllegalArgumentException RoleNotFoundException InvalidRoleValueException RelationServiceNotRegisteredException RelationTypeNotFoundException RelationNotFoundException

Callback used by the Relation Service when a MBean referenced in a role is unregistered.

pack-private void handleMBeanUnregistrationInt (ObjectName objectName, String roleName, boolean relationServCallFlg, RelationService relationServ) throws IllegalArgumentException RoleNotFoundException InvalidRoleValueException RelationServiceNotRegisteredException RelationTypeNotFoundException RelationNotFoundException

public Boolean isInRelationService () [Specified in RelationSupportMBean]

Returns an internal flag specifying if the object is still handled by the Relation Service.

public void postDeregister () [Specified in MBeanRegistration]

public void postRegister (Boolean registrationDone) [Specified in MBeanRegistration]

public void preDeregister () throws Exception [Specified in MBeanRegistration]

public ObjectName preRegister (MBeanServer server, ObjectName name) throws Exception [Specified in MBeanRegistration]

public RoleList retrieveAllRoles ()

Returns all roles in the relation without checking read mode.

public void setRelationServiceManagementFlag (Boolean flag) throws IllegalArgumentException [Specified in RelationSupportMBean]

public void setRole (Role role) throws IllegalArgumentException RoleNotFoundException RelationTypeNotFoundException InvalidRoleValueException RelationServiceNotRegisteredException RelationNotFoundException

Sets the given role.

pack-private Object setRoleInt (Role aRole, boolean relationServCallFlg, RelationService relationServ, boolean multiRoleFlg) throws IllegalArgumentException RoleNotFoundException InvalidRoleValueException RelationServiceNotRegisteredException RelationTypeNotFoundException RelationNotFoundException

public RoleResult setRoles (RoleList list) throws IllegalArgumentException RelationServiceNotRegisteredException RelationTypeNotFoundException RelationNotFoundException

Sets the given roles.

pack-private RoleResult setRolesInt (RoleList list, boolean relationServCallFlg, RelationService relationServ) throws IllegalArgumentException RelationServiceNotRegisteredException RelationTypeNotFoundException RelationNotFoundException