BroadleafCookieHttpSessionStrategy (broadleaf-enterprise 4.2.6-SNAPSHOT API)

java.lang.Object
- com.broadleafcommerce.enterprise.csr.session.BroadleafCookieHttpSessionStrategy

All Implemented Interfaces:

HttpSessionManager, MultiHttpSessionStrategy, org.springframework.session.web.http.HttpSessionIdResolver
```
public class BroadleafCookieHttpSessionStrategy
extends Object
implements HttpSessionManager, MultiHttpSessionStrategy, org.springframework.session.web.http.HttpSessionIdResolver
```
A port of the CookieHttpSessionStrategy from < 2.0.0 Spring Session to be compatible with 2.0.0+ Spring Session. Spring removed multi session support in 2.0.0 because it conflicted with a reactive system. This class is mostly the same as the CookieHttpSessionStrategy but it also implements the new (as of 2.0.0 Spring Session) class HttpSessionIdResolver. By implementing this class we can use most of SessionRepositoryFilter.

Author:

Jay Aisenbrey (cja769)

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_ALIAS

static String DEFAULT_SESSION_ALIAS_PARAM_NAME

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ALIAS`
`static String`	`DEFAULT_SESSION_ALIAS_PARAM_NAME`

Constructor Summary

Constructors
Constructor and Description

BroadleafCookieHttpSessionStrategy()

Constructors
Constructor and Description
`BroadleafCookieHttpSessionStrategy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`encodeURL(String url, String sessionAlias)` Provides the ability to encode the URL for a given session alias.
`void`	`expireSession(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`String`	`getCurrentSessionAlias(javax.servlet.http.HttpServletRequest request)` Gets the current session's alias from the `HttpServletRequest`.
`String`	`getNewSessionAlias(javax.servlet.http.HttpServletRequest request)` Gets a new and unique Session alias.
`String`	`getRequestedSessionId(javax.servlet.http.HttpServletRequest request)`
`Map<String,String>`	`getSessionIds(javax.servlet.http.HttpServletRequest request)` Gets a mapping of the session alias to the session id from the `HttpServletRequest`.
`List<String>`	`resolveSessionIds(javax.servlet.http.HttpServletRequest request)`
`void`	`setCookieSerializer(org.springframework.session.web.http.CookieSerializer cookieSerializer)` Sets the `CookieSerializer` to be used.
`void`	`setDeserializationDelimiter(String delimiter)` Sets the delimiter between a session alias and a session id when deserializing a cookie.
`void`	`setSerializationDelimiter(String delimiter)` Sets the delimiter between a session alias and a session id when deserializing a cookie.
`void`	`setSessionId(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String sessionId)`
`javax.servlet.http.HttpServletRequest`	`wrapRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Allows customizing the `HttpServletRequest`.
`javax.servlet.http.HttpServletResponse`	`wrapResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Allows customizing the `HttpServletResponse`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_ALIAS
```
public static final String DEFAULT_ALIAS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SESSION_ALIAS_PARAM_NAME
```
public static final String DEFAULT_SESSION_ALIAS_PARAM_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BroadleafCookieHttpSessionStrategy
```
public BroadleafCookieHttpSessionStrategy()
```
- Method Detail
  - resolveSessionIds
```
public List<String> resolveSessionIds(javax.servlet.http.HttpServletRequest request)
```
    Specified by:
    
    resolveSessionIds in interface org.springframework.session.web.http.HttpSessionIdResolver
  - getCurrentSessionAlias
```
public String getCurrentSessionAlias(javax.servlet.http.HttpServletRequest request)
```
    Description copied from interface: HttpSessionManager
    
    Gets the current session's alias from the HttpServletRequest.
    
    Specified by:
    
    getCurrentSessionAlias in interface HttpSessionManager
    
    Parameters:
    
    request - the HttpServletRequest to obtain the current session's alias from.
    
    Returns:
    
    the current sessions' alias. Cannot be null.
  - getSessionIds
```
public Map<String,String> getSessionIds(javax.servlet.http.HttpServletRequest request)
```
    Description copied from interface: HttpSessionManager
    
    Gets a mapping of the session alias to the session id from the HttpServletRequest.
    
    Specified by:
    
    getSessionIds in interface HttpSessionManager
    
    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.
  - getRequestedSessionId
```
public String getRequestedSessionId(javax.servlet.http.HttpServletRequest request)
```
  - getNewSessionAlias
```
public String getNewSessionAlias(javax.servlet.http.HttpServletRequest request)
```
    Description copied from interface: HttpSessionManager
    
    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);
    
    Specified by:
    
    getNewSessionAlias in interface HttpSessionManager
    
    Parameters:
    
    request - the HttpServletRequest to get a new alias from
    
    Returns:
    
    Gets a new and unique Session alias.
  - wrapRequest
```
public javax.servlet.http.HttpServletRequest wrapRequest(javax.servlet.http.HttpServletRequest request,
                                                         javax.servlet.http.HttpServletResponse response)
```
    Description copied from interface: MultiHttpSessionStrategy
    
    Allows customizing the HttpServletRequest.
    
    Specified by:
    
    wrapRequest in interface MultiHttpSessionStrategy
    
    Parameters:
    
    request - the original HttpServletRequest. Cannot be null.
    
    response - the original HttpServletResponse. This is NOT the result of MultiHttpSessionStrategy.wrapResponse(HttpServletRequest, HttpServletResponse) Cannot be null. .
    
    Returns:
    
    a non-null HttpServletRequest
  - wrapResponse
```
public javax.servlet.http.HttpServletResponse wrapResponse(javax.servlet.http.HttpServletRequest request,
                                                           javax.servlet.http.HttpServletResponse response)
```
    Description copied from interface: MultiHttpSessionStrategy
    
    Allows customizing the HttpServletResponse.
    
    Specified by:
    
    wrapResponse in interface MultiHttpSessionStrategy
    
    Parameters:
    
    request - the original HttpServletRequest. This is NOT the result of MultiHttpSessionStrategy.wrapRequest(HttpServletRequest, HttpServletResponse). Cannot be null.
    
    response - the original HttpServletResponse. Cannot be null.
    
    Returns:
    
    a non-null HttpServletResponse
  - encodeURL
```
public String encodeURL(String url,
                        String sessionAlias)
```
    Description copied from interface: HttpSessionManager
    
    Provides the ability to encode the URL for a given session alias.
    
    Specified by:
    
    encodeURL in interface HttpSessionManager
    
    Parameters:
    
    url - the url to encode.
    
    sessionAlias - the session alias to encode.
    
    Returns:
    
    the encoded URL
  - setDeserializationDelimiter
```
public void setDeserializationDelimiter(String delimiter)
```
    Sets the delimiter between a session alias and a session id when deserializing a cookie. The default is " " This is useful when using RFC 6265 for writing the cookies which doesn't allow for spaces in the cookie values.
    
    Parameters:
    
    delimiter - the delimiter to set (i.e. "_ " will try a delimeter of either "_" or " ")
  - setSerializationDelimiter
```
public void setSerializationDelimiter(String delimiter)
```
    Sets the delimiter between a session alias and a session id when deserializing a cookie. The default is " ". This is useful when using RFC 6265 for writing the cookies which doesn't allow for spaces in the cookie values.
    
    Parameters:
    
    delimiter - the delimiter to set (i.e. "_")
  - setCookieSerializer
```
public void setCookieSerializer(org.springframework.session.web.http.CookieSerializer cookieSerializer)
```
    Sets the CookieSerializer to be used.
    
    Parameters:
    
    cookieSerializer - the cookieSerializer to set. Cannot be null.
  - setSessionId
```
public void setSessionId(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         String sessionId)
```
    Specified by:
    
    setSessionId in interface org.springframework.session.web.http.HttpSessionIdResolver
  - expireSession
```
public void expireSession(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
```
    Specified by:
    
    expireSession in interface org.springframework.session.web.http.HttpSessionIdResolver

Class BroadleafCookieHttpSessionStrategy

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ALIAS

DEFAULT_SESSION_ALIAS_PARAM_NAME

Constructor Detail

BroadleafCookieHttpSessionStrategy

Method Detail

resolveSessionIds

getCurrentSessionAlias

getSessionIds

getRequestedSessionId

getNewSessionAlias

wrapRequest

wrapResponse

encodeURL

setDeserializationDelimiter

setSerializationDelimiter

setCookieSerializer

setSessionId

expireSession