Package Summary  Overview Summary

class:RelationServiceMBean [NONE]
All Known Implementing Classes:
RelationService
public interface RelationServiceMBean
The Relation Service is in charge of creating and deleting relation types and relations, of handling the consistency and of providing query mechanisms.
Since:
1.5

method:isActive() [NONE]

  • isActive

    void isActive() throws RelationServiceNotRegisteredException
    Checks if the Relation Service is active. Current condition is that the Relation Service must be registered in the MBean Server
    Throws:
    RelationServiceNotRegisteredException - if it is not registered

    • method:getPurgeFlag() [NONE]

    getPurgeFlag

    boolean getPurgeFlag()
    Returns the flag to indicate if when a notification is received for the unregistration of an MBean referenced in a relation, if an immediate "purge" of the relations (look for the relations no longer valid) has to be performed, or if that will be performed only when the purgeRelations method is explicitly called.

    true is immediate purge.

    Returns:
    true if purges are immediate.
    See Also:

    method:setPurgeFlag(boolean) [NONE]

    setPurgeFlag

    void setPurgeFlag (boolean purgeFlag)
    Sets the flag to indicate if when a notification is received for the unregistration of an MBean referenced in a relation, if an immediate "purge" of the relations (look for the relations no longer valid) has to be performed, or if that will be performed only when the purgeRelations method is explicitly called.

    true is immediate purge.

    Parameters:
    purgeFlag - flag
    See Also:

    method:createRelationType(java.lang.String,javax.management.relation.RoleInfo[]) [NONE]

    createRelationType

    void createRelationType (String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException
    Creates a relation type (RelationTypeSupport object) with given role infos (provided by the RoleInfo objects), and adds it in the Relation Service.
    Parameters:
    relationTypeName - name of the relation type
    roleInfoArray - array of role infos
    Throws:
    IllegalArgumentException - if null parameter
    InvalidRelationTypeException - If:

    - there is already a relation type with that name

    - the same name has been used for two different role infos

    - no role info provided

    - one null role info provided

    method:addRelationType(javax.management.relation.RelationType) [NONE]

    addRelationType

    void addRelationType (RelationType relationTypeObj) throws IllegalArgumentException, InvalidRelationTypeException
    Adds given object as a relation type. The object is expected to implement the RelationType interface.
    Parameters:
    relationTypeObj - relation type object (implementing the RelationType interface)
    Throws:
    IllegalArgumentException - if null parameter or if relationTypeObj.getRelationTypeName() returns null.
    InvalidRelationTypeException - if there is already a relation type with that name

    method:getAllRelationTypeNames() [NONE]

    getAllRelationTypeNames

    List<String> getAllRelationTypeNames()
    Retrieves names of all known relation types.
    Returns:
    ArrayList of relation type names (Strings)

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

    getRoleInfos

    List<RoleInfo> getRoleInfos (String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException
    Retrieves list of role infos (RoleInfo objects) of a given relation type.
    Parameters:
    relationTypeName - name of relation type
    Returns:
    ArrayList of RoleInfo.
    Throws:
    IllegalArgumentException - if null parameter
    RelationTypeNotFoundException - if there is no relation type with that name.

    method:getRoleInfo(java.lang.String,java.lang.String) [NONE]

    getRoleInfo

    RoleInfo getRoleInfo (String relationTypeName, String roleInfoName) throws IllegalArgumentException, RelationTypeNotFoundException, RoleInfoNotFoundException
    Retrieves role info for given role of a given relation type.
    Parameters:
    relationTypeName - name of relation type
    roleInfoName - name of role
    Returns:
    RoleInfo object.
    Throws:
    IllegalArgumentException - if null parameter
    RelationTypeNotFoundException - if the relation type is not known in the Relation Service
    RoleInfoNotFoundException - if the role is not part of the relation type.

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

    removeRelationType

    void removeRelationType (String relationTypeName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationTypeNotFoundException
    Removes given relation type from Relation Service.

    The relation objects of that type will be removed from the Relation Service.

    Parameters:
    relationTypeName - name of the relation type to be removed
    Throws:
    RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
    IllegalArgumentException - if null parameter
    RelationTypeNotFoundException - If there is no relation type with that name

    method:createRelation(java.lang.String,java.lang.String,javax.management.relation.RoleList) [NONE]

    createRelation

    void createRelation (String relationId, String relationTypeName, RoleList roleList) throws RelationServiceNotRegisteredException, IllegalArgumentException, RoleNotFoundException, InvalidRelationIdException, RelationTypeNotFoundException, InvalidRoleValueException
    Creates a simple relation (represented by a RelationSupport object) of given relation type, and adds it in the Relation Service.

    Roles are initialized according to the role list provided in parameter. The ones not initialized in this way are set to an empty ArrayList of ObjectNames.

    A RelationNotification, with type RELATION_BASIC_CREATION, is sent.

    Parameters:
    relationId - relation identifier, to identify uniquely the relation inside the Relation Service
    relationTypeName - name of the relation type (has to be created in the Relation Service)
    roleList - role list to initialize roles of the relation (can be null).
    Throws:
    RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
    IllegalArgumentException - if null parameter
    RoleNotFoundException - if a value is provided for a role that does not exist in the relation type
    InvalidRelationIdException - if relation id already used
    RelationTypeNotFoundException - if relation type not known in Relation Service
    InvalidRoleValueException - if:

    - the same role name is used for two different roles

    - 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

    - an MBean provided for that role does not exist

    method:addRelation(javax.management.ObjectName) [NONE]

    addRelation

    void addRelation (ObjectName relationObjectName) throws IllegalArgumentException, RelationServiceNotRegisteredException, NoSuchMethodException, InvalidRelationIdException, InstanceNotFoundException, InvalidRelationServiceException, RelationTypeNotFoundException, RoleNotFoundException, InvalidRoleValueException
    Adds an MBean created by the user (and registered by him in the MBean Server) as a relation in the Relation Service.

    To be added as a relation, the MBean must conform to the following:

    - implement the Relation interface

    - have for RelationService ObjectName the ObjectName of current Relation Service

    - have a relation id that is unique and unused in current Relation Service

    - have for relation type a relation type created in the Relation Service

    - have roles conforming to the role info provided in the relation type.

    Parameters:
    relationObjectName - ObjectName of the relation MBean to be added.
    Throws:
    IllegalArgumentException - if null parameter
    RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
    NoSuchMethodException - If the MBean does not implement the Relation interface
    InvalidRelationIdException - if:

    - no relation identifier in MBean

    - the relation identifier is already used in the Relation Service

    InstanceNotFoundException - if the MBean for given ObjectName has not been registered
    InvalidRelationServiceException - if:

    - no Relation Service name in MBean

    - the Relation Service name in the MBean is not the one of the current Relation Service

    RelationTypeNotFoundException - if:

    - no relation type name in MBean

    - the relation type name in MBean does not correspond to a relation type created in the Relation Service

    InvalidRoleValueException - if:

    - the number of referenced MBeans in a role is less than expected minimum degree

    - the number of referenced MBeans in a role exceeds expected maximum degree

    - one referenced MBean in the value is not an Object of the MBean class expected for that role

    - an MBean provided for a role does not exist

    RoleNotFoundException - if a value is provided for a role that does not exist in the relation type

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

    isRelationMBean

    ObjectName isRelationMBean (String relationId) throws IllegalArgumentException, RelationNotFoundException
    If the relation is represented by an MBean (created by the user and added as a relation in the Relation Service), returns the ObjectName of the MBean.
    Parameters:
    relationId - relation id identifying the relation
    Returns:
    ObjectName of the corresponding relation MBean, or null if the relation is not an MBean.
    Throws:
    IllegalArgumentException - if null parameter
    RelationNotFoundException - there is no relation associated to that id

    method:isRelation(javax.management.ObjectName) [NONE]

    isRelation

    String isRelation (ObjectName objectName) throws IllegalArgumentException
    Returns the relation id associated to the given ObjectName if the MBean has been added as a relation in the Relation Service.
    Parameters:
    objectName - ObjectName of supposed relation
    Returns:
    relation id (String) or null (if the ObjectName is not a relation handled by the Relation Service)
    Throws:
    IllegalArgumentException - if null parameter

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

    hasRelation

    Boolean hasRelation (String relationId) throws IllegalArgumentException
    Checks if there is a relation identified in Relation Service with given relation id.
    Parameters:
    relationId - relation id identifying the relation
    Returns:
    boolean: true if there is a relation, false else
    Throws:
    IllegalArgumentException - if null parameter

    method:getAllRelationIds() [NONE]

    getAllRelationIds

    List<String> getAllRelationIds()
    Returns all the relation ids for all the relations handled by the Relation Service.
    Returns:
    ArrayList of String

    method:checkRoleReading(java.lang.String,java.lang.String) [NONE]

    checkRoleReading

    Integer checkRoleReading (String roleName, String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException
    Checks if given Role can be read in a relation of the given type.
    Parameters:
    roleName - name of role to be checked
    relationTypeName - name of the relation type
    Returns:
    an Integer wrapping an integer corresponding to possible problems represented as constants in RoleUnresolved:

    - 0 if role can be read

    - integer corresponding to RoleStatus.NO_ROLE_WITH_NAME

    - integer corresponding to RoleStatus.ROLE_NOT_READABLE

    Throws:
    IllegalArgumentException - if null parameter
    RelationTypeNotFoundException - if the relation type is not known in the Relation Service

    method:checkRoleWriting(javax.management.relation.Role,java.lang.String,java.lang.Boolean) [NONE]

    checkRoleWriting

    Integer checkRoleWriting (Role role, String relationTypeName, Boolean initFlag) throws IllegalArgumentException, RelationTypeNotFoundException
    Checks if given Role can be set in a relation of given type.
    Parameters:
    role - role to be checked
    relationTypeName - name of relation type
    initFlag - flag to specify that the checking is done for the initialization of a role, write access shall not be verified.
    Returns:
    an Integer wrapping an integer corresponding to possible problems represented as constants in RoleUnresolved:

    - 0 if role can be set

    - integer corresponding to RoleStatus.NO_ROLE_WITH_NAME

    - integer for RoleStatus.ROLE_NOT_WRITABLE

    - integer for RoleStatus.LESS_THAN_MIN_ROLE_DEGREE

    - integer for RoleStatus.MORE_THAN_MAX_ROLE_DEGREE

    - integer for RoleStatus.REF_MBEAN_OF_INCORRECT_CLASS

    - integer for RoleStatus.REF_MBEAN_NOT_REGISTERED

    Throws:
    IllegalArgumentException - if null parameter
    RelationTypeNotFoundException - if unknown relation type

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

    sendRelationCreationNotification

    void sendRelationCreationNotification (String relationId) throws IllegalArgumentException, RelationNotFoundException
    Sends a notification (RelationNotification) for a relation creation. The notification type is:

    - RelationNotification.RELATION_BASIC_CREATION if the relation is an object internal to the Relation Service

    - RelationNotification.RELATION_MBEAN_CREATION if the relation is a MBean added as a relation.

    The source object is the Relation Service itself.

    It is called in Relation Service createRelation() and addRelation() methods.

    Parameters:
    relationId - relation identifier of the updated relation
    Throws:
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if there is no relation for given relation id

    method:sendRoleUpdateNotification(java.lang.String,javax.management.relation.Role,java.util.List) [NONE]

    sendRoleUpdateNotification

    void sendRoleUpdateNotification (String relationId, Role newRole, List<ObjectName> oldRoleValue) throws IllegalArgumentException, RelationNotFoundException
    Sends a notification (RelationNotification) for a role update in the given relation. The notification type is:

    - RelationNotification.RELATION_BASIC_UPDATE if the relation is an object internal to the Relation Service

    - RelationNotification.RELATION_MBEAN_UPDATE if the relation is a MBean added as a relation.

    The source object is the Relation Service itself.

    It is called in relation MBean setRole() (for given role) and setRoles() (for each role) methods (implementation provided in RelationSupport class).

    It is also called in Relation Service setRole() (for given role) and setRoles() (for each role) methods.

    Parameters:
    relationId - relation identifier of the updated relation
    newRole - new role (name and new value)
    oldRoleValue - old role value (List of ObjectName objects)
    Throws:
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if there is no relation for given relation id

    method:sendRelationRemovalNotification(java.lang.String,java.util.List) [NONE]

    sendRelationRemovalNotification

    void sendRelationRemovalNotification (String relationId, List<ObjectName> unregMBeanList) throws IllegalArgumentException, RelationNotFoundException
    Sends a notification (RelationNotification) for a relation removal. The notification type is:

    - RelationNotification.RELATION_BASIC_REMOVAL if the relation is an object internal to the Relation Service

    - RelationNotification.RELATION_MBEAN_REMOVAL if the relation is a MBean added as a relation.

    The source object is the Relation Service itself.

    It is called in Relation Service removeRelation() method.

    Parameters:
    relationId - relation identifier of the updated relation
    unregMBeanList - List of ObjectNames of MBeans expected to be unregistered due to relation removal (can be null)
    Throws:
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if there is no relation for given relation id

    method:updateRoleMap(java.lang.String,javax.management.relation.Role,java.util.List) [NONE]

    updateRoleMap

    void updateRoleMap (String relationId, Role newRole, List<ObjectName> oldRoleValue) throws IllegalArgumentException, RelationServiceNotRegisteredException, RelationNotFoundException
    Handles update of the Relation Service role map for the update of given role in given relation.

    It is called in relation MBean setRole() (for given role) and setRoles() (for each role) methods (implementation provided in RelationSupport class).

    It is also called in Relation Service setRole() (for given role) and setRoles() (for each role) methods.

    To allow the Relation Service to maintain the consistency (in case of MBean unregistration) and to be able to perform queries, this method must be called when a role is updated.

    Parameters:
    relationId - relation identifier of the updated relation
    newRole - new role (name and new value)
    oldRoleValue - old role value (List of ObjectName objects)
    Throws:
    IllegalArgumentException - if null parameter
    RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
    RelationNotFoundException - if no relation for given id.

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

    removeRelation

    void removeRelation (String relationId) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException
    Removes given relation from the Relation Service.

    A RelationNotification notification is sent, its type being:

    - RelationNotification.RELATION_BASIC_REMOVAL if the relation was only internal to the Relation Service

    - RelationNotification.RELATION_MBEAN_REMOVAL if the relation is registered as an MBean.

    For MBeans referenced in such relation, nothing will be done,

    Parameters:
    relationId - relation id of the relation to be removed
    Throws:
    RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if no relation corresponding to given relation id

    method:purgeRelations() [NONE]

    purgeRelations

    void purgeRelations() throws RelationServiceNotRegisteredException
    Purges the relations.

    Depending on the purgeFlag value, this method is either called automatically when a notification is received for the unregistration of an MBean referenced in a relation (if the flag is set to true), or not (if the flag is set to false).

    In that case it is up to the user to call it to maintain the consistency of the relations. To be kept in mind that if an MBean is unregistered and the purge not done immediately, if the ObjectName is reused and assigned to another MBean referenced in a relation, calling manually this purgeRelations() method will cause trouble, as will consider the ObjectName as corresponding to the unregistered MBean, not seeing the new one.

    The behavior depends on the cardinality of the role where the unregistered MBean is referenced:

    - if removing one MBean reference in the role makes its number of references less than the minimum degree, the relation has to be removed.

    - if the remaining number of references after removing the MBean reference is still in the cardinality range, keep the relation and update it calling its handleMBeanUnregistration() callback.

    Throws:
    RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server.

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

    findReferencingRelations

    Map<String, List<String>>  findReferencingRelations (ObjectName mbeanName, String relationTypeName, String roleName) throws IllegalArgumentException
    Retrieves the relations where a given MBean is referenced.

    This corresponds to the CIM "References" and "ReferenceNames" operations.

    Parameters:
    mbeanName - ObjectName of MBean
    relationTypeName - can be null; if specified, only the relations of that type will be considered in the search. Else all relation types are considered.
    roleName - can be null; if specified, only the relations where the MBean is referenced in that role will be returned. Else all roles are considered.
    Returns:
    an HashMap, where the keys are the relation ids of the relations where the MBean is referenced, and the value is, for each key, an ArrayList of role names (as an MBean can be referenced in several roles in the same relation).
    Throws:
    IllegalArgumentException - if null parameter

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

    findAssociatedMBeans

    Map<ObjectName, List<String>>  findAssociatedMBeans (ObjectName mbeanName, String relationTypeName, String roleName) throws IllegalArgumentException
    Retrieves the MBeans associated to given one in a relation.

    This corresponds to CIM Associators and AssociatorNames operations.

    Parameters:
    mbeanName - ObjectName of MBean
    relationTypeName - can be null; if specified, only the relations of that type will be considered in the search. Else all relation types are considered.
    roleName - can be null; if specified, only the relations where the MBean is referenced in that role will be considered. Else all roles are considered.
    Returns:
    an HashMap, where the keys are the ObjectNames of the MBeans associated to given MBean, and the value is, for each key, an ArrayList of the relation ids of the relations where the key MBean is associated to given one (as they can be associated in several different relations).
    Throws:
    IllegalArgumentException - if null parameter

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

    findRelationsOfType

    List<String> findRelationsOfType (String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException
    Returns the relation ids for relations of the given type.
    Parameters:
    relationTypeName - relation type name
    Returns:
    an ArrayList of relation ids.
    Throws:
    IllegalArgumentException - if null parameter
    RelationTypeNotFoundException - if there is no relation type with that name.

    method:getRole(java.lang.String,java.lang.String) [NONE]

    getRole

    List<ObjectName> getRole (String relationId, String roleName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException, RoleNotFoundException
    Retrieves role value for given role name in given relation.
    Parameters:
    relationId - relation id
    roleName - name of role
    Returns:
    the ArrayList of ObjectName objects being the role value
    Throws:
    RelationServiceNotRegisteredException - if the Relation Service is not registered
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if no relation with given id
    RoleNotFoundException - if:

    - there is no role with given name

    or

    - the role is not readable.

    See Also:

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

    getRoles

    RoleResult getRoles (String relationId, String[] roleNameArray) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException
    Retrieves values of roles with given names in given relation.
    Parameters:
    relationId - relation id
    roleNameArray - array of names of roles to be retrieved
    Returns:
    a RoleResult object, including a RoleList (for roles successfully retrieved) and a RoleUnresolvedList (for roles not retrieved).
    Throws:
    RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if no relation with given id
    See Also:

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

    getAllRoles

    RoleResult getAllRoles (String relationId) throws IllegalArgumentException, RelationNotFoundException, RelationServiceNotRegisteredException
    Returns all roles present in the relation.
    Parameters:
    relationId - relation id
    Returns:
    a RoleResult object, including a RoleList (for roles successfully retrieved) and a RoleUnresolvedList (for roles not readable).
    Throws:
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if no relation for given id
    RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server

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

    getRoleCardinality

    Integer getRoleCardinality (String relationId, String roleName) throws IllegalArgumentException, RelationNotFoundException, RoleNotFoundException
    Retrieves the number of MBeans currently referenced in the given role.
    Parameters:
    relationId - relation id
    roleName - name of role
    Returns:
    the number of currently referenced MBeans in that role
    Throws:
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if no relation with given id
    RoleNotFoundException - if there is no role with given name

    method:setRole(java.lang.String,javax.management.relation.Role) [NONE]

    setRole

    void setRole (String relationId, Role role) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException, RoleNotFoundException, InvalidRoleValueException, RelationTypeNotFoundException
    Sets the given role in given relation.

    Will check the role according to its corresponding role definition provided in relation's relation type

    The Relation Service will keep track of the change to keep the consistency of relations by handling referenced MBean deregistrations.

    Parameters:
    relationId - relation id
    role - role to be set (name and new value)
    Throws:
    RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if no relation with given id
    RoleNotFoundException - if:

    - internal relation

    and

    - the role does not exist or is not writable

    InvalidRoleValueException - if internal relation and value provided for role is not valid:

    - the number of referenced MBeans in given value is less than expected minimum degree

    or

    - the number of referenced MBeans in provided value exceeds expected maximum degree

    or

    - one referenced MBean in the value is not an Object of the MBean class expected for that role

    or

    - an MBean provided for that role does not exist

    RelationTypeNotFoundException - if unknown relation type
    See Also:

    method:setRoles(java.lang.String,javax.management.relation.RoleList) [NONE]

    setRoles

    RoleResult setRoles (String relationId, RoleList roleList) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationNotFoundException
    Sets the given roles in given relation.

    Will check the role according to its corresponding role definition provided in relation's relation type

    The Relation Service keeps track of the changes to keep the consistency of relations by handling referenced MBean deregistrations.

    Parameters:
    relationId - relation id
    roleList - list of roles to be set
    Returns:
    a RoleResult object, including a RoleList (for roles successfully set) and a RoleUnresolvedList (for roles not set).
    Throws:
    RelationServiceNotRegisteredException - if the Relation Service is not registered in the MBean Server
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if no relation with given id
    See Also:

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

    getReferencedMBeans

    Map<ObjectName, List<String>>  getReferencedMBeans (String relationId) throws IllegalArgumentException, RelationNotFoundException
    Retrieves MBeans referenced in the various roles of the relation.
    Parameters:
    relationId - relation id
    Returns:
    a HashMap mapping:

    ObjectName -> ArrayList of String (role names)

    Throws:
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if no relation for given relation id

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

    getRelationTypeName

    String getRelationTypeName (String relationId) throws IllegalArgumentException, RelationNotFoundException
    Returns name of associated relation type for given relation.
    Parameters:
    relationId - relation id
    Returns:
    the name of the associated relation type.
    Throws:
    IllegalArgumentException - if null parameter
    RelationNotFoundException - if no relation for given relation id

    © 2023 Oracle Corporation and/or its affiliates