javax.naming
Class CannotProceedException

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.lang.Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable 
      extended by java.lang.Exception sample code for java.lang.Exception definition code for java.lang.Exception 
          extended by javax.naming.NamingException sample code for javax.naming.NamingException definition code for javax.naming.NamingException 
              extended by javax.naming.CannotProceedException
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class CannotProceedException
extends NamingException sample code for javax.naming.NamingException definition code for javax.naming.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
protected  Name sample code for javax.naming.Name definition code for javax.naming.Name altName sample code for javax.naming.CannotProceedException.altName definition code for javax.naming.CannotProceedException.altName
          Contains the name of the resolved object, relative to the context altNameCtx.
protected  Context sample code for javax.naming.Context definition code for javax.naming.Context altNameCtx sample code for javax.naming.CannotProceedException.altNameCtx definition code for javax.naming.CannotProceedException.altNameCtx
          Contains the context relative to which altName is specified.
protected  Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable <?,?> environment sample code for javax.naming.CannotProceedException.environment definition code for javax.naming.CannotProceedException.environment
          Contains the environment relevant for the Context or DirContext method that cannot proceed.
protected  Name sample code for javax.naming.Name definition code for javax.naming.Name remainingNewName sample code for javax.naming.CannotProceedException.remainingNewName definition code for javax.naming.CannotProceedException.remainingNewName
          Contains the remaining unresolved part of the second "name" argument to Context.rename().
 
Fields inherited from class javax.naming.NamingException sample code for javax.naming.NamingException definition code for javax.naming.NamingException
remainingName sample code for javax.naming.NamingException.remainingName definition code for javax.naming.NamingException.remainingName , resolvedName sample code for javax.naming.NamingException.resolvedName definition code for javax.naming.NamingException.resolvedName , resolvedObj sample code for javax.naming.NamingException.resolvedObj definition code for javax.naming.NamingException.resolvedObj , rootException sample code for javax.naming.NamingException.rootException definition code for javax.naming.NamingException.rootException
 
Constructor Summary
CannotProceedException sample code for javax.naming.CannotProceedException.CannotProceedException() definition code for javax.naming.CannotProceedException.CannotProceedException() ()
          Constructs a new instance of CannotProceedException.
CannotProceedException sample code for javax.naming.CannotProceedException.CannotProceedException(java.lang.String) definition code for javax.naming.CannotProceedException.CannotProceedException(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  explanation)
          Constructs a new instance of CannotProceedException using an explanation.
 
Method Summary
 Name sample code for javax.naming.Name definition code for javax.naming.Name getAltName sample code for javax.naming.CannotProceedException.getAltName() definition code for javax.naming.CannotProceedException.getAltName() ()
          Retrieves the altName field of this exception.
 Context sample code for javax.naming.Context definition code for javax.naming.Context getAltNameCtx sample code for javax.naming.CannotProceedException.getAltNameCtx() definition code for javax.naming.CannotProceedException.getAltNameCtx() ()
          Retrieves the altNameCtx field of this exception.
 Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable <?,?> getEnvironment sample code for javax.naming.CannotProceedException.getEnvironment() definition code for javax.naming.CannotProceedException.getEnvironment() ()
          Retrieves the environment that was in effect when this exception was created.
 Name sample code for javax.naming.Name definition code for javax.naming.Name getRemainingNewName sample code for javax.naming.CannotProceedException.getRemainingNewName() definition code for javax.naming.CannotProceedException.getRemainingNewName() ()
          Retrieves the "remaining new name" field of this exception, which is used when this exception is thrown during a rename() operation.
 void setAltName sample code for javax.naming.CannotProceedException.setAltName(javax.naming.Name) definition code for javax.naming.CannotProceedException.setAltName(javax.naming.Name) (Name sample code for javax.naming.Name definition code for javax.naming.Name  altName)
          Sets the altName field of this exception.
 void setAltNameCtx sample code for javax.naming.CannotProceedException.setAltNameCtx(javax.naming.Context) definition code for javax.naming.CannotProceedException.setAltNameCtx(javax.naming.Context) (Context sample code for javax.naming.Context definition code for javax.naming.Context  altNameCtx)
          Sets the altNameCtx field of this exception.
 void setEnvironment sample code for javax.naming.CannotProceedException.setEnvironment(java.util.Hashtable) definition code for javax.naming.CannotProceedException.setEnvironment(java.util.Hashtable) (Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable <?,?> environment)
          Sets the environment that will be returned when getEnvironment() is called.
 void setRemainingNewName sample code for javax.naming.CannotProceedException.setRemainingNewName(javax.naming.Name) definition code for javax.naming.CannotProceedException.setRemainingNewName(javax.naming.Name) (Name sample code for javax.naming.Name definition code for javax.naming.Name  newName)
          Sets the "remaining new name" field of this exception.
 
