APIdia Launch Partner
Top Description Fields Constructors Methods
javax.naming

public Class CannotProceedException

extends NamingException
Class Inheritance
Imports
java.util.Hashtable
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.

Authors
Rosanna Lee, Scott Seligman
Since
1.3

Field Summary

Modifier and TypeField and Description
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().

private static final long
serialVersionUID

Hides javax.naming.NamingException.serialVersionUID.

Use serialVersionUID from JNDI 1.1.1 for interoperability
Inherited from javax.naming.NamingException:
remainingNameresolvedNameresolvedObjrootException

Constructor Summary

AccessConstructor and Description
public
CannotProceedException(String
A possibly null string containing additional detail about this exception. If null, this exception has no detail message.
explanation)

Constructs a new instance of CannotProceedException using an explanation.

public
CannotProceedException()

Constructs a new instance of CannotProceedException.

Method Summary

Modifier and TypeMethod and Description
public Name

Returns:

The name of the resolved object, relative to altNameCtx. It is a composite name. If null, then no name is specified.
getAltName()

Retrieves the altName field of this exception.

public Context

Returns:

The context relative to which altName is named. If null, then the default initial context is implied.
getAltNameCtx()

Retrieves the altNameCtx field of this exception.

public Hashtable<?, ?>

Returns:

Possibly null environment property set. null means no environment was recorded for this exception.
getEnvironment()

Retrieves the environment that was in effect when this exception was created.

public Name

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

Retrieves the "remaining new name" field of this exception, which is used when this exception is thrown during a rename() operation.

public void
setAltName(Name
The name of the resolved object, relative to altNameCtx. It is a composite name. If null, then no name is specified.
altName)

Sets the altName field of this exception.

public void
setAltNameCtx(Context
The context relative to which altName is named. If null, then the default initial context is implied.
altNameCtx)

Sets the altNameCtx field of this exception.

public void
setEnvironment(Hashtable<?, ?>
A possibly null environment property set. null means no environment is being recorded for this exception.
environment)

Sets the environment that will be returned when getEnvironment() is called.

public void
setRemainingNewName(Name
The possibly null name to set the "remaining new name" to. If null, it sets the remaining name field to null.
newName)

Sets the "remaining new name" field of this exception.

Inherited from javax.naming.NamingException:
appendRemainingComponentappendRemainingNamegetCausegetExplanationgetRemainingNamegetResolvedNamegetResolvedObjgetRootCauseinitCausesetRemainingNamesetResolvedNamesetResolvedObjsetRootCausetoStringtoString

Field Detail

altNameback to summary
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().

See Also
getAltName, setAltName, altNameCtx, javax.naming.spi.ObjectFactory#getObjectInstance
altNameCtxback to summary
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().

Annotations
@SuppressWarnings:serial
See Also
getAltNameCtx, setAltNameCtx, altName, javax.naming.spi.ObjectFactory#getObjectInstance
environmentback to summary
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().

See Also
getEnvironment, setEnvironment
remainingNewNameback to summary
protected Name remainingNewName

Contains the remaining unresolved part of the second "name" argument to Context.rename(). This information is 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, setRemainingNewName
serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.naming.NamingException.serialVersionUID.

Use serialVersionUID from JNDI 1.1.1 for interoperability

Constructor Detail

CannotProceedExceptionback to summary
public CannotProceedException(String explanation)

Constructs a new instance of CannotProceedException using an explanation. All unspecified fields default to null.

Parameters
explanation:String

A possibly null string containing additional detail about this exception. If null, this exception has no detail message.

See Also
java.lang.Throwable#getMessage
CannotProceedExceptionback to summary
public CannotProceedException()

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

Method Detail

getAltNameback to summary
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:Name

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, javax.naming.spi.ObjectFactory#getObjectInstance
getAltNameCtxback to summary
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:Context

The context relative to which altName is named. If null, then the default initial context is implied.

See Also
setAltNameCtx, getAltName, javax.naming.spi.ObjectFactory#getObjectInstance
getEnvironmentback to summary
public Hashtable<?, ?> getEnvironment()

Retrieves the environment that was in effect when this exception was created.

Returns:Hashtable<?, ?>

Possibly null environment property set. null means no environment was recorded for this exception.

See Also
setEnvironment
getRemainingNewNameback to summary
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:Name

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
setAltNameback to summary
public void setAltName(Name altName)

Sets the altName field of this exception.

Parameters
altName:Name

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
setAltNameCtxback to summary
public void setAltNameCtx(Context altNameCtx)

Sets the altNameCtx field of this exception.

Parameters
altNameCtx:Context

The context relative to which altName is named. If null, then the default initial context is implied.

See Also
getAltNameCtx, setAltName
setEnvironmentback to summary
public void setEnvironment(Hashtable<?, ?> environment)

Sets the environment that will be returned when getEnvironment() is called.

Parameters
environment:Hashtable<?, ?>

A possibly null environment property set. null means no environment is being recorded for this exception.

See Also
getEnvironment
setRemainingNewNameback to summary
public void setRemainingNewName(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:Name

The possibly null name to set the "remaining new name" to. If null, it sets the remaining name field to null.

See Also
getRemainingNewName