javax.naming: public class: CannotProceedException

javax.naming
public class: CannotProceedException [javadoc | source]

java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         javax.naming.NamingException
            javax.naming.CannotProceedException

All Implemented Interfaces:
Serializable

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

since: 1.3 -

Field 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(). Also see: getRemainingNewName setRemainingNewName serial:
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(). Also see: getEnvironment setEnvironment serial:
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(). Also see: getAltName setAltName altNameCtx javax.naming.spi.ObjectFactory#getObjectInstance serial:
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(). Also see: getAltNameCtx setAltNameCtx altName javax.naming.spi.ObjectFactory#getObjectInstance serial:

Fields inherited from javax.naming.NamingException:
resolvedName, resolvedObj, remainingName, rootException

Fields inherited from java.lang.Exception:
serialVersionUID

Constructor:

Constructor:
public CannotProceedException() { super(); } Constructs a new instance of CannotProceedException. All fields default to null.
public CannotProceedException(String explanation) { super(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. Also see: java.lang.Throwable#getMessage

 public CannotProceedException() {
        super();
}

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

 public CannotProceedException(String explanation) {
                                                                               
        super(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.

Also see:

java.lang.Throwable#getMessage

Method from javax.naming.CannotProceedException Summary:
getAltName, getAltNameCtx, getEnvironment, getRemainingNewName, setAltName, setAltNameCtx, setEnvironment, setRemainingNewName

Methods from javax.naming.NamingException:
appendRemainingComponent, appendRemainingName, getCause, getExplanation, getRemainingName, getResolvedName, getResolvedObj, getRootCause, initCause, setRemainingName, setResolvedName, setResolvedObj, setRootCause, toString, toString

Methods from java.lang.Throwable:
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.naming.CannotProceedException Detail:
public Name getAltName() { return altName; } 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.
public Context getAltNameCtx() { return altNameCtx; } 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.
public Hashtable getEnvironment() { return environment; } Retrieves the environment that was in effect when this exception was created.
public Name getRemainingNewName() { return remainingNewName; } 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 altName) { this.altName = altName; } Sets the `altName` field of this exception.
public void setAltNameCtx(Context altNameCtx) { this.altNameCtx = altNameCtx; } Sets the `altNameCtx` field of this exception.
public void setEnvironment(Hashtable environment) { this.environment = environment; // %%% clone it?? } Sets the environment that will be returned when getEnvironment() is called.
public void setRemainingNewName(Name newName) { if (newName != null) this.remainingNewName = (Name)(newName.clone()); else this.remainingNewName = null; } 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.

Method from javax.naming.CannotProceedException Detail:

 public Name getAltName() {
        return altName;
}

altName

altNameCtx

javax.naming.spi.ObjectFactory.getObjectInstance

 public Context getAltNameCtx() {
        return altNameCtx;
}

altNameCtx

altName

javax.naming.spi.ObjectFactory.getObjectInstance

 public Hashtable getEnvironment() {
        return environment;
}

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

 public Name getRemainingNewName() {
        return remainingNewName;
}

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 altName) {
        this.altName = altName;
}

altName

 public  void setAltNameCtx(Context altNameCtx) {
        this.altNameCtx = altNameCtx;
}

altNameCtx

 public  void setEnvironment(Hashtable environment) {
        this.environment = environment; // %%% clone it??
}

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

 public  void setRemainingNewName(Name newName) {
        if (newName != null)
            this.remainingNewName = (Name)(newName.clone());
        else
            this.remainingNewName = null;
}

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.