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.Service;
027:
028: /**
029: * The SessionService allows access to the current sessions of the current context.
030: * The session objects that are cached by this service are obtained through
031: * a listener. The listener must be configured in your web.xml file.
032: *
033: * @author <a href="mailto:quintonm@bellsouth.net">Quinton McCombs</a>
034: * @since 2.3
035: * @see org.apache.turbine.services.session.SessionListener
036: * @version $Id: SessionService.java 534527 2007-05-02 16:10:59Z tv $
037: */
038: public interface SessionService extends Service {
039:
040: /**
041: * The key under which this service is stored in TurbineServices.
042: */
043: String SERVICE_NAME = "SessionService";
044:
045: /**
046: * Gets all active sessions
047: *
048: * @return Collection of HttpSession objects
049: */
050: Collection getActiveSessions();
051:
052: /**
053: * Adds a session to the current list. This method should only be
054: * called by the listener.
055: *
056: * @param session Session to add
057: */
058: void addSession(HttpSession session);
059:
060: /**
061: * Removes a session from the current list. This method should only be
062: * called by the listener.
063: *
064: * @param session Session to remove
065: */
066: void removeSession(HttpSession session);
067:
068: /**
069: * Determines if a given user is currently logged in. The actual
070: * implementation of the User object must implement the equals()
071: * method. By default, Torque based objects (liek TurbineUser)
072: * have an implementation of equals() that will compare the
073: * result of getPrimaryKey().
074: *
075: * @param user User to check for
076: * @return true if the user is logged in on one of the
077: * active sessions.
078: */
079: boolean isUserLoggedIn(User user);
080:
081: /**
082: * Gets a collection of all user objects representing the users currently
083: * logged in. This will exclude any instances of anonymous user that
084: * Turbine will use before the user actually logs on.
085: *
086: * @return collection of org.apache.turbine.om.security.User objects
087: */
088: Collection getActiveUsers();
089:
090: /**
091: * Gets the User object of the the specified HttpSession.
092: *
093: * @param session The session from which to extract a user.
094: * @return The Turbine User object.
095: */
096: User getUserFromSession(HttpSession session);
097:
098: /**
099: * Gets the HttpSession by the session identifier
100: *
101: * @param sessionId The unique session identifier.
102: * @return The session keyed by the specified identifier.
103: */
104: HttpSession getSession(String sessionId);
105:
106: /**
107: * Get a collection of all session on which the given user
108: * is logged in.
109: *
110: * @param user the user
111: * @return Collection of HtttSession objects
112: */
113: Collection getSessionsForUser(User user);
114:
115: }
|