|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.lang.Throwable java.lang.Exception javax.naming.NamingException javax.naming.CannotProceedException
public class CannotProceedException
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.
Field Summary | |
---|---|
protected Name |
altName
Contains the name of the resolved object, relative to the context altNameCtx . |
protected Context |
altNameCtx
Contains the context relative to which altName is specified. |
protected Hashtable<?,?> |
environment
Contains the environment relevant for the Context or DirContext method that cannot proceed. |
protected Name |
remainingNewName
Contains the remaining unresolved part of the second "name" argument to Context.rename(). |
Fields inherited from class javax.naming.NamingException |
---|
remainingName, resolvedName, resolvedObj, rootException |
Constructor Summary | |
---|---|
CannotProceedException()
Constructs a new instance of CannotProceedException. |
|
CannotProceedException(String explanation)
Constructs a new instance of CannotProceedException using an explanation. |
Method Summary | |
---|---|
Name |
getAltName()
Retrieves the altName field of this exception. |
Context |
getAltNameCtx()
Retrieves the altNameCtx field of this exception. |
Hashtable<?,?> |
getEnvironment()
Retrieves the environment that was in effect when this exception was created. |
Name |
getRemainingNewName()
Retrieves the "remaining new name" field of this exception, which is used when this exception is thrown during a rename() operation. |
void |
setAltName(Name altName)
Sets the altName field of this exception. |
void |
setAltNameCtx(Context altNameCtx)
Sets the altNameCtx field of this exception. |
void |
setEnvironment(Hashtable<?,?> environment)
Sets the environment that will be returned when getEnvironment() is called. |
void |
setRemainingNewName(Name newName)
Sets the "remaining new name" field of this exception. |
Methods inherited from class javax.naming.NamingException |
---|
appendRemainingComponent, appendRemainingName, getCause, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, initCause, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, toString |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected Name remainingNewName
This field is initialized to null. It should not be manipulated directly: it should be accessed and updated using getRemainingName() and setRemainingName().
protected Hashtable<?,?> environment
This field is initialized to null. It should not be manipulated directly: it should be accessed and updated using getEnvironment() and setEnvironment().
protected Name altName
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().
protected Context altNameCtx
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().
Constructor Detail |
---|
public CannotProceedException(String explanation)
explanation
- A possibly null string containing additional
detail about this exception.
If null, this exception has no detail message.Throwable.getMessage()
public CannotProceedException()
Method Detail |
---|
public Hashtable<?,?> getEnvironment()
setEnvironment(java.util.Hashtable, ?>)
public void setEnvironment(Hashtable<?,?> environment)
environment
- A possibly null environment property set.
null means no environment is being recorded for
this exception.getEnvironment()
public Name getRemainingNewName()
setRemainingNewName(javax.naming.Name)
public void setRemainingNewName(Name newName)
getRemainingNewName()
.
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.
newName
- The possibly null name to set the "remaining new name" to.
If null, it sets the remaining name field to null.getRemainingNewName()
public Name getAltName()
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.
altNameCtx
.
It is a composite name. If null, then no name is specified.setAltName(javax.naming.Name)
,
getAltNameCtx()
,
ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable, ?>)
public void setAltName(Name altName)
altName
field of this exception.
altName
- The name of the resolved object, relative to
altNameCtx
.
It is a composite name.
If null, then no name is specified.getAltName()
,
setAltNameCtx(javax.naming.Context)
public Context getAltNameCtx()
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.
altName
is named.
If null, then the default initial context is implied.setAltNameCtx(javax.naming.Context)
,
getAltName()
,
ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable, ?>)
public void setAltNameCtx(Context altNameCtx)
altNameCtx
field of this exception.
altNameCtx
- The context relative to which altName
is named. If null, then the default initial context
is implied.getAltNameCtx()
,
setAltName(javax.naming.Name)
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.