All Packages Class Hierarchy This Package Previous Next Index
Class javax.naming.LinkException
java.lang.Object
|
+----java.lang.Throwable
|
+----java.lang.Exception
|
+----javax.naming.NamingException
|
+----javax.naming.LinkException
- 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.
- Link Resolved Name. Portion of link name that has been resolved.
- Link Resolved Object. Object to which resolution of link name proceeded.
- Link Remaining Name. Portion of link name that has not been resolved.
- Link Explanation. Detail explaining why link resolution failed.
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.
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.
- See Also:
- lookupLink, LinkRef
-
linkExplanation
- An exception of why resolution of the link failed.
-
linkRemainingName
- The remaining link name that has not been resolved yet.
-
linkResolvedName
- The part of the link that has been successfully resolved.
-
linkResolvedObj
- The object to which resolution of the part of the link was successful.
-
LinkException()
- Constructs a new instance of LinkException.
-
LinkException(String)
- Constructs a new instance of LinkException with an explanation
All the other fields are initialized to null.
-
getLinkExplanation()
- Retrieves the explanation associated with the problem encounter
when resolving a link.
-
getLinkRemainingName()
- Retrieves the remaining unresolved portion of the link name.
-
getLinkResolvedName()
- Retrieves the leading portion of the link name that was resolved
successfully.
-
getLinkResolvedObj()
- Retrieves the object to which resolution was successful.
-
setLinkExplanation(String)
- Sets the explanation associated with the problem encounter
when resolving a link.
-
setLinkRemainingName(Name)
- Sets the remaining link name field of this exception.
-
setLinkResolvedName(Name)
- Sets the resolved link name field of this exception.
-
setLinkResolvedObj(Object)
- Sets the link resolved object field of this exception.
-
toString()
- Generates the string representation of this exception.
-
toString(boolean)
- Generates the string representation of this exception.
linkResolvedName
protected Name linkResolvedName
- 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.
- See Also:
- getLinkResolvedName, setLinkResolvedName
linkResolvedObj
protected Object linkResolvedObj
- 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.
- See Also:
- getLinkResolvedObj, setLinkResolvedObj
linkRemainingName
protected Name linkRemainingName
- 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.
- See Also:
- getLinkRemainingName, setLinkRemainingName
linkExplanation
protected String linkExplanation
- An 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.
- See Also:
- getLinkExplanation, setLinkExplanation
LinkException
public LinkException(String explanation)
- Constructs a new instance of LinkException with an explanation
All the other fields are initialized to null.
- Parameters:
- explanation - A possibly null string containing additional
detail about this exception.
- See Also:
- getMessage
LinkException
public LinkException()
- Constructs a new instance of LinkException.
All the non-link-related and link-related fields are initialized to null.
getLinkResolvedName
public Name getLinkResolvedName()
- Retrieves the leading portion of the link name that was resolved
successfully.
- Returns:
- 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 Also:
- getLinkResolvedObj, setLinkResolvedName
getLinkRemainingName
public Name getLinkRemainingName()
- Retrieves the remaining unresolved portion of the link name.
- Returns:
- 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 Also:
- setLinkRemainingName
getLinkResolvedObj
public Object getLinkResolvedObj()
- Retrieves the object to which resolution was successful.
This is the object to which the resolved link name is bound.
- Returns:
- The possibly null object that was resolved so far.
If null, it means the link resolved object field has not been set.
- See Also:
- getLinkResolvedName, setLinkResolvedObj
getLinkExplanation
public String getLinkExplanation()
- Retrieves the explanation associated with the problem encounter
when resolving a link.
- Returns:
- 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.
setLinkExplanation
public void setLinkExplanation(String msg)
- Sets the explanation associated with the problem encounter
when resolving a link.
- Parameters:
- msg - The possibly null detail string explaining more about the problem
with resolving a link. If null, it means no detail will be recorded.
setLinkResolvedName
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.
- Parameters:
- 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 Also:
- getLinkResolvedName
setLinkRemainingName
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.
- Parameters:
- name - The name to set remaining link name to. This can be null.
If null, it sets the remaining name field to null.
- See Also:
- getLinkRemainingName
setLinkResolvedObj
public void setLinkResolvedObj(Object obj)
- Sets the link resolved object field of this exception.
This indicates the last successfully resolved object of link name.
- Parameters:
- 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 Also:
- getLinkResolvedObj
toString
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.
- Returns:
- The non-null string representation of this link exception.
- Overrides:
- toString in class NamingException
toString
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.
- Parameters:
- detail - If true, add information about the link resolved
object.
- Returns:
- The non-null string representation of this link exception.
- Overrides:
- toString in class NamingException
All Packages Class Hierarchy This Package Previous Next Index