Package com.day.cq.personalization

Class ContextSessionPersistence

java.lang.Object

com.day.cq.personalization.ContextSessionPersistence

public class ContextSessionPersistence
extends Object

Constructor Summary

Constructors

Constructor	Description
ContextSessionPersistence()

Method Summary

Modifier and Type	Method	Description
static String	get(SlingHttpServletRequest request, String key)	Returns the value from the default session persistence cookie for the specified key.
static String	get(SlingHttpServletRequest request, String key, String cookieName)	Returns the value from the specified cookieName cookie for the specified key.
static String	get(SlingHttpServletRequest request, String key, SlingSettingsService settingsService)	Deprecated. since 5.6.
static String	getCookieName()	Return the name of the default session persistence cookie.
static String	getCookieName(String cookiePrefix, SlingSettingsService settingsService)	Deprecated. since 5.6.
static String	getCookieName(SlingSettingsService settingsService)	Deprecated. since 5.6.
static String	getMap(SlingHttpServletRequest request)	Returns a key/value map of the default session persistence cookie.
static String	getMap(SlingHttpServletRequest request, String cookieName)	Returns a key/value map of named cookie.
static String	getMap(SlingHttpServletRequest request, SlingSettingsService settingsService)	Deprecated. since 5.6.
static Map<String,String>	getStore(SlingHttpServletRequest request, String key)	Return a single store (by its key) from the default session persistence cookie.
static Map<String,String>	getStore(SlingHttpServletRequest request, String key, String cookieName)	Return a single store (by its key) from a named cookie.
static Map<String,String>	getStore(SlingHttpServletRequest request, String key, SlingSettingsService settingsService)	Deprecated. since 5.6.
static void	put(SlingHttpServletRequest request, SlingHttpServletResponse response, String key, String value)	Add a name/value pair to the default session persistence cookie.
static void	put(SlingHttpServletRequest request, SlingHttpServletResponse response, String key, String value, String cookieName)	Add a name/value pair to a named cookie.
static void	put(SlingHttpServletRequest request, SlingHttpServletResponse response, String key, String value, SlingSettingsService settingsService)	Deprecated. since 5.6.
static void	putStore(SlingHttpServletRequest request, SlingHttpServletResponse response, String key, Map<String,String> store)	Persists a single store under the given key.
static void	putStore(SlingHttpServletRequest request, SlingHttpServletResponse response, String key, Map<String,String> store, SlingSettingsService settingsService)	Deprecated. since 5.6.
static void	putStores(SlingHttpServletRequest request, SlingHttpServletResponse response, Map<String,Map<String,String>> stores, String cookieName)	Put multiple stores at once without overwriting stores previously put to response.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextSessionPersistence

public ContextSessionPersistence()

Method Detail

get

public static String get(SlingHttpServletRequest request,
                         String key,
                         SlingSettingsService settingsService)

Deprecated.

since 5.6. Use get(org.apache.sling.api.SlingHttpServletRequest, String) instead.

Returns the value from the default session persistence cookie for the specified key.

Parameters:

request - The SlingHttpServletRequest

key - Key

settingsService - The SlingSettingsService

Returns:

Value or an empty string

get

public static String get(SlingHttpServletRequest request,
                         String key)

Returns the value from the default session persistence cookie for the specified key.

Parameters:

request - The SlingHttpServletRequest

key - Key

Returns:

Value or an empty string

get

public static String get(SlingHttpServletRequest request,
                         String key,
                         String cookieName)

Returns the value from the specified cookieName cookie for the specified key.

Parameters:

request - The SlingHttpServletRequest

key - Key

cookieName - Cookie name

Returns:

Value or an empty string

getMap

public static String getMap(SlingHttpServletRequest request,
                            SlingSettingsService settingsService)

Deprecated.

since 5.6. Use getMap(org.apache.sling.api.SlingHttpServletRequest) instead.

Returns a key/value map of the default session persistence cookie.

Parameters:

request - The SlingHttpServletRequest

settingsService - The SlingSettingsService

Returns:

Map with key/value pairs

getMap

public static String getMap(SlingHttpServletRequest request)

Returns a key/value map of the default session persistence cookie.

Parameters:

request - The SlingHttpServletRequest

Returns:

Map with key/value pairs

getMap

public static String getMap(SlingHttpServletRequest request,
                            String cookieName)

Returns a key/value map of named cookie.

