| package org.apache.turbine.services.session; |
| |
| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2001-2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" and |
| * "Apache Turbine" must not be used to endorse or promote products |
| * derived from this software without prior written permission. For |
| * written permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * "Apache Turbine", nor may "Apache" appear in their name, without |
| * prior written permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| import java.util.Collection; |
| import javax.servlet.http.HttpSession; |
| |
| import org.apache.turbine.om.security.User; |
| import org.apache.turbine.services.TurbineServices; |
| |
| /** |
| * This is a conveience class provided to allow access to the SessionService |
| * through static methods. The SessionService should ALWAYS be accessed |
| * through this class. |
| * |
| * @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a> |
| * @version $Id$ |
| * @see org.apache.turbine.services.session.SessionService |
| */ |
| public abstract class TurbineSession |
| { |
| /** |
| * Gets a list of the active sessions |
| * |
| * @return List of HttpSession objects |
| */ |
| public static Collection getActiveSessions() |
| { |
| return getService().getActiveSessions(); |
| } |
| |
| /** |
| * Adds a session to the current list. This method should only be |
| * called by the listener. |
| * |
| * @param session Session to add |
| */ |
| public static void addSession(HttpSession session) |
| { |
| getService().addSession(session); |
| } |
| |
| /** |
| * Removes a session from the current list. This method should only be |
| * called by the listener. |
| * |
| * @param session Session to remove |
| */ |
| public static void removeSession(HttpSession session) |
| { |
| getService().removeSession(session); |
| } |
| |
| /** |
| * Determines if a given user is currently logged in. The actual |
| * implementation of the User object must implement the equals() |
| * method. By default, Torque based objects (liek TurbineUser) |
| * have an implementation of equals() that will compare the |
| * result of getPrimaryKey(). |
| * |
| * @param user User to check for |
| * @return true if the user is logged in on one of the |
| * active sessions. |
| */ |
| public static boolean isUserLoggedIn(User user) |
| { |
| return getService().isUserLoggedIn(user); |
| } |
| |
| /** |
| * Gets a collection of all user objects representing the users currently |
| * logged in. This will exclude any instances of anonymous user that |
| * Turbine will use before the user actually logs on. |
| * |
| * @return collection of org.apache.turbine.om.security.User objects |
| */ |
| public static Collection getActiveUsers() |
| { |
| return getService().getActiveUsers(); |
| } |
| |
| /** |
| * Utility method for accessing the service |
| * implementation |
| * |
| * @return a IntakeService implementation instance |
| */ |
| private static SessionService getService() |
| { |
| return (SessionService) TurbineServices |
| .getInstance().getService(SessionService.SERVICE_NAME); |
| } |
| |
| /** |
| * Gets the User object of the the specified HttpSession. |
| * |
| * @param session |
| * @return |
| */ |
| public static User getUserFromSession(HttpSession session) |
| { |
| return getService().getUserFromSession(session); |
| } |
| |
| /** |
| * Gets the HttpSession by the session identifier |
| * |
| * @param sessionId |
| * @return |
| */ |
| public static HttpSession getSession(String sessionId) |
| { |
| return getService().getSession(sessionId); |
| } |
| |
| /** |
| * Get a collection of all session on which the given user |
| * is logged in. |
| * |
| * @param user the user |
| * @return Collection of HtttSession objects |
| */ |
| public static Collection getSessionsForUser(User user) |
| { |
| return getService().getSessionsForUser(user); |
| } |
| } |