Package org.apache.sshd.client.future
Class DefaultOpenFuture
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<OpenFuture>
org.apache.sshd.client.future.DefaultOpenFuture
- All Implemented Interfaces:
OpenFuture
,SshFuture<OpenFuture>
,VerifiableFuture<OpenFuture>
,WaitableFuture
A default implementation of
OpenFuture
.-
Field Summary
Fields inherited from class org.apache.sshd.common.future.AbstractSshFuture
CANCELED
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the cause of the connection failure.boolean
isOpened()
void
setException
(Throwable exception) Sets the exception caught due to connection failure and notifies all threads waiting for this future.void
Sets the newly connected session and notifies all threads waiting for this future.verify
(long timeoutMillis) Wait and verify that the operation was successfulMethods 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
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.client.future.OpenFuture
cancel, isCanceled
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
-
DefaultOpenFuture
-
-
Method Details
-
verify
Description copied from interface:VerifiableFuture
Wait and verify that the operation was successful- Specified by:
verify
in interfaceVerifiableFuture<OpenFuture>
- Parameters:
timeoutMillis
- Wait timeout in milliseconds- Returns:
- The (same) future instance
- Throws:
IOException
- If failed to verify successfully on time
-
getException
Description copied from interface:OpenFuture
Returns the cause of the connection failure.- Specified by:
getException
in interfaceOpenFuture
- Returns:
null
if the connect operation is not finished yet, or if the connection attempt is successful (useWaitableFuture.isDone()
to distinguish between the two).
-
isOpened
public boolean isOpened()- Specified by:
isOpened
in interfaceOpenFuture
- Returns:
true
if the connect operation is finished successfully.
-
setOpened
public void setOpened()Description copied from interface:OpenFuture
Sets the newly connected session and notifies all threads waiting for this future. This method is invoked by SSHD internally. Please do not call this method directly.- Specified by:
setOpened
in interfaceOpenFuture
-
setException
Description copied from interface:OpenFuture
Sets the exception caught due to connection failure and notifies all threads waiting for this future. This method is invoked by SSHD internally. Please do not call this method directly.- Specified by:
setException
in interfaceOpenFuture
- Parameters:
exception
- The caughtThrowable
-