AuthPolicy


1   /* 
2    * Copyright (C) 2006 Methodhead Software LLC.  All rights reserved.
3    * 
4    * This file is part of TransferCM.
5    * 
6    * TransferCM is free software; you can redistribute it and/or modify it under the
7    * terms of the GNU General Public License as published by the Free Software
8    * Foundation; either version 2 of the License, or (at your option) any later
9    * version.
10   * 
11   * TransferCM is distributed in the hope that it will be useful, but WITHOUT ANY
12   * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13   * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
14   * details.
15   * 
16   * You should have received a copy of the GNU General Public License along with
17   * TransferCM; if not, write to the Free Software Foundation, Inc., 51 Franklin St,
18   * Fifth Floor, Boston, MA  02110-1301  USA
19   */
20  
21  package com.methodhead.auth;
22  
23  import javax.servlet.http.HttpServletRequest  ;
24  import org.apache.struts.action.ActionForm;
25  import com.methodhead.util.OperationContext;
26  
27  /**
28   * Provides factory and authentication methods for <tt>com.methodhead.auth</tt>
29   * operations.
30   */
31  public interface AuthPolicy {
32  
33    // constants ////////////////////////////////////////////////////////////////
34  
35    // constructors /////////////////////////////////////////////////////////////
36  
37    // methods //////////////////////////////////////////////////////////////////
38  
39    /**
40     * Instantiates a new user object.
41     */
42    public AuthUser newUser();
43  
44    /**
45     * Called when a user is logged in using cookie information.  When this
46     * method is called, the user has already been successfully authenticated,
47     * but is not yet logged in.  This method should return <code>true</code> to
48     * successfully log the user in.  If <code>false</code> is returned, the user
49     * is forwarded to the login screen.
50     */
51    public boolean autoLogin(
52      AuthUser user,
53      HttpServletRequest   request,
54      ActionForm form );
55  }
56
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags