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
/* * @(#)LinkException.java 1.8 03/12/19 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.naming; /** * This exception is used to describe problems encounter while resolving links. * Addition information is added to the base NamingException for pinpointing * the problem with the link. *<p> * Analogous to how NamingException captures name resolution information, * LinkException captures "link"-name resolution information pinpointing * the problem encountered while resolving a link. All these fields may * be null. * <ul> * <li> Link Resolved Name. Portion of link name that has been resolved. * <li> Link Resolved Object. Object to which resolution of link name proceeded. * <li> Link Remaining Name. Portion of link name that has not been resolved. * <li> Link Explanation. Detail explaining why link resolution failed. *</ul> * *<p> * A LinkException instance is not synchronized against concurrent * multithreaded access. Multiple threads trying to access and modify * a single LinkException instance should lock the object. * * @author Rosanna Lee * @author Scott Seligman * @version 1.8 03/12/19 * * @see Context#lookupLink * @see LinkRef * @since 1.3 */ /*<p> * The serialized form of a LinkException object consists of the * serialized fields of its NamingException superclass, the link resolved * name (a Name object), the link resolved object, link remaining name * (a Name object), and the link explanation String. */ public class LinkException extends NamingException { /** * Contains the part of the link 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 #getLinkResolvedName * @see #setLinkResolvedName */ protected Name linkResolvedName; /** * Contains the object to which resolution of the part of the link 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 #getLinkResolvedObj * @see #setLinkResolvedObj */ protected Object linkResolvedObj; /** * Contains the remaining link 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 and set methods. * @serial * @see #getLinkRemainingName * @see #setLinkRemainingName */ protected Name linkRemainingName; /** * Contains the exception of why resolution of the link failed. * 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 #getLinkExplanation * @see #setLinkExplanation */ protected String linkExplanation; /** * Constructs a new instance of LinkException with an explanation * All the other fields are initialized to null. * @param explanation A possibly null string containing additional * detail about this exception. * @see java.lang.Throwable#getMessage */ public LinkException(String explanation) { super(explanation); linkResolvedName = null; linkResolvedObj = null; linkRemainingName = null; linkExplanation = null; } /** * Constructs a new instance of LinkException. * All the non-link-related and link-related fields are initialized to null. */ public LinkException() { super(); linkResolvedName = null; linkResolvedObj = null; linkRemainingName = null; linkExplanation = null; } /** * Retrieves the leading portion of the link name that was resolved * successfully. * * @return The part of the link name that was resolved successfully. * It is a composite name. It can be null, which means * the link resolved name field has not been set. * @see #getLinkResolvedObj * @see #setLinkResolvedName */ public Name getLinkResolvedName() { return this.linkResolvedName; } /** * Retrieves the remaining unresolved portion of the link name. * @return The part of the link name that has not been resolved. * It is a composite name. It can be null, which means * the link remaining name field has not been set. * @see #setLinkRemainingName */ public Name getLinkRemainingName() { return this.linkRemainingName; } /** * Retrieves the object to which resolution was successful. * This is the object to which the resolved link name is bound. * * @return The possibly null object that was resolved so far. * If null, it means the link resolved object field has not been set. * @see #getLinkResolvedName * @see #setLinkResolvedObj */ public Object getLinkResolvedObj() { return this.linkResolvedObj; } /** * Retrieves the explanation associated with the problem encounter * when resolving a link. * * @return The possibly null detail string explaining more about the problem * with resolving a link. * If null, it means there is no * link detail message for this exception. * @see #setLinkExplanation */ public String getLinkExplanation() { return this.linkExplanation; } /** * Sets the explanation associated with the problem encounter * when resolving a link. * * @param msg The possibly null detail string explaining more about the problem * with resolving a link. If null, it means no detail will be recorded. * @see #getLinkExplanation */ public void setLinkExplanation(String msg) { this.linkExplanation = msg; } /** * Sets the resolved link 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 name to set resolved link name to. This can be null. * If null, it sets the link resolved name field to null. * @see #getLinkResolvedName */ public void setLinkResolvedName(Name name) { if (name != null) { this.linkResolvedName = (Name)(name.clone()); } else { this.linkResolvedName = null; } } /** * Sets the remaining link 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 name to set remaining link name to. This can be null. * If null, it sets the remaining name field to null. * @see #getLinkRemainingName */ public void setLinkRemainingName(Name name) { if (name != null) this.linkRemainingName = (Name)(name.clone()); else this.linkRemainingName = null; } /** * Sets the link resolved object field of this exception. * This indicates the last successfully resolved object of link name. * @param obj The object to set link resolved object to. This can be null. * If null, the link resolved object field is set to null. * @see #getLinkResolvedObj */ public void setLinkResolvedObj(Object obj) { this.linkResolvedObj = obj; } /** * Generates the string representation of this exception. * This string consists of the NamingException information plus * the link's remaining name. * This string is used for debugging and not meant to be interpreted * programmatically. * @return The non-null string representation of this link exception. */ public String toString() { return super.toString() + "; Link Remaining Name: '" + this.linkRemainingName + "'"; } /** * Generates the string representation of this exception. * This string consists of the NamingException information plus * the additional information of resolving the link. * If 'detail' is true, the string also contains information on * the link resolved object. If false, this method is the same * as the form of toString() that accepts no parameters. * This string is used for debugging and not meant to be interpreted * programmatically. * * @param detail If true, add information about the link resolved * object. * @return The non-null string representation of this link exception. */ public String toString(boolean detail) { if (!detail || this.linkResolvedObj == null) return this.toString(); return this.toString() + "; Link Resolved Object: " + this.linkResolvedObj; } /** * Use serialVersionUID from JNDI 1.1.1 for interoperability */ private static final long serialVersionUID = -7967662604076777712L; };