com.sshtools.client

Interface ClientAuthenticator

All Superinterfaces:

RequestFuture

All Known Implementing Classes:

ExternalKeyAuthenticator, KeyboardInteractiveAuthenticator, KeyPairAuthenticator, NoneAuthenticator, PasswordAuthenticator, PrivateKeyFileAuthenticator, PublicKeyAuthenticator, SimpleClientAuthenticator

public interface ClientAuthenticator
extends RequestFuture

Base interface for all client authentication methods.

Method Summary

Modifier and Type	Method and Description
void	authenticate(TransportProtocolClient transport, java.lang.String username) Start the authentication
void	cancel()
void	failure() Called by the API to indicate authentication failure.
java.lang.String[]	getAuthenticationMethods()
java.lang.String	getName() The authentication mechanism name/.
boolean	isCancelled()
boolean	isMoreAuthenticationRequired()
boolean	processMessage(com.sshtools.common.util.ByteArrayReader msg) Process an authentication message.
void	success() Called by the API to indicate authentication success.
void	success(boolean moreAuthenticationsRequired, java.lang.String[] authenticationMethods)

Methods inherited from interface com.sshtools.common.ssh.RequestFuture

addFutureListener, isDone, isSuccess, waitFor, waitForever

Method Detail

getName

java.lang.String getName()

The authentication mechanism name/.

Returns:

authenticate

void authenticate(TransportProtocolClient transport,
                  java.lang.String username)
           throws java.io.IOException,
                  SshException

Start the authentication

Parameters:

transport -

username -

Throws:

java.io.IOException

SshException

processMessage

boolean processMessage(com.sshtools.common.util.ByteArrayReader msg)
                throws java.io.IOException,
                       SshException

Process an authentication message.

Parameters:

msg -

Returns:

Throws:

java.io.IOException

SshException

success

void success()

Called by the API to indicate authentication success.

failure

void failure()

Called by the API to indicate authentication failure.

isMoreAuthenticationRequired

boolean isMoreAuthenticationRequired()

isCancelled

boolean isCancelled()

cancel

void cancel()

getAuthenticationMethods

java.lang.String[] getAuthenticationMethods()

success

void success(boolean moreAuthenticationsRequired,
             java.lang.String[] authenticationMethods)