com.maverick.ssh2
Class AuthenticationResult

java.lang.Object
  extended byjava.lang.Throwable
      extended bycom.maverick.ssh2.AuthenticationResult
All Implemented Interfaces:
java.io.Serializable

public class AuthenticationResult
extends java.lang.Throwable

Throwable class used by the AuthenticationProtocol to indicate that a authentication request has either been completed, failed or cancelled.

Author:
Lee David Painter
See Also:
Serialized Form

Constructor Summary
AuthenticationResult(int result)
          Construct an AuthenticationResult
AuthenticationResult(int result, java.lang.String auths)
          Construct an AuthenticationResult
 
Method Summary
 java.lang.String getAuthenticationMethods()
          Get the authentication methods that can be used.
 int getResult()
          Get the result of this authentication.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AuthenticationResult

public AuthenticationResult(int result)
Construct an AuthenticationResult

Parameters:
result -

AuthenticationResult

public AuthenticationResult(int result,
                            java.lang.String auths)
Construct an AuthenticationResult

Parameters:
result -
auths -
Method Detail

getResult

public int getResult()
Get the result of this authentication.

Returns:
one of the constants defined above

getAuthenticationMethods

public java.lang.String getAuthenticationMethods()
Get the authentication methods that can be used.

Returns:
a comma delimited list of authentication methods, for example "publickey,password"


Copyright © 2003-2008 SSHTools LTD. All Rights Reserved.