All Packages Class Hierarchy This Package Previous Next Index
Class javax.naming.NamingException
java.lang.Object
|
+----java.lang.Throwable
|
+----java.lang.Exception
|
+----javax.naming.NamingException
- public class NamingException
- extends Exception
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.
- Resolved Name. Portion of name that has been resolved.
- Resolved Object. Object to which resolution of name proceeded.
- Remaining Name. Portion of name that has not been resolved.
- Explanation. Detail explaining why name resolution failed.
- Root Exception. The exception that caused this naming exception
to be thrown.
null is an acceptable value for any of these fields. When null,
it means that no such information has been recorded for that field.
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.
The serialized form of a NamingException object consists of the
explanation String, the resolved name (a Name object), the
resolved object, the remaining name (a Name object), and the root
exception (a Throwable object).
-
remainingName
- The remaining name that has not been resolved yet.
-
resolvedName
- The part of the name that has been successfully resolved.
-
resolvedObj
- The object to which resolution of the part of the name was
successful.
-
rootException
- The original exception that caused this NamingException to
be thrown.
-
NamingException()
- Constructs a new NamingException.
-
NamingException(String)
- Constructs a new NamingException with an explanation.
-
appendRemainingComponent(String)
- Add name as the last component in remaining name.
-
appendRemainingName(Name)
- Add components from 'name' as the last components in
remaining name.
-
getExplanation()
- Retrieves the explanation associated with this exception.
-
getRemainingName()
- Retrieves the remaining unresolved portion of the name.
-
getResolvedName()
- Retrieves the leading portion of the name that was resolved
successfully.
-
getResolvedObj()
- Retrieves the object to which resolution was successful.
-
getRootCause()
- Retrieves the root cause of this NamingException, if any.
-
setRemainingName(Name)
- Sets the remaining name field of this exception.
-
setResolvedName(Name)
- Sets the resolved name field of this exception.
-
setResolvedObj(Object)
- Sets the resolved object field of this exception.
-
setRootCause(Throwable)
- Records that the root cause of this NamingException.
-
toString()
- Generates the string representation of this exception.
-
toString(boolean)
- Generates the string representation in more detail.
resolvedName
protected Name resolvedName
- 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.
- See Also:
- getResolvedName, setResolvedName
resolvedObj
protected Object resolvedObj
- 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.
- See Also:
- getResolvedObj, setResolvedObj
remainingName
protected Name remainingName
- 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.
- See Also:
- getRemainingName, setRemainingName, appendRemainingName, appendRemainingComponent
rootException
protected Throwable rootException
- The original exception that caused this NamingException to
be thrown. This field is set if there is additional
information that that could be obtained from the original
exception, or if there original exception could not be
mapped to a subclass of NamingException.
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:
- getRootCause, setRootCause
NamingException
public NamingException(String explanation)
- Constructs a new NamingException with an explanation.
All unspecified fields are set to null.
- Parameters:
- explanation - A possibly null string containing
additional detail about this exception.
- See Also:
- getMessage
NamingException
public NamingException()
- Constructs a new NamingException.
All fields are set to null.
getResolvedName
public Name getResolvedName()
- Retrieves the leading portion of the name that was resolved
successfully.
- Returns:
- 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 Also:
- getResolvedObj, setResolvedName
getRemainingName
public Name getRemainingName()
- Retrieves the remaining unresolved portion of the name.
- Returns:
- 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 Also:
- setRemainingName, appendRemainingName, appendRemainingComponent
getResolvedObj
public Object getResolvedObj()
- Retrieves the object to which resolution was successful.
This is the object to which the resolved name is bound.
- Returns:
- The possibly null object that was resolved so far.
null means that the resolved object field has not been set.
- See Also:
- getResolvedName, setResolvedObj
getExplanation
public String getExplanation()
- Retrieves the explanation associated with this exception.
- Returns:
- The possibly null detail string explaining more
about this exception. If null, it means there is no
detail message for this exception.
- See Also:
- getMessage
setResolvedName
public void setResolvedName(Name name)
- Sets the resolved 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 possibly null name to set resolved name to.
If null, it sets the resolved name field to null.
- See Also:
- getResolvedName
setRemainingName
public void setRemainingName(Name name)
- Sets the remaining 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 possibly null name to set remaining name to.
If null, it sets the remaining name field to null.
- See Also:
- getRemainingName, appendRemainingName, appendRemainingComponent
setResolvedObj
public void setResolvedObj(Object obj)
- Sets the resolved object field of this exception.
- Parameters:
- obj - The possibly null object to set resolved object to.
If null, the resolved object field is set to null.
- See Also:
- getResolvedObj
appendRemainingComponent
public void appendRemainingComponent(String name)
- Add name as the last component in remaining name.
- Parameters:
- name - The component to add.
If name is null, this method does not do anything.
- See Also:
- setRemainingName, getRemainingName, appendRemainingName
appendRemainingName
public void appendRemainingName(Name name)
- Add components from 'name' as the last components in
remaining name.
name 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.
Subsequent changes to name
does not
affect the remaining name field in this NamingException and vice versa.
- Parameters:
- name - The possibly null name containing ordered components to add.
If name is null, this method does not do anything.
- See Also:
- setRemainingName, getRemainingName, appendRemainingComponent
getRootCause
public Throwable getRootCause()
- 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 want to use the NamingException structure
to indicate how far the naming operation proceeded.
- Returns:
- The possibly null exception that caused this naming
exception. If null, it means no root cause has been
set for this naming exception.
- See Also:
- setRootCause, rootException
setRootCause
public void setRootCause(Throwable e)
- Records that the root cause of this NamingException.
If e is this, this method does no do anything.
- Parameters:
- e - The possibly null exception that caused the naming
operation to fail. If null, it means this naming
exception has no root cause.
- See Also:
- getRootCause, rootException
toString
public String toString()
- Generates the string representation of this exception.
The string representation consists of the root cause (if any),
the remaining name (if it is not null),
and the explanation parameter from in the constructor
(if it is not null).
This string is used for debugging and not meant to be interpreted
programmatically.
- Returns:
- The non-null string containing the string representation
of this exception.
- Overrides:
- toString in class Throwable
toString
public String toString(boolean detail)
- 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.
- Parameters:
- detail - If true, include details about the resolved object
in addition to the other information.
- Returns:
- The non-null string containing the string representation.
All Packages Class Hierarchy This Package Previous Next Index