FileDocCategorySizeDatePackage
CannotProceedException.javaAPI DocJava SE 5 API9135Fri Aug 26 14:57:38 BST 2005javax.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.

author
Rosanna Lee
author
Scott Seligman
version
1.11 04/07/16
since
1.3

Fields Summary
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().

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().

protected 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().

protected 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().

private static final long
serialVersionUID
Use serialVersionUID from JNDI 1.1.1 for interoperability
Constructors Summary
public CannotProceedException(String explanation)
Constructs a new instance of CannotProceedException using an explanation. All unspecified fields default to null.

param
explanation A possibly null string containing additional detail about this exception. If null, this exception has no detail message.
see
java.lang.Throwable#getMessage


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

	super();
    
Methods Summary
public javax.naming.NamegetAltName()
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.

return
The name of the resolved object, relative to altNameCtx. It is a composite name. If null, then no name is specified.
see
#setAltName
see
#getAltNameCtx
see
javax.naming.spi.ObjectFactory#getObjectInstance

	return altName;
    
public javax.naming.ContextgetAltNameCtx()
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.

return
The context relative to which altName is named. If null, then the default initial context is implied.
see
#setAltNameCtx
see
#getAltName
see
javax.naming.spi.ObjectFactory#getObjectInstance

	return altNameCtx;
    
public java.util.HashtablegetEnvironment()
Retrieves the environment that was in effect when this exception was created.

return
Possibly null environment property set. null means no environment was recorded for this exception.
see
#setEnvironment

	return environment;
    
public javax.naming.NamegetRemainingNewName()
Retrieves the "remaining new name" field of this exception, which is used when this exception is thrown during a rename() operation.

return
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
#setRemainingNewName

	return remainingNewName;
    
public voidsetAltName(javax.naming.Name altName)
Sets the altName field of this exception.

param
altName The name of the resolved object, relative to altNameCtx. It is a composite name. If null, then no name is specified.
see
#getAltName
see
#setAltNameCtx

	this.altName = altName;
    
public voidsetAltNameCtx(javax.naming.Context altNameCtx)
Sets the altNameCtx field of this exception.

param
altNameCtx The context relative to which altName is named. If null, then the default initial context is implied.
see
#getAltNameCtx
see
#setAltName

	this.altNameCtx = altNameCtx;
    
public voidsetEnvironment(java.util.Hashtable environment)
Sets the environment that will be returned when getEnvironment() is called.

param
environment A possibly null environment property set. null means no environment is being recorded for this exception.
see
#getEnvironment

	this.environment = environment;	// %%% clone it??
    
public voidsetRemainingNewName(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.

param
newName The possibly null name to set the "remaining new name" to. If null, it sets the remaining name field to null.
see
#getRemainingNewName

	if (newName != null)
	    this.remainingNewName = (Name)(newName.clone());
	else
	    this.remainingNewName = null;