Class AuthPassword

java.lang.Object

net.schmizz.sshj.userauth.method.AbstractAuthMethod

net.schmizz.sshj.userauth.method.AuthPassword

All Implemented Interfaces:

SSHPacketHandler, AuthMethod

public class AuthPassword
extends AbstractAuthMethod

Implements the password authentication method. Password-change request handling is not currently supported.

Field Summary

Fields

Modifier and Type	Field	Description
private final PasswordUpdateProvider	newPasswordProvider
private static final PasswordUpdateProvider	nullProvider
private final PasswordFinder	pwdf

Fields inherited from class AbstractAuthMethod

log, params

Constructor Summary

Constructors

Constructor	Description
AuthPassword(PasswordFinder pwdf)
AuthPassword(PasswordFinder pwdf, PasswordUpdateProvider newPasswordProvider)

Method Summary

Modifier and Type	Method	Description
SSHPacket	buildReq()	Builds a SSHPacket containing the fields common to all authentication method.
void	handle(Message cmd, SSHPacket buf)	Delegate handling of some SSH packet to this object.
boolean	shouldRetry()	Returns true if the associated PasswordFinder tells that we should retry with a new password that it will supply.

Methods inherited from class AbstractAuthMethod

getName, init, makeAccountResource, request, setLoggerFactory

Methods inherited from class Object

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

Field Details

pwdf

private final PasswordFinder pwdf

nullProvider

private static final PasswordUpdateProvider nullProvider

newPasswordProvider

private final PasswordUpdateProvider newPasswordProvider

Constructor Details

AuthPassword

public AuthPassword(PasswordFinder pwdf)

AuthPassword

public AuthPassword(PasswordFinder pwdf,
 PasswordUpdateProvider newPasswordProvider)

Method Details

buildReq

public SSHPacket buildReq()
                   throws UserAuthException

Description copied from class: AbstractAuthMethod

Builds a SSHPacket containing the fields common to all authentication method. Method-specific fields can further be put into this buffer.

Overrides:

buildReq in class AbstractAuthMethod

Throws:

UserAuthException

handle

public void handle(Message cmd,
 SSHPacket buf)
            throws UserAuthException,
TransportException

Description copied from interface: SSHPacketHandler

Delegate handling of some SSH packet to this object.

Specified by:

handle in interface SSHPacketHandler

Overrides:

handle in class AbstractAuthMethod

Parameters:

cmd - the SSH message identifier

buf - SSHPacket containing rest of the request

Throws:

UserAuthException

TransportException

shouldRetry

public boolean shouldRetry()

Returns true if the associated PasswordFinder tells that we should retry with a new password that it will supply.

Specified by:

shouldRetry in interface AuthMethod

Overrides:

shouldRetry in class AbstractAuthMethod

Returns:

whether authentication should be reattempted if it failed.