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
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 -
Method Summary
Modifier and TypeMethodDescriptionReturns the cause of the authentication failure.boolean
boolean
void
setAuthed
(boolean authed) Notifies that the session has been authenticated.void
setException
(Throwable exception) Sets the exception caught due to connection failure and notifies all threads waiting for this future.verify
(long timeoutMillis) Wait and verify that the operation was successfulMethods 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 Details
-
DefaultAuthFuture
-
-
Method Details
-
verify
Description copied from interface:VerifiableFuture
Wait and verify that the operation was successful- Specified by:
verify
in interfaceVerifiableFuture<AuthFuture>
- Parameters:
timeoutMillis
- Wait timeout in milliseconds- Returns:
- The (same) future instance
- Throws:
IOException
- If failed to verify successfully on time
-
getException
Description copied from interface:AuthFuture
Returns the cause of the authentication failure.- Specified by:
getException
in interfaceAuthFuture
- Returns:
null
if the authentication operation is not finished yet, or if the connection attempt is successful (useWaitableFuture.isDone()
to distinguish between the two).
-
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
-
setException
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 interfaceAuthFuture
- Parameters:
exception
- The caughtThrowable
-