org.springframework.session.web.http

Interface HttpSessionManager

All Known Implementing Classes:

CookieHttpSessionStrategy

public interface HttpSessionManager

Allows managing a mapping of alias to the session id for having multiple active sessions at the same time.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	encodeURL(java.lang.String url, java.lang.String sessionAlias) Provides the ability to encode the URL for a given session alias.
java.lang.String	getCurrentSessionAlias(javax.servlet.http.HttpServletRequest request) Gets the current session's alias from the HttpServletRequest.
java.lang.String	getNewSessionAlias(javax.servlet.http.HttpServletRequest request) Gets a new and unique Session alias.
java.util.Map<java.lang.String,java.lang.String>	getSessionIds(javax.servlet.http.HttpServletRequest request) Gets a mapping of the session alias to the session id from the HttpServletRequest.

Method Detail

getCurrentSessionAlias

java.lang.String getCurrentSessionAlias(javax.servlet.http.HttpServletRequest request)

Gets the current session's alias from the HttpServletRequest.

Parameters:

request - the HttpServletRequest to obtain the current session's alias from.

Returns:

the current sessions' alias. Cannot be null.

getSessionIds

java.util.Map<java.lang.String,java.lang.String> getSessionIds(javax.servlet.http.HttpServletRequest request)

Gets a mapping of the session alias to the session id from the HttpServletRequest.

Parameters:

request - the HttpServletRequest to obtain the mapping from. Cannot be null.

Returns:

a mapping of the session alias to the session id from the HttpServletRequest. Cannot be null.

encodeURL

java.lang.String encodeURL(java.lang.String url,
                           java.lang.String sessionAlias)

Provides the ability to encode the URL for a given session alias.

Parameters:

url - the url to encode.

sessionAlias - the session alias to encode.

Returns:

the encoded URL

getNewSessionAlias

java.lang.String getNewSessionAlias(javax.servlet.http.HttpServletRequest request)

Gets a new and unique Session alias. Typically this will be called to pass into HttpSessionManager#encodeURL(java.lang.String). For example: String newAlias = httpSessionManager.getNewSessionAlias(request); String addAccountUrl = httpSessionManager.encodeURL("./", newAlias);

Parameters:

request - the HttpServletRequest to get a new alias from

Returns:

Gets a new and unique Session alias.