org.broadleafcommerce.common.web

Class BroadleafSandBoxResolverImpl

java.lang.Object

org.broadleafcommerce.common.web.BroadleafSandBoxResolverImpl

All Implemented Interfaces:

BroadleafSandBoxResolver

@Component(value="blSandBoxResolver")
public class BroadleafSandBoxResolverImpl
extends java.lang.Object
implements BroadleafSandBoxResolver

Responsible for determining the SandBox to use for the current request. SandBox's are used to store a user's changes to products, content-items, etc. until they are ready to be pushed to production. If a request is being served with a SandBox parameter, it indicates that the user wants to see the site as if their changes were applied.

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SANDBOX_VAR Request attribute to store the current sandbox
protected java.lang.Boolean	sandBoxPreviewEnabled Property used to disable sandbox mode.

Constructor Summary

Constructors

Constructor and Description
BroadleafSandBoxResolverImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getSandBoxPreviewEnabled() Sets whether or not the site can be viewed in preview mode.
SandBox	resolveSandBox(javax.servlet.http.HttpServletRequest request, Site site) Determines the current sandbox based on other parameters on the request such as the blSandBoxId parameters.
SandBox	resolveSandBox(org.springframework.web.context.request.WebRequest request, Site site) Resolve the sandbox for the given site and request
void	setSandBoxPreviewEnabled(java.lang.Boolean sandBoxPreviewEnabled)

Methods inherited from class java.lang.Object

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

Field Detail

sandBoxPreviewEnabled

protected java.lang.Boolean sandBoxPreviewEnabled

Property used to disable sandbox mode. Some implementations will want to turn off sandboxes in production.

SANDBOX_VAR

public static java.lang.String SANDBOX_VAR

Request attribute to store the current sandbox

Constructor Detail

BroadleafSandBoxResolverImpl

public BroadleafSandBoxResolverImpl()

Method Detail

resolveSandBox

public SandBox resolveSandBox(javax.servlet.http.HttpServletRequest request,
                              Site site)

Determines the current sandbox based on other parameters on the request such as the blSandBoxId parameters. If the getSandBoxPreviewEnabled(), then this method will not return a user SandBox.

Specified by:

resolveSandBox in interface BroadleafSandBoxResolver

resolveSandBox

public SandBox resolveSandBox(org.springframework.web.context.request.WebRequest request,
                              Site site)

Description copied from interface: BroadleafSandBoxResolver

Resolve the sandbox for the given site and request

Specified by:

resolveSandBox in interface BroadleafSandBoxResolver

Returns:

the sandbox for the current request

getSandBoxPreviewEnabled

public java.lang.Boolean getSandBoxPreviewEnabled()

Sets whether or not the site can be viewed in preview mode.

Returns:

setSandBoxPreviewEnabled

public void setSandBoxPreviewEnabled(java.lang.Boolean sandBoxPreviewEnabled)