Methods inherited from class javax.naming.NamingException sample code for javax.naming.NamingException definition code for javax.naming.NamingException
appendRemainingComponent sample code for javax.naming.NamingException.appendRemainingComponent(java.lang.String) definition code for javax.naming.NamingException.appendRemainingComponent(java.lang.String) , appendRemainingName sample code for javax.naming.NamingException.appendRemainingName(javax.naming.Name) definition code for javax.naming.NamingException.appendRemainingName(javax.naming.Name) , getCause sample code for javax.naming.NamingException.getCause() definition code for javax.naming.NamingException.getCause() , getExplanation sample code for javax.naming.NamingException.getExplanation() definition code for javax.naming.NamingException.getExplanation() , getRemainingName sample code for javax.naming.NamingException.getRemainingName() definition code for javax.naming.NamingException.getRemainingName() , getResolvedName sample code for javax.naming.NamingException.getResolvedName() definition code for javax.naming.NamingException.getResolvedName() , getResolvedObj sample code for javax.naming.NamingException.getResolvedObj() definition code for javax.naming.NamingException.getResolvedObj() , getRootCause sample code for javax.naming.NamingException.getRootCause() definition code for javax.naming.NamingException.getRootCause() , initCause sample code for javax.naming.NamingException.initCause(java.lang.Throwable) definition code for javax.naming.NamingException.initCause(java.lang.Throwable) , setRemainingName sample code for javax.naming.NamingException.setRemainingName(javax.naming.Name) definition code for javax.naming.NamingException.setRemainingName(javax.naming.Name) , setResolvedName sample code for javax.naming.NamingException.setResolvedName(javax.naming.Name) definition code for javax.naming.NamingException.setResolvedName(javax.naming.Name) , setResolvedObj sample code for javax.naming.NamingException.setResolvedObj(java.lang.Object) definition code for javax.naming.NamingException.setResolvedObj(java.lang.Object) , setRootCause sample code for javax.naming.NamingException.setRootCause(java.lang.Throwable) definition code for javax.naming.NamingException.setRootCause(java.lang.Throwable) , toString sample code for javax.naming.NamingException.toString() definition code for javax.naming.NamingException.toString() , toString sample code for javax.naming.NamingException.toString(boolean) definition code for javax.naming.NamingException.toString(boolean)
 
Methods inherited from class java.lang.Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable
fillInStackTrace sample code for java.lang.Throwable.fillInStackTrace() definition code for java.lang.Throwable.fillInStackTrace() , getLocalizedMessage sample code for java.lang.Throwable.getLocalizedMessage() definition code for java.lang.Throwable.getLocalizedMessage() , getMessage sample code for java.lang.Throwable.getMessage() definition code for java.lang.Throwable.getMessage() , getStackTrace sample code for java.lang.Throwable.getStackTrace() definition code for java.lang.Throwable.getStackTrace() , printStackTrace sample code for java.lang.Throwable.printStackTrace() definition code for java.lang.Throwable.printStackTrace() , printStackTrace sample code for java.lang.Throwable.printStackTrace(java.io.PrintStream) definition code for java.lang.Throwable.printStackTrace(java.io.PrintStream) , printStackTrace sample code for java.lang.Throwable.printStackTrace(java.io.PrintWriter) definition code for java.lang.Throwable.printStackTrace(java.io.PrintWriter) , setStackTrace sample code for java.lang.Throwable.setStackTrace(java.lang.StackTraceElement[]) definition code for java.lang.Throwable.setStackTrace(java.lang.StackTraceElement[])
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

remainingNewName sample code for javax.naming.CannotProceedException.remainingNewName

protected Name sample code for javax.naming.Name definition code for javax.naming.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().

See Also:
getRemainingNewName() sample code for javax.naming.CannotProceedException.getRemainingNewName() definition code for javax.naming.CannotProceedException.getRemainingNewName() , setRemainingNewName(javax.naming.Name) sample code for javax.naming.CannotProceedException.setRemainingNewName(javax.naming.Name) definition code for javax.naming.CannotProceedException.setRemainingNewName(javax.naming.Name)

environment sample code for javax.naming.CannotProceedException.environment

protected Hashtable sample code for java.util.Hashtable definition code for java.util.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().

See Also:
getEnvironment() sample code for javax.naming.CannotProceedException.getEnvironment() definition code for javax.naming.CannotProceedException.getEnvironment() , setEnvironment(java.util.Hashtable) sample code for javax.naming.CannotProceedException.setEnvironment(java.util.Hashtable) definition code for javax.naming.CannotProceedException.setEnvironment(java.util.Hashtable)

altName sample code for javax.naming.CannotProceedException.altName

protected Name sample code for javax.naming.Name definition code for javax.naming.Name  altName
Contains 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() sample code for javax.naming.CannotProceedException.getAltName() definition code for javax.naming.CannotProceedException.getAltName() , setAltName(javax.naming.Name) sample code for javax.naming.CannotProceedException.setAltName(javax.naming.Name) definition code for javax.naming.CannotProceedException.setAltName(javax.naming.Name) , altNameCtx sample code for javax.naming.CannotProceedException.altNameCtx definition code for javax.naming.CannotProceedException.altNameCtx , ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable) sample code for javax.naming.spi.ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable) definition code for javax.naming.spi.ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)

altNameCtx sample code for javax.naming.CannotProceedException.altNameCtx

protected Context sample code for javax.naming.Context definition code for javax.naming.Context  altNameCtx
Contains 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() sample code for javax.naming.CannotProceedException.getAltNameCtx() definition code for javax.naming.CannotProceedException.getAltNameCtx() , setAltNameCtx(javax.naming.Context) sample code for javax.naming.CannotProceedException.setAltNameCtx(javax.naming.Context) definition code for javax.naming.CannotProceedException.setAltNameCtx(javax.naming.Context) , altName sample code for javax.naming.CannotProceedException.altName definition code for javax.naming.CannotProceedException.altName , ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable) sample code for javax.naming.spi.ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable) definition code for javax.naming.spi.ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)
Constructor Detail

CannotProceedException sample code for javax.naming.CannotProceedException(java.lang.String) definition code for javax.naming.CannotProceedException(java.lang.String)

public CannotProceedException(String sample code for java.lang.String definition code for java.lang.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() sample code for java.lang.Throwable.getMessage() definition code for java.lang.Throwable.getMessage()

CannotProceedException sample code for javax.naming.CannotProceedException() definition code for javax.naming.CannotProceedException()

public CannotProceedException()
Constructs a new instance of CannotProceedException. All fields default to null.

Method Detail

getEnvironment sample code for javax.naming.CannotProceedException.getEnvironment() definition code for javax.naming.CannotProceedException.getEnvironment()

public Hashtable sample code for java.util.Hashtable definition code for java.util.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) sample code for javax.naming.CannotProceedException.setEnvironment(java.util.Hashtable) definition code for javax.naming.CannotProceedException.setEnvironment(java.util.Hashtable)

