org.apache.sshd.server.auth
Class UserAuthPassword

java.lang.Object
  org.apache.sshd.server.auth.UserAuthPassword

All Implemented Interfaces:

UserAuth

public class UserAuthPassword
extends java.lang.Object
implements UserAuth

TODO Add javadoc

Author:

Apache MINA SSHD Project

Nested Class Summary

static class

UserAuthPassword.Factory

Constructor Summary

UserAuthPassword()

Method Summary

java.lang.Boolean

auth(ServerSession session, java.lang.String username, Buffer buffer) Try to authenticate the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAuthPassword

public UserAuthPassword()

Method Detail

auth

public java.lang.Boolean auth(ServerSession session,
                              java.lang.String username,
                              Buffer buffer)
                       throws java.lang.Exception

Description copied from interface: UserAuth

Try to authenticate the user. This methods should return a non null object which is the user identity if the authentication succeeded. If the authentication failed, this method should throw an exception. If the authentication is still ongoing, a null value should be returned.

Specified by:

auth in interface UserAuth

Parameters:

session - the current ssh session

username - the user trying to log in

buffer - the request buffer containing parameters specific to this request

Returns:

true if the authentication succeeded, false if the authentication is not finished yet

Throws:

java.lang.Exception - if the authentication fails