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