com.opensymphony.user.authenticator
Interface Authenticator

All Known Implementing Classes:

AbstractAuthenticator

public interface Authenticator

Interface describing how to authenicate a user.

Author:

Mike Cannon-Brookes

Method Summary

boolean	init(java.util.Properties properties) Called by UserManager before any other method.
boolean	login(java.lang.String username, java.lang.String password) Login a user via a username and password
boolean	login(java.lang.String username, java.lang.String password, javax.servlet.http.HttpServletRequest req)

Method Detail

login

public boolean login(java.lang.String username,
                     java.lang.String password)
              throws AuthenticationException

Login a user via a username and password

Returns:

Whether or not login was successful.

Throws:

AuthenticationException

init

public boolean init(java.util.Properties properties)

Called by UserManager before any other method. Allows for Authenticator specific initialization.

Parameters:

properties - Extra properties passed across by UserManager.

login

public boolean login(java.lang.String username,
                     java.lang.String password,
                     javax.servlet.http.HttpServletRequest req)
              throws AuthenticationException

Throws:

AuthenticationException