com.vmware.vapi.std.errors

Class Canceled

java.lang.Object

com.vmware.vapi.std.errors.Canceled

public static class Canceled
extends java.lang.Object

The Canceled exception indicates that the method canceled itself in response to an explicit request to do so. Methods being "canceled" for other reasons (for example the client connection was closed, a time out occured, or due to excessive resource consumption) should not report this exception.

Examples:

• A user is monitoring the progress of the method in a GUI and sees that it is likely to take longer than he is willing to wait and clicks the cancel button.
• A user invokes the method using a command-line tool and decides that she didn't really want to invoke that method, and presses CTRL-c.

Counterexamples:

• The client's connection to the server was closed. Reporting an exception is pointless since the client will not receive the error response because the connection has been closed.
• The request is taking longer than some amount of time. The TimedOut exception would be reported if the time was specified as part of the input or is documented in the API contract.

See Also:

Serialized Form

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait