All Packages Class Hierarchy This Package Previous Next Index
Class javax.naming.CannotProceedException
java.lang.Object
|
+----java.lang.Throwable
|
+----java.lang.Exception
|
+----javax.naming.NamingException
|
+----javax.naming.CannotProceedException
- public class CannotProceedException
- extends NamingException
This exception is thrown to indicate that the operation reached
a point in the name where the operation cannot proceed any further.
When performing an operation on a composite name, a naming service
provider may reach a part of the name that does not belong to its
namespace. At that point, it can construct a
CannotProceedException and then invoke methods provided by
javax.naming.spi.NamingManager (such as getContinuationContext())
to locate another provider to continue the operation. If this is
not possible, this exception is raised to the caller of the
context operation.
If the program wants to handle this exception in particular, it
should catch CannotProceedException explicitly before attempting to
catch NamingException.
A CannotProceedException instance is not synchronized against concurrent
multithreaded access. Multiple threads trying to access and modify
CannotProceedException should lock the object.
The serialized form of a CannotProceedException object consists of
the serialized fields of its NamingException superclass, the remaining new
name (a Name object), the environment (a Hashtable), the altName field
(a Name object), and the serialized form of the altNameCtx field.
-
altName
- This field is used to record the name of the resolved object, relative
to the context
altNameCtx
.
-
altNameCtx
- This field is used to record the context relative to which
altName
is specified.
-
environment
- This field is used to record the environment
relevant for the Context or DirContext method that cannot proceed.
-
remainingNewName
- This field is used to record information necessary for
continuing the Context.rename() operation.
-
CannotProceedException()
- Constructs a new instance of CannotProceedException.
-
CannotProceedException(String)
- Constructs a new instance of CannotProceedException using an
explanation.
-
getAltName()
- Retrieves the
altName
field of this exception.
-
getAltNameCtx()
- Retrieves the
altNameCtx
field of this exception.
-
getEnvironment()
- Retrieves the environment that was in effect when this exception
was created.
-
getRemainingNewName()
- Retrieves the "remaining new name" field of this exception, which is
used when this exception is thrown during a rename() operation.
-
setAltName(Name)
- Sets the
altName
field of this exception.
-
setAltNameCtx(Context)
- Sets the
altNameCtx
field of this exception.
-
setEnvironment(Hashtable)
- Sets the environment that will be returned when getEnvironment()
is called.
-
setRemainingNewName(Name)
- Sets the "remaining new name" field of this exception.
remainingNewName
protected Name remainingNewName
- This field is used to record information necessary for
continuing the Context.rename() operation.
It contains the remaining unresolved part of the second
"name" argument to Context.rename().
This field is initialized to null.
It should not be manipulated directly: it should
be accessed and updated using getRemainingName() and setRemainingName().
- See Also:
- getRemainingNewName, setRemainingNewName
environment
protected Hashtable environment
- This field is used to record the environment
relevant for the Context or DirContext method that cannot proceed.
This field is initialized to null.
It should not be manipulated directly: it should be accessed
and updated using getEnvironment() and setEnvironment().
- See Also:
- getEnvironment, setEnvironment
altName
protected Name altName
- This field is used to record the name of the resolved object, relative
to the context
altNameCtx
. It is a composite name.
If null, then no name is specified.
See the javax.naming.spi.ObjectFactory.getObjectInstance
method for details on how this is used.
This field is initialized to null.
It should not be manipulated directly: it should
be accessed and updated using getAltName() and setAltName().
- See Also:
- getAltName, setAltName, altNameCtx, getObjectInstance
altNameCtx
protected Context altNameCtx
- This field is used to record the context relative to which
altName
is specified. If null, then the default initial
context is implied.
See the javax.naming.spi.ObjectFactory.getObjectInstance
method for details on how this is used.
This field is initialized to null.
It should not be manipulated directly: it should
be accessed and updated using getAltNameCtx() and setAltNameCtx().
- See Also:
- getAltNameCtx, setAltNameCtx, altName, getObjectInstance
CannotProceedException
public CannotProceedException(String explanation)
- Constructs a new instance of CannotProceedException using an
explanation. All unspecified fields default to null.
- Parameters:
- explanation - A possibly null string containing additional
detail about this exception.
If null, this exception has no detail message.
- See Also:
- getMessage
CannotProceedException
public CannotProceedException()
- Constructs a new instance of CannotProceedException.
All fields default to null.
getEnvironment
public Hashtable getEnvironment()
- Retrieves the environment that was in effect when this exception
was created.
- Returns:
- Possibly null environment property set.
null means no environment was recorded for this exception.
- See Also:
- setEnvironment
setEnvironment
public void setEnvironment(Hashtable environment)
- Sets the environment that will be returned when getEnvironment()
is called.
- Parameters:
- A - possibly null environment property set.
null means no environment is being recorded for
this exception.
getRemainingNewName
public Name getRemainingNewName()
- Retrieves the "remaining new name" field of this exception, which is
used when this exception is thrown during a rename() operation.
- Returns:
- The possibly null part of the new name that has not been resolved.
It is a composite name. It can be null, which means
the remaining new name field has not been set.
- See Also:
- setRemainingNewName
setRemainingNewName
public void setRemainingNewName(Name newName)
- Sets the "remaining new name" field of this exception.
This is the value returned by
getRemainingName()
.
newName 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 newName
is made and stored.
Subsequent changes to name
does not
affect the copy in this NamingException and vice versa.
- Parameters:
- newName - The possibly null name to set the "remaining new name" to.
If null, it sets the remaining name field to null.
- See Also:
- getRemainingNewName
getAltName
public Name getAltName()
- Retrieves the
altName
field of this exception.
This is the name of the resolved object, relative to the context
altNameCtx
. It will be used during a subsequent call to the
javax.naming.spi.ObjectFactory.getObjectInstance
method.
- Returns:
- The name of the resolved object, relative to
altNameCtx
.
It is a composite name. If null, then no name is specified.
- See Also:
- setAltName, getAltNameCtx, getObjectInstance
setAltName
public void setAltName(Name altName)
- Sets the
altName
field of this exception.
- Parameters:
- altName - The name of the resolved object, relative to
altNameCtx
.
It is a composite name.
If null, then no name is specified.
- See Also:
- getAltName, setAltNameCtx
getAltNameCtx
public Context getAltNameCtx()
- Retrieves the
altNameCtx
field of this exception.
This is the context relative to which altName
is named.
It will be used during a subsequent call to the
javax.naming.spi.ObjectFactory.getObjectInstance
method.
- Returns:
- The context relative to which
altName
is named.
If null, then the default initial context is implied.
- See Also:
- setAltNameCtx, getAltName, getObjectInstance
setAltNameCtx
public void setAltNameCtx(Context altNameCtx)
- Sets the
altNameCtx
field of this exception.
- Parameters:
- altNameCtx
- The context relative to which
altName
is named. If null, then the default initial context
is implied.
- See Also:
- getAltNameCtx, setAltName
All Packages Class Hierarchy This Package Previous Next Index