Class RelationSupport

java.lang.Object
javax.management.relation.RelationSupport
All Implemented Interfaces:
MBeanRegistration, Relation, RelationSupportMBean
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.

Since:
1.5

  • Constructor Summary

    Constructors
    Constructor
    Description
    RelationSupport(String relationId, ObjectName relationServiceName, String relationTypeName, RoleList list)
    Creates a RelationSupport object.
    RelationSupport(String relationId, ObjectName relationServiceName, MBeanServer relationServiceMBeanServer, String relationTypeName, RoleList list)
    Creates a RelationSupport object.

  • Method Summary

    Modifier and Type
    Method
    Description
    RoleResult
    getAllRoles()
    Returns all roles present in the relation.
    Map<ObjectName, List<String>>
    getReferencedMBeans()
    Retrieves MBeans referenced in the various roles of the relation.
    String
    getRelationId()
    Returns relation identifier (used to uniquely identify the relation inside the Relation Service).
    ObjectName
    getRelationServiceName()
    Returns ObjectName of the Relation Service handling the relation.
    String
    getRelationTypeName()
    Returns name of associated relation type.
    List<ObjectName>
    getRole(String roleName)
    Retrieves role value for given role name.
    Integer
    getRoleCardinality(String roleName)
    Returns the number of MBeans currently referenced in the given role.
    RoleResult
    getRoles(String[] roleNameArray)
    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
    isInRelationService()
    Returns an internal flag specifying if the object is still handled by the Relation Service.
    void
    postDeregister()
    Allows the MBean to perform any operations needed after having been unregistered in the MBean server.
    void
    postRegister(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.
    RoleList
    retrieveAllRoles()
    Returns all roles in the relation without checking read mode.
    void
    setRelationServiceManagementFlag(Boolean flag)
    Specifies whether this relation is handled by the Relation Service.
    void
    setRole(Role role)
    Sets the given role.
    RoleResult
    setRoles(RoleList list)
    Sets the given roles.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • RelationSupport

      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.

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

      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 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, or relation type name) is null.

    • RelationSupport

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

  • Method Details