Class CannotProceedException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- javax.naming.NamingException
-
- javax.naming.CannotProceedException
-
- All Implemented Interfaces:
- Serializable
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.
- Since:
- 1.3
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description protected Name
altName
Contains the name of the resolved object, relative to the contextaltNameCtx
.protected Context
altNameCtx
Contains the context relative to whichaltName
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
Constructors Constructor and Description CannotProceedException()
Constructs a new instance of CannotProceedException.CannotProceedException(String explanation)
Constructs a new instance of CannotProceedException using an explanation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description Name
getAltName()
Retrieves thealtName
field of this exception.Context
getAltNameCtx()
Retrieves thealtNameCtx
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 thealtName
field of this exception.void
setAltNameCtx(Context altNameCtx)
Sets thealtNameCtx
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
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace
-
-
-
-
Field Detail
remainingNewName
protected Name remainingNewName
Contains the remaining unresolved part of the second "name" argument to Context.rename(). This information necessary for continuing the Context.rename() operation.This field is initialized to null. It should not be manipulated directly: it should be accessed and updated using getRemainingName() and setRemainingName().
environment
protected Hashtable<?,?> environment
Contains 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().
altName
protected Name altName
Contains the name of the resolved object, relative to the contextaltNameCtx
. It is a composite name. If null, then no name is specified. See thejavax.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().
altNameCtx
protected Context altNameCtx
Contains the context relative to whichaltName
is specified. If null, then the default initial context is implied. See thejavax.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
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:
-
Throwable.getMessage()
CannotProceedException
public CannotProceedException()
Constructs a new instance of CannotProceedException. All fields default to null.
-
Method Detail
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(java.util.Hashtable<?, ?>)
setEnvironment
public void setEnvironment(Hashtable<?,?> environment)
Sets the environment that will be returned when getEnvironment() is called.- Parameters:
-
environment
- A possibly null environment property set. null means no environment is being recorded for this exception. - See Also:
-
getEnvironment()
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(javax.naming.Name)
setRemainingNewName
public void setRemainingNewName(Name newName)
Sets the "remaining new name" field of this exception. This is the value returned bygetRemainingNewName()
.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 toname
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 thealtName
field of this exception. This is the name of the resolved object, relative to the contextaltNameCtx
. It will be used during a subsequent call to thejavax.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(javax.naming.Name)
,getAltNameCtx()
,ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>)
setAltName
public void setAltName(Name altName)
Sets thealtName
field of this exception.- Parameters:
-
altName
- The name of the resolved object, relative toaltNameCtx
. It is a composite name. If null, then no name is specified. - See Also:
-
getAltName()
,setAltNameCtx(javax.naming.Context)
getAltNameCtx
public Context getAltNameCtx()
Retrieves thealtNameCtx
field of this exception. This is the context relative to whichaltName
is named. It will be used during a subsequent call to thejavax.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(javax.naming.Context)
,getAltName()
,ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable<?, ?>)
setAltNameCtx
public void setAltNameCtx(Context altNameCtx)
Sets thealtNameCtx
field of this exception.- Parameters:
-
altNameCtx
- The context relative to whichaltName
is named. If null, then the default initial context is implied. - See Also:
-
getAltNameCtx()
,setAltName(javax.naming.Name)
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.