org.onehippo.cms7.services.cmscontext

Interface CmsSessionContext

public interface CmsSessionContext

Provides access to CMS Application Session Context specific information

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCALE Key to retrieve the locale applicable to the current CMS session.
static String	REPOSITORY_CREDENTIALS Key to the the SimpleCredentials with which the CMS session authenticates with the Repository.
static String	SESSION_KEY Attribute name under which the CmsSessionContext is bind in its HttpSession

Method Summary

Modifier and Type	Method and Description
Object	get(String key) Retrieve CMS Session Context specific information by key
String	getCmsContextServiceId()
static CmsSessionContext	getContext(javax.servlet.http.HttpSession session) Static method to retrieve the CmsSessionContext from a HttpSession
String	getId()
default Locale	getLocale()
default javax.jcr.SimpleCredentials	getRepositoryCredentials()

Field Detail

SESSION_KEY

static final String SESSION_KEY

Attribute name under which the CmsSessionContext is bind in its HttpSession

REPOSITORY_CREDENTIALS

static final String REPOSITORY_CREDENTIALS

Key to the the SimpleCredentials with which the CMS session authenticates with the Repository.

See Also:

getRepositoryCredentials(), Constant Field Values

LOCALE

static final String LOCALE

Key to retrieve the locale applicable to the current CMS session.

See Also:

getLocale(), Constant Field Values

Method Detail

getContext

static CmsSessionContext getContext(javax.servlet.http.HttpSession session)

Static method to retrieve the CmsSessionContext from a HttpSession

Parameters:

session - the HttpSession

Returns:

the CmsSessionContext bound to the provided HttpSession

getId

String getId()

Returns:

Unique identifier for this CmsSessionContext

getCmsContextServiceId

String getCmsContextServiceId()

Returns:

Unique identifier for the CmsContextService which created this CmsSessionContext

get

Object get(String key)

Retrieve CMS Session Context specific information by key

Parameters:

key - the key of the information

Returns:

the information

getRepositoryCredentials

default javax.jcr.SimpleCredentials getRepositoryCredentials()

Returns:

the SimpleCredentials with which the CMS session authenticates with the Repository

getLocale

default Locale getLocale()

Returns:

the Locale applicable to the current CMS session