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 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
/* * @(#)BasicAttributes.java 1.13 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.naming.directory; import java.util.Hashtable; import java.util.Enumeration; import javax.naming.NamingException; import javax.naming.NamingEnumeration; /** * This class provides a basic implementation * of the Attributes interface. *<p> * BasicAttributes is either case-sensitive or case-insensitive (case-ignore). * This property is determined at the time the BasicAttributes constructor * is called. * In a case-insensitive BasicAttributes, the case of its attribute identifiers * is ignored when searching for an attribute, or adding attributes. * In a case-sensitive BasicAttributes, the case is significant. *<p> * When the BasicAttributes class needs to create an Attribute, it * uses BasicAttribute. There is no other dependency on BasicAttribute. *<p> * Note that updates to BasicAttributes (such as adding or removing an attribute) * does not affect the corresponding representation in the directory. * Updates to the directory can only be effected * using operations in the DirContext interface. *<p> * A BasicAttributes instance is not synchronized against concurrent * multithreaded access. Multiple threads trying to access and modify * a single BasicAttributes instance should lock the object. * * @author Rosanna Lee * @author Scott Seligman * @version 1.13 05/11/17 * * @see DirContext#getAttributes * @see DirContext#modifyAttributes * @see DirContext#bind * @see DirContext#rebind * @see DirContext#createSubcontext * @see DirContext#search * @since 1.3 */ public class BasicAttributes implements Attributes { /** * Indicates whether case of attribute ids is ignored. * @serial */ private boolean ignoreCase = false; // The 'key' in attrs is stored in the 'right case'. // If ignoreCase is true, key is aways lowercase. // If ignoreCase is false, key is stored as supplied by put(). // %%% Not declared "private" due to bug 4064984. transient Hashtable attrs = new Hashtable(11); /** * Constructs a new instance of Attributes. * The character case of attribute identifiers * is significant when subsequently retrieving or adding attributes. */ public BasicAttributes() { } /** * Constructs a new instance of Attributes. * If <code>ignoreCase</code> is true, the character case of attribute * identifiers is ignored; otherwise the case is significant. * @param ignoreCase true means this attribute set will ignore * the case of its attribute identifiers * when retrieving or adding attributes; * false means case is respected. */ public BasicAttributes(boolean ignoreCase) { this.ignoreCase = ignoreCase; } /** * Constructs a new instance of Attributes with one attribute. * The attribute specified by attrID and val are added to the newly * created attribute. * The character case of attribute identifiers * is significant when subsequently retrieving or adding attributes. * @param attrID non-null The id of the attribute to add. * @param val The value of the attribute to add. If null, a null * value is added to the attribute. */ public BasicAttributes(String attrID, Object val) { this(); this.put(new BasicAttribute(attrID, val)); } /** * Constructs a new instance of Attributes with one attribute. * The attribute specified by attrID and val are added to the newly * created attribute. * If <code>ignoreCase</code> is true, the character case of attribute * identifiers is ignored; otherwise the case is significant. * @param attrID non-null The id of the attribute to add. * If this attribute set ignores the character * case of its attribute ids, the case of attrID * is ignored. * @param val The value of the attribute to add. If null, a null * value is added to the attribute. * @param ignoreCase true means this attribute set will ignore * the case of its attribute identifiers * when retrieving or adding attributes; * false means case is respected. */ public BasicAttributes(String attrID, Object val, boolean ignoreCase) { this(ignoreCase); this.put(new BasicAttribute(attrID, val)); } public Object clone() { BasicAttributes attrset; try { attrset = (BasicAttributes)super.clone(); } catch (CloneNotSupportedException e) { attrset = new BasicAttributes(ignoreCase); } attrset.attrs = (Hashtable)attrs.clone(); return attrset; } public boolean isCaseIgnored() { return ignoreCase; } public int size() { return attrs.size(); } public Attribute get(String attrID) { Attribute attr = (Attribute) attrs.get( ignoreCase ? attrID.toLowerCase() : attrID); return (attr); } public NamingEnumeration<Attribute> getAll() { return new AttrEnumImpl(); } public NamingEnumeration<String> getIDs() { return new IDEnumImpl(); } public Attribute put(String attrID, Object val) { return (Attribute)this.put(new BasicAttribute(attrID, val)); } public Attribute put(Attribute attr) { String id = attr.getID(); if (ignoreCase) { id = id.toLowerCase(); } return (Attribute)attrs.put(id, attr); } public Attribute remove(String attrID) { String id = (ignoreCase ? attrID.toLowerCase() : attrID); return (Attribute)attrs.remove(id); } /** * Generates the string representation of this attribute set. * The string consists of each attribute identifier and the contents * of each attribute. The contents of this string is useful * for debugging and is not meant to be interpreted programmatically. * * @return A non-null string listing the contents of this attribute set. */ public String toString() { if (attrs.size() == 0) { return("No attributes"); } else { return attrs.toString(); } } /** * Determines whether this <tt>BasicAttributes</tt> is equal to another * <tt>Attributes</tt> * Two <tt>Attributes</tt> are equal if they are both instances of * <tt>Attributes</tt>, * treat the case of attribute IDs the same way, and contain the * same attributes. Each <tt>Attribute</tt> in this <tt>BasicAttributes</tt> * is checked for equality using <tt>Object.equals()</tt>, which may have * be overridden by implementations of <tt>Attribute</tt>). * If a subclass overrides <tt>equals()</tt>, * it should override <tt>hashCode()</tt> * as well so that two <tt>Attributes</tt> instances that are equal * have the same hash code. * @param obj the possibly null object to compare against. * * @return true If obj is equal to this BasicAttributes. * @see #hashCode */ public boolean equals(Object obj) { if ((obj != null) && (obj instanceof Attributes)) { Attributes target = (Attributes)obj; // Check case first if (ignoreCase != target.isCaseIgnored()) { return false; } if (size() == target.size()) { Attribute their, mine; try { NamingEnumeration theirs = target.getAll(); while (theirs.hasMore()) { their = (Attribute)theirs.next(); mine = get(their.getID()); if (!their.equals(mine)) { return false; } } } catch (NamingException e) { return false; } return true; } } return false; } /** * Calculates the hash code of this BasicAttributes. *<p> * The hash code is computed by adding the hash code of * the attributes of this object. If this BasicAttributes * ignores case of its attribute IDs, one is added to the hash code. * If a subclass overrides <tt>hashCode()</tt>, * it should override <tt>equals()</tt> * as well so that two <tt>Attributes</tt> instances that are equal * have the same hash code. * * @return an int representing the hash code of this BasicAttributes instance. * @see #equals */ public int hashCode() { int hash = (ignoreCase ? 1 : 0); try { NamingEnumeration all = getAll(); while (all.hasMore()) { hash += all.next().hashCode(); } } catch (NamingException e) {} return hash; } /** * Overridden to avoid exposing implementation details. * @serialData Default field (ignoreCase flag -- a boolean), followed by * the number of attributes in the set * (an int), and then the individual Attribute objects. */ private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException { s.defaultWriteObject(); // write out the ignoreCase flag s.writeInt(attrs.size()); Enumeration attrEnum = attrs.elements(); while (attrEnum.hasMoreElements()) { s.writeObject(attrEnum.nextElement()); } } /** * Overridden to avoid exposing implementation details. */ private void readObject(java.io.ObjectInputStream s) throws java.io.IOException, ClassNotFoundException { s.defaultReadObject(); // read in the ignoreCase flag int n = s.readInt(); // number of attributes attrs = (n >= 1) ? new Hashtable(n * 2) : new Hashtable(2); // can't have initial size of 0 (grrr...) while (--n >= 0) { put((Attribute)s.readObject()); } } class AttrEnumImpl implements NamingEnumeration<Attribute> { Enumeration<Attribute> elements; public AttrEnumImpl() { this.elements = attrs.elements(); } public boolean hasMoreElements() { return elements.hasMoreElements(); } public Attribute nextElement() { return elements.nextElement(); } public boolean hasMore() throws NamingException { return hasMoreElements(); } public Attribute next() throws NamingException { return nextElement(); } public void close() throws NamingException { elements = null; } } class IDEnumImpl implements NamingEnumeration<String> { Enumeration<Attribute> elements; public IDEnumImpl() { // Walking through the elements, rather than the keys, gives // us attribute IDs that have not been converted to lowercase. this.elements = attrs.elements(); } public boolean hasMoreElements() { return elements.hasMoreElements(); } public String nextElement() { Attribute attr = (Attribute)elements.nextElement(); return attr.getID(); } public boolean hasMore() throws NamingException { return hasMoreElements(); } public String next() throws NamingException { return nextElement(); } public void close() throws NamingException { elements = null; } } /** * Use serialVersionUID from JNDI 1.1.1 for interoperability. */ private static final long serialVersionUID = 4980164073184639448L; }