org.broadleafcommerce.common.web.resource

Class BroadleafContextUtil

java.lang.Object

org.broadleafcommerce.common.web.resource.BroadleafContextUtil

@Service(value="blBroadleafContextUtil")
public class BroadleafContextUtil
extends Object

Some resource handlers need a valid site, theme, or sandbox to be available when serving request.

This component provides the establishThinRequestContext() method for that purpose.

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
protected DeployBehaviorUtil	deployBehaviorUtil
protected BroadleafSandBoxResolver	sbResolver
protected BroadleafSiteResolver	siteResolver
protected BroadleafThemeResolver	themeResolver
protected boolean	versioningEnabled

Constructor Summary

Constructors

Constructor and Description
BroadleafContextUtil()

Method Summary

Modifier and Type	Method and Description
void	clearThinRequestContext()
void	establishThinRequestContext() Creates a BroadleafRequestContext with supported values populated
protected void	establishThinRequestContextInternal(boolean includeTheme, boolean includeSandBox) Adds request and site to the BroadleafRequestContext If includeTheme is true then also adds the Theme.
void	establishThinRequestContextWithoutSandBox() Creates a BroadleafRequestContext without a Sandbox
void	establishThinRequestContextWithoutThemeOrSandbox() Creates a BroadleafRequestContext without a Theme or Sandbox
protected String	getContextName(javax.servlet.http.HttpServletRequest request)
protected org.springframework.security.core.context.SecurityContext	readSecurityContextFromSession(javax.servlet.http.HttpSession httpSession)

Methods inherited from class java.lang.Object

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

Field Detail

siteResolver

protected BroadleafSiteResolver siteResolver

sbResolver

protected BroadleafSandBoxResolver sbResolver

themeResolver

protected BroadleafThemeResolver themeResolver

deployBehaviorUtil

protected DeployBehaviorUtil deployBehaviorUtil

versioningEnabled

protected boolean versioningEnabled

Constructor Detail

BroadleafContextUtil

public BroadleafContextUtil()

Method Detail

establishThinRequestContext

public void establishThinRequestContext()

Creates a BroadleafRequestContext with supported values populated

See Also:

establishThinRequestContextInternal(boolean, boolean)

establishThinRequestContextWithoutSandBox

public void establishThinRequestContextWithoutSandBox()

Creates a BroadleafRequestContext without a Sandbox

See Also:

establishThinRequestContextInternal(boolean, boolean)

establishThinRequestContextWithoutThemeOrSandbox

public void establishThinRequestContextWithoutThemeOrSandbox()

Creates a BroadleafRequestContext without a Theme or Sandbox

See Also:

establishThinRequestContextInternal(boolean, boolean)

establishThinRequestContextInternal

protected void establishThinRequestContextInternal(boolean includeTheme,
                                                   boolean includeSandBox)

Adds request and site to the BroadleafRequestContext If includeTheme is true then also adds the Theme. If includeSandBox is true then also adds the SandBox.

Parameters:

includeTheme -

includeSandBox -

clearThinRequestContext

public void clearThinRequestContext()

getContextName

protected String getContextName(javax.servlet.http.HttpServletRequest request)

readSecurityContextFromSession

protected org.springframework.security.core.context.SecurityContext readSecurityContextFromSession(javax.servlet.http.HttpSession httpSession)