View Javadoc

1   // 
2   // Copyright (c) 2003, Caltha - Gajda, Krzewski, Mach, Potempski Sp.J. 
3   // All rights reserved. 
4   // 
5   // Redistribution and use in source and binary forms, with or without modification,  
6   // are permitted provided that the following conditions are met: 
7   //  
8   // * Redistributions of source code must retain the above copyright notice,  
9   //   this list of conditions and the following disclaimer. 
10  // * Redistributions in binary form must reproduce the above copyright notice,  
11  //   this list of conditions and the following disclaimer in the documentation  
12  //   and/or other materials provided with the distribution. 
13  // * Neither the name of the Caltha - Gajda, Krzewski, Mach, Potempski Sp.J.  
14  //   nor the names of its contributors may be used to endorse or promote products  
15  //   derived from this software without specific prior written permission. 
16  // 
17  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"  
18  // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED  
19  // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
20  // IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,  
21  // INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,  
22  // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
23  // OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,  
24  // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)  
25  // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE  
26  // POSSIBILITY OF SUCH DAMAGE. 
27  // 
28  
29  package org.objectledge.authentication;
30  
31  import java.security.Principal;
32  
33  import org.objectledge.context.Context;
34  import org.objectledge.pipeline.ProcessingException;
35  import org.objectledge.pipeline.Valve;
36  import org.objectledge.web.HttpContext;
37  import org.objectledge.web.WebConstants;
38  
39  /***
40   * Pipeline processing valve that sets the context variable describing currently authenticated user.
41   *
42   * @author <a href="mailto:pablo@caltha.pl">Pawel Potempski</a>
43   * @version $Id: AuthenticationValve.java,v 1.13 2005/07/22 17:25:47 pablo Exp $
44   */
45  public class AuthenticationValve 
46      implements Valve
47  {
48  	/*** the authentication component */
49  	private UserManager userManager;
50  	
51  	/***
52  	 * Constructor.
53  	 * 
54       * @param userManager the user manager component.
55  	 */
56  	public AuthenticationValve(UserManager userManager)
57  	{
58  		this.userManager = userManager;
59  	}
60  	
61      /***
62       * Run the pipeline valve - authenticate user.
63       * 
64       * @param context the thread's processing context.
65       * @throws ProcessingException if authentication failed.
66       */
67      public void process(Context context)
68          throws ProcessingException
69      {
70      	HttpContext httpContext = HttpContext.getHttpContext(context);
71      	Principal principal = (Principal)httpContext.getRequest().
72  			getSession().getAttribute(WebConstants.PRINCIPAL_SESSION_KEY);
73  		Principal anonymous = null;
74          try
75          {
76              anonymous = userManager.getAnonymousAccount();
77          }
78          catch(AuthenticationException e)
79          {
80              throw new ProcessingException("Failed to retrieve anonymous account");
81          }
82  		boolean authenticated = false;
83  		if(principal == null)
84  		{
85  			principal = anonymous;
86  		}
87  		else
88  		{
89  			authenticated = !principal.equals(anonymous);
90  		}
91          AuthenticationContext authenticationContext = new AuthenticationContext();
92          authenticationContext.setUserPrincipal(principal, authenticated);
93          context.setAttribute(AuthenticationContext.class, authenticationContext);
94          
95      	httpContext.getRequest().getSession().setAttribute(WebConstants.PRINCIPAL_SESSION_KEY, 
96              principal);
97      }
98  }