org.apache.sshd.common.future

Class DefaultKeyExchangeFuture

java.lang.Object

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

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

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

org.apache.sshd.common.future.DefaultVerifiableSshFuture<KeyExchangeFuture>

org.apache.sshd.common.future.DefaultKeyExchangeFuture

All Implemented Interfaces:

KeyExchangeFuture, SshFuture<KeyExchangeFuture>, VerifiableFuture<KeyExchangeFuture>, WaitableFuture

public class DefaultKeyExchangeFuture
extends DefaultVerifiableSshFuture<KeyExchangeFuture>
implements KeyExchangeFuture

Field Summary

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

CANCELED, debugEnabled, traceEnabled

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

log

Constructor Summary

Constructors

Constructor and Description
DefaultKeyExchangeFuture(java.lang.Object id, java.lang.Object lock)

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	getException() Returns the cause of the exchange failure.
KeyExchangeFuture	verify(long timeoutMillis) Wait and verify that the operation was successful

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

addListener, await0, cancel, getNumRegisteredListeners, getValue, isCanceled, isDone, notifyListeners, 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

getSimplifiedLogger

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, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone

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

verify, verify, verify

Constructor Detail

DefaultKeyExchangeFuture

public DefaultKeyExchangeFuture(java.lang.Object id,
                                java.lang.Object lock)

Method Detail

verify

public KeyExchangeFuture verify(long timeoutMillis)
                         throws java.io.IOException

Description copied from interface: VerifiableFuture

Wait and verify that the operation was successful

Specified by:

verify in interface VerifiableFuture<KeyExchangeFuture>

Parameters:

timeoutMillis - Wait timeout in milliseconds

Returns:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time

getException

public java.lang.Throwable getException()

Description copied from interface: KeyExchangeFuture

Returns the cause of the exchange failure.

Specified by:

getException in interface KeyExchangeFuture

Returns:

null if the exchange operation is not finished yet, or if the connection attempt is successful (use WaitableFuture.isDone() to distinguish between the two).