com.jivesoftware.spi.user
Interface AuthenticationProvider

All Superinterfaces:

ServiceProvider

public interface AuthenticationProvider
extends ServiceProvider

Service for authenticating and identifying users.

See Also:

ServiceProvider, User

Method Summary

java.lang.String	getUsername(javax.servlet.http.HttpServletRequest req)
void	login(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, User user)
void	logout(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, User user)

Methods inherited from interface com.jivesoftware.spi.ServiceProvider

destroy, getConfigurationMap, initialize

Method Detail

login

void login(javax.servlet.http.HttpServletRequest req,
           javax.servlet.http.HttpServletResponse res,
           User user)
           throws javax.naming.AuthenticationException

Parameters:

req - HttpRequest to let the service provider encode/decode any session specific information

res - HttpRequest to let the service provider encode/decode any session specific information

user - User object containing user credentials, could be null if no credentails were available at the time this call was made.

Throws:

javax.naming.AuthenticationException - Contains information about authentication failure

logout

void logout(javax.servlet.http.HttpServletRequest req,
            javax.servlet.http.HttpServletResponse res,
            User user)

Parameters:

req - HttpRequest to let the service provider clean up the any session specific info in the request.

res - HttpResponse to let the service provider clean up the any session specific info in the request.

user - User object containing user credentials. Could be null if no user credentials were available when this call was made.

getUsername

java.lang.String getUsername(javax.servlet.http.HttpServletRequest req)

Parameters:

req - HttpRequest that contains user information.

Returns:

user User object containing user credentials