org.onehippo.cms7.services.cmscontext

Interface CmsContextService

public interface CmsContextService

Method Summary

Modifier and Type	Method and Description
CmsSessionContext	attachSessionContext(String ctxId, javax.servlet.http.HttpSession session) Creates a new CmsSessionContext attached to an existing (CMS Application HttpSession based) CmsSessionContext and stores it in the provided HttpSession under attribute CmsSessionContext.SESSION_KEY.
String	getId() Returns the unique identifier for this service
CmsSessionContext	getSessionContext(String ctxId) Returns the CmsSessionContext by its unique id

Method Detail

getId

String getId()

Returns the unique identifier for this service

getSessionContext

CmsSessionContext getSessionContext(String ctxId)

Returns the CmsSessionContext by its unique id

Parameters:

ctxId - The id for the CmsSessionContext to return

Returns:

the CmsSessionContext

attachSessionContext

CmsSessionContext attachSessionContext(String ctxId,
                                       javax.servlet.http.HttpSession session)

Creates a new CmsSessionContext attached to an existing (CMS Application HttpSession based) CmsSessionContext and stores it in the provided HttpSession under attribute CmsSessionContext.SESSION_KEY.

The attached CmsSessionContext will be automatically destroyed and removed from its HttpSession when the underlying CMS application CmsSessionContext is destroyed.

When the provided HttpSession expires or invalidated OR the attached CmsSessionContext is removed from its HttpSession otherwise, the attached CmsSessionContext is automatically destroyed and detached from the underlying CmsSessionContext.

Parameters:

ctxId - Id for the CmsSessionContext to attach a new CmsSessionContext to

session - The HttpSession in which to bind the new attached CmsSessionContext

Returns:

the attached CmsSessionContext, also bound to the provided HttpSession attribute CmsSessionContext.SESSION_KEY