org.openqa.jetty.jetty.servlet

Interface SessionManager

All Superinterfaces:

LifeCycle, Serializable

All Known Implementing Classes:

AbstractSessionManager, HashSessionManager

public interface SessionManager
extends LifeCycle, Serializable

Session Manager. The API required to manage sessions for a servlet context.

Version:

$Id: SessionManager.java,v 1.18 2005/03/15 10:03:58 gregwilkins Exp $

Author:

Greg Wilkins

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SessionManager.Session

Field Summary

Fields

Modifier and Type	Field and Description
static String	__MaxAge Session Max Age.
static String	__SessionCookie Session cookie name.
static String	__SessionDomain Session Domain.
static String	__SessionPath Session Path.
static String	__SessionURL Session URL parameter name.
static String	__SessionUrlPrefix

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventListener(EventListener listener) Add an event listener.
boolean	getHttpOnly()
javax.servlet.http.HttpSession	getHttpSession(String id)
int	getMaxInactiveInterval()
boolean	getSecureCookies()
javax.servlet.http.Cookie	getSessionCookie(javax.servlet.http.HttpSession session, boolean requestIsSecure) Get a Cookie for a session.
void	initialize(ServletHandler handler)
javax.servlet.http.HttpSession	newHttpSession(javax.servlet.http.HttpServletRequest request)
void	removeEventListener(EventListener listener)
void	setMaxInactiveInterval(int seconds)

Methods inherited from interface org.openqa.jetty.util.LifeCycle

isStarted, start, stop

Field Detail

__SessionCookie

static final String __SessionCookie

Session cookie name. Defaults to JSESSIONID, but can be set with the org.openqa.jetty.jetty.servlet.SessionCookie system property.

__SessionURL

static final String __SessionURL

Session URL parameter name. Defaults to jsessionid, but can be set with the org.openqa.jetty.jetty.servlet.SessionURL system property.

__SessionUrlPrefix

static final String __SessionUrlPrefix

__SessionDomain

static final String __SessionDomain

Session Domain. If this property is set as a ServletContext InitParam, then it is used as the domain for session cookies. If it is not set, then no domain is specified for the session cookie.

See Also:

Constant Field Values

__SessionPath

static final String __SessionPath

Session Path. If this property is set as a ServletContext InitParam, then it is used as the path for the session cookie. If it is not set, then the context path is used as the path for the cookie.

See Also:

Constant Field Values

__MaxAge

static final String __MaxAge

Session Max Age. If this property is set as a ServletContext InitParam, then it is used as the max age for the session cookie. If it is not set, then a max age of -1 is used.

See Also:

Constant Field Values

Method Detail

initialize

void initialize(ServletHandler handler)

getHttpSession

javax.servlet.http.HttpSession getHttpSession(String id)

newHttpSession

javax.servlet.http.HttpSession newHttpSession(javax.servlet.http.HttpServletRequest request)

getSecureCookies

boolean getSecureCookies()

Returns:

true if session cookies should be secure

getHttpOnly

boolean getHttpOnly()

Returns:

true if session cookies should be httponly (microsoft extension)

getMaxInactiveInterval

int getMaxInactiveInterval()

setMaxInactiveInterval

void setMaxInactiveInterval(int seconds)

addEventListener

void addEventListener(EventListener listener)
                      throws IllegalArgumentException

Add an event listener.

Parameters:

listener - An Event Listener. Individual SessionManagers implemetations may accept arbitrary listener types, but they are expected to at least handle HttpSessionActivationListener, HttpSessionAttributeListener, HttpSessionBindingListener, HttpSessionListener

Throws:

IllegalArgumentException - If an unsupported listener is passed.

removeEventListener

void removeEventListener(EventListener listener)

getSessionCookie

javax.servlet.http.Cookie getSessionCookie(javax.servlet.http.HttpSession session,
                                         boolean requestIsSecure)

Get a Cookie for a session.

Parameters:

session -

Returns:

A Cookie object