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
public class DefaultOpenFuture extends DefaultVerifiableSshFuture<OpenFuture> implements OpenFuture
A default implementation ofOpenFuture
.
-
-
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 Description DefaultOpenFuture(java.lang.Object id, java.lang.Object lock)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Throwable
getException()
Returns the cause of the connection failure.boolean
isOpened()
void
setException(java.lang.Throwable exception)
Sets the exception caught due to connection failure and notifies all threads waiting for this future.void
setOpened()
Sets the newly connected session and notifies all threads waiting for this future.OpenFuture
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.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
-
Methods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone
-
-
-
-
Method Detail
-
verify
public OpenFuture verify(long timeoutMillis) throws java.io.IOException
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:
java.io.IOException
- If failed to verify successfully on time
-
getException
public java.lang.Throwable 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
public void setException(java.lang.Throwable exception)
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
-
-