public class LinkException extends NamingException
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.
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.
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.
Context.lookupLink(javax.naming.Name), LinkRef, Serialized Formprotected Name linkResolvedName
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.
protected Object linkResolvedObj
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.
protected Name linkRemainingName
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.
protected String linkExplanation
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.
public LinkException(String explanation)
Constructs a new instance of LinkException with an explanation All the other fields are initialized to null.
explanation - A possibly null string containing additional detail about this exception.Throwable.getMessage()public LinkException()
Constructs a new instance of LinkException. All the non-link-related and link-related fields are initialized to null.
public Name getLinkResolvedName()
Retrieves the leading portion of the link name that was resolved successfully.
getLinkResolvedObj(), setLinkResolvedName(javax.naming.Name)
public Name getLinkRemainingName()
Retrieves the remaining unresolved portion of the link name.
setLinkRemainingName(javax.naming.Name)public Object getLinkResolvedObj()
Retrieves the object to which resolution was successful. This is the object to which the resolved link name is bound.
getLinkResolvedName(), setLinkResolvedObj(java.lang.Object)
public String getLinkExplanation()
Retrieves the explanation associated with the problem encounter when resolving a link.
setLinkExplanation(java.lang.String)public void setLinkExplanation(String msg)
Sets the explanation associated with the problem encounter when resolving a link.
msg - The possibly null detail string explaining more about the problem with resolving a link. If null, it means no detail will be recorded.getLinkExplanation()public void setLinkResolvedName(Name name)
Sets the resolved link name field of this exception.
name 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.
A copy of name is made and stored. Subsequent changes to name does not affect the copy in this NamingException and vice versa.
name - The name to set resolved link name to. This can be null. If null, it sets the link resolved name field to null.getLinkResolvedName()public void setLinkRemainingName(Name name)
Sets the remaining link name field of this exception.
name 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.
A copy of name is made and stored. Subsequent changes to name does not affect the copy in this NamingException and vice versa.
name - The name to set remaining link name to. This can be null. If null, it sets the remaining name field to null.getLinkRemainingName()public void setLinkResolvedObj(Object obj)
Sets the link resolved object field of this exception. This indicates the last successfully resolved object of link name.
obj - The object to set link resolved object to. This can be null. If null, the link resolved object field is set to null.getLinkResolvedObj()public String toString()
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.
toString in class NamingException
public String toString(boolean detail)
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.
toString in class NamingException
detail - If true, add information about the link resolved object.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.