org.springframework.session.web.http

Interface HttpSessionStrategy

All Known Subinterfaces:

MultiHttpSessionStrategy

All Known Implementing Classes:

CookieHttpSessionStrategy, HeaderHttpSessionStrategy

public interface HttpSessionStrategy

A strategy for mapping HTTP request and responses to a Session.

Since:

1.0

Author:

Rob Winch

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRequestedSessionId(HttpServletRequest request) Obtains the requested session id from the provided HttpServletRequest.
void	onInvalidateSession(HttpServletRequest request, HttpServletResponse response) This method is invoked when a session is invalidated and should inform a client that the session id is no longer valid.
void	onNewSession(Session session, HttpServletRequest request, HttpServletResponse response) This method is invoked when a new session is created and should inform a client what the new session id is.

Method Detail

getRequestedSessionId

java.lang.String getRequestedSessionId(HttpServletRequest request)

Obtains the requested session id from the provided HttpServletRequest. For example, the session id might come from a cookie or a request header.

Parameters:

request - the HttpServletRequest to obtain the session id from. Cannot be null.

Returns:

the HttpServletRequest to obtain the session id from.

onNewSession

void onNewSession(Session session,
                  HttpServletRequest request,
                  HttpServletResponse response)

This method is invoked when a new session is created and should inform a client what the new session id is. For example, it might create a new cookie with the session id in it or set an HTTP response header with the value of the new session id. Some implementations may wish to associate additional information to the Session at this time. For example, they may wish to add the IP Address, browser headers, the username, etc to the Session.

Parameters:

session - the Session that is being sent to the client. Cannot be null.

request - the HttpServletRequest that create the new Session Cannot be null.

response - the HttpServletResponse that is associated with the HttpServletRequest that created the new Session Cannot be null.

onInvalidateSession

void onInvalidateSession(HttpServletRequest request,
                         HttpServletResponse response)

This method is invoked when a session is invalidated and should inform a client that the session id is no longer valid. For example, it might remove a cookie with the session id in it or set an HTTP response header with an empty value indicating to the client to no longer submit that session id.

Parameters:

request - the HttpServletRequest that invalidated the Session Cannot be null.

response - the HttpServletResponse that is associated with the HttpServletRequest that invalidated the Session Cannot be null.