001    //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/security/session/SessionManager.java $
002    /*----------------------------------------------------------------------------
003     This file is part of deegree, http://deegree.org/
004     Copyright (C) 2001-2009 by:
005       Department of Geography, University of Bonn
006     and
007       lat/lon GmbH
008    
009     This library is free software; you can redistribute it and/or modify it under
010     the terms of the GNU Lesser General Public License as published by the Free
011     Software Foundation; either version 2.1 of the License, or (at your option)
012     any later version.
013     This library is distributed in the hope that it will be useful, but WITHOUT
014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016     details.
017     You should have received a copy of the GNU Lesser General Public License
018     along with this library; if not, write to the Free Software Foundation, Inc.,
019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020    
021     Contact information:
022    
023     lat/lon GmbH
024     Aennchenstr. 19, 53177 Bonn
025     Germany
026     http://lat-lon.de/
027    
028     Department of Geography, University of Bonn
029     Prof. Dr. Klaus Greve
030     Postfach 1147, 53001 Bonn
031     Germany
032     http://www.geographie.uni-bonn.de/deegree/
033    
034     e-mail: info@deegree.org
035    ----------------------------------------------------------------------------*/
036    package org.deegree.security.session;
037    
038    /**
039     * This exception shall be thrown when a session(ID) will be used that has been expired.
040     *
041     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth </a>
042     * @author last edited by: $Author: mschneider $
043     *
044     * @version $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $
045     */
046    public interface SessionManager {
047    
048        /**
049         * returns the session identified by its ID. If no session with the passed ID is known
050         * <tt>null</tt> will be returned. If the requested session isn't alive anymore it will be
051         * removed from the session manager
052         *
053         * @param id
054         * @return the session identified by its ID. If no session with the passed ID is known
055         *         <tt>null</tt> will be returned.
056         * @throws SessionStatusException
057         */
058        public Session getSessionByID( String id )
059                                throws SessionStatusException;
060    
061        /**
062         * returns the session assigned to the passed user. If no session is assigend to the passed user
063         * <tt>null</tt> will be returned. If the requested session isn't alive anymore it will be
064         * removed from the session manager
065         *
066         * @param user
067         * @return the session assigned to the passed user. If no session is assigend to the passed user
068         *         <tt>null</tt> will be returned.
069         * @throws SessionStatusException
070         */
071        public Session getSessionByUser( String user )
072                                throws SessionStatusException;
073    
074        /**
075         * adds a session to the session managment. the session will be stored within two lists. one
076         * addresses the session with its ID the other with its user name. If the session is anonymous
077         * it just will be stored in the first list.
078         *
079         * @param session
080         * @throws SessionStatusException
081         */
082        public void addSession( Session session )
083                                throws SessionStatusException;
084    
085        /**
086         * removes a session identified by its ID from the session managment. the removed session will
087         * be returned.
088         *
089         * @param id
090         * @return the session
091         */
092        public Session removeSessionByID( String id );
093    
094        /**
095         * removes all sessions that are expired from the session management
096         */
097        public void clearExpired();
098    
099    }