org.broadleafcommerce.common.web.BroadleafRequestContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of broadleaf-common Show documentation
Show all versions of broadleaf-common Show documentation
A collection of classes shared by broadleaf profile, cms, admin, and core.
/*
* #%L
* BroadleafCommerce Common Libraries
* %%
* Copyright (C) 2009 - 2013 Broadleaf Commerce
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package org.broadleafcommerce.common.web;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.broadleafcommerce.common.RequestDTO;
import org.broadleafcommerce.common.classloader.release.ThreadLocalManager;
import org.broadleafcommerce.common.currency.domain.BroadleafCurrency;
import org.broadleafcommerce.common.locale.domain.Locale;
import org.broadleafcommerce.common.sandbox.domain.SandBox;
import org.broadleafcommerce.common.sandbox.domain.SandBoxType;
import org.broadleafcommerce.common.site.domain.Catalog;
import org.broadleafcommerce.common.site.domain.Site;
import org.broadleafcommerce.common.site.domain.Theme;
import org.springframework.context.MessageSource;
import org.springframework.web.context.request.ServletWebRequest;
import org.springframework.web.context.request.WebRequest;
import java.util.Currency;
import java.util.HashMap;
import java.util.Map;
import java.util.TimeZone;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* Convenient holder class for various objects to be automatically available on thread local without invoking the various
* services yourself
*
* @see {@link BroadleafRequestProcessor}
*/
public class BroadleafRequestContext {
protected static final Log LOG = LogFactory.getLog(BroadleafRequestContext.class);
private static final ThreadLocal BROADLEAF_REQUEST_CONTEXT = ThreadLocalManager.createThreadLocal(BroadleafRequestContext.class);
public static BroadleafRequestContext getBroadleafRequestContext() {
return BROADLEAF_REQUEST_CONTEXT.get();
}
public static void setBroadleafRequestContext(BroadleafRequestContext broadleafRequestContext) {
BROADLEAF_REQUEST_CONTEXT.set(broadleafRequestContext);
}
public static boolean hasLocale(){
if (getBroadleafRequestContext() != null) {
if(getBroadleafRequestContext().getLocale() != null){
return true;
}
}
return false;
}
public static boolean hasCurrency() {
if (getBroadleafRequestContext() != null) {
if (getBroadleafRequestContext().getBroadleafCurrency() != null) {
return true;
}
}
return false;
}
protected HttpServletRequest request;
protected HttpServletResponse response;
protected WebRequest webRequest;
protected SandBox sandBox;
protected Locale locale;
protected TimeZone timeZone;
protected BroadleafCurrency broadleafCurrency;
protected Site site;
protected Theme theme;
protected java.util.Locale javaLocale;
protected Currency javaCurrency;
protected Catalog currentCatalog;
protected Boolean ignoreSite = false;
protected Map additionalProperties = new HashMap();
protected MessageSource messageSource;
protected RequestDTO requestDTO;
protected Boolean isAdmin = false;
protected Long adminUserId;
protected Boolean internalIgnoreFilters = false;
/**
* Gets the current request on the context
* @return
*/
public HttpServletRequest getRequest() {
return request;
}
/**
* Sets the current request on the context. Note that this also invokes {@link #setWebRequest(WebRequest)} by wrapping
* request in a {@link ServletWebRequest}.
*
* @param request
*/
public void setRequest(HttpServletRequest request) {
this.request = request;
this.webRequest = new ServletWebRequest(request);
}
/**
* Returns the response for the context
*
* @return
*/
public HttpServletResponse getResponse() {
return response;
}
/**
* Sets the response on the context
*
* @param response
*/
public void setResponse(HttpServletResponse response) {
this.response = response;
}
/**
* 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 {@link ServletWebRequest} then
* {@link #setRequest(HttpServletRequest)} will be invoked as well with the native underlying {@link HttpServletRequest}
* passed as a parameter.
*
*
* Also, if webRequest is an instance of {@link 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 {@link HttpServletRequest}
* and {@link HttpServletResponse}
* @param webRequest
*/
public void setWebRequest(WebRequest webRequest) {
this.webRequest = webRequest;
if (webRequest instanceof ServletWebRequest) {
this.request = ((ServletWebRequest) webRequest).getRequest();
setResponse(((ServletWebRequest) webRequest).getResponse());
}
}
/**
* Returns the generic request for use outside of servlets (like in Portlets). This will be automatically set
* by invoking {@link #setRequest(HttpServletRequest)}
*
* @return the generic request
* @see {@link #setWebRequest(WebRequest)}
*/
public WebRequest getWebRequest() {
return webRequest;
}
/**
* Returns a Site instance that is not attached to any Hibernate session
* @return
*/
@Deprecated
public Site getSite() {
return getNonPersistentSite();
}
@Deprecated
public void setSite(Site site) {
setNonPersistentSite(site);
}
public Site getNonPersistentSite() {
return site;
}
public void setNonPersistentSite(Site site) {
this.site = site;
}
public SandBox getSandBox() {
return sandBox;
}
public Long getSandBoxId() {
if (sandBox != null) {
return sandBox.getId();
}
return null;
}
public boolean isProductionSandBox() {
return sandBox == null || SandBoxType.PRODUCTION == sandBox.getSandBoxType();
}
public void setSandBox(SandBox sandBox) {
this.sandBox = sandBox;
}
public Locale getLocale() {
return locale;
}
/**
* Returns the java.util.Locale constructed from the org.broadleafcommerce.common.locale.domain.Locale.
* @return
*/
public java.util.Locale getJavaLocale() {
if (this.javaLocale == null) {
this.javaLocale = convertLocaleToJavaLocale();
}
return this.javaLocale;
}
/**
* 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
*
* @return
*/
public Currency getJavaCurrency() {
if (javaCurrency == null) {
try {
if (getBroadleafCurrency() != null && getBroadleafCurrency().getCurrencyCode() != null) {
javaCurrency = Currency.getInstance(getBroadleafCurrency().getCurrencyCode());
} else {
javaCurrency = Currency.getInstance(getJavaLocale());
}
} catch (IllegalArgumentException e) {
LOG.warn("There was an error processing the configured locale into the java currency. This is likely because the default" +
" locale is set to something like 'en' (which is NOT apart of ISO 3166 and does not have a currency" +
" associated with it) instead of 'en_US' (which IS apart of ISO 3166 and has a currency associated" +
" with it). Because of this, the currency is now set to the default locale of the JVM");
LOG.warn("To fully resolve this, update the default entry in the BLC_LOCALE table to take into account the" +
" country code as well as the language. Alternatively, you could also update the BLC_CURRENCY table" +
" to contain a default currency.");
javaCurrency = Currency.getInstance(java.util.Locale.getDefault());
}
}
return javaCurrency;
}
public void setLocale(Locale locale) {
this.locale = locale;
this.javaLocale = convertLocaleToJavaLocale();
}
public String getRequestURIWithoutContext() {
String requestURIWithoutContext = null;
if (request.getRequestURI() != null) {
if (request.getContextPath() != null) {
requestURIWithoutContext = request.getRequestURI().substring(request.getContextPath().length());
} else {
requestURIWithoutContext = request.getRequestURI();
}
// Remove JSESSION-ID or other modifiers
int pos = requestURIWithoutContext.indexOf(";");
if (pos >= 0) {
requestURIWithoutContext = requestURIWithoutContext.substring(0,pos);
}
}
return requestURIWithoutContext;
}
protected java.util.Locale convertLocaleToJavaLocale() {
if (locale == null || locale.getLocaleCode() == null) {
return java.util.Locale.getDefault();
} else {
return BroadleafRequestContext.convertLocaleToJavaLocale(locale);
}
}
public static java.util.Locale convertLocaleToJavaLocale(Locale broadleafLocale) {
if (broadleafLocale != null) {
String localeString = broadleafLocale.getLocaleCode();
return org.springframework.util.StringUtils.parseLocaleString(localeString);
}
return null;
}
public boolean isSecure() {
boolean secure = false;
if (request != null) {
secure = ("HTTPS".equalsIgnoreCase(request.getScheme()) || request.isSecure());
}
return secure;
}
public Theme getTheme() {
return theme;
}
public void setTheme(Theme theme) {
this.theme = theme;
}
public BroadleafCurrency getBroadleafCurrency() {
return broadleafCurrency;
}
public void setBroadleafCurrency(BroadleafCurrency broadleafCurrency) {
this.broadleafCurrency = broadleafCurrency;
}
public Catalog getCurrentCatalog() {
return currentCatalog;
}
public void setCurrentCatalog(Catalog currentCatalog) {
this.currentCatalog = currentCatalog;
}
@SuppressWarnings("unchecked")
public static Map getRequestParameterMap() {
return getBroadleafRequestContext().getRequest().getParameterMap();
}
public Boolean getIgnoreSite() {
return ignoreSite;
}
public void setIgnoreSite(Boolean ignoreSite) {
this.ignoreSite = ignoreSite;
}
public Map getAdditionalProperties() {
return additionalProperties;
}
public void setAdditionalProperties(Map additionalProperties) {
this.additionalProperties = additionalProperties;
}
public MessageSource getMessageSource() {
return messageSource;
}
public void setMessageSource(MessageSource messageSource) {
this.messageSource = messageSource;
}
public TimeZone getTimeZone() {
return timeZone;
}
public void setTimeZone(TimeZone timeZone) {
this.timeZone = timeZone;
}
public RequestDTO getRequestDTO() {
return requestDTO;
}
public void setRequestDTO(RequestDTO requestDTO) {
this.requestDTO = requestDTO;
}
public Boolean getAdmin() {
return isAdmin == null ? false : isAdmin;
}
public void setAdmin(Boolean admin) {
isAdmin = admin;
}
public Long getAdminUserId() {
return adminUserId;
}
public void setAdminUserId(Long adminUserId) {
this.adminUserId = adminUserId;
}
/**
* Intended for internal use only
*/
public Boolean getInternalIgnoreFilters() {
return internalIgnoreFilters;
}
/**
* Intended for internal use only
*/
public void setInternalIgnoreFilters(Boolean internalIgnoreFilters) {
this.internalIgnoreFilters = internalIgnoreFilters;
}
}