Class DefaultConnectFuture

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.future.AbstractSshFuture<ConnectFuture>

org.apache.sshd.common.future.DefaultSshFuture<ConnectFuture>

org.apache.sshd.common.future.DefaultVerifiableSshFuture<ConnectFuture>

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 of ConnectFuture.

Field Summary

Fields inherited from class AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor	Description
DefaultConnectFuture(Object id, Object lock)

Method Summary

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 DefaultCancellableSshFuture

cancel, createCancellation, getCancellation, getException, isCanceled, setException

Methods inherited from class DefaultSshFuture

addListener, await0, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue, toString

Methods inherited from class AbstractSshFuture

asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResult

Methods inherited from class 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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Cancellable

cancel, getCancellation, isCanceled

Methods inherited from interface ConnectFuture

getClientSession

Methods inherited from interface HasException

getException

Methods inherited from interface SessionHolder

getSessionContext

Methods inherited from interface SshFuture

addListener, removeListener

Methods inherited from interface VerifiableFuture

verify, verify, verify, verify, verify, verify, verify

Methods inherited from interface WaitableFuture

await, await, await, await, await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone

Methods inherited from interface WithException

setException

Constructor Details

DefaultConnectFuture

public DefaultConnectFuture(Object id,
 Object lock)

Method Details

verify

public ConnectFuture verify(long timeout,
 CancelOption... options)
                     throws IOException

Wait and verify that the operation was successful

If no CancelOptions are given, this behaves as if CancelOption.CANCEL_ON_TIMEOUT and CancelOption.CANCEL_ON_INTERRUPT were set.

Specified by:

verify in interface VerifiableFuture<ConnectFuture>

Parameters:

timeout - Wait timeout in milliseconds

options - Optional CancelOptions defining the behavior on time-out or interrupt; ignored if the future is not Cancellable.

Returns:

The (same) future instance

Throws:

IOException - If failed to verify successfully on time

getSession

public ClientSession getSession()

Specified by:

getSession in interface SessionHolder<ClientSession>

isConnected

public boolean isConnected()

Specified by:

isConnected in interface ConnectFuture

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 interface ConnectFuture

Parameters:

session - The ClientSession