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 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
/* * @(#)NamingException.java 1.11 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.naming; /** * This is the superclass of all exceptions thrown by * operations in the Context and DirContext interfaces. * The nature of the failure is described by the name of the subclass. * This exception captures the information pinpointing where the operation * failed, such as where resolution last proceeded to. * <ul> * <li> Resolved Name. Portion of name that has been resolved. * <li> Resolved Object. Object to which resolution of name proceeded. * <li> Remaining Name. Portion of name that has not been resolved. * <li> Explanation. Detail explaining why name resolution failed. * <li> Root Exception. The exception that caused this naming exception * to be thrown. *</ul> * null is an acceptable value for any of these fields. When null, * it means that no such information has been recorded for that field. *<p> * A NamingException instance is not synchronized against concurrent * multithreaded access. Multiple threads trying to access and modify * a single NamingException instance should lock the object. *<p> * This exception has been retrofitted to conform to * the general purpose exception-chaining mechanism. The * <i>root exception</i> (or <i>root cause</i>) is the same object as the * <i>cause</i> returned by the {@link Throwable#getCause()} method. * * @author Rosanna Lee * @author Scott Seligman * @version 1.11 05/11/17 * @since 1.3 */ public class NamingException extends Exception { /** * Contains the part of the name that has been successfully resolved. * It is a composite name and can be null. * This field is initialized by the constructors. * You should access and manipulate this field * through its get and set methods. * @serial * @see #getResolvedName * @see #setResolvedName */ protected Name resolvedName; /** * Contains the object to which resolution of the part of the name was * successful. Can be null. * This field is initialized by the constructors. * You should access and manipulate this field * through its get and set methods. * @serial * @see #getResolvedObj * @see #setResolvedObj */ protected Object resolvedObj; /** * Contains the remaining name that has not been resolved yet. * It is a composite name and can be null. * This field is initialized by the constructors. * You should access and manipulate this field * through its get, set, "append" methods. * @serial * @see #getRemainingName * @see #setRemainingName * @see #appendRemainingName * @see #appendRemainingComponent */ protected Name remainingName; /** * Contains the original exception that caused this NamingException to * be thrown. This field is set if there is additional * information that could be obtained from the original * exception, or if the original exception could not be * mapped to a subclass of NamingException. * Can be null. *<p> * This field predates the general-purpose exception chaining facility. * The {@link #initCause(Throwable)} and {@link #getCause()} methods * are now the preferred means of accessing this information. * * @serial * @see #getRootCause * @see #setRootCause(Throwable) * @see #initCause(Throwable) * @see #getCause */ protected Throwable rootException = null; /** * Constructs a new NamingException with an explanation. * All unspecified fields are set to null. * * @param explanation A possibly null string containing * additional detail about this exception. * @see java.lang.Throwable#getMessage */ public NamingException(String explanation) { super(explanation); resolvedName = remainingName = null; resolvedObj = null; } /** * Constructs a new NamingException. * All fields are set to null. */ public NamingException() { super(); resolvedName = remainingName = null; resolvedObj = null; } /** * Retrieves the leading portion of the name that was resolved * successfully. * * @return The part of the name that was resolved successfully. * It is a composite name. It can be null, which means * the resolved name field has not been set. * @see #getResolvedObj * @see #setResolvedName */ public Name getResolvedName() { return resolvedName; } /** * Retrieves the remaining unresolved portion of the name. * @return The part of the name that has not been resolved. * It is a composite name. It can be null, which means * the remaining name field has not been set. * @see #setRemainingName * @see #appendRemainingName * @see #appendRemainingComponent */ public Name getRemainingName() { return remainingName; } /** * Retrieves the object to which resolution was successful. * This is the object to which the resolved name is bound. * * @return The possibly null object that was resolved so far. * null means that the resolved object field has not been set. * @see #getResolvedName * @see #setResolvedObj */ public Object getResolvedObj() { return resolvedObj; } /** * Retrieves the explanation associated with this exception. * * @return The possibly null detail string explaining more * about this exception. If null, it means there is no * detail message for this exception. * * @see java.lang.Throwable#getMessage */ public String getExplanation() { return getMessage(); } /** * Sets the resolved name field of this exception. *<p> * <tt>name</tt> is a composite name. If the intent is to set * this field using a compound name or string, you must * "stringify" the compound name, and create a composite * name with a single component using the string. You can then * invoke this method using the resulting composite name. *<p> * A copy of <code>name</code> is made and stored. * Subsequent changes to <code>name</code> does not * affect the copy in this NamingException and vice versa. * * @param name The possibly null name to set resolved name to. * If null, it sets the resolved name field to null. * @see #getResolvedName */ public void setResolvedName(Name name) { if (name != null) resolvedName = (Name)(name.clone()); else resolvedName = null; } /** * Sets the remaining name field of this exception. *<p> * <tt>name</tt> is a composite name. If the intent is to set * this field using a compound name or string, you must * "stringify" the compound name, and create a composite * name with a single component using the string. You can then * invoke this method using the resulting composite name. *<p> * A copy of <code>name</code> is made and stored. * Subsequent changes to <code>name</code> does not * affect the copy in this NamingException and vice versa. * @param name The possibly null name to set remaining name to. * If null, it sets the remaining name field to null. * @see #getRemainingName * @see #appendRemainingName * @see #appendRemainingComponent */ public void setRemainingName(Name name) { if (name != null) remainingName = (Name)(name.clone()); else remainingName = null; } /** * Sets the resolved object field of this exception. * @param obj The possibly null object to set resolved object to. * If null, the resolved object field is set to null. * @see #getResolvedObj */ public void setResolvedObj(Object obj) { resolvedObj = obj; } /** * Add name as the last component in remaining name. * @param name The component to add. * If name is null, this method does not do anything. * @see #setRemainingName * @see #getRemainingName * @see #appendRemainingName */ public void appendRemainingComponent(String name) { if (name != null) { try { if (remainingName == null) { remainingName = new CompositeName(); } remainingName.add(name); } catch (NamingException e) { throw new IllegalArgumentException(e.toString()); } } } /** * Add components from 'name' as the last components in * remaining name. *<p> * <tt>name</tt> is a composite name. If the intent is to append * a compound name, you should "stringify" the compound name * then invoke the overloaded form that accepts a String parameter. *<p> * Subsequent changes to <code>name</code> does not * affect the remaining name field in this NamingException and vice versa. * @param name The possibly null name containing ordered components to add. * If name is null, this method does not do anything. * @see #setRemainingName * @see #getRemainingName * @see #appendRemainingComponent */ public void appendRemainingName(Name name) { if (name == null) { return; } if (remainingName != null) { try { remainingName.addAll(name); } catch (NamingException e) { throw new IllegalArgumentException(e.toString()); } } else { remainingName = (Name)(name.clone()); } } /** * Retrieves the root cause of this NamingException, if any. * The root cause of a naming exception is used when the service provider * wants to indicate to the caller a non-naming related exception * but at the same time wants to use the NamingException structure * to indicate how far the naming operation proceeded. *<p> * This method predates the general-purpose exception chaining facility. * The {@link #getCause()} method is now the preferred means of obtaining * this information. * * @return The possibly null exception that caused this naming * exception. If null, it means no root cause has been * set for this naming exception. * @see #setRootCause * @see #rootException * @see #getCause */ public Throwable getRootCause() { return rootException; } /** * Records the root cause of this NamingException. * If <tt>e</tt> is <tt>this</tt>, this method does not do anything. *<p> * This method predates the general-purpose exception chaining facility. * The {@link #initCause(Throwable)} method is now the preferred means * of recording this information. * * @param e The possibly null exception that caused the naming * operation to fail. If null, it means this naming * exception has no root cause. * @see #getRootCause * @see #rootException * @see #initCause */ public void setRootCause(Throwable e) { if (e != this) { rootException = e; } } /** * Returns the cause of this exception. The cause is the * throwable that caused this naming exception to be thrown. * Returns <code>null</code> if the cause is nonexistent or * unknown. * * @return the cause of this exception, or <code>null</code> if the * cause is nonexistent or unknown. * @see #initCause(Throwable) * @since 1.4 */ public Throwable getCause() { return getRootCause(); } /** * Initializes the cause of this exception to the specified value. * The cause is the throwable that caused this naming exception to be * thrown. *<p> * This method may be called at most once. * * @param cause the cause, which is saved for later retrieval by * the {@link #getCause()} method. A <tt>null</tt> value * indicates that the cause is nonexistent or unknown. * @return a reference to this <code>NamingException</code> instance. * @throws IllegalArgumentException if <code>cause</code> is this * exception. (A throwable cannot be its own cause.) * @throws IllegalStateException if this method has already * been called on this exception. * @see #getCause * @since 1.4 */ public Throwable initCause(Throwable cause) { super.initCause(cause); setRootCause(cause); return this; } /** * Generates the string representation of this exception. * The string representation consists of this exception's class name, * its detailed message, and if it has a root cause, the string * representation of the root cause exception, followed by * the remaining name (if it is not null). * This string is used for debugging and not meant to be interpreted * programmatically. * * @return The non-null string containing the string representation * of this exception. */ public String toString() { String answer = super.toString(); if (rootException != null) { answer += " [Root exception is " + rootException + "]"; } if (remainingName != null) { answer += "; remaining name '" + remainingName + "'"; } return answer; } /** * Generates the string representation in more detail. * This string representation consists of the information returned * by the toString() that takes no parameters, plus the string * representation of the resolved object (if it is not null). * This string is used for debugging and not meant to be interpreted * programmatically. * * @param detail If true, include details about the resolved object * in addition to the other information. * @return The non-null string containing the string representation. */ public String toString(boolean detail) { if (!detail || resolvedObj == null) { return toString(); } else { return (toString() + "; resolved object " + resolvedObj); } } /** * Use serialVersionUID from JNDI 1.1.1 for interoperability */ private static final long serialVersionUID = -1299181962103167177L; };