Class DefaultAuthFuture

java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.common.future.AbstractSshFuture<AuthFuture>
org.apache.sshd.common.future.DefaultSshFuture<AuthFuture>
org.apache.sshd.common.future.DefaultVerifiableSshFuture<AuthFuture>
org.apache.sshd.common.future.DefaultCancellableSshFuture<AuthFuture>
org.apache.sshd.client.future.DefaultAuthFuture
All Implemented Interfaces:
AuthFuture, org.apache.sshd.common.future.Cancellable, org.apache.sshd.common.future.HasException, org.apache.sshd.common.future.SshFuture<AuthFuture>, org.apache.sshd.common.future.VerifiableFuture<AuthFuture>, org.apache.sshd.common.future.WaitableFuture, org.apache.sshd.common.future.WithException
public class DefaultAuthFuture extends org.apache.sshd.common.future.DefaultCancellableSshFuture<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
    Description
    DefaultAuthFuture(Object id, Object lock)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.sshd.common.future.CancelFuture
    cancel()
    Note that returned CancelFuture may also be fulfilled unsuccessfully (i.e., (DefaultSshFuture.isDone() && !DefaultCancellableSshFuture.isCanceled()) == true.
    org.apache.sshd.common.future.CancelFuture
    getCancellation()
     
    boolean
    isFailure()
     
    boolean
    isSuccess()
     
    void
    setAuthed(boolean authed)
    Notifies that the session has been authenticated.
    void
    setCancellable(boolean cancellable)
    Enables or disables cancellation of this AuthFuture.
    AuthFuture
    verify(long timeoutMillis, org.apache.sshd.common.future.CancelOption... options)
     
    boolean
    wasCanceled()
    Tells whether Cancellable.cancel() was called on this AuthFuture.

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

    createCancellation, getException, isCanceled, setException

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

    addListener, await0, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, 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 Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

    isCanceled

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

    getException

    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, verify, verify, verify, verify

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

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

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

    setException

  • Constructor Details

    • DefaultAuthFuture

      public DefaultAuthFuture(Object id, Object lock)

  • Method Details

    • verify

      public AuthFuture verify(long timeoutMillis, org.apache.sshd.common.future.CancelOption... options) throws IOException
      Specified by:
      verify in interface org.apache.sshd.common.future.VerifiableFuture<AuthFuture>
      Throws:
      IOException

    • 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

    • cancel

      public org.apache.sshd.common.future.CancelFuture cancel()
      Note that returned CancelFuture may also be fulfilled unsuccessfully (i.e., (DefaultSshFuture.isDone() && !DefaultCancellableSshFuture.isCanceled()) == true.
      Specified by:
      cancel in interface org.apache.sshd.common.future.Cancellable
      Overrides:
      cancel in class org.apache.sshd.common.future.DefaultCancellableSshFuture<AuthFuture>
      Returns:
      A CancelFuture that can be used to wait until the cancellation has been effected or the AuthFuture has been fulfilled; never null.

    • getCancellation

      public org.apache.sshd.common.future.CancelFuture getCancellation()
      Specified by:
      getCancellation in interface org.apache.sshd.common.future.Cancellable
      Overrides:
      getCancellation in class org.apache.sshd.common.future.DefaultCancellableSshFuture<AuthFuture>

    • wasCanceled

      public boolean wasCanceled()
      Description copied from interface: AuthFuture
      Tells whether Cancellable.cancel() was called on this AuthFuture.

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

      Specified by:
      wasCanceled in interface AuthFuture
      Returns:
      true if Cancellable.cancel() was called, false otherwise

    • setCancellable

      public void setCancellable(boolean cancellable)
      Description copied from interface: AuthFuture
      Enables or disables cancellation of this AuthFuture.

      This is a framework method; do not call directly.

      Specified by:
      setCancellable in interface AuthFuture
      Parameters:
      cancellable - whether this future is currently cancellable