Parameters:

request - The SlingHTTPServletRequest

cookieName - Cookie name

Returns:

Map with key/value pairs

put

public static void put(SlingHttpServletRequest request,
                       SlingHttpServletResponse response,
                       String key,
                       String value,
                       SlingSettingsService settingsService)

Deprecated.

since 5.6. Use put(org.apache.sling.api.SlingHttpServletRequest, org.apache.sling.api.SlingHttpServletResponse, String, String) instead.

Add a name/value pair to the default session persistence cookie.

Parameters:

request - The SlingHTTPServletRequest

response - The SlingHTTPServletResponse

key - Key

value - Value

settingsService - The SlingSettingsService

put

public static void put(SlingHttpServletRequest request,
                       SlingHttpServletResponse response,
                       String key,
                       String value)

Add a name/value pair to the default session persistence cookie.

Parameters:

request - The SlingHTTPServletRequest

response - The SlingHTTPServletResponse

key - Key

value - Value

put

public static void put(SlingHttpServletRequest request,
                       SlingHttpServletResponse response,
                       String key,
                       String value,
                       String cookieName)

Add a name/value pair to a named cookie.

Parameters:

request - The SlingHTTPServletRequest

response - The SlingHTTPServletResponse

key - Key

value - Value

cookieName - Cookie name

getStore

public static Map<String,String> getStore(SlingHttpServletRequest request,
                                                String key,
                                                SlingSettingsService settingsService)

Deprecated.

since 5.6. Use getStore(org.apache.sling.api.SlingHttpServletRequest, String) instead.

Return a single store (by its key) from the default session persistence cookie.

Parameters:

request - The SlingHTTPServletRequest

key - Key referencing the store

settingsService - The SlingSettingsService

Returns:

the store

getStore

public static Map<String,String> getStore(SlingHttpServletRequest request,
                                                String key)

Return a single store (by its key) from the default session persistence cookie.

Parameters:

request - The SlingHttpServletRequest

key - Key referencing the store

Returns:

the store

getStore

public static Map<String,String> getStore(SlingHttpServletRequest request,
                                                String key,
                                                String cookieName)

Return a single store (by its key) from a named cookie.

Parameters:

request - The SlingHttpServletRequest

key - Key referencing the store

cookieName - Cookie name

Returns:

the store

putStore

public static void putStore(SlingHttpServletRequest request,
                            SlingHttpServletResponse response,
                            String key,
                            Map<String,String> store,
                            SlingSettingsService settingsService)

Deprecated.

since 5.6. Use putStore(org.apache.sling.api.SlingHttpServletRequest, org.apache.sling.api.SlingHttpServletResponse, String, java.util.Map) instead.

Persists a single store under the given key.

Parameters:

request - The SlingHttpServletRequest

response - The SlingHttpServletResponse

key - Key

store - A map representing the store

settingsService - The SlingSettingsService

putStore

public static void putStore(SlingHttpServletRequest request,
                            SlingHttpServletResponse response,
                            String key,
                            Map<String,String> store)

Persists a single store under the given key.

Note: Don't use this method to persist multiple stores. Use putStores(SlingHttpServletRequest, SlingHttpServletResponse, Map, String) instead.

Parameters:

request - The SlingHttpServletRequest

response - The SlingHttpServletResponse

key - Key

store - A map representing the store

putStores

public static void putStores(SlingHttpServletRequest request,
                             SlingHttpServletResponse response,
                             Map<String,Map<String,String>> stores,
                             String cookieName)

Put multiple stores at once without overwriting stores previously put to response. The method takes a map of stores where the key corresponds to the store key.

Parameters:

request - The request

response - The response

stores - The map of stores

cookieName - The cookie's name

getCookieName

public static String getCookieName()

Return the name of the default session persistence cookie.

Returns:

Cookie name

getCookieName

public static String getCookieName(SlingSettingsService settingsService)

Deprecated.

since 5.6. Use getCookieName() instead.

Return the name of the cookie.

Parameters:

settingsService - The SlingSettingsService

Returns:

Cookie name

getCookieName

public static String getCookieName(String cookiePrefix,
                                   SlingSettingsService settingsService)

Deprecated.

since 5.6. Use getCookieName() instead.

Return the name of the cookie.

Parameters:

cookiePrefix - The cookie prefix

settingsService - The SlingSettingsService

Returns:

Cookie name