Apache Mina SSHD 2.15.0 · org.apache.sshd.client.future.AuthFuture

Method Summary

Modifier and Type	Method and Description
public boolean	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 `isDone()` in order to ensure that the result is valid. isFailure()
public boolean	Returns: `true` if the authentication operation is finished successfully Note calling this method while the operation is in progress returns `false`. Should check `isDone()` in order to ensure that the result is valid. isSuccess()
public void	setAuthed(boolean Authentication success state authed) Notifies that the session has been authenticated.
public void	setCancellable(boolean whether this future is currently cancellable cancellable) Enables or disables cancellation of this `AuthFuture`.
public boolean	Returns: `true` if `cancel()` was called, `false` otherwise wasCanceled() Tells whether `cancel()` was called on this `AuthFuture`.

Inherited from org.apache.sshd.common.future.Cancellable:: cancel getCancellation isCanceled
Inherited from org.apache.sshd.common.future.SshFuture:: addListener removeListener
Inherited from org.apache.sshd.common.future.VerifiableFuture:: verify verify verify verify verify verify verify verify

isFailure	back to summary
public boolean isFailure() Returns:boolean `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 `isDone()` in order to ensure that the result is valid.

isSuccess	back to summary
public boolean isSuccess() Returns:boolean `true` if the authentication operation is finished successfully Note calling this method while the operation is in progress returns `false`. Should check `isDone()` in order to ensure that the result is valid.

setAuthed	back to summary
public 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:boolean Authentication success state

setAuthed

public 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

setCancellable back to summary

setCancellable	back to summary
public void setCancellable(boolean cancellable) Enables or disables cancellation of this `AuthFuture`. This is a framework method; do not call directly. Parameters cancellable:boolean whether this future is currently cancellable

public void setCancellable(boolean cancellable)

Enables or disables cancellation of this AuthFuture.

This is a framework method; do not call directly.

Parameters

wasCanceled back to summary

wasCanceled	back to summary
public boolean wasCanceled() Tells whether `cancel()` was called on this `AuthFuture`. This is different from `isCanceled()`. Canceling an on-going authentication may not be possible; `cancel()` is only a request to cancel the authentication. That request may not be honored and the `CancelFuture` may actually be `isCanceled()` `== false`. `AuthFuture`.`isCanceled()` is then `false`, too. Returns:boolean `true` if `cancel()` was called, `false` otherwise

public boolean wasCanceled()

Tells whether cancel() was called on this AuthFuture.

This is different from isCanceled(). Canceling an on-going authentication may not be possible; cancel() is only a request to cancel the authentication. That request may not be honored and the CancelFuture may actually be isCanceled() == false. AuthFuture.isCanceled() is then false, too.