Package com.sshtools.client

Class PasswordAuthenticator

java.lang.Object

com.sshtools.common.ssh.AbstractRequestFuture

com.sshtools.client.SimpleClientAuthenticator

com.sshtools.client.PasswordAuthenticator

All Implemented Interfaces:

ClientAuthenticator, RequestFuture

public class PasswordAuthenticator
extends SimpleClientAuthenticator

Implements the password authentication method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PasswordAuthenticator.PasswordPrompt

Constructor Summary

Constructors

Constructor	Description
PasswordAuthenticator(char[] password)	Deprecated, for removal: This API element is subject to removal in a future version.
PasswordAuthenticator(String password)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	authenticate(TransportProtocolClient transport, String username)	Start the authentication
void	done(boolean success)
static PasswordAuthenticator	forPassword(char[] password)
static PasswordAuthenticator	forPassword(String password)
String	getName()	The authentication mechanism name/.
String	getPassword()
static PasswordAuthenticator	of(PasswordAuthenticator.PasswordPrompt password)

Methods inherited from class com.sshtools.client.SimpleClientAuthenticator

cancel, failure, getAuthenticationMethods, isCancelled, isMoreAuthenticationRequired, processMessage, success, success

Methods inherited from class com.sshtools.common.ssh.AbstractRequestFuture

addFutureListener, 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.common.ssh.RequestFuture

addFutureListener, isDone, isDoneAndSuccess, isSuccess, waitFor, waitForever

Constructor Details

PasswordAuthenticator

@Deprecated(forRemoval=true,
            since="3.1.3")
public PasswordAuthenticator(String password)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated. Use forPassword(String).

Parameters:

password -

PasswordAuthenticator

@Deprecated(forRemoval=true,
            since="3.1.3")
public PasswordAuthenticator(char[] password)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated. Use forPassword(char[]).

Parameters:

password -

Method Details

of

public static PasswordAuthenticator of(PasswordAuthenticator.PasswordPrompt password)

forPassword

public static PasswordAuthenticator forPassword(String password)

forPassword

public static PasswordAuthenticator forPassword(char[] password)

getPassword

public String getPassword()

done

public void done(boolean success)

Overrides:

done in class AbstractRequestFuture

authenticate

public void authenticate(TransportProtocolClient transport,
 String username)
                  throws SshException

Description copied from interface: ClientAuthenticator

Start the authentication

Throws:

SshException

getName

public String getName()

Description copied from interface: ClientAuthenticator

The authentication mechanism name/.

Returns: