org.apache.sshd.client.future

Class DefaultOpenFuture

java.lang.Object

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

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

org.apache.sshd.client.future.DefaultOpenFuture

All Implemented Interfaces:

OpenFuture, SshFuture<OpenFuture>

public class DefaultOpenFuture
extends DefaultSshFuture<OpenFuture>
implements OpenFuture

A default implementation of OpenFuture.

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor and Description
DefaultOpenFuture(Object lock)

Method Summary

Modifier and Type	Method and Description
Throwable	getException() Returns 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	setOpened() Sets the newly connected session and notifies all threads waiting for this future.
void	verify() Wait and verify that the channel has been successfully opened.
void	verify(long timeoutMillis) Wait and verify that the channel has been successfully opened.
void	verify(long timeout, TimeUnit unit) Wait and verify that the channel has been successfully opened.

Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture

addListener, await, await, await, await0, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, getValue, isCanceled, isDone, removeListener, setValue, verifyResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, isDone, removeListener

Constructor Detail

DefaultOpenFuture

public DefaultOpenFuture(Object lock)

Method Detail

verify

public void verify()
            throws IOException

Description copied from interface: OpenFuture

Wait and verify that the channel has been successfully opened.

Specified by:

verify in interface OpenFuture

Throws:

IOException - if the action failed for any reason

verify

public void verify(long timeout,
                   TimeUnit unit)
            throws IOException

Description copied from interface: OpenFuture

Wait and verify that the channel has been successfully opened.

Specified by:

verify in interface OpenFuture

Parameters:

timeout - The number of time units to wait

unit - The wait TimeUnit

Throws:

IOException - If failed to verify successfully on time

verify

public void verify(long timeoutMillis)
            throws IOException

Description copied from interface: OpenFuture

Wait and verify that the channel has been successfully opened.

Specified by:

verify in interface OpenFuture

Parameters:

timeoutMillis - Wait timeout in milliseconds

Throws:

IOException - If failed to verify successfully on time

getException

public Throwable getException()

Description copied from interface: OpenFuture

Returns the cause of the connection failure.

Specified by:

getException in interface OpenFuture

Returns:

null if the connect operation is not finished yet, or if the connection attempt is successful.

isOpened

public boolean isOpened()

Specified by:

isOpened in interface OpenFuture

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

setException

public void setException(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 interface OpenFuture

Parameters:

exception - The caught Throwable