org.apache.sshd.client.future

Class DefaultOpenFuture

java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
DefaultOpenFuture(java.lang.Object lock)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Throwable	getException() Returns the cause of the connection failure.
boolean	isOpened() Returns true if the connect operation is finished successfully.
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.
void	verify() Wait and verify that the channel has been successfuly opened.

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

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

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(java.lang.Object lock)

Method Detail

verify

public void verify()
            throws SshException

Description copied from interface: OpenFuture

Wait and verify that the channel has been successfuly opened.

Specified by:

verify in interface OpenFuture

Throws:

SshException - if the authentication failed for any reason

getException

public java.lang.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()

Description copied from interface: OpenFuture

Returns true if the connect operation is finished successfully.

Specified by:

isOpened in interface OpenFuture

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