javax.management.relation
Interface RelationSupportMBean

All Superinterfaces:
Relation sample code for javax.management.relation.Relation definition code for javax.management.relation.Relation
All Known Implementing Classes:
RelationSupport sample code for javax.management.relation.RelationSupport definition code for javax.management.relation.RelationSupport

public interface RelationSupportMBean
extends Relation sample code for javax.management.relation.Relation definition code for javax.management.relation.Relation

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

Since:
1.5

Method Summary
 Boolean sample code for java.lang.Boolean definition code for java.lang.Boolean isInRelationService sample code for javax.management.relation.RelationSupportMBean.isInRelationService() definition code for javax.management.relation.RelationSupportMBean.isInRelationService() ()
          Returns an internal flag specifying if the object is still handled by the Relation Service.
 void setRelationServiceManagementFlag sample code for javax.management.relation.RelationSupportMBean.setRelationServiceManagementFlag(java.lang.Boolean) definition code for javax.management.relation.RelationSupportMBean.setRelationServiceManagementFlag(java.lang.Boolean) (Boolean sample code for java.lang.Boolean definition code for java.lang.Boolean  theFlg)
          Specifies whether this relation is handled by the Relation Service.
 
Methods inherited from interface javax.management.relation.Relation sample code for javax.management.relation.Relation definition code for javax.management.relation.Relation
getAllRoles sample code for javax.management.relation.Relation.getAllRoles() definition code for javax.management.relation.Relation.getAllRoles() , getReferencedMBeans sample code for javax.management.relation.Relation.getReferencedMBeans() definition code for javax.management.relation.Relation.getReferencedMBeans() , getRelationId sample code for javax.management.relation.Relation.getRelationId() definition code for javax.management.relation.Relation.getRelationId() , getRelationServiceName sample code for javax.management.relation.Relation.getRelationServiceName() definition code for javax.management.relation.Relation.getRelationServiceName() , getRelationTypeName sample code for javax.management.relation.Relation.getRelationTypeName() definition code for javax.management.relation.Relation.getRelationTypeName() , getRole sample code for javax.management.relation.Relation.getRole(java.lang.String) definition code for javax.management.relation.Relation.getRole(java.lang.String) , getRoleCardinality sample code for javax.management.relation.Relation.getRoleCardinality(java.lang.String) definition code for javax.management.relation.Relation.getRoleCardinality(java.lang.String) , getRoles sample code for javax.management.relation.Relation.getRoles(java.lang.String[]) definition code for javax.management.relation.Relation.getRoles(java.lang.String[]) , handleMBeanUnregistration sample code for javax.management.relation.Relation.handleMBeanUnregistration(javax.management.ObjectName, java.lang.String) definition code for javax.management.relation.Relation.handleMBeanUnregistration(javax.management.ObjectName, java.lang.String) , retrieveAllRoles sample code for javax.management.relation.Relation.retrieveAllRoles() definition code for javax.management.relation.Relation.retrieveAllRoles() , setRole sample code for javax.management.relation.Relation.setRole(javax.management.relation.Role) definition code for javax.management.relation.Relation.setRole(javax.management.relation.Role) , setRoles sample code for javax.management.relation.Relation.setRoles(javax.management.relation.RoleList) definition code for javax.management.relation.Relation.setRoles(javax.management.relation.RoleList)
 

Method Detail

isInRelationService sample code for javax.management.relation.RelationSupportMBean.isInRelationService() definition code for javax.management.relation.RelationSupportMBean.isInRelationService()

Boolean sample code for java.lang.Boolean definition code for java.lang.Boolean  isInRelationService()
Returns an internal flag specifying if the object is still handled by the Relation Service.

Returns:
a Boolean equal to Boolean.TRUE sample code for java.lang.Boolean.TRUE definition code for java.lang.Boolean.TRUE if the object is still handled by the Relation Service and Boolean.FALSE sample code for java.lang.Boolean.FALSE definition code for java.lang.Boolean.FALSE otherwise.

setRelationServiceManagementFlag sample code for javax.management.relation.RelationSupportMBean.setRelationServiceManagementFlag(java.lang.Boolean) definition code for javax.management.relation.RelationSupportMBean.setRelationServiceManagementFlag(java.lang.Boolean)

void setRelationServiceManagementFlag(Boolean sample code for java.lang.Boolean definition code for java.lang.Boolean  theFlg)
                                      throws IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException 

Specifies whether this relation is handled by the Relation Service.

BEWARE, this method has to be exposed as the Relation Service will access the relation through its management interface. It is RECOMMENDED NOT to use this method. Using it does not affect the registration of the relation object in the Relation Service, but will provide wrong information about it!

Parameters:
theFlg - whether the relation is handled by the Relation Service.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if null parameter