javax::naming::NamingException Class Reference

This is the superclass of all exceptions thrown by operations in the Context and DirContext interfaces. More...

#include <javax_naming_NamingException.h>

Inheritance diagram for javax::naming::NamingException:

[legend]Collaboration diagram for javax::naming::NamingException:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::javax::naming::NamingException >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::naming::NamingException > >	array2D
Public Member Functions
virtual void	appendRemainingComponent (const ::java::lang::String &name,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Add name as the last component in remaining name.
virtual void	appendRemainingName (const ::javax::naming::Name &name,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Add components from 'name' as the last components in remaining name.
virtual ::java::lang::Throwable	getCause (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
virtual ::java::lang::String	getExplanation (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Retrieves the explanation associated with this exception.
virtual ::javax::naming::Name	getRemainingName (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Retrieves the remaining unresolved portion of the name.
virtual ::javax::naming::Name	getResolvedName (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Retrieves the leading portion of the name that was resolved successfully.
virtual ::java::lang::Object	getResolvedObj (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Retrieves the object to which resolution was successful.
virtual ::java::lang::Throwable	getRootCause (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Retrieves the root cause of this NamingException, if any.
virtual ::java::lang::Throwable	initCause (const ::java::lang::Throwable &cause,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	NamingException (const ::java::lang::String &explanation,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a new NamingException with an explanation.
	NamingException (::xmog_dummy _use_java_ctor,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a new NamingException.
virtual void	setRemainingName (const ::javax::naming::Name &name,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the remaining name field of this exception.
virtual void	setResolvedName (const ::javax::naming::Name &name,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the resolved name field of this exception.
virtual void	setResolvedObj (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the resolved object field of this exception.
virtual void	setRootCause (const ::java::lang::Throwable &e,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Records the root cause of this NamingException.
virtual ::java::lang::String	toString (bool detail,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Generates the string representation in more detail.
virtual ::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Generates the string representation of this exception.

---

Detailed Description

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.

Author:

Rosanna Lee

Scott Seligman

---

Constructor & Destructor Documentation

javax::naming::NamingException::NamingException (  ::xmog_dummy  _use_java_ctor, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Constructs a new NamingException. All fields are set to null. Parameters: _use_java_ctor  indicates that you want to delegate to a Java constructor whose natural proxy conflicts with a C++ requirement. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

javax::naming::NamingException::NamingException (  const ::java::lang::String &  explanation, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

---

Member Function Documentation

virtual void javax::naming::NamingException::appendRemainingComponent (  const ::java::lang::String &  name, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::naming::NamingException::appendRemainingName (  const ::javax::naming::Name &  name, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual ::java::lang::Throwable javax::naming::NamingException::getCause (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Throwable.

virtual ::java::lang::String javax::naming::NamingException::getExplanation (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Retrieves the explanation associated with this exception. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: The possibly null detail string explaining more about this exception. If null, it means there is no detail message for this exception.

virtual ::javax::naming::Name javax::naming::NamingException::getRemainingName (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Retrieves the remaining unresolved portion of the name. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. 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.

virtual ::javax::naming::Name javax::naming::NamingException::getResolvedName (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Retrieves the leading portion of the name that was resolved successfully. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. 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.

virtual ::java::lang::Object javax::naming::NamingException::getResolvedObj (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Retrieves the object to which resolution was successful. This is the object to which the resolved name is bound. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: The possibly null object that was resolved so far. null means that the resolved object field has not been set.

virtual ::java::lang::Throwable javax::naming::NamingException::getRootCause (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: The possibly null exception that caused this naming exception. If null, it means no root cause has been set for this naming exception.

virtual ::java::lang::Throwable javax::naming::NamingException::initCause (  const ::java::lang::Throwable &  cause, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Parameters: cause  a reference to an outer class instance. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Throwable.

virtual void javax::naming::NamingException::setRemainingName (  const ::javax::naming::Name &  name, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::naming::NamingException::setResolvedName (  const ::javax::naming::Name &  name, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::naming::NamingException::setResolvedObj (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual void javax::naming::NamingException::setRootCause (  const ::java::lang::Throwable &  e, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Records the root cause of this NamingException. If e is this, this method does not 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. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

virtual ::java::lang::String javax::naming::NamingException::toString (  bool  detail, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: The non-null string containing the string representation.

virtual ::java::lang::String javax::naming::NamingException::toString (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: The non-null string containing the string representation of this exception. Reimplemented from java::lang::Throwable.

---

The documentation for this class was generated from the following file:

• javax_naming_NamingException.h

---