org.broadleafcommerce.common.web.controller.BroadleafControllerUtility Maven / Gradle / Ivy
/*
* #%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.controller;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import javax.servlet.http.HttpServletRequest;
/**
* Commonly used Broadleaf Controller operations.
* - ajaxRedirects
* - isAjaxRequest
* - ajaxRender
*
* BroadleafAbstractController provides convenience methods for this functionality.
* Implementors who are not able (or willing) to have their Controllers extend
* BroadleafAbstractController can utilize this utility class to achieve some of
* the same benefits.
*
*
* @author bpolster
*/
public class BroadleafControllerUtility {
protected static final Log LOG = LogFactory.getLog(BroadleafControllerUtility.class);
public static final String BLC_REDIRECT_ATTRIBUTE = "blc_redirect";
public static final String BLC_AJAX_PARAMETER = "blcAjax";
/**
* A helper method that returns whether or not the given request was invoked via an AJAX call
*
* Returns true if the request contains the XMLHttpRequest header or a blcAjax=true parameter.
*
* @param request
* @return - whether or not it was an AJAX request
*/
public static boolean isAjaxRequest(HttpServletRequest request) {
String ajaxParameter = request.getParameter(BLC_AJAX_PARAMETER);
String requestedWithHeader = request.getHeader("X-Requested-With");
boolean result = (ajaxParameter != null && "true".equals(ajaxParameter))
|| "XMLHttpRequest".equals(requestedWithHeader);
if (LOG.isTraceEnabled()) {
StringBuilder sb = new StringBuilder()
.append("Request URL: [").append(request.getServletPath()).append("]")
.append(" - ")
.append("ajaxParam: [").append(String.valueOf(ajaxParameter)).append("]")
.append(" - ")
.append("X-Requested-With: [").append(requestedWithHeader).append("]")
.append(" - ")
.append("Returning: [").append(result).append("]");
LOG.trace(sb.toString());
}
return result;
}
}