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_MODEL_ATTR_NAME
static String	DEFAULT_RESPONSE_BODY_MODEL_ATTR_NAME
protected String	errorModelAttributeName
protected String	responseBodyModelAttributeName
protected ScriptFactory	scriptFactory

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

METHOD_GET, METHOD_HEAD, METHOD_POST

Constructor Summary

Constructors

Constructor and Description
RestScriptsController()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,Object>	createScriptVariables(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected Object	executeScript(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String scriptUrl)
protected String	getScriptUrl(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)
void	setErrorModelAttributeName(String errorModelAttributeName)
void	setResponseBodyModelAttributeName(String responseBodyModelAttributeName)
void	setScriptFactory(ScriptFactory scriptFactory)

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

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

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

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

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_MODEL_ATTR_NAME

public static final String DEFAULT_ERROR_MODEL_ATTR_NAME

See Also:

Constant Field Values

scriptFactory

protected ScriptFactory scriptFactory

responseBodyModelAttributeName

protected String responseBodyModelAttributeName

errorModelAttributeName

protected String errorModelAttributeName

Constructor Detail

RestScriptsController

public RestScriptsController()

Method Detail

setScriptFactory

public void setScriptFactory(ScriptFactory scriptFactory)

setResponseBodyModelAttributeName

public void setResponseBodyModelAttributeName(String responseBodyModelAttributeName)

setErrorModelAttributeName

public void setErrorModelAttributeName(String errorModelAttributeName)

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)

getScriptUrl

protected String getScriptUrl(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(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   String scriptUrl)