org.simpleframework.http.session.SessionProvider Maven / Gradle / Ivy
/*
* SessionProvider.java May 2007
*
* Copyright (C) 2007, Niall Gallagher
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
package org.simpleframework.http.session;
/**
* The SessionProvider object is used to create sessions
* that are active for a given time period. Each session is referenced
* using a unique key, and only one session exists per key at a time.
* Once a session has been created it remains active for a fixed time
* period, this time period is renewed each time that session is open.
*
* When the session provider is no longer required it can be closed.
* Closing the session provider will cancel and destroy all active
* sessions, and release all resources occupied by the provider such
* as threads and memory. Typically it is advisable to close a provider
* when it is not longer required by the application.
*
* @author Niall Gallagher
*/
public interface SessionProvider {
/**
* This open method is used to either open an existing
* session or create a new session if one does not exist. This is
* always guaranteed to open a session. Upon each open for a given
* sesion that sessions expiry is renewed for a fixed period of
* time, typically this is several minutes long.
*
* @param key the unique key identifying the session instance
*
* @return returns either a new session object or an existing
*
* @throws Exception if the keyed session can not be retrieved
*/
public Session open(T key) throws Exception;
/**
* This open method is used to either open an existing
* session or create a new session if requested. This is used to
* optionally create a new session if one does not already exist.
* This is used in situations where a session might not be required
* but the existance of one may be queried. Once created a session
* is active for a fixed time period.
*
* @param key the unique key identifying the session instance
*
* @return returns either a new session object or an existing one
*
* @throws Exception if the keyed session can not be retrieved
*/
public Session open(T key, boolean create) throws Exception;
/**
* This close method is used to close the provider and
* release all resources associated with it. This includes canceling
* all active sessions and emptying the contents of those sessions.
* All threads and other such resources are released by this method.
*
* @throws Exception if the session provider can not be shutdown
*/
public void close() throws Exception;
}