001: package org.apache.turbine.services.session;
002:
003: /*
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021:
022: import java.util.Collection;
023: import javax.servlet.http.HttpSession;
024:
025: import org.apache.turbine.om.security.User;
026: import org.apache.turbine.services.TurbineServices;
027:
028: /**
029: * This is a conveience class provided to allow access to the SessionService
030: * through static methods. The SessionService should ALWAYS be accessed
031: * through this class.
032: *
033: * @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a>
034: * @version $Id: TurbineSession.java 534527 2007-05-02 16:10:59Z tv $
035: * @see org.apache.turbine.services.session.SessionService
036: */
037: public abstract class TurbineSession {
038: /**
039: * Gets a list of the active sessions
040: *
041: * @return List of HttpSession objects
042: */
043: public static Collection getActiveSessions() {
044: return getService().getActiveSessions();
045: }
046:
047: /**
048: * Adds a session to the current list. This method should only be
049: * called by the listener.
050: *
051: * @param session Session to add
052: */
053: public static void addSession(HttpSession session) {
054: getService().addSession(session);
055: }
056:
057: /**
058: * Removes a session from the current list. This method should only be
059: * called by the listener.
060: *
061: * @param session Session to remove
062: */
063: public static void removeSession(HttpSession session) {
064: getService().removeSession(session);
065: }
066:
067: /**
068: * Determines if a given user is currently logged in. The actual
069: * implementation of the User object must implement the equals()
070: * method. By default, Torque based objects (liek TurbineUser)
071: * have an implementation of equals() that will compare the
072: * result of getPrimaryKey().
073: *
074: * @param user User to check for
075: * @return true if the user is logged in on one of the
076: * active sessions.
077: */
078: public static boolean isUserLoggedIn(User user) {
079: return getService().isUserLoggedIn(user);
080: }
081:
082: /**
083: * Gets a collection of all user objects representing the users currently
084: * logged in. This will exclude any instances of anonymous user that
085: * Turbine will use before the user actually logs on.
086: *
087: * @return collection of org.apache.turbine.om.security.User objects
088: */
089: public static Collection getActiveUsers() {
090: return getService().getActiveUsers();
091: }
092:
093: /**
094: * Utility method for accessing the service
095: * implementation
096: *
097: * @return a IntakeService implementation instance
098: */
099: private static SessionService getService() {
100: return (SessionService) TurbineServices.getInstance()
101: .getService(SessionService.SERVICE_NAME);
102: }
103:
104: /**
105: * Gets the User object of the the specified HttpSession.
106: *
107: * @param session
108: * @return
109: */
110: public static User getUserFromSession(HttpSession session) {
111: return getService().getUserFromSession(session);
112: }
113:
114: /**
115: * Gets the HttpSession by the session identifier
116: *
117: * @param sessionId
118: * @return
119: */
120: public static HttpSession getSession(String sessionId) {
121: return getService().getSession(sessionId);
122: }
123:
124: /**
125: * Get a collection of all session on which the given user
126: * is logged in.
127: *
128: * @param user the user
129: * @return Collection of HtttSession objects
130: */
131: public static Collection getSessionsForUser(User user) {
132: return getService().getSessionsForUser(user);
133: }
134: }
|