setEnvironment sample code for javax.naming.CannotProceedException.setEnvironment(java.util.Hashtable<?, ?>) definition code for javax.naming.CannotProceedException.setEnvironment(java.util.Hashtable<?, ?>)

public void setEnvironment(Hashtable sample code for java.util.Hashtable definition code for java.util.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() sample code for javax.naming.CannotProceedException.getEnvironment() definition code for javax.naming.CannotProceedException.getEnvironment()

getRemainingNewName sample code for javax.naming.CannotProceedException.getRemainingNewName() definition code for javax.naming.CannotProceedException.getRemainingNewName()

public Name sample code for javax.naming.Name definition code for javax.naming.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) sample code for javax.naming.CannotProceedException.setRemainingNewName(javax.naming.Name) definition code for javax.naming.CannotProceedException.setRemainingNewName(javax.naming.Name)

setRemainingNewName sample code for javax.naming.CannotProceedException.setRemainingNewName(javax.naming.Name) definition code for javax.naming.CannotProceedException.setRemainingNewName(javax.naming.Name)

public void setRemainingNewName(Name sample code for javax.naming.Name definition code for javax.naming.Name  newName)
Sets the "remaining new name" field of this exception. This is the value returned by 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.

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() sample code for javax.naming.CannotProceedException.getRemainingNewName() definition code for javax.naming.CannotProceedException.getRemainingNewName()

getAltName sample code for javax.naming.CannotProceedException.getAltName() definition code for javax.naming.CannotProceedException.getAltName()

public Name sample code for javax.naming.Name definition code for javax.naming.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(javax.naming.Name) sample code for javax.naming.CannotProceedException.setAltName(javax.naming.Name) definition code for javax.naming.CannotProceedException.setAltName(javax.naming.Name) , getAltNameCtx() sample code for javax.naming.CannotProceedException.getAltNameCtx() definition code for javax.naming.CannotProceedException.getAltNameCtx() , ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable) sample code for javax.naming.spi.ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable) definition code for javax.naming.spi.ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)

setAltName sample code for javax.naming.CannotProceedException.setAltName(javax.naming.Name) definition code for javax.naming.CannotProceedException.setAltName(javax.naming.Name)

public void setAltName(Name sample code for javax.naming.Name definition code for javax.naming.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() sample code for javax.naming.CannotProceedException.getAltName() definition code for javax.naming.CannotProceedException.getAltName() , setAltNameCtx(javax.naming.Context) sample code for javax.naming.CannotProceedException.setAltNameCtx(javax.naming.Context) definition code for javax.naming.CannotProceedException.setAltNameCtx(javax.naming.Context)

getAltNameCtx sample code for javax.naming.CannotProceedException.getAltNameCtx() definition code for javax.naming.CannotProceedException.getAltNameCtx()

public Context sample code for javax.naming.Context definition code for javax.naming.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(javax.naming.Context) sample code for javax.naming.CannotProceedException.setAltNameCtx(javax.naming.Context) definition code for javax.naming.CannotProceedException.setAltNameCtx(javax.naming.Context) , getAltName() sample code for javax.naming.CannotProceedException.getAltName() definition code for javax.naming.CannotProceedException.getAltName() , ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable) sample code for javax.naming.spi.ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable) definition code for javax.naming.spi.ObjectFactory.getObjectInstance(java.lang.Object, javax.naming.Name, javax.naming.Context, java.util.Hashtable)

setAltNameCtx sample code for javax.naming.CannotProceedException.setAltNameCtx(javax.naming.Context) definition code for javax.naming.CannotProceedException.setAltNameCtx(javax.naming.Context)

public void setAltNameCtx(Context sample code for javax.naming.Context definition code for javax.naming.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() sample code for javax.naming.CannotProceedException.getAltNameCtx() definition code for javax.naming.CannotProceedException.getAltNameCtx() , setAltName(javax.naming.Name) sample code for javax.naming.CannotProceedException.setAltName(javax.naming.Name) definition code for javax.naming.CannotProceedException.setAltName(javax.naming.Name)