APIdia Launch Partner
Top Description Fields Constructors Methods
javax.naming

public Class NamingException

extends Exception
Class Inheritance
Known Direct Subclasses
javax.naming.NamingSecurityException, javax.naming.NoInitialContextException, javax.naming.NotContextException, javax.naming.OperationNotSupportedException, javax.naming.PartialResultException, javax.naming.ReferralException, javax.naming.ServiceUnavailableException, javax.naming.directory.AttributeInUseException, javax.naming.directory.AttributeModificationException, javax.naming.directory.InvalidAttributeIdentifierException, javax.naming.directory.InvalidAttributesException, javax.naming.directory.InvalidAttributeValueException, javax.naming.directory.InvalidSearchControlsException, javax.naming.directory.InvalidSearchFilterException, javax.naming.directory.NoSuchAttributeException, javax.naming.directory.SchemaViolationException, javax.naming.LimitExceededException, javax.naming.CannotProceedException, javax.naming.CommunicationException, javax.naming.ConfigurationException, javax.naming.ContextNotEmptyException, javax.naming.InsufficientResourcesException, javax.naming.InterruptedNamingException, javax.naming.InvalidNameException, javax.naming.LinkException, javax.naming.NameAlreadyBoundException, javax.naming.NameNotFoundException

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. 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.

Authors
Rosanna Lee, Scott Seligman
Since
1.3

Field Summary

Modifier and TypeField and Description
protected Name
remainingName

Contains the remaining name that has not been resolved yet.

protected Name
resolvedName

Contains the part of the name that has been successfully resolved.

protected Object
resolvedObj

Contains the object to which resolution of the part of the name was successful.

protected Throwable
rootException

Contains the original exception that caused this NamingException to be thrown.

private static final long
serialVersionUID

Hides java.lang.Exception.serialVersionUID.

Use serialVersionUID from JNDI 1.1.1 for interoperability

Constructor Summary

AccessConstructor and Description
public
NamingException(String
A possibly null string containing additional detail about this exception.
explanation
)

Constructs a new NamingException with an explanation.

public
NamingException()

Constructs a new NamingException.

Method Summary

Modifier and TypeMethod and Description
public void
appendRemainingComponent(String
The component to add. If name is null, this method does not do anything.
name
)

Add name as the last component in remaining name.

public void
appendRemainingName(Name
The possibly null name containing ordered components to add. If name is null, this method does not do anything.
name
)

Add components from 'name' as the last components in remaining name.

public Throwable

Returns:

the cause of this exception, or null if the cause is nonexistent or unknown.
getCause
()

Overrides java.lang.Throwable.getCause.

Returns the cause of this exception.

public String

Returns:

The possibly null detail string explaining more about this exception. If null, it means there is no detail message for this exception.
getExplanation
()

Retrieves the explanation associated with this exception.

public 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.
getRemainingName
()

Retrieves the remaining unresolved portion of the name.

public Name

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.
getResolvedName
()

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

public Object

Returns:

The possibly null object that was resolved so far. null means that the resolved object field has not been set.
getResolvedObj
()

Retrieves the object to which resolution was successful.

public Throwable

Returns:

The possibly null exception that caused this naming exception. If null, it means no root cause has been set for this naming exception.
getRootCause
()

Retrieves the root cause of this NamingException, if any.

public Throwable

Returns:

a reference to this NamingException instance.
initCause
(Throwable
the cause, which is saved for later retrieval by the getCause() method. A null value indicates that the cause is nonexistent or unknown.
cause
)

Overrides java.lang.Throwable.initCause.

Initializes the cause of this exception to the specified value.

public void
setRemainingName(Name
The possibly null name to set remaining name to. If null, it sets the remaining name field to null.
name
)

Sets the remaining name field of this exception.

public void
setResolvedName(Name
The possibly null name to set resolved name to. If null, it sets the resolved name field to null.
name
)

Sets the resolved name field of this exception.

public void
setResolvedObj(Object
The possibly null object to set resolved object to. If null, the resolved object field is set to null.
obj
)

Sets the resolved object field of this exception.

public void
setRootCause(Throwable
The possibly null exception that caused the naming operation to fail. If null, it means this naming exception has no root cause.
e
)

Records the root cause of this NamingException.

public String

Returns:

The non-null string containing the string representation of this exception.
toString
()

Overrides java.lang.Throwable.toString.

Generates the string representation of this exception.

public String

Returns:

The non-null string containing the string representation.
toString
(boolean
If true, include details about the resolved object in addition to the other information.
detail
)

Generates the string representation in more detail.

Field Detail

remainingNameback to summary
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.

See Also
getRemainingName, setRemainingName, appendRemainingName, appendRemainingComponent
resolvedNameback to 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.

See Also
getResolvedName, setResolvedName
resolvedObjback to summary
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.

Annotations
@SuppressWarnings:serial
See Also
getResolvedObj, setResolvedObj
rootExceptionback to summary
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.

See Also
getRootCause, setRootCause(Throwable), initCause(Throwable), getCause
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Exception.serialVersionUID.

Use serialVersionUID from JNDI 1.1.1 for interoperability

Constructor Detail

NamingExceptionback to summary
public NamingException(String explanation)

Constructs a new NamingException with an explanation. All unspecified fields are set to null.

Parameters
explanation:String

A possibly null string containing additional detail about this exception.

See Also
java.lang.Throwable#getMessage
NamingExceptionback to summary
public NamingException()

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

Method Detail

appendRemainingComponentback to summary
public void appendRemainingComponent(String name)

Add name as the last component in remaining name.

Parameters
name:String

The component to add. If name is null, this method does not do anything.

See Also
setRemainingName, getRemainingName, appendRemainingName
appendRemainingNameback to summary
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 do not affect the remaining name field in this NamingException and vice versa.

Parameters
name: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
getCauseback to summary
public Throwable getCause()

Overrides java.lang.Throwable.getCause.

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.

Returns:Throwable

the cause of this exception, or null if the cause is nonexistent or unknown.

Since
1.4
See Also
initCause(Throwable)
getExplanationback to summary
public String getExplanation()

Retrieves the explanation associated with this exception.

Returns:String

The possibly null detail string explaining more about this exception. If null, it means there is no detail message for this exception.

See Also
java.lang.Throwable#getMessage
getRemainingNameback to summary
public Name getRemainingName()

Retrieves the remaining unresolved portion of the name.

Returns:Name

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
getResolvedNameback to summary
public Name getResolvedName()

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

Returns:Name

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
getResolvedObjback to summary
public Object getResolvedObj()

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

Returns:Object

The possibly null object that was resolved so far. null means that the resolved object field has not been set.

See Also
getResolvedName, setResolvedObj
getRootCauseback to summary
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 getCause() method is now the preferred means of obtaining this information.

Returns:Throwable

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, getCause
initCauseback to summary
public Throwable initCause(Throwable cause)

Overrides java.lang.Throwable.initCause.

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.

Parameters
cause:Throwable

the cause, which is saved for later retrieval by the getCause() method. A null value indicates that the cause is nonexistent or unknown.

Returns:Throwable

a reference to this NamingException instance.

Exceptions
IllegalArgumentException:
if cause is this exception. (A throwable cannot be its own cause.)
IllegalStateException:
if this method has already been called on this exception.
Since
1.4
See Also
getCause
setRemainingNameback to summary
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 do not affect the copy in this NamingException and vice versa.

Parameters
name: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
setResolvedNameback to summary
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 do not affect the copy in this NamingException and vice versa.

Parameters
name:Name

The possibly null name to set resolved name to. If null, it sets the resolved name field to null.

See Also
getResolvedName
setResolvedObjback to summary
public void setResolvedObj(Object obj)

Sets the resolved object field of this exception.

Parameters
obj:Object

The possibly null object to set resolved object to. If null, the resolved object field is set to null.

See Also
getResolvedObj
setRootCauseback to summary
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 initCause(Throwable) method is now the preferred means of recording this information.

Parameters
e:Throwable

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, initCause
toStringback to summary
public String toString()

Overrides java.lang.Throwable.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.

Returns:String

The non-null string containing the string representation of this exception.

toStringback to summary
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:boolean

If true, include details about the resolved object in addition to the other information.

Returns:String

The non-null string containing the string representation.