Package Summary  Overview Summary

class:RelationSupport [NONE]

  • 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:<init>(java.lang.String,javax.management.ObjectName,java.lang.String,javax.management.relation.RoleList) [NONE]

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

constructor:<init>(java.lang.String,javax.management.ObjectName,javax.management.MBeanServer,java.lang.String,javax.management.relation.RoleList) [NONE]

  • 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:getRole(java.lang.String) [NONE]

method:getRoles(java.lang.String[]) [NONE]

method:getAllRoles() [NONE]

method:retrieveAllRoles() [NONE]

  • retrieveAllRoles

    public RoleList retrieveAllRoles()
    Returns all roles in the relation without checking read mode.
    Specified by:
    retrieveAllRoles in interface Relation
    Returns:
    a RoleList

method:getRoleCardinality(java.lang.String) [NONE]

method:setRole(javax.management.relation.Role) [NONE]

method:setRoles(javax.management.relation.RoleList) [NONE]

method:handleMBeanUnregistration(javax.management.ObjectName,java.lang.String) [NONE]

method:getReferencedMBeans() [NONE]

  • getReferencedMBeans

    public Map<ObjectName,List<String>> getReferencedMBeans()
    Retrieves MBeans referenced in the various roles of the relation.
    Specified by:
    getReferencedMBeans in interface Relation
    Returns:
    a HashMap mapping:

    ObjectName -> ArrayList of String (role names)

method:getRelationTypeName() [NONE]

  • getRelationTypeName

    public String getRelationTypeName()
    Returns name of associated relation type.
    Specified by:
    getRelationTypeName in interface Relation
    Returns:
    the name of the relation type.

method:getRelationServiceName() [NONE]

  • getRelationServiceName

    public ObjectName getRelationServiceName()
    Returns ObjectName of the Relation Service handling the relation.
    Specified by:
    getRelationServiceName in interface Relation
    Returns:
    the ObjectName of the Relation Service.

method:getRelationId() [NONE]

  • getRelationId

    public String getRelationId()
    Returns relation identifier (used to uniquely identify the relation inside the Relation Service).
    Specified by:
    getRelationId in interface Relation
    Returns:
    the relation id.

method:preRegister(javax.management.MBeanServer,javax.management.ObjectName) [NONE]

  • preRegister

    public ObjectName preRegister​(MBeanServer server,
                                  ObjectName name)
                           throws Exception
    
    Description copied from interface: MBeanRegistration
    Allows the MBean to perform any operations it needs before being registered in the MBean Server. If the name of the MBean is not specified, the MBean can provide a name for its registration. If any exception is raised, the MBean will not be registered in the MBean Server.
    Specified by:
    preRegister in interface MBeanRegistration
    Parameters:
    server - 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.
    Returns:
    The name under which the MBean is to be registered. This value must not be null. If the name parameter is not null, it will usually but not necessarily be the returned value.
    Throws:
    Exception - This exception will be caught by the MBean Server and re-thrown as an MBeanRegistrationException.

method:postRegister(java.lang.Boolean) [NONE]

  • postRegister

    public void postRegister​(Boolean registrationDone)
    Description copied from interface: MBeanRegistration
    Allows the MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.

    If the implementation of this method throws a RuntimeException or an Error, the MBean Server will rethrow those inside a RuntimeMBeanException or RuntimeErrorException, respectively. However, throwing an exception in postRegister will not change the state of the MBean: if the MBean was already registered (registrationDone is true), the MBean will remain registered.

    This might be confusing for the code calling createMBean() or registerMBean(), as such code might assume that MBean registration has failed when such an exception is raised. Therefore it is recommended that implementations of postRegister do not throw Runtime Exceptions or Errors if it can be avoided.

    Specified by:
    postRegister in interface MBeanRegistration
    Parameters:
    registrationDone - Indicates whether or not the MBean has been successfully registered in the MBean server. The value false means that the registration phase has failed.

method:preDeregister() [NONE]

method:postDeregister() [NONE]

  • postDeregister

    public void postDeregister()
    Description copied from interface: MBeanRegistration
    Allows the MBean to perform any operations needed after having been unregistered in the MBean server.

    If the implementation of this method throws a RuntimeException or an Error, the MBean Server will rethrow those inside a RuntimeMBeanException or RuntimeErrorException, respectively. However, throwing an exception in postDeregister will not change the state of the MBean: the MBean was already successfully deregistered and will remain so.

    This might be confusing for the code calling unregisterMBean(), as it might assume that MBean deregistration has failed. Therefore it is recommended that implementations of postDeregister do not throw Runtime Exceptions or Errors if it can be avoided.

    Specified by:
    postDeregister in interface MBeanRegistration

method:isInRelationService() [NONE]

method:setRelationServiceManagementFlag(java.lang.Boolean) [NONE]

  • setRelationServiceManagementFlag

    public void setRelationServiceManagementFlag​(Boolean flag)
                                          throws IllegalArgumentException
    
    Description copied from interface: RelationSupportMBean

    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!

    Specified by:
    setRelationServiceManagementFlag in interface RelationSupportMBean
    Parameters:
    flag - whether the relation is handled by the Relation Service.
    Throws:
    IllegalArgumentException - if null parameter

© 2019 Oracle Corporation and/or its affiliates