com.vaadin.server.WrappedSession Maven / Gradle / Ivy
/*
* Vaadin Framework 7
*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.server;
import java.io.Serializable;
import java.util.Set;
import javax.servlet.http.HttpSession;
/**
* A generic session, wrapping a more specific session implementation, e.g.
* {@link HttpSession} or {@code PortletSession}.
*
*
* @author Vaadin Ltd
* @version @VERSION@
* @since 7.0.0
*/
public interface WrappedSession extends Serializable {
/**
* Returns the maximum time interval, in seconds, that this session will be
* kept open between client accesses.
*
* @return an integer specifying the number of seconds this session remains
* open between client requests
*
* @see javax.servlet.http.HttpSession#getMaxInactiveInterval()
* @see javax.portlet.PortletSession#getMaxInactiveInterval()
*/
public int getMaxInactiveInterval();
/**
* Gets an attribute from this session.
*
* @param name
* the name of the attribute
* @return the attribute value, or null if the attribute is not
* defined in the session
*
* @see javax.servlet.http.HttpSession#getAttribute(String)
* @see javax.portlet.PortletSession#getAttribute(String)
*/
public Object getAttribute(String name);
/**
* Saves an attribute value in this session.
*
* @param name
* the name of the attribute
* @param value
* the attribute value
*
* @see javax.servlet.http.HttpSession#setAttribute(String, Object)
* @see javax.portlet.PortletSession#setAttribute(String, Object)
*/
public void setAttribute(String name, Object value);
/**
* Gets the current set of attribute names stored in this session.
*
* @return an unmodifiable set of the current attribute names
*
* @see HttpSession#getAttributeNames()
* @see PortletSession#getAttributeNames()
*/
public Set getAttributeNames();
/**
* Invalidates this session then unbinds any objects bound to it.
*
* @see HttpSession#invalidate()
* @see PortletSession#invalidate()
*/
public void invalidate();
/**
* Gets a string with a unique identifier for the session.
*
* @return a unique session id string
*
* @see HttpSession#getId()
* @see PortletSession#getId()
*/
public String getId();
/**
* 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
*
* @throws IllegalStateException
* if this method is called on an invalidated session
* @see HttpSession#getCreationTime()
* @see PortletSession#getCreationTime()
*/
public long getCreationTime();
/**
* Returns the last time the client sent a request associated with this
* session, as the number of milliseconds since midnight January 1, 1970
* GMT, and marked by the time the container received the request.
*
* 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
*
* @throws IllegalStateException
* if this method is called on an invalidated session
*
* @see HttpSession#getLastAccessedTime()
* @see PortletSession#getLastAccessedTime()
*/
public long getLastAccessedTime();
/**
* 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
* @throws IllegalStateException
* if this method is called on an invalidated session
* @see HttpSession#isNew()
* @see PortletSession#isNew()
*/
public boolean isNew();
/**
* 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.
*
* @param name
* the name of the object to remove from this session
* @throws IllegalStateException
* if this method is called on an invalidated session
* @see HttpSession#removeAttribute(String)
* @see PortletSession#removeAttribute(String)
*/
public void removeAttribute(String name);
/**
* 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
* @see HttpSession#setMaxInactiveInterval(int)
* @see PortletSession#setMaxInactiveInterval(int)
*/
public void setMaxInactiveInterval(int interval);
}