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<T>
-
- org.apache.sshd.common.future.DefaultCancellableSshFuture<ConnectFuture>
-
- org.apache.sshd.client.future.DefaultConnectFuture
-
- All Implemented Interfaces:
ConnectFuture
,ClientSessionHolder
,Cancellable
,HasException
,SshFuture<ConnectFuture>
,VerifiableFuture<ConnectFuture>
,WaitableFuture
,WithException
,SessionContextHolder
,SessionHolder<ClientSession>
public class DefaultConnectFuture extends DefaultCancellableSshFuture<ConnectFuture> implements ConnectFuture
A default implementation ofConnectFuture
.
-
-
Field Summary
-
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 ClientSession
getSession()
boolean
isConnected()
void
setSession(ClientSession session)
Sets the newly connected session and notifies all threads waiting for this future.ConnectFuture
verify(long timeout, CancelOption... options)
Wait and verify that the operation was successful-
Methods inherited from class org.apache.sshd.common.future.DefaultCancellableSshFuture
cancel, createCancellation, getCancellation, getException, isCanceled, setException
-
Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture
addListener, await0, 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.Cancellable
cancel, getCancellation, isCanceled
-
Methods inherited from interface org.apache.sshd.client.future.ConnectFuture
getClientSession
-
Methods inherited from interface org.apache.sshd.common.future.HasException
getException
-
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, verify, verify, verify, verify, verify
-
Methods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, await, await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone
-
Methods inherited from interface org.apache.sshd.common.future.WithException
setException
-
-
-
-
Method Detail
-
verify
public ConnectFuture verify(long timeout, CancelOption... options) throws java.io.IOException
Wait and verify that the operation was successfulIf no
CancelOption
s are given, this behaves as ifCancelOption.CANCEL_ON_TIMEOUT
andCancelOption.CANCEL_ON_INTERRUPT
were set.- Specified by:
verify
in interfaceVerifiableFuture<ConnectFuture>
- Parameters:
timeout
- 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:
java.io.IOException
- If failed to verify successfully on time
-
getSession
public ClientSession getSession()
- Specified by:
getSession
in interfaceSessionHolder<ClientSession>
-
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
-
-