/* * Copyright (c) 2000, 2005, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.management.relation; import javax.management.ObjectName;import javax.management.InstanceNotFoundException; import java.util.List;import java.util.Map; /** * 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 */public interface RelationServiceMBean { /** * Checks if the Relation Service is active. * Current condition is that the Relation Service must be registered in the * MBean Server * * @exception RelationServiceNotRegisteredException if it is not * registered */ public void isActive() throws RelationServiceNotRegisteredException; // // Accessors // /** * 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. * <P>true is immediate purge. * * @return true if purges are immediate. * * @see #setPurgeFlag */ public boolean getPurgeFlag(); /** * 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. * <P>true is immediate purge. * * @param purgeFlag flag * * @see #getPurgeFlag */ public void setPurgeFlag(boolean purgeFlag); // // Relation type handling // /** * Creates a relation type (RelationTypeSupport object) with given * role infos (provided by the RoleInfo objects), and adds it in the * Relation Service. * * @param relationTypeName name of the relation type * @param roleInfoArray array of role infos * * @exception IllegalArgumentException if null parameter * @exception InvalidRelationTypeException If: * <P>- there is already a relation type with that name * <P>- the same name has been used for two different role infos * <P>- no role info provided * <P>- one null role info provided */ public void createRelationType(String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException; /** * Adds given object as a relation type. The object is expected to * implement the RelationType interface. * * @param relationTypeObj relation type object (implementing the * RelationType interface) * * @exception IllegalArgumentException if null parameter or if * {@link RelationType#getRelationTypeName * relationTypeObj.getRelationTypeName()} returns null. * @exception InvalidRelationTypeException if there is already a relation * type with that name */ public void addRelationType(RelationType relationTypeObj) throws IllegalArgumentException, InvalidRelationTypeException; /** * Retrieves names of all known relation types. * * @return ArrayList of relation type names (Strings) */ public List<String> getAllRelationTypeNames(); /** * Retrieves list of role infos (RoleInfo objects) of a given relation * type. * * @param relationTypeName name of relation type * * @return ArrayList of RoleInfo. * * @exception IllegalArgumentException if null parameter * @exception RelationTypeNotFoundException if there is no relation type * with that name. */ public List<RoleInfo> getRoleInfos(String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException; /** * Retrieves role info for given role of a given relation type. * * @param relationTypeName name of relation type * @param roleInfoName name of role * * @return RoleInfo object. * * @exception IllegalArgumentException if null parameter * @exception RelationTypeNotFoundException if the relation type is not * known in the Relation Service * @exception RoleInfoNotFoundException if the role is not part of the * relation type. */ public RoleInfo getRoleInfo(String relationTypeName, String roleInfoName) throws IllegalArgumentException, RelationTypeNotFoundException, RoleInfoNotFoundException; /** * Removes given relation type from Relation Service. * <P>The relation objects of that type will be removed from the * Relation Service. * * @param relationTypeName name of the relation type to be removed * * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception IllegalArgumentException if null parameter * @exception RelationTypeNotFoundException If there is no relation type * with that name */ public void removeRelationType(String relationTypeName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationTypeNotFoundException; // // Relation handling // /** * Creates a simple relation (represented by a RelationSupport object) of * given relation type, and adds it in the Relation Service. * <P>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. * <P>A RelationNotification, with type RELATION_BASIC_CREATION, is sent. * * @param relationId relation identifier, to identify uniquely the relation * inside the Relation Service * @param relationTypeName name of the relation type (has to be created * in the Relation Service) * @param roleList role list to initialize roles of the relation (can * be null). * * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception IllegalArgumentException if null parameter * @exception RoleNotFoundException if a value is provided for a role * that does not exist in the relation type * @exception InvalidRelationIdException if relation id already used * @exception RelationTypeNotFoundException if relation type not known in * Relation Service * @exception InvalidRoleValueException if: * <P>- the same role name is used for two different roles * <P>- the number of referenced MBeans in given value is less than * expected minimum degree * <P>- the number of referenced MBeans in provided value exceeds expected * maximum degree * <P>- one referenced MBean in the value is not an Object of the MBean * class expected for that role * <P>- an MBean provided for that role does not exist */ public void createRelation(String relationId, String relationTypeName, RoleList roleList) throws RelationServiceNotRegisteredException, IllegalArgumentException, RoleNotFoundException, InvalidRelationIdException, RelationTypeNotFoundException, InvalidRoleValueException; /** * Adds an MBean created by the user (and registered by him in the MBean * Server) as a relation in the Relation Service. * <P>To be added as a relation, the MBean must conform to the * following: * <P>- implement the Relation interface * <P>- have for RelationService ObjectName the ObjectName of current * Relation Service * <P>- have a relation id that is unique and unused in current Relation Service * <P>- have for relation type a relation type created in the Relation * Service * <P>- have roles conforming to the role info provided in the relation * type. * * @param relationObjectName ObjectName of the relation MBean to be added. * * @exception IllegalArgumentException if null parameter * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception NoSuchMethodException If the MBean does not implement the * Relation interface * @exception InvalidRelationIdException if: * <P>- no relation identifier in MBean * <P>- the relation identifier is already used in the Relation Service * @exception InstanceNotFoundException if the MBean for given ObjectName * has not been registered * @exception InvalidRelationServiceException if: * <P>- no Relation Service name in MBean * <P>- the Relation Service name in the MBean is not the one of the * current Relation Service * @exception RelationTypeNotFoundException if: * <P>- no relation type name in MBean * <P>- the relation type name in MBean does not correspond to a relation * type created in the Relation Service * @exception InvalidRoleValueException if: * <P>- the number of referenced MBeans in a role is less than * expected minimum degree * <P>- the number of referenced MBeans in a role exceeds expected * maximum degree * <P>- one referenced MBean in the value is not an Object of the MBean * class expected for that role * <P>- an MBean provided for a role does not exist * @exception RoleNotFoundException if a value is provided for a role * that does not exist in the relation type */ public void addRelation(ObjectName relationObjectName) throws IllegalArgumentException, RelationServiceNotRegisteredException, NoSuchMethodException, InvalidRelationIdException, InstanceNotFoundException, InvalidRelationServiceException, RelationTypeNotFoundException, RoleNotFoundException, InvalidRoleValueException; /** * 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. * * @param relationId relation id identifying the relation * * @return ObjectName of the corresponding relation MBean, or null if * the relation is not an MBean. * * @exception IllegalArgumentException if null parameter * @exception RelationNotFoundException there is no relation associated * to that id */ public ObjectName isRelationMBean(String relationId) throws IllegalArgumentException, RelationNotFoundException; /** * Returns the relation id associated to the given ObjectName if the * MBean has been added as a relation in the Relation Service. * * @param objectName ObjectName of supposed relation * * @return relation id (String) or null (if the ObjectName is not a * relation handled by the Relation Service) * * @exception IllegalArgumentException if null parameter */ public String isRelation(ObjectName objectName) throws IllegalArgumentException; /** * Checks if there is a relation identified in Relation Service with given * relation id. * * @param relationId relation id identifying the relation * * @return boolean: true if there is a relation, false else * * @exception IllegalArgumentException if null parameter */ public Boolean hasRelation(String relationId) throws IllegalArgumentException; /** * Returns all the relation ids for all the relations handled by the * Relation Service. * * @return ArrayList of String */ public List<String> getAllRelationIds(); /** * Checks if given Role can be read in a relation of the given type. * * @param roleName name of role to be checked * @param relationTypeName name of the relation type * * @return an Integer wrapping an integer corresponding to possible * problems represented as constants in RoleUnresolved: * <P>- 0 if role can be read * <P>- integer corresponding to RoleStatus.NO_ROLE_WITH_NAME * <P>- integer corresponding to RoleStatus.ROLE_NOT_READABLE * * @exception IllegalArgumentException if null parameter * @exception RelationTypeNotFoundException if the relation type is not * known in the Relation Service */ public Integer checkRoleReading(String roleName, String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException; /** * Checks if given Role can be set in a relation of given type. * * @param role role to be checked * @param relationTypeName name of relation type * @param initFlag flag to specify that the checking is done for the * initialization of a role, write access shall not be verified. * * @return an Integer wrapping an integer corresponding to possible * problems represented as constants in RoleUnresolved: * <P>- 0 if role can be set * <P>- integer corresponding to RoleStatus.NO_ROLE_WITH_NAME * <P>- integer for RoleStatus.ROLE_NOT_WRITABLE * <P>- integer for RoleStatus.LESS_THAN_MIN_ROLE_DEGREE * <P>- integer for RoleStatus.MORE_THAN_MAX_ROLE_DEGREE * <P>- integer for RoleStatus.REF_MBEAN_OF_INCORRECT_CLASS * <P>- integer for RoleStatus.REF_MBEAN_NOT_REGISTERED * * @exception IllegalArgumentException if null parameter * @exception RelationTypeNotFoundException if unknown relation type */ public Integer checkRoleWriting(Role role, String relationTypeName, Boolean initFlag) throws IllegalArgumentException, RelationTypeNotFoundException; /** * Sends a notification (RelationNotification) for a relation creation. * The notification type is: * <P>- RelationNotification.RELATION_BASIC_CREATION if the relation is an * object internal to the Relation Service * <P>- RelationNotification.RELATION_MBEAN_CREATION if the relation is a * MBean added as a relation. * <P>The source object is the Relation Service itself. * <P>It is called in Relation Service createRelation() and * addRelation() methods. * * @param relationId relation identifier of the updated relation * * @exception IllegalArgumentException if null parameter * @exception RelationNotFoundException if there is no relation for given * relation id */ public void sendRelationCreationNotification(String relationId) throws IllegalArgumentException, RelationNotFoundException; /** * Sends a notification (RelationNotification) for a role update in the * given relation. The notification type is: * <P>- RelationNotification.RELATION_BASIC_UPDATE if the relation is an * object internal to the Relation Service * <P>- RelationNotification.RELATION_MBEAN_UPDATE if the relation is a * MBean added as a relation. * <P>The source object is the Relation Service itself. * <P>It is called in relation MBean setRole() (for given role) and * setRoles() (for each role) methods (implementation provided in * RelationSupport class). * <P>It is also called in Relation Service setRole() (for given role) and * setRoles() (for each role) methods. * * @param relationId relation identifier of the updated relation * @param newRole new role (name and new value) * @param oldRoleValue old role value (List of ObjectName objects) * * @exception IllegalArgumentException if null parameter * @exception RelationNotFoundException if there is no relation for given * relation id */ public void sendRoleUpdateNotification(String relationId, Role newRole, List<ObjectName> oldRoleValue) throws IllegalArgumentException, RelationNotFoundException; /** * Sends a notification (RelationNotification) for a relation removal. * The notification type is: * <P>- RelationNotification.RELATION_BASIC_REMOVAL if the relation is an * object internal to the Relation Service * <P>- RelationNotification.RELATION_MBEAN_REMOVAL if the relation is a * MBean added as a relation. * <P>The source object is the Relation Service itself. * <P>It is called in Relation Service removeRelation() method. * * @param relationId relation identifier of the updated relation * @param unregMBeanList List of ObjectNames of MBeans expected * to be unregistered due to relation removal (can be null) * * @exception IllegalArgumentException if null parameter * @exception RelationNotFoundException if there is no relation for given * relation id */ public void sendRelationRemovalNotification(String relationId, List<ObjectName> unregMBeanList) throws IllegalArgumentException, RelationNotFoundException; /** * Handles update of the Relation Service role map for the update of given * role in given relation. * <P>It is called in relation MBean setRole() (for given role) and * setRoles() (for each role) methods (implementation provided in * RelationSupport class). * <P>It is also called in Relation Service setRole() (for given role) and * setRoles() (for each role) methods. * <P>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. * * @param relationId relation identifier of the updated relation * @param newRole new role (name and new value) * @param oldRoleValue old role value (List of ObjectName objects) * * @exception IllegalArgumentException if null parameter * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception RelationNotFoundException if no relation for given id. */ public void updateRoleMap(String relationId, Role newRole, List<ObjectName> oldRoleValue) throws IllegalArgumentException, RelationServiceNotRegisteredException, RelationNotFoundException; /** * Removes given relation from the Relation Service. * <P>A RelationNotification notification is sent, its type being: * <P>- RelationNotification.RELATION_BASIC_REMOVAL if the relation was * only internal to the Relation Service * <P>- RelationNotification.RELATION_MBEAN_REMOVAL if the relation is * registered as an MBean. * <P>For MBeans referenced in such relation, nothing will be done, *Lines 1–500 of 798. Load more
/* * Copyright (c) 2000, 2005, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.management.relation; import javax.management.ObjectName; import javax.management.InstanceNotFoundException; import java.util.List; import java.util.Map; /** * 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 */ public interface RelationServiceMBean { /** * Checks if the Relation Service is active. * Current condition is that the Relation Service must be registered in the * MBean Server * * @exception RelationServiceNotRegisteredException if it is not * registered */ public void isActive() throws RelationServiceNotRegisteredException; // // Accessors // /** * 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. * <P>true is immediate purge. * * @return true if purges are immediate. * * @see #setPurgeFlag */ public boolean getPurgeFlag(); /** * 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. * <P>true is immediate purge. * * @param purgeFlag flag * * @see #getPurgeFlag */ public void setPurgeFlag(boolean purgeFlag); // // Relation type handling // /** * Creates a relation type (RelationTypeSupport object) with given * role infos (provided by the RoleInfo objects), and adds it in the * Relation Service. * * @param relationTypeName name of the relation type * @param roleInfoArray array of role infos * * @exception IllegalArgumentException if null parameter * @exception InvalidRelationTypeException If: * <P>- there is already a relation type with that name * <P>- the same name has been used for two different role infos * <P>- no role info provided * <P>- one null role info provided */ public void createRelationType(String relationTypeName, RoleInfo[] roleInfoArray) throws IllegalArgumentException, InvalidRelationTypeException; /** * Adds given object as a relation type. The object is expected to * implement the RelationType interface. * * @param relationTypeObj relation type object (implementing the * RelationType interface) * * @exception IllegalArgumentException if null parameter or if * {@link RelationType#getRelationTypeName * relationTypeObj.getRelationTypeName()} returns null. * @exception InvalidRelationTypeException if there is already a relation * type with that name */ public void addRelationType(RelationType relationTypeObj) throws IllegalArgumentException, InvalidRelationTypeException; /** * Retrieves names of all known relation types. * * @return ArrayList of relation type names (Strings) */ public List<String> getAllRelationTypeNames(); /** * Retrieves list of role infos (RoleInfo objects) of a given relation * type. * * @param relationTypeName name of relation type * * @return ArrayList of RoleInfo. * * @exception IllegalArgumentException if null parameter * @exception RelationTypeNotFoundException if there is no relation type * with that name. */ public List<RoleInfo> getRoleInfos(String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException; /** * Retrieves role info for given role of a given relation type. * * @param relationTypeName name of relation type * @param roleInfoName name of role * * @return RoleInfo object. * * @exception IllegalArgumentException if null parameter * @exception RelationTypeNotFoundException if the relation type is not * known in the Relation Service * @exception RoleInfoNotFoundException if the role is not part of the * relation type. */ public RoleInfo getRoleInfo(String relationTypeName, String roleInfoName) throws IllegalArgumentException, RelationTypeNotFoundException, RoleInfoNotFoundException; /** * Removes given relation type from Relation Service. * <P>The relation objects of that type will be removed from the * Relation Service. * * @param relationTypeName name of the relation type to be removed * * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception IllegalArgumentException if null parameter * @exception RelationTypeNotFoundException If there is no relation type * with that name */ public void removeRelationType(String relationTypeName) throws RelationServiceNotRegisteredException, IllegalArgumentException, RelationTypeNotFoundException; // // Relation handling // /** * Creates a simple relation (represented by a RelationSupport object) of * given relation type, and adds it in the Relation Service. * <P>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. * <P>A RelationNotification, with type RELATION_BASIC_CREATION, is sent. * * @param relationId relation identifier, to identify uniquely the relation * inside the Relation Service * @param relationTypeName name of the relation type (has to be created * in the Relation Service) * @param roleList role list to initialize roles of the relation (can * be null). * * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception IllegalArgumentException if null parameter * @exception RoleNotFoundException if a value is provided for a role * that does not exist in the relation type * @exception InvalidRelationIdException if relation id already used * @exception RelationTypeNotFoundException if relation type not known in * Relation Service * @exception InvalidRoleValueException if: * <P>- the same role name is used for two different roles * <P>- the number of referenced MBeans in given value is less than * expected minimum degree * <P>- the number of referenced MBeans in provided value exceeds expected * maximum degree * <P>- one referenced MBean in the value is not an Object of the MBean * class expected for that role * <P>- an MBean provided for that role does not exist */ public void createRelation(String relationId, String relationTypeName, RoleList roleList) throws RelationServiceNotRegisteredException, IllegalArgumentException, RoleNotFoundException, InvalidRelationIdException, RelationTypeNotFoundException, InvalidRoleValueException; /** * Adds an MBean created by the user (and registered by him in the MBean * Server) as a relation in the Relation Service. * <P>To be added as a relation, the MBean must conform to the * following: * <P>- implement the Relation interface * <P>- have for RelationService ObjectName the ObjectName of current * Relation Service * <P>- have a relation id that is unique and unused in current Relation Service * <P>- have for relation type a relation type created in the Relation * Service * <P>- have roles conforming to the role info provided in the relation * type. * * @param relationObjectName ObjectName of the relation MBean to be added. * * @exception IllegalArgumentException if null parameter * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception NoSuchMethodException If the MBean does not implement the * Relation interface * @exception InvalidRelationIdException if: * <P>- no relation identifier in MBean * <P>- the relation identifier is already used in the Relation Service * @exception InstanceNotFoundException if the MBean for given ObjectName * has not been registered * @exception InvalidRelationServiceException if: * <P>- no Relation Service name in MBean * <P>- the Relation Service name in the MBean is not the one of the * current Relation Service * @exception RelationTypeNotFoundException if: * <P>- no relation type name in MBean * <P>- the relation type name in MBean does not correspond to a relation * type created in the Relation Service * @exception InvalidRoleValueException if: * <P>- the number of referenced MBeans in a role is less than * expected minimum degree * <P>- the number of referenced MBeans in a role exceeds expected * maximum degree * <P>- one referenced MBean in the value is not an Object of the MBean * class expected for that role * <P>- an MBean provided for a role does not exist * @exception RoleNotFoundException if a value is provided for a role * that does not exist in the relation type */ public void addRelation(ObjectName relationObjectName) throws IllegalArgumentException, RelationServiceNotRegisteredException, NoSuchMethodException, InvalidRelationIdException, InstanceNotFoundException, InvalidRelationServiceException, RelationTypeNotFoundException, RoleNotFoundException, InvalidRoleValueException; /** * 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. * * @param relationId relation id identifying the relation * * @return ObjectName of the corresponding relation MBean, or null if * the relation is not an MBean. * * @exception IllegalArgumentException if null parameter * @exception RelationNotFoundException there is no relation associated * to that id */ public ObjectName isRelationMBean(String relationId) throws IllegalArgumentException, RelationNotFoundException; /** * Returns the relation id associated to the given ObjectName if the * MBean has been added as a relation in the Relation Service. * * @param objectName ObjectName of supposed relation * * @return relation id (String) or null (if the ObjectName is not a * relation handled by the Relation Service) * * @exception IllegalArgumentException if null parameter */ public String isRelation(ObjectName objectName) throws IllegalArgumentException; /** * Checks if there is a relation identified in Relation Service with given * relation id. * * @param relationId relation id identifying the relation * * @return boolean: true if there is a relation, false else * * @exception IllegalArgumentException if null parameter */ public Boolean hasRelation(String relationId) throws IllegalArgumentException; /** * Returns all the relation ids for all the relations handled by the * Relation Service. * * @return ArrayList of String */ public List<String> getAllRelationIds(); /** * Checks if given Role can be read in a relation of the given type. * * @param roleName name of role to be checked * @param relationTypeName name of the relation type * * @return an Integer wrapping an integer corresponding to possible * problems represented as constants in RoleUnresolved: * <P>- 0 if role can be read * <P>- integer corresponding to RoleStatus.NO_ROLE_WITH_NAME * <P>- integer corresponding to RoleStatus.ROLE_NOT_READABLE * * @exception IllegalArgumentException if null parameter * @exception RelationTypeNotFoundException if the relation type is not * known in the Relation Service */ public Integer checkRoleReading(String roleName, String relationTypeName) throws IllegalArgumentException, RelationTypeNotFoundException; /** * Checks if given Role can be set in a relation of given type. * * @param role role to be checked * @param relationTypeName name of relation type * @param initFlag flag to specify that the checking is done for the * initialization of a role, write access shall not be verified. * * @return an Integer wrapping an integer corresponding to possible * problems represented as constants in RoleUnresolved: * <P>- 0 if role can be set * <P>- integer corresponding to RoleStatus.NO_ROLE_WITH_NAME * <P>- integer for RoleStatus.ROLE_NOT_WRITABLE * <P>- integer for RoleStatus.LESS_THAN_MIN_ROLE_DEGREE * <P>- integer for RoleStatus.MORE_THAN_MAX_ROLE_DEGREE * <P>- integer for RoleStatus.REF_MBEAN_OF_INCORRECT_CLASS * <P>- integer for RoleStatus.REF_MBEAN_NOT_REGISTERED * * @exception IllegalArgumentException if null parameter * @exception RelationTypeNotFoundException if unknown relation type */ public Integer checkRoleWriting(Role role, String relationTypeName, Boolean initFlag) throws IllegalArgumentException, RelationTypeNotFoundException; /** * Sends a notification (RelationNotification) for a relation creation. * The notification type is: * <P>- RelationNotification.RELATION_BASIC_CREATION if the relation is an * object internal to the Relation Service * <P>- RelationNotification.RELATION_MBEAN_CREATION if the relation is a * MBean added as a relation. * <P>The source object is the Relation Service itself. * <P>It is called in Relation Service createRelation() and * addRelation() methods. * * @param relationId relation identifier of the updated relation * * @exception IllegalArgumentException if null parameter * @exception RelationNotFoundException if there is no relation for given * relation id */ public void sendRelationCreationNotification(String relationId) throws IllegalArgumentException, RelationNotFoundException; /** * Sends a notification (RelationNotification) for a role update in the * given relation. The notification type is: * <P>- RelationNotification.RELATION_BASIC_UPDATE if the relation is an * object internal to the Relation Service * <P>- RelationNotification.RELATION_MBEAN_UPDATE if the relation is a * MBean added as a relation. * <P>The source object is the Relation Service itself. * <P>It is called in relation MBean setRole() (for given role) and * setRoles() (for each role) methods (implementation provided in * RelationSupport class). * <P>It is also called in Relation Service setRole() (for given role) and * setRoles() (for each role) methods. * * @param relationId relation identifier of the updated relation * @param newRole new role (name and new value) * @param oldRoleValue old role value (List of ObjectName objects) * * @exception IllegalArgumentException if null parameter * @exception RelationNotFoundException if there is no relation for given * relation id */ public void sendRoleUpdateNotification(String relationId, Role newRole, List<ObjectName> oldRoleValue) throws IllegalArgumentException, RelationNotFoundException; /** * Sends a notification (RelationNotification) for a relation removal. * The notification type is: * <P>- RelationNotification.RELATION_BASIC_REMOVAL if the relation is an * object internal to the Relation Service * <P>- RelationNotification.RELATION_MBEAN_REMOVAL if the relation is a * MBean added as a relation. * <P>The source object is the Relation Service itself. * <P>It is called in Relation Service removeRelation() method. * * @param relationId relation identifier of the updated relation * @param unregMBeanList List of ObjectNames of MBeans expected * to be unregistered due to relation removal (can be null) * * @exception IllegalArgumentException if null parameter * @exception RelationNotFoundException if there is no relation for given * relation id */ public void sendRelationRemovalNotification(String relationId, List<ObjectName> unregMBeanList) throws IllegalArgumentException, RelationNotFoundException; /** * Handles update of the Relation Service role map for the update of given * role in given relation. * <P>It is called in relation MBean setRole() (for given role) and * setRoles() (for each role) methods (implementation provided in * RelationSupport class). * <P>It is also called in Relation Service setRole() (for given role) and * setRoles() (for each role) methods. * <P>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. * * @param relationId relation identifier of the updated relation * @param newRole new role (name and new value) * @param oldRoleValue old role value (List of ObjectName objects) * * @exception IllegalArgumentException if null parameter * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception RelationNotFoundException if no relation for given id. */ public void updateRoleMap(String relationId, Role newRole, List<ObjectName> oldRoleValue) throws IllegalArgumentException, RelationServiceNotRegisteredException, RelationNotFoundException; /** * Removes given relation from the Relation Service. * <P>A RelationNotification notification is sent, its type being: * <P>- RelationNotification.RELATION_BASIC_REMOVAL if the relation was * only internal to the Relation Service * <P>- RelationNotification.RELATION_MBEAN_REMOVAL if the relation is * registered as an MBean. * <P>For MBeans referenced in such relation, nothing will be done, *