1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
/* * @(#)Relation.java 1.26 05/12/29 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.management.relation; import java.util.List; import java.util.Map; import javax.management.ObjectName; import javax.management.InstanceNotFoundException; import javax.management.ReflectionException; /** * This interface has to be implemented by any MBean class expected to * represent a relation managed using the Relation Service. * <P>Simple relations, i.e. having only roles, no properties or methods, can * be created directly by the Relation Service (represented as RelationSupport * objects, internally handled by the Relation Service). * <P>If the user wants to represent more complex relations, involving * properties and/or methods, he has to provide his own class implementing the * Relation interface. This can be achieved either by inheriting from * RelationSupport class, or by implementing the interface (fully or delegation to * a RelationSupport object member). * <P>Specifying such user relation class is to introduce properties and/or * methods. Those have to be exposed for remote management. So this means that * any user relation class must be a MBean class. * * @since 1.5 */ public interface Relation { /** * Retrieves role value for given role name. * <P>Checks if the role exists and is readable according to the relation * type. * * @param roleName name of role * * @return the ArrayList of ObjectName objects being the role value * * @exception IllegalArgumentException if null role name * @exception RoleNotFoundException if: * <P>- there is no role with given name * <P>- the role is not readable. * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * * @see #setRole */ public List<ObjectName> getRole(String roleName) throws IllegalArgumentException, RoleNotFoundException, RelationServiceNotRegisteredException; /** * Retrieves values of roles with given names. * <P>Checks for each role if it exists and is readable according to the * relation type. * * @param roleNameArray array of names of roles to be retrieved * * @return a RoleResult object, including a RoleList (for roles * successfully retrieved) and a RoleUnresolvedList (for roles not * retrieved). * * @exception IllegalArgumentException if null role name * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * * @see #setRoles */ public RoleResult getRoles(String[] roleNameArray) throws IllegalArgumentException, RelationServiceNotRegisteredException; /** * Returns the number of MBeans currently referenced in the given role. * * @param roleName name of role * * @return the number of currently referenced MBeans in that role * * @exception IllegalArgumentException if null role name * @exception RoleNotFoundException if there is no role with given name */ public Integer getRoleCardinality(String roleName) throws IllegalArgumentException, RoleNotFoundException; /** * Returns all roles present in the relation. * * @return a RoleResult object, including a RoleList (for roles * successfully retrieved) and a RoleUnresolvedList (for roles not * readable). * * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server */ public RoleResult getAllRoles() throws RelationServiceNotRegisteredException; /** * Returns all roles in the relation without checking read mode. * * @return a RoleList. */ public RoleList retrieveAllRoles(); /** * Sets the given role. * <P>Will check the role according to its corresponding role definition * provided in relation's relation type * <P>Will send a notification (RelationNotification with type * RELATION_BASIC_UPDATE or RELATION_MBEAN_UPDATE, depending if the * relation is a MBean or not). * * @param role role to be set (name and new value) * * @exception IllegalArgumentException if null role * @exception RoleNotFoundException if there is no role with the supplied * role's name or if the role is not writable (no test on the write access * mode performed when initializing the role) * @exception InvalidRoleValueException if value provided for * role is not valid, i.e.: * <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>- a MBean provided for that role does not exist. * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception RelationTypeNotFoundException if the relation type has not * been declared in the Relation Service. * @exception RelationNotFoundException if the relation has not been * added in the Relation Service. * * @see #getRole */ public void setRole(Role role) throws IllegalArgumentException, RoleNotFoundException, RelationTypeNotFoundException, InvalidRoleValueException, RelationServiceNotRegisteredException, RelationNotFoundException; /** * Sets the given roles. * <P>Will check the role according to its corresponding role definition * provided in relation's relation type * <P>Will send one notification (RelationNotification with type * RELATION_BASIC_UPDATE or RELATION_MBEAN_UPDATE, depending if the * relation is a MBean or not) per updated role. * * @param roleList list of roles to be set * * @return a RoleResult object, including a RoleList (for roles * successfully set) and a RoleUnresolvedList (for roles not * set). * * @exception IllegalArgumentException if null role list * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception RelationTypeNotFoundException if the relation type has not * been declared in the Relation Service. * @exception RelationNotFoundException if the relation MBean has not been * added in the Relation Service. * * @see #getRoles */ public RoleResult setRoles(RoleList roleList) throws IllegalArgumentException, RelationServiceNotRegisteredException, RelationTypeNotFoundException, RelationNotFoundException; /** * Callback used by the Relation Service when a MBean referenced in a role * is unregistered. * <P>The Relation Service will call this method to let the relation * take action to reflect the impact of such unregistration. * <P>BEWARE. the user is not expected to call this method. * <P>Current implementation is to set the role with its current value * (list of ObjectNames of referenced MBeans) without the unregistered * one. * * @param objectName ObjectName of unregistered MBean * @param roleName name of role where the MBean is referenced * * @exception IllegalArgumentException if null parameter * @exception RoleNotFoundException if role does not exist in the * relation or is not writable * @exception InvalidRoleValueException if role value does not conform to * the associated role info (this will never happen when called from the * Relation Service) * @exception RelationServiceNotRegisteredException if the Relation * Service is not registered in the MBean Server * @exception RelationTypeNotFoundException if the relation type has not * been declared in the Relation Service. * @exception RelationNotFoundException if this method is called for a * relation MBean not added in the Relation Service. */ public void handleMBeanUnregistration(ObjectName objectName, String roleName) throws IllegalArgumentException, RoleNotFoundException, InvalidRoleValueException, RelationServiceNotRegisteredException, RelationTypeNotFoundException, RelationNotFoundException; /** * Retrieves MBeans referenced in the various roles of the relation. * * @return a HashMap mapping: * <P> ObjectName -> ArrayList of String (role names) */ public Map<ObjectName,List<String>> getReferencedMBeans(); /** * Returns name of associated relation type. * * @return the name of the relation type. */ public String getRelationTypeName(); /** * Returns ObjectName of the Relation Service handling the relation. * * @return the ObjectName of the Relation Service. */ public ObjectName getRelationServiceName(); /** * Returns relation identifier (used to uniquely identify the relation * inside the Relation Service). * * @return the relation id. */ public String getRelationId(); }