org.broadleafcommerce.common.web

Class BroadleafRequestContext

java.lang.Object

org.broadleafcommerce.common.web.BroadleafRequestContext

public class BroadleafRequestContext
extends Object

Convenient holder class for various objects to be automatically available on thread local without invoking the various services yourself

See Also:

BroadleafRequestProcessor}

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	additionalProperties
protected Long	adminUserId
protected BroadleafCurrency	broadleafCurrency
protected Catalog	currentCatalog
protected Boolean	ignoreSite
protected Boolean	internalIgnoreFilters
protected Boolean	isAdmin
protected Currency	javaCurrency
protected Locale	javaLocale
protected Locale	locale
protected static org.apache.commons.logging.Log	LOG
protected org.springframework.context.MessageSource	messageSource
protected javax.servlet.http.HttpServletRequest	request
protected RequestDTO	requestDTO
protected javax.servlet.http.HttpServletResponse	response
protected SandBox	sandBox
protected Site	site
protected Theme	theme
protected TimeZone	timeZone
protected org.springframework.web.context.request.WebRequest	webRequest

Constructor Summary

Constructors

Constructor and Description
BroadleafRequestContext()

Method Summary

Methods

Modifier and Type	Method and Description
protected Locale	convertLocaleToJavaLocale()
static Locale	convertLocaleToJavaLocale(Locale broadleafLocale)
Map<String,Object>	getAdditionalProperties()
Boolean	getAdmin()
Long	getAdminUserId()
BroadleafCurrency	getBroadleafCurrency()
static BroadleafRequestContext	getBroadleafRequestContext()
Catalog	getCurrentCatalog()
Boolean	getIgnoreSite()
Boolean	getInternalIgnoreFilters() Intended for internal use only
Currency	getJavaCurrency() Returns the java.util.Currency constructed from the org.broadleafcommerce.common.currency.domain.BroadleafCurrency.
Locale	getJavaLocale() Returns the java.util.Locale constructed from the org.broadleafcommerce.common.locale.domain.Locale.
Locale	getLocale()
org.springframework.context.MessageSource	getMessageSource()
Site	getNonPersistentSite()
javax.servlet.http.HttpServletRequest	getRequest() Gets the current request on the context
RequestDTO	getRequestDTO()
static Map<String,String[]>	getRequestParameterMap()
String	getRequestURIWithoutContext()
javax.servlet.http.HttpServletResponse	getResponse() Returns the response for the context
SandBox	getSandBox()
Long	getSandBoxId()
Site	getSite() Deprecated.
Theme	getTheme()
TimeZone	getTimeZone()
org.springframework.web.context.request.WebRequest	getWebRequest() Returns the generic request for use outside of servlets (like in Portlets).
static boolean	hasCurrency()
static boolean	hasLocale()
boolean	isProductionSandBox()
boolean	isSecure()
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdmin(Boolean admin)
void	setAdminUserId(Long adminUserId)
void	setBroadleafCurrency(BroadleafCurrency broadleafCurrency)
static void	setBroadleafRequestContext(BroadleafRequestContext broadleafRequestContext)
void	setCurrentCatalog(Catalog currentCatalog)
void	setIgnoreSite(Boolean ignoreSite)
void	setInternalIgnoreFilters(Boolean internalIgnoreFilters) Intended for internal use only
void	setLocale(Locale locale)
void	setMessageSource(org.springframework.context.MessageSource messageSource)
void	setNonPersistentSite(Site site)
void	setRequest(javax.servlet.http.HttpServletRequest request) Sets the current request on the context.
void	setRequestDTO(RequestDTO requestDTO)
void	setResponse(javax.servlet.http.HttpServletResponse response) Sets the response on the context
void	setSandBox(SandBox sandBox)
void	setSite(Site site) Deprecated.
void	setTheme(Theme theme)
void	setTimeZone(TimeZone timeZone)
void	setWebRequest(org.springframework.web.context.request.WebRequest webRequest) Sets the generic request on the context.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

request

protected javax.servlet.http.HttpServletRequest request

response

protected javax.servlet.http.HttpServletResponse response

webRequest

protected org.springframework.web.context.request.WebRequest webRequest

sandBox

protected SandBox sandBox

locale

protected Locale locale

timeZone

protected TimeZone timeZone

broadleafCurrency

protected BroadleafCurrency broadleafCurrency

site

protected Site site

theme

protected Theme theme

javaLocale

protected Locale javaLocale

javaCurrency

protected Currency javaCurrency

currentCatalog

protected Catalog currentCatalog

ignoreSite

protected Boolean ignoreSite

additionalProperties

protected Map<String,Object> additionalProperties

messageSource

protected org.springframework.context.MessageSource messageSource

requestDTO

protected RequestDTO requestDTO

isAdmin

protected Boolean isAdmin

adminUserId

protected Long adminUserId

internalIgnoreFilters

protected Boolean internalIgnoreFilters

Constructor Detail

BroadleafRequestContext

public BroadleafRequestContext()

Method Detail

getBroadleafRequestContext

public static BroadleafRequestContext getBroadleafRequestContext()

setBroadleafRequestContext

public static void setBroadleafRequestContext(BroadleafRequestContext broadleafRequestContext)

hasLocale

public static boolean hasLocale()

hasCurrency

public static boolean hasCurrency()

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Gets the current request on the context

Returns:

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)

Sets the current request on the context. Note that this also invokes setWebRequest(WebRequest) by wrapping request in a ServletWebRequest.

Parameters:

request -

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Returns the response for the context

Returns:

setResponse

public void setResponse(javax.servlet.http.HttpServletResponse response)

Sets the response on the context

Parameters:

response -

setWebRequest

public void setWebRequest(org.springframework.web.context.request.WebRequest webRequest)

Sets the generic request on the context. This is available to be used in non-Servlet environments (like Portlets). Note that if webRequest is an instance of ServletWebRequest then setRequest(HttpServletRequest) will be invoked as well with the native underlying HttpServletRequest passed as a parameter.

Also, if webRequest is an instance of ServletWebRequest then an attempt is made to set the response (note that this could be null if the ServletWebRequest was not instantiated with both the HttpServletRequest and HttpServletResponse

Parameters:

webRequest -

getWebRequest

public org.springframework.web.context.request.WebRequest getWebRequest()

Returns the generic request for use outside of servlets (like in Portlets). This will be automatically set by invoking setRequest(HttpServletRequest)

Returns:

the generic request

See Also:

#setWebRequest(WebRequest)}

getSite

@Deprecated
public Site getSite()

Deprecated.

Returns a Site instance that is not attached to any Hibernate session

Returns:

setSite

@Deprecated
public void setSite(Site site)

Deprecated.

getNonPersistentSite

public Site getNonPersistentSite()

setNonPersistentSite

public void setNonPersistentSite(Site site)

getSandBox

public SandBox getSandBox()

getSandBoxId

public Long getSandBoxId()

isProductionSandBox

public boolean isProductionSandBox()

setSandBox

public void setSandBox(SandBox sandBox)

getLocale

public Locale getLocale()

getJavaLocale

public Locale getJavaLocale()

Returns the java.util.Locale constructed from the org.broadleafcommerce.common.locale.domain.Locale.

Returns:

getJavaCurrency

public Currency getJavaCurrency()

Returns the java.util.Currency constructed from the org.broadleafcommerce.common.currency.domain.BroadleafCurrency. If there is no BroadleafCurrency specified this will return the currency based on the JVM locale

Returns:

setLocale

public void setLocale(Locale locale)

getRequestURIWithoutContext

public String getRequestURIWithoutContext()

convertLocaleToJavaLocale

protected Locale convertLocaleToJavaLocale()

convertLocaleToJavaLocale

public static Locale convertLocaleToJavaLocale(Locale broadleafLocale)

isSecure

public boolean isSecure()

getTheme

public Theme getTheme()

setTheme

public void setTheme(Theme theme)

getBroadleafCurrency

public BroadleafCurrency getBroadleafCurrency()

setBroadleafCurrency

public void setBroadleafCurrency(BroadleafCurrency broadleafCurrency)

getCurrentCatalog

public Catalog getCurrentCatalog()

setCurrentCatalog

public void setCurrentCatalog(Catalog currentCatalog)

getRequestParameterMap

public static Map<String,String[]> getRequestParameterMap()

getIgnoreSite

public Boolean getIgnoreSite()

setIgnoreSite

public void setIgnoreSite(Boolean ignoreSite)

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)

getMessageSource

public org.springframework.context.MessageSource getMessageSource()

setMessageSource

public void setMessageSource(org.springframework.context.MessageSource messageSource)

getTimeZone

public TimeZone getTimeZone()

setTimeZone

public void setTimeZone(TimeZone timeZone)

getRequestDTO

public RequestDTO getRequestDTO()

setRequestDTO

public void setRequestDTO(RequestDTO requestDTO)

getAdmin

public Boolean getAdmin()

setAdmin

public void setAdmin(Boolean admin)

getAdminUserId

public Long getAdminUserId()

setAdminUserId

public void setAdminUserId(Long adminUserId)

getInternalIgnoreFilters

public Boolean getInternalIgnoreFilters()

Intended for internal use only

setInternalIgnoreFilters

public void setInternalIgnoreFilters(Boolean internalIgnoreFilters)

Intended for internal use only