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<T>
org.apache.sshd.common.future.DefaultCancellableSshFuture<AuthFuture>
org.apache.sshd.client.future.DefaultAuthFuture
- All Implemented Interfaces:
AuthFuture
,Cancellable
,SshFuture<AuthFuture>
,VerifiableFuture<AuthFuture>
,WaitableFuture
,WithException
public class DefaultAuthFuture
extends 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
-
Method Summary
Modifier and TypeMethodDescriptioncancel()
Note that returnedCancelFuture
may also be fulfilled unsuccessfully (i.e., (DefaultSshFuture.isDone()
&& !
DefaultCancellableSshFuture.isCanceled()
) == true
.boolean
boolean
void
setAuthed
(boolean authed) Notifies that the session has been authenticated.void
setCancellable
(boolean cancellable) Enables or disables cancellation of thisAuthFuture
.verify
(long timeoutMillis, CancelOption... options) boolean
Tells whetherCancellable.cancel()
was called on thisAuthFuture
.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 java.lang.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.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
Methods inherited from interface org.apache.sshd.common.future.WithException
getException, setException
-
Constructor Details
-
DefaultAuthFuture
-
-
Method Details
-
verify
- Specified by:
verify
in interfaceVerifiableFuture<AuthFuture>
- Throws:
IOException
-
isSuccess
public boolean isSuccess()- Specified by:
isSuccess
in interfaceAuthFuture
- Returns:
true
if the authentication operation is finished successfully. Note: calling this method while the operation is in progress returnsfalse
. Should checkWaitableFuture.isDone()
in order to ensure that the result is valid.
-
isFailure
public boolean isFailure()- Specified by:
isFailure
in interfaceAuthFuture
- 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 checkWaitableFuture.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 interfaceAuthFuture
- Parameters:
authed
- Authentication success state
-
cancel
Note that returnedCancelFuture
may also be fulfilled unsuccessfully (i.e., (DefaultSshFuture.isDone()
&& !
DefaultCancellableSshFuture.isCanceled()
) == true
.- Specified by:
cancel
in interfaceCancellable
- Overrides:
cancel
in classDefaultCancellableSshFuture<AuthFuture>
- Returns:
- A
CancelFuture
that can be used to wait until the cancellation has been effected or theAuthFuture
has been fulfilled; nevernull
.
-
getCancellation
- Specified by:
getCancellation
in interfaceCancellable
- Overrides:
getCancellation
in classDefaultCancellableSshFuture<AuthFuture>
-
wasCanceled
public boolean wasCanceled()Description copied from interface:AuthFuture
Tells whetherCancellable.cancel()
was called on thisAuthFuture
.This is different from
Cancellable.isCanceled()
. Cancelling 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 theCancelFuture
may actually beisCanceled()
== false
.AuthFuture
.Cancellable.isCanceled()
is thenfalse
, too.- Specified by:
wasCanceled
in interfaceAuthFuture
- Returns:
true
ifCancellable.cancel()
was called,false
otherwise
-
setCancellable
public void setCancellable(boolean cancellable) Description copied from interface:AuthFuture
Enables or disables cancellation of thisAuthFuture
.This is a framework method; do not call directly.
- Specified by:
setCancellable
in interfaceAuthFuture
- Parameters:
cancellable
- whether this future is currently cancellable
-