Package org.apache.sshd.client.future

Class DefaultAuthFuture

java.lang.Object

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

org.apache.sshd.common.future.AbstractSshFuture<T>

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

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

org.apache.sshd.client.future.DefaultAuthFuture

All Implemented Interfaces:

AuthFuture, SshFuture<AuthFuture>, VerifiableFuture<AuthFuture>, WaitableFuture

public class DefaultAuthFuture
extends DefaultVerifiableSshFuture<AuthFuture>
implements AuthFuture

A default implementation of AuthFuture.

Field Summary

Fields inherited from class org.apache.sshd.common.future.AbstractSshFuture

CANCELED

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

log

Constructor Summary

Constructors

Constructor	Description
DefaultAuthFuture(java.lang.Object id, java.lang.Object lock)

Method Summary

Modifier and Type	Method	Description
java.lang.Throwable	getException()	Returns the cause of the authentication failure.
boolean	isFailure()
boolean	isSuccess()
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.
AuthFuture	verify(long timeoutMillis)	Wait and verify that the operation was successful

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

addListener, await0, cancel, getNumRegisteredListeners, getValue, isCanceled, isDone, notifyListeners, removeListener, setValue, toString

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

asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResult

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

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

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

verify, verify, verify

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

await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone

Constructor Detail

DefaultAuthFuture

public DefaultAuthFuture(java.lang.Object id,
                         java.lang.Object lock)

Method Detail

verify

public AuthFuture verify(long timeoutMillis)
                  throws java.io.IOException

Description copied from interface: VerifiableFuture

Wait and verify that the operation was successful

Specified by:

verify in interface VerifiableFuture<AuthFuture>

Parameters:

timeoutMillis - Wait timeout in milliseconds

Returns:

The (same) future instance

Throws:

java.io.IOException - If failed to verify successfully on time

getException

public java.lang.Throwable getException()

Description copied from interface: AuthFuture

Returns the cause of the authentication failure.

Specified by:

getException in interface AuthFuture

Returns:

null if the authentication operation is not finished yet, or if the connection attempt is successful (use WaitableFuture.isDone() to distinguish between the two).

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface AuthFuture

Returns:

true if the authentication operation is finished successfully. Note: calling this method while the operation is in progress returns false. Should check WaitableFuture.isDone() in order to ensure that the result is valid.

isFailure

public boolean isFailure()

Specified by:

isFailure in interface AuthFuture

Returns:

false if the authentication operation failed. Note: the operation is considered failed if an exception is received instead of a success/fail response code or the operation is in progress. Should check WaitableFuture.isDone() in order to ensure that the result is valid.

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