com.sshtools.client

Class SimpleClientAuthenticator

java.lang.Object

com.sshtools.common.ssh.AbstractRequestFuture

com.sshtools.client.SimpleClientAuthenticator

All Implemented Interfaces:

ClientAuthenticator, RequestFuture

Direct Known Subclasses:

ExternalKeyAuthenticator, KeyboardInteractiveAuthenticator, NoneAuthenticator, PasswordAuthenticator, PublicKeyAuthenticator

public abstract class SimpleClientAuthenticator
extends AbstractRequestFuture
implements ClientAuthenticator

A simple base class for implementing non-interactive authentication methods. Use when the authentication method consists of a single message sent to the server.

Constructor Summary

Constructors

Constructor and Description
SimpleClientAuthenticator()

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	failure() Called by the API to indicate authentication failure.
java.lang.String[]	getAuthenticationMethods()
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 class com.sshtools.common.ssh.AbstractRequestFuture

addFutureListener, done, isDone, isSuccess, waitFor, waitForever

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sshtools.client.ClientAuthenticator

authenticate, getName

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

addFutureListener, isDone, isSuccess, waitFor, waitForever

Constructor Detail

SimpleClientAuthenticator

public SimpleClientAuthenticator()

Method Detail

processMessage

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

Description copied from interface: ClientAuthenticator

Process an authentication message.

Specified by:

processMessage in interface ClientAuthenticator

Returns:

Throws:

java.io.IOException

SshException

isMoreAuthenticationRequired

public boolean isMoreAuthenticationRequired()

Specified by:

isMoreAuthenticationRequired in interface ClientAuthenticator

getAuthenticationMethods

public java.lang.String[] getAuthenticationMethods()

Specified by:

getAuthenticationMethods in interface ClientAuthenticator

success

public void success()

Description copied from interface: ClientAuthenticator

Called by the API to indicate authentication success.

Specified by:

success in interface ClientAuthenticator

success

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

Specified by:

success in interface ClientAuthenticator

failure

public void failure()

Description copied from interface: ClientAuthenticator

Called by the API to indicate authentication failure.

Specified by:

failure in interface ClientAuthenticator

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface ClientAuthenticator

cancel

public void cancel()

Specified by:

cancel in interface ClientAuthenticator