package org.restafarian.core.security;

 import javax.servlet.ServletContext;

 import javax.servlet.http.HttpServletRequest;

 import javax.servlet.http.HttpServletResponse;

 import org.apache.commons.configuration.Configuration;

 import org.restafarian.core.beans.Person;

 /**

  * <p>This interface specifies the required methods for a user manager.</p>

  */

 public interface UserManager {

         /**

          * <p>Initializes the module using the configuration.</p>

          *

          * @param context the <code>ServletContext</code> object

          * @param config the <code>Configuration</code> object

          */

         public void init(ServletContext context, Configuration config);

         /**

          * <p>Returns the currently authenticated user, or null, if there is

          * no user currently authenticated.</p>

          *

          * @param req the <code>HttpServletRequest</code> object

          * @return the currently authenticated user

          */

         public Person getAuthenticatedUser(HttpServletRequest req);

         /**

          * <p>Sets the currently authenticated user.</p>

          *

          * @param req the <code>HttpServletRequest</code> object

          * @param res the <code>HttpServletResponse</code> object

          * @param user the currently authenticated user

          */

         public void setAuthenticatedUser(HttpServletRequest req, HttpServletResponse res, Person user);

 }