com.sshtools.ssh2

Class AuthenticationResult

java.lang.Object

java.lang.Throwable

com.sshtools.ssh2.AuthenticationResult

All Implemented Interfaces:

Serializable

public class AuthenticationResult
extends 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

Constructors

Constructor and Description
AuthenticationResult(int result) Construct an AuthenticationResult
AuthenticationResult(int result, String auths) Construct an AuthenticationResult

Method Summary

Methods

Modifier and Type	Method and Description
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

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, 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,
                    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 String getAuthenticationMethods()

Get the authentication methods that can be used.

Returns:

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