org.apache.sshd.client.future

Class DefaultAuthFuture

java.lang.Object

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

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

org.apache.sshd.client.future.DefaultAuthFuture

All Implemented Interfaces:

AuthFuture, SshFuture<AuthFuture>

public class DefaultAuthFuture
extends DefaultSshFuture<AuthFuture>
implements AuthFuture

A default implementation of AuthFuture.

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
DefaultAuthFuture(Object lock)

Method Summary

Modifier and Type	Method and Description
Throwable	getException() Returns the cause of the connection failure.
boolean	isFailure()
boolean	isSuccess()
void	setAuthed(boolean authed) Notifies that the session has been authenticated.
void	setException(Throwable exception) Sets the exception caught due to connection failure and notifies all threads waiting for this future.
void	verify() Wait and verify that the authentication succeeded.
void	verify(long timeoutMillis) Wait and verify that the authentication succeeded within the specified timeout.
void	verify(long timeout, TimeUnit unit) Wait and verify that the authentication succeeded within the specified timeout.

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.AuthFuture

cancel, isCanceled

Methods inherited from interface org.apache.sshd.common.future.SshFuture

addListener, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, isDone, removeListener

Constructor Detail

DefaultAuthFuture

public DefaultAuthFuture(Object lock)

Method Detail

verify

public void verify()
            throws IOException

Description copied from interface: AuthFuture

Wait and verify that the authentication succeeded.

Specified by:

verify in interface AuthFuture

Throws:

IOException - if the authentication failed for any reason

verify

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

Description copied from interface: AuthFuture

Wait and verify that the authentication succeeded within the specified timeout.

Specified by:

verify in interface AuthFuture

Parameters:

timeout - The number of time units

unit - The TimeUnit for the timeout

Throws:

IOException - if the authentication failed for any reason

verify

public void verify(long timeoutMillis)
            throws IOException

Description copied from interface: AuthFuture

Wait and verify that the authentication succeeded within the specified timeout.

Specified by:

verify in interface AuthFuture

Parameters:

timeoutMillis - Timeout in milliseconds

Throws:

IOException - if the authentication failed for any reason

getException

public Throwable getException()

Description copied from interface: AuthFuture

Returns the cause of the connection failure.

Specified by:

getException in interface AuthFuture

Returns:

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

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface AuthFuture

Returns:

true if the authentication operation is finished successfully.

isFailure

public boolean isFailure()

Specified by:

isFailure in interface AuthFuture

Returns:

false if the authentication operation failed.

setAuthed

public void setAuthed(boolean authed)

Description copied from interface: AuthFuture

Notifies that the session has been authenticated. This method is invoked by SSHD internally. Please do not call this method directly.

Specified by:

setAuthed in interface AuthFuture

Parameters:

authed - Authentication success state

setException

public void setException(Throwable exception)

Description copied from interface: AuthFuture

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 AuthFuture

Parameters:

exception - The caught Throwable