org.apache.sshd.common.future

Class DefaultCancelFuture

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.future.AbstractSshFuture<T>

org.apache.sshd.common.future.DefaultSshFuture<CancelFuture>

org.apache.sshd.common.future.DefaultCancelFuture

All Implemented Interfaces:

CancelFuture, SshFuture<CancelFuture>, VerifiableFuture<Boolean>, WaitableFuture

public class DefaultCancelFuture
extends DefaultSshFuture<CancelFuture>
implements CancelFuture

A default implementation of a CancelFuture.

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultCancelFuture(Object id)

Method Summary

Modifier and Type	Method and Description
CancellationException	getBackTrace() Obtains an exception describing the stack trace of where the cancellation was initiated.
boolean	isCanceled() Tells whether the cancellation has been effected.
void	setBackTrace(CancellationException backTrace) Sets a CancellationException describing the stack trace of where the cancellation was initiated.
void	setCanceled() Marks this CancelFuture as the cancellation having been effected.
void	setCanceled(Throwable error) Marks this CancelFuture as the cancellation having been effected.
void	setNotCanceled() Completes this future with a value indicating that the cancellation was not done.
Boolean	verify(long timeoutMillis, CancelOption... options) Wait and verify that the operation was successful

Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture

addListener, await0, createCancellation, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue, toString

Methods inherited from class org.apache.sshd.common.future.AbstractSshFuture

asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResult

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.future.SshFuture

addListener, removeListener

Methods inherited from interface org.apache.sshd.common.future.WaitableFuture

await, await, await, await, await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone

Methods inherited from interface org.apache.sshd.common.future.VerifiableFuture

verify, verify, verify, verify, verify, verify, verify

Constructor Detail

DefaultCancelFuture

protected DefaultCancelFuture(Object id)

Method Detail

verify

public Boolean verify(long timeoutMillis,
                      CancelOption... options)
               throws IOException

Wait and verify that the operation was successful

Specified by:

verify in interface VerifiableFuture<Boolean>

Parameters:

timeoutMillis - Wait timeout in milliseconds

options - Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.

Returns:

the value of isCanceled()

Throws:

IOException - If failed to verify successfully on time

setCanceled

public void setCanceled()

Description copied from interface: CancelFuture

Marks this CancelFuture as the cancellation having been effected.

This is a framework-internal method.

Specified by:

setCanceled in interface CancelFuture

setCanceled

public void setCanceled(Throwable error)

Description copied from interface: CancelFuture

Marks this CancelFuture as the cancellation having been effected.

This is a framework-internal method.

Specified by:

setCanceled in interface CancelFuture

Parameters:

error - optional Throwable, if non-null, it'll be attached to the backtrace.

setNotCanceled

public void setNotCanceled()

Description copied from interface: CancelFuture

Completes this future with a value indicating that the cancellation was not done.

Specified by:

setNotCanceled in interface CancelFuture

isCanceled

public boolean isCanceled()

Description copied from interface: CancelFuture

Tells whether the cancellation has been effected. (WaitableFuture.isDone() && !isCanceled()) means the cancellation was not effected. In that case check the original operation for a success or failure value.

Specified by:

isCanceled in interface CancelFuture

Returns:

true if the cancellation was done; false otherwise

setBackTrace

public void setBackTrace(CancellationException backTrace)

Description copied from interface: CancelFuture

Sets a CancellationException describing the stack trace of where the cancellation was initiated. Has no effect if a backtrace was already set, or the given backtrace is null.

This is a framework-internal method.

Specified by:

setBackTrace in interface CancelFuture

Parameters:

backTrace - CancellationException to set

getBackTrace

public CancellationException getBackTrace()

Description copied from interface: CancelFuture

Obtains an exception describing the stack trace of where the cancellation was initiated.

Specified by:

getBackTrace in interface CancelFuture

Returns:

a CancellationException