Package org.broadleafcommerce.common.web.resource

Class BroadleafContextUtil

java.lang.Object

org.broadleafcommerce.common.web.resource.BroadleafContextUtil

@Service("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	Description
protected DeployBehaviorUtil	deployBehaviorUtil
protected BroadleafSandBoxResolver	sbResolver
protected BroadleafSiteResolver	siteResolver
protected BroadleafThemeResolver	themeResolver
protected boolean	versioningEnabled

Constructor Summary

Constructors

Constructor	Description
BroadleafContextUtil()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

siteResolver

protected BroadleafSiteResolver siteResolver

sbResolver

protected BroadleafSandBoxResolver sbResolver

themeResolver

protected BroadleafThemeResolver themeResolver

deployBehaviorUtil

protected DeployBehaviorUtil deployBehaviorUtil

versioningEnabled

protected boolean versioningEnabled

Constructor Details

BroadleafContextUtil

public BroadleafContextUtil()

Method Details

establishThinRequestContext

public void establishThinRequestContext()

Creates a BroadleafRequestContext with supported values populated

See Also:

• establishThinRequestContextInternal(boolean, boolean)

establishThinRequestContext

public void establishThinRequestContext(boolean forceCreate)

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 -

establishThinRequestContextInternal

protected void establishThinRequestContextInternal(boolean includeTheme,
 boolean includeSandBox,
 boolean forceCreate)

clearThinRequestContext

public void clearThinRequestContext()

getContextName

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

readSecurityContextFromSession

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