org.apache.sshd.client.future

Interface AuthFuture

All Superinterfaces:

SshFuture<AuthFuture>

All Known Implementing Classes:

DefaultAuthFuture

public interface AuthFuture
extends SshFuture<AuthFuture>

An SshFuture for asynchronous authentication requests.

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the authentication attempt and notifies all threads waiting for this future.
Throwable	getException() Returns the cause of the connection failure.
boolean	isCanceled()
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 interface org.apache.sshd.common.future.SshFuture

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

Method Detail

verify

void verify()
     throws IOException

Wait and verify that the authentication succeeded.

Throws:

IOException - if the authentication failed for any reason

verify

void verify(long timeout,
            TimeUnit unit)
     throws IOException

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

Parameters:

timeout - The number of time units

unit - The TimeUnit for the timeout

Throws:

IOException - if the authentication failed for any reason

verify

void verify(long timeoutMillis)
     throws IOException

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

Parameters:

timeoutMillis - Timeout in milliseconds

Throws:

IOException - if the authentication failed for any reason

getException

Throwable getException()

Returns the cause of the connection failure.

Returns:

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

isSuccess

boolean isSuccess()

Returns:

true if the authentication operation is finished successfully.

isFailure

boolean isFailure()

Returns:

false if the authentication operation failed.

isCanceled

boolean isCanceled()

Returns:

true if the connect operation has been canceled by cancel() method.

setAuthed

void setAuthed(boolean authed)

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

Parameters:

authed - Authentication success state

setException

void setException(Throwable exception)

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.

Parameters:

exception - The caught Throwable

cancel

void cancel()

Cancels the authentication attempt and notifies all threads waiting for this future.