javax.naming: public class: NamingException

javax.naming
public class: NamingException [javadoc | source]

java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         javax.naming.NamingException

All Implemented Interfaces:
Serializable

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.

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.

author: Rosanna - Lee

author: Scott - Seligman

since: 1.3 -

Field Summary
protected Name	resolvedName	Contains 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. Also see: getResolvedName setResolvedName serial:
protected Object	resolvedObj	Contains 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. Also see: getResolvedObj setResolvedObj serial:
protected Name	remainingName	Contains 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. Also see: getRemainingName setRemainingName appendRemainingName appendRemainingComponent serial:
protected Throwable	rootException	Contains 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 #initCause(Throwable) and #getCause() methods are now the preferred means of accessing this information. Also see: getRootCause setRootCause(Throwable) initCause(Throwable) getCause serial:

Fields inherited from java.lang.Exception:
serialVersionUID

Constructor:

Constructor:
public NamingException() { super(); resolvedName = remainingName = null; resolvedObj = null; } Constructs a new NamingException. All fields are set to null.
public NamingException(String explanation) { super(explanation); resolvedName = remainingName = null; resolvedObj = null; } 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. Also see: java.lang.Throwable#getMessage

 public NamingException() {
        super();
        resolvedName = remainingName = null;
        resolvedObj = null;
}

Constructs a new NamingException. All fields are set to null.

 public NamingException(String explanation) {
        super(explanation);
        resolvedName = remainingName = null;
        resolvedObj = null;
}

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.

Also see:

java.lang.Throwable#getMessage

Method from javax.naming.NamingException Summary:
appendRemainingComponent, appendRemainingName, getCause, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, initCause, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, toString

Methods from java.lang.Throwable:
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getStackTraceDepth, getStackTraceElement, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.naming.NamingException Detail:
public void appendRemainingComponent(String name) { if (name != null) { try { if (remainingName == null) { remainingName = new CompositeName(); } remainingName.add(name); } catch (NamingException e) { throw new IllegalArgumentException(e.toString()); } } } Add name as the last component in remaining name.
public void appendRemainingName(Name name) { if (name == null) { return; } if (remainingName != null) { try { remainingName.addAll(name); } catch (NamingException e) { throw new IllegalArgumentException(e.toString()); } } else { remainingName = (Name)(name.clone()); } } 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.
public Throwable getCause() { return getRootCause(); } Returns the cause of this exception. The cause is the throwable that caused this naming exception to be thrown. Returns `null` if the cause is nonexistent or unknown.
public String getExplanation() { return getMessage(); } Retrieves the explanation associated with this exception.
public Name getRemainingName() { return remainingName; } Retrieves the remaining unresolved portion of the name.
public Name getResolvedName() { return resolvedName; } Retrieves the leading portion of the name that was resolved successfully.
public Object getResolvedObj() { return resolvedObj; } Retrieves the object to which resolution was successful. This is the object to which the resolved name is bound.
public Throwable getRootCause() { return rootException; } 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 #getCause() method is now the preferred means of obtaining this information.
public Throwable initCause(Throwable cause) { super.initCause(cause); setRootCause(cause); return this; } 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.
public void setRemainingName(Name name) { if (name != null) remainingName = (Name)(name.clone()); else remainingName = null; } 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.
public void setResolvedName(Name name) { if (name != null) resolvedName = (Name)(name.clone()); else resolvedName = null; } 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.
public void setResolvedObj(Object obj) { resolvedObj = obj; } Sets the resolved object field of this exception.
public void setRootCause(Throwable e) { if (e != this) { rootException = 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 #initCause(Throwable) method is now the preferred means of recording this information.
public String toString() { String answer = super.toString(); if (rootException != null) { answer += " [Root exception is " + rootException + "]"; } if (remainingName != null) { answer += "; remaining name '" + remainingName + "'"; } return answer; } 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.
public String toString(boolean detail) { if (!detail \|\| resolvedObj == null) { return toString(); } else { return (toString() + "; resolved object " + resolvedObj); } } 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.

Method from javax.naming.NamingException Detail:

 public  void appendRemainingComponent(String name) {
        if (name != null) {
            try {
                if (remainingName == null) {
                    remainingName = new CompositeName();
                }
                remainingName.add(name);
            } catch (NamingException e) {
                throw new IllegalArgumentException(e.toString());
            }
        }
}

Add name as the last component in remaining name.

 public  void appendRemainingName(Name name) {
        if (name == null) {
            return;
        }
        if (remainingName != null) {
            try {
                remainingName.addAll(name);
            } catch (NamingException e) {
                throw new IllegalArgumentException(e.toString());
            }
        } else {
            remainingName = (Name)(name.clone());
        }
}

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.

 public Throwable getCause() {
        return getRootCause();
}

null

 public String getExplanation() {
        return getMessage();
}

Retrieves the explanation associated with this exception.

 public Name getRemainingName() {
        return remainingName;
}

Retrieves the remaining unresolved portion of the name.

 public Name getResolvedName() {
        return resolvedName;
}

Retrieves the leading portion of the name that was resolved successfully.

 public Object getResolvedObj() {
        return resolvedObj;
}

Retrieves the object to which resolution was successful. This is the object to which the resolved name is bound.

 public Throwable getRootCause() {
        return rootException;
}

This method predates the general-purpose exception chaining facility. The #getCause() method is now the preferred means of obtaining this information.

 public Throwable initCause(Throwable cause) {
        super.initCause(cause);
        setRootCause(cause);
        return this;
}

This method may be called at most once.

 public  void setRemainingName(Name name) {
        if (name != null)
            remainingName = (Name)(name.clone());
        else
            remainingName = null;
}

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.

 public  void setResolvedName(Name name) {
        if (name != null)
            resolvedName = (Name)(name.clone());
        else
            resolvedName = null;
}

A copy of name is made and stored. Subsequent changes to name does not affect the copy in this NamingException and vice versa.

 public  void setResolvedObj(Object obj) {
        resolvedObj = obj;
}

Sets the resolved object field of this exception.

 public  void setRootCause(Throwable e) {
        if (e != this) {
            rootException = e;
        }
}

e

this

This method predates the general-purpose exception chaining facility. The #initCause(Throwable) method is now the preferred means of recording this information.

 public String toString() {
        String answer = super.toString();
        if (rootException != null) {
            answer += " [Root exception is " + rootException + "]";
        }
        if (remainingName != null) {
            answer += "; remaining name '" + remainingName + "'";
        }
        return answer;
}

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.

 public String toString(boolean detail) {
        if (!detail || resolvedObj == null) {
            return toString();
        } else {
            return (toString() + "; resolved object " + resolvedObj);
        }
}

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.