org.simpleframework.http.session.Session Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simple

Simple is a high performance asynchronous HTTP server for Java

There is a newer version: 5.1.6

/*
 * Session.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;

import java.util.Map;

import org.simpleframework.util.lease.Lease;

/**
 * The Session object is a simple leased container for
 * state within a web application. This is essentially a map of key
 * value pairs leased on a fixed duration to ensure it remains active
 * between we requests. If the session remains idle for sufficiently
 * long then it is disposed of by the SessionProvider 
 * so that resources occupied can be released.   
 * 
 * @author Niall Gallagher
 * 
 * @see org.simpleframework.util.lease.Lease
 */
public interface Session extends Map {  
   
  /**
   * This is used to acquire the Lease object to control
   * the session. The lease is responsible for maintaining this map
   * within the application. Once the lease expires the session will
   * be removed and its mapped values will be available for recovery.
   * 
   * @return this returns the lease used to manage this session
   */
  public Lease getLease();  
}