org.craftercms.engine.controller.rest

Class RestScriptsController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

org.craftercms.engine.controller.rest.RestScriptsController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

public class RestScriptsController
extends org.springframework.web.servlet.mvc.AbstractController

Controller for REST script requests.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ERROR_MESSAGE_MODEL_ATTR_NAME
static String	DEFAULT_RESPONSE_BODY_MODEL_ATTR_NAME
protected boolean	disableVariableRestrictions
protected String	errorMessageModelAttributeName
protected String	responseBodyModelAttributeName
protected ScriptUrlTemplateScanner	urlTemplateScanner

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

HEADER_CACHE_CONTROL, METHOD_GET, METHOD_HEAD, METHOD_POST

Constructor Summary

Constructors

Constructor and Description
RestScriptsController()

Method Summary

Modifier and Type	Method and Description
protected String	checkHttpStatusCodeAwareException(Exception e, javax.servlet.http.HttpServletResponse response)
protected String	checkValidationException(Exception e, javax.servlet.http.HttpServletResponse response)
protected Map<String,Object>	createScriptVariables(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected Object	executeScript(ScriptFactory scriptFactory, Map<String,Object> scriptVariables, javax.servlet.http.HttpServletResponse response, String scriptUrl)
protected String	getScriptUrl(ScriptFactory scriptFactory, SiteContext siteContext, javax.servlet.http.HttpServletRequest request, String serviceUrl)
protected String	getServiceUrl(javax.servlet.http.HttpServletRequest request)
protected org.springframework.web.servlet.ModelAndView	handleRequestInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected String	parseScriptUrlForVariables(SiteContext siteContext, String scriptUrl, Map<String,Object> variables)
void	setDisableVariableRestrictions(boolean disableVariableRestrictions)
void	setErrorMessageModelAttributeName(String errorMessageModelAttributeName)
void	setResponseBodyModelAttributeName(String responseBodyModelAttributeName)
void	setUrlTemplateScanner(ScriptUrlTemplateScanner urlTemplateScanner)

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheControl, applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, checkRequest, getAllowHeader, getCacheControl, getCacheSeconds, getSupportedMethods, getVaryByRequestHeaders, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, prepareResponse, preventCaching, setAlwaysMustRevalidate, setCacheControl, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader, setVaryByRequestHeaders

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESPONSE_BODY_MODEL_ATTR_NAME

public static final String DEFAULT_RESPONSE_BODY_MODEL_ATTR_NAME

See Also:

Constant Field Values

DEFAULT_ERROR_MESSAGE_MODEL_ATTR_NAME

public static final String DEFAULT_ERROR_MESSAGE_MODEL_ATTR_NAME

See Also:

Constant Field Values

responseBodyModelAttributeName

protected String responseBodyModelAttributeName

errorMessageModelAttributeName

protected String errorMessageModelAttributeName

urlTemplateScanner

protected ScriptUrlTemplateScanner urlTemplateScanner

disableVariableRestrictions

protected boolean disableVariableRestrictions

Constructor Detail

RestScriptsController

public RestScriptsController()

Method Detail

setResponseBodyModelAttributeName

public void setResponseBodyModelAttributeName(String responseBodyModelAttributeName)

setErrorMessageModelAttributeName

public void setErrorMessageModelAttributeName(String errorMessageModelAttributeName)

setUrlTemplateScanner

public void setUrlTemplateScanner(ScriptUrlTemplateScanner urlTemplateScanner)

setDisableVariableRestrictions

public void setDisableVariableRestrictions(boolean disableVariableRestrictions)

handleRequestInternal

protected org.springframework.web.servlet.ModelAndView handleRequestInternal(javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response)
                                                                      throws Exception

Specified by:

handleRequestInternal in class org.springframework.web.servlet.mvc.AbstractController

Throws:

Exception

getServiceUrl

protected String getServiceUrl(javax.servlet.http.HttpServletRequest request)

parseScriptUrlForVariables

protected String parseScriptUrlForVariables(SiteContext siteContext,
                                            String scriptUrl,
                                            Map<String,Object> variables)

getScriptUrl

protected String getScriptUrl(ScriptFactory scriptFactory,
                              SiteContext siteContext,
                              javax.servlet.http.HttpServletRequest request,
                              String serviceUrl)

createScriptVariables

protected Map<String,Object> createScriptVariables(javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response)

executeScript

protected Object executeScript(ScriptFactory scriptFactory,
                               Map<String,Object> scriptVariables,
                               javax.servlet.http.HttpServletResponse response,
                               String scriptUrl)

checkHttpStatusCodeAwareException

protected String checkHttpStatusCodeAwareException(Exception e,
                                                   javax.servlet.http.HttpServletResponse response)

checkValidationException

protected String checkValidationException(Exception e,
                                          javax.servlet.http.HttpServletResponse response)