org.apache.sshd.client.future
Class DefaultAuthFuture

java.lang.Object
  extended by org.apache.sshd.common.future.DefaultSshFuture<AuthFuture>
      extended by org.apache.sshd.client.future.DefaultAuthFuture
All Implemented Interfaces:
AuthFuture, SshFuture<AuthFuture>

public class DefaultAuthFuture
extends DefaultSshFuture<AuthFuture>
implements AuthFuture

A default implementation of AuthFuture.

Author:
Apache MINA SSHD Project

Constructor Summary
DefaultAuthFuture(Object lock)
           
 
Method Summary
 Throwable getException()
          Returns the cause of the connection failure.
 boolean isFailure()
          Returns false if the authentication operation failed.
 boolean isSuccess()
          Returns true if the authentication operation is finished successfully.
 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.
 
Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture
addListener, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, getValue, isCanceled, isDone, removeListener, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, isDone, removeListener
 

Constructor Detail

DefaultAuthFuture

public DefaultAuthFuture(Object lock)
Method Detail

getException

public Throwable getException()
Description copied from interface: AuthFuture
Returns the cause of the connection failure.

Specified by:
getException in interface AuthFuture
Returns:
null if the connect operation is not finished yet, or if the connection attempt is successful.

isSuccess

public boolean isSuccess()
Description copied from interface: AuthFuture
Returns true if the authentication operation is finished successfully.

Specified by:
isSuccess in interface AuthFuture

isFailure

public boolean isFailure()
Description copied from interface: AuthFuture
Returns false if the authentication operation failed.

Specified by:
isFailure in interface AuthFuture

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

setException

public void setException(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


Copyright © 2008-2012 Apache Software Foundation. All Rights Reserved.