All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.servlet.http.HttpSession Maven / Gradle / Ivy

The newest version!
/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights 
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:  
 *       "This product includes software developed by the 
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written 
 *    permission, please contact [email protected].
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * .
 *
 * ====================================================================
 *
 * This source code implements specifications defined by the Java
 * Community Process. In order to remain compliant with the specification
 * DO NOT add / change / or delete method signatures!
 */

package javax.servlet.http;

import java.util.Enumeration;

/**
 *
 * Provides a way to identify a user across more than one page
 * request or visit to a Web site and to store information about that user.
 *
 * 

The servlet container uses this interface to create a session * between an HTTP client and an HTTP server. The session persists * for a specified time period, across more than one connection or * page request from the user. A session usually corresponds to one * user, who may visit a site many times. The server can maintain a * session in many ways such as using cookies or rewriting URLs. * *

This interface allows servlets to *

    *
  • View and manipulate information about a session, such as * the session identifier, creation time, and last accessed time *
  • Bind objects to sessions, allowing user information to persist * across multiple user connections *
* *

When an application stores an object in or removes an object from a * session, the session checks whether the object implements * {@link HttpSessionBindingListener}. If it does, * the servlet notifies the object that it has been bound to or unbound * from the session. * *

A servlet should be able to handle cases in which * the client does not choose to join a session, such as when cookies are * intentionally turned off. Until the client joins the session, * isNew returns true. If the client chooses * not to join * the session, getSession will return a different session * on each request, and isNew will always return * true. * *

Session information is scoped only to the current web application * (ServletContext), so information stored in one context * will not be directly visible in another. * * @author Various * @version $Version$ * * * @see HttpSessionBindingListener * @see HttpSessionContext * */ public interface HttpSession { /** * * Returns the time when this session was created, measured * in milliseconds since midnight January 1, 1970 GMT. * * @return a long specifying * when this session was created, * expressed in * milliseconds since 1/1/1970 GMT * * @exception IllegalStateException if this method is called on an * invalidated session * */ public long getCreationTime(); /** * * Returns a string containing the unique identifier assigned * to this session. The identifier is assigned * by the servlet container and is implementation dependent. * * @return a string specifying the identifier * assigned to this session * * @exeption IllegalStateException if this method is called on an * invalidated session * */ public String getId(); /** * * Returns the last time the client sent a request associated with * this session, as the number of milliseconds since midnight * January 1, 1970 GMT. * *

Actions that your application takes, such as getting or setting * a value associated with the session, do not affect the access * time. * * @return a long * representing the last time * the client sent a request associated * with this session, expressed in * milliseconds since 1/1/1970 GMT * * @exeption IllegalStateException if this method is called on an * invalidated session * */ public long getLastAccessedTime(); /** * * Specifies the time, in seconds, between client requests before the * servlet container will invalidate this session. A negative time * indicates the session should never timeout. * * @param interval An integer specifying the number * of seconds * */ public void setMaxInactiveInterval(int interval); /** * Returns the maximum time interval, in seconds, that * the servlet container will keep this session open between * client accesses. After this interval, the servlet container * will invalidate the session. The maximum time interval can be set * with the setMaxInactiveInterval method. * A negative time indicates the session should never timeout. * * * @return an integer specifying the number of * seconds this session remains open * between client requests * * @see #setMaxInactiveInterval * * */ public int getMaxInactiveInterval(); /** * * @deprecated As of Version 2.1, this method is * deprecated and has no replacement. * It will be removed in a future * version of the Java Servlet API. * */ public HttpSessionContext getSessionContext(); /** * * Returns the object bound with the specified name in this session, or * null if no object is bound under the name. * * @param name a string specifying the name of the object * * @return the object with the specified name * * @exception IllegalStateException if this method is called on an * invalidated session * */ public Object getAttribute(String name); /** * * @deprecated As of Version 2.2, this method is * replaced by {@link #getAttribute}. * * @param name a string specifying the name of the object * * @return the object with the specified name * * @exception IllegalStateException if this method is called on an * invalidated session * */ public Object getValue(String name); /** * * Returns an Enumeration of String objects * containing the names of all the objects bound to this session. * * @return an Enumeration of * String objects specifying the * names of all the objects bound to * this session * * @exception IllegalStateException if this method is called on an * invalidated session * */ public Enumeration getAttributeNames(); /** * * @deprecated As of Version 2.2, this method is * replaced by {@link #getAttributeNames} * * @return an array of String * objects specifying the * names of all the objects bound to * this session * * @exception IllegalStateException if this method is called on an * invalidated session * */ public String[] getValueNames(); /** * Binds an object to this session, using the name specified. * If an object of the same name is already bound to the session, * the object is replaced. * *

After this method executes, and if the object * implements HttpSessionBindingListener, * the container calls * HttpSessionBindingListener.valueBound. * * @param name the name to which the object is bound; * cannot be null * * @param value the object to be bound; cannot be null * * @exception IllegalStateException if this method is called on an * invalidated session * */ public void setAttribute(String name, Object value); /** * * @deprecated As of Version 2.2, this method is * replaced by {@link #setAttribute} * * @param name the name to which the object is bound; * cannot be null * * @param value the object to be bound; cannot be null * * @exception IllegalStateException if this method is called on an * invalidated session * */ public void putValue(String name, Object value); /** * * Removes the object bound with the specified name from * this session. If the session does not have an object * bound with the specified name, this method does nothing. * *

After this method executes, and if the object * implements HttpSessionBindingListener, * the container calls * HttpSessionBindingListener.valueUnbound. * * * * @param name the name of the object to * remove from this session * * @exception IllegalStateException if this method is called on an * invalidated session */ public void removeAttribute(String name); /** * * @deprecated As of Version 2.2, this method is * replaced by {@link #removeAttribute} * * @param name the name of the object to * remove from this session * * @exception IllegalStateException if this method is called on an * invalidated session */ public void removeValue(String name); /** * * Invalidates this session and unbinds any objects bound * to it. * * @exception IllegalStateException if this method is called on an * already invalidated session * */ public void invalidate(); /** * * Returns true if the client does not yet know about the * session or if the client chooses not to join the session. For * example, if the server used only cookie-based sessions, and * the client had disabled the use of cookies, then a session would * be new on each request. * * @return true if the * server has created a session, * but the client has not yet joined * * @exception IllegalStateException if this method is called on an * already invalidated session * */ public boolean isNew(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy