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

void	cancel() Cancels the authentication attempt and notifies all threads waiting for this future.
java.lang.Throwable	getException() Returns the cause of the connection failure.
boolean	isCanceled() Returns true if the connect operation has been canceled by cancel() method.
boolean	isFailure() Returns false if the authentication operation failed.
boolean	isSuccess() Returns true if the authentication operation is finished successfully.
void	setAuthed(boolean authed) Notifies that the session has been authenticated.
void	setException(java.lang.Throwable exception) Sets the exception caught due to connection failure and notifies all threads waiting for this future.

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

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

Method Detail

getException

java.lang.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.

setException

void setException(java.lang.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.

cancel

void cancel()

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