Exception: javax.naming.NamingException
- public exception 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.
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.
This exception has been retrofitted to conform to the general purpose exception-chaining mechanism. The root exception (or root cause) is the same object as the cause returned by the Throwable.getCause() method.
Inheritance
Superclass tree:- java.lang.Object
- java.lang.Throwable
- java.lang.Exception
- javax.naming.NamingException
Methods
-
NamingExceptiontop
public NamingException()Constructs a new NamingException. All fields are set to null. -
NamingExceptiontop
public NamingException(String explanation)Constructs a new NamingException with an explanation. All unspecified fields are set to null. -
appendRemainingComponenttop
public void appendRemainingComponent(String name)Add name as the last component in remaining name. -
appendRemainingNametop
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
namedoes not affect the remaining name field in this NamingException and vice versa. -
getCausetop
public Throwable getCause()Returns the cause of this exception. The cause is the throwable that caused this naming exception to be thrown. Returnsnullif the cause is nonexistent or unknown. -
getExplanationtop
public String getExplanation()Retrieves the explanation associated with this exception. -
getRemainingNametop
public Name getRemainingName()Retrieves the remaining unresolved portion of the name. -
getResolvedNametop
public Name getResolvedName()Retrieves the leading portion of the name that was resolved successfully. -
getResolvedObjtop
public Object getResolvedObj()Retrieves the object to which resolution was successful. This is the object to which the resolved name is bound. -
getRootCausetop
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 wants to use the NamingException structure to indicate how far the naming operation proceeded.This method predates the general-purpose exception chaining facility. The javax.naming.NamingException.getCause() method is now the preferred means of obtaining this information.
-
initCausetop
Initializes the cause of this exception to the specified value. The cause is the throwable that caused this naming exception to be thrown.This method may be called at most once.
-
setRemainingNametop
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
nameis made and stored. Subsequent changes tonamedoes not affect the copy in this NamingException and vice versa. -
setResolvedNametop
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
nameis made and stored. Subsequent changes tonamedoes not affect the copy in this NamingException and vice versa. -
setResolvedObjtop
public void setResolvedObj(Object obj)Sets the resolved object field of this exception. -
setRootCausetop
public void setRootCause(Throwable e)Records the root cause of this NamingException. If e is this, this method does not do anything.This method predates the general-purpose exception chaining facility. The javax.naming.NamingException.initCause(java.lang.Throwable) method is now the preferred means of recording this information.
-
toStringtop
public String toString()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. -
toStringtop
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.
Fields
-
remainingName
protected Name remainingNameContains 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. -
resolvedName
protected Name resolvedNameContains 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. -
resolvedObj
protected Object resolvedObjContains 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. -
rootException
protected Throwable rootExceptionContains 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.This field predates the general-purpose exception chaining facility. The javax.naming.NamingException.initCause(java.lang.Throwable) and javax.naming.NamingException.getCause() methods are now the preferred means of accessing this information.