Package org.apache.sshd.client.future
Class DefaultConnectFuture
- 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<ConnectFuture>
-
- org.apache.sshd.client.future.DefaultConnectFuture
-
- All Implemented Interfaces:
ConnectFuture
,ClientSessionHolder
,SshFuture<ConnectFuture>
,VerifiableFuture<ConnectFuture>
,WaitableFuture
,SessionContextHolder
,SessionHolder<ClientSession>
public class DefaultConnectFuture extends DefaultVerifiableSshFuture<ConnectFuture> implements ConnectFuture
A default implementation ofConnectFuture
.
-
-
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 DefaultConnectFuture(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.ClientSession
getSession()
boolean
isConnected()
void
setException(java.lang.Throwable exception)
Sets the exception caught due to connection failure and notifies all threads waiting for this future.void
setSession(ClientSession session)
Sets the newly connected session and notifies all threads waiting for this future.ConnectFuture
verify(long timeout)
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.ConnectFuture
cancel, getClientSession, isCanceled
-
Methods inherited from interface org.apache.sshd.common.session.SessionHolder
getSessionContext
-
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 ConnectFuture verify(long timeout) throws java.io.IOException
Description copied from interface:VerifiableFuture
Wait and verify that the operation was successful- Specified by:
verify
in interfaceVerifiableFuture<ConnectFuture>
- Parameters:
timeout
- Wait timeout in milliseconds- Returns:
- The (same) future instance
- Throws:
java.io.IOException
- If failed to verify successfully on time
-
getSession
public ClientSession getSession()
- Specified by:
getSession
in interfaceSessionHolder<ClientSession>
-
getException
public java.lang.Throwable getException()
Description copied from interface:ConnectFuture
Returns the cause of the connection failure.- Specified by:
getException
in interfaceConnectFuture
- Returns:
null
if the connect operation is not finished yet, or if the connection attempt is successful (useWaitableFuture.isDone()
to distinguish between the two)
-
isConnected
public boolean isConnected()
- Specified by:
isConnected
in interfaceConnectFuture
- Returns:
true
if the connect operation is finished successfully.
-
setSession
public void setSession(ClientSession session)
Description copied from interface:ConnectFuture
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:
setSession
in interfaceConnectFuture
- Parameters:
session
- TheClientSession
-
setException
public void setException(java.lang.Throwable exception)
Description copied from interface:ConnectFuture
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 interfaceConnectFuture
- Parameters:
exception
- The caughtThrowable
-
-