org.restafarian.core.security
Interface UserManager

All Known Implementing Classes:

CookieBasedUserManager, DefaultUserManager, ServiceBasedUserManager, SessionBasedUserManager, SpringBasedUserManager

public interface UserManager

This interface specifies the required methods for a user manager.

Method Summary

Person	getAuthenticatedUser(javax.servlet.http.HttpServletRequest req) Returns the currently authenticated user, or null, if there is no user currently authenticated.
void	init(javax.servlet.ServletContext context, org.apache.commons.configuration.Configuration config) Initializes the module using the configuration.
void	setAuthenticatedUser(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, Person user) Sets the currently authenticated user.

Method Detail

init

void init(javax.servlet.ServletContext context,
          org.apache.commons.configuration.Configuration config)

Initializes the module using the configuration.

Parameters:

context - the ServletContext object

config - the Configuration object

getAuthenticatedUser

Person getAuthenticatedUser(javax.servlet.http.HttpServletRequest req)

Returns the currently authenticated user, or null, if there is no user currently authenticated.

Parameters:

req - the HttpServletRequest object

Returns:

the currently authenticated user

setAuthenticatedUser

void setAuthenticatedUser(javax.servlet.http.HttpServletRequest req,
                          javax.servlet.http.HttpServletResponse res,
                          Person user)

Sets the currently authenticated user.

Parameters:

req - the HttpServletRequest object

res - the HttpServletResponse object

user - the currently authenticated user