Package org.apache.sshd.common.future
Class DefaultKeyExchangeFuture
java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.common.future.AbstractSshFuture<KeyExchangeFuture>
org.apache.sshd.common.future.DefaultSshFuture<KeyExchangeFuture>
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.util.logging.AbstractLoggingBean
log
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the cause of the exchange failure.verify
(long timeoutMillis, CancelOption... options) Wait and verify that the operation was successfulMethods 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.VerifiableFuture
verify, verify, verify
Methods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone
-
Constructor Details
-
DefaultKeyExchangeFuture
-
-
Method Details
-
verify
Description copied from interface:VerifiableFuture
Wait and verify that the operation was successful- Specified by:
verify
in interfaceVerifiableFuture<KeyExchangeFuture>
- Parameters:
timeoutMillis
- Wait timeout in millisecondsoptions
- OptionalCancelOption
s defining the behavior on time-out or interrupt; ignored if the future is notCancellable
.- Returns:
- The (same) future instance
- Throws:
IOException
- If failed to verify successfully on time
-
getException
Description copied from interface:KeyExchangeFuture
Returns the cause of the exchange failure.- Specified by:
getException
in interfaceKeyExchangeFuture
- Returns:
null
if the exchange operation is not finished yet, or if the connection attempt is successful (useWaitableFuture.isDone()
to distinguish between the two).
-