Package org.craftercms.engine.util

Class GroovyScriptUtils

java.lang.Object

org.craftercms.engine.util.GroovyScriptUtils

public class GroovyScriptUtils
extends Object

Utility methods for Groovy scripts.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	GROOVY_SCRIPT_LOGGER
static final String	VARIABLE_APPLICATION
static final String	VARIABLE_APPLICATION_CONTEXT
static final String	VARIABLE_AUTH
static final String	VARIABLE_AUTH_TOKEN
static final String	VARIABLE_CONTENT_MODEL
static final String	VARIABLE_COOKIES
static final String	VARIABLE_CRAFTER_MODEL	Deprecated.
static final String	VARIABLE_FILTER_CHAIN
static final String	VARIABLE_HEADERS
static final String	VARIABLE_LOCALE
static final String	VARIABLE_LOGGER
static final String	VARIABLE_MODEL	Deprecated.
static final String	VARIABLE_PARAMS
static final String	VARIABLE_PATH_VARS
static final String	VARIABLE_PROFILE
static final String	VARIABLE_REQUEST
static final String	VARIABLE_RESPONSE
static final String	VARIABLE_SESSION
static final String	VARIABLE_SITE_CONFIG
static final String	VARIABLE_SITE_CONTEXT
static final String	VARIABLE_TEMPLATE_MODEL

Method Summary

Modifier and Type	Method	Description
static void	addControllerScriptVariables(Map<String,Object> variables, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext servletContext, Object templateModel)
static void	addFilterScriptVariables(Map<String,Object> variables, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext servletContext, javax.servlet.FilterChain filterChain)
static void	addHealthCheckScriptVariables(Map<String,Object> variables, boolean disableVariableRestrictions)
static void	addJobScriptVariables(Map<String,Object> variables, javax.servlet.ServletContext servletContext)
static void	addLocaleResolverScriptVariables(Map<String,Object> variables, javax.servlet.http.HttpServletRequest request)
static void	addRestScriptVariables(Map<String,Object> variables, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext servletContext)
static void	addSiteItemScriptVariables(Map<String,Object> variables, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext servletContext, SiteItem item, Object templateModel)
static org.codehaus.groovy.control.CompilerConfiguration	getCompilerConfiguration(boolean enableScriptSandbox)

Methods inherited from class java.lang.Object

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

Field Details

GROOVY_SCRIPT_LOGGER

public static final org.slf4j.Logger GROOVY_SCRIPT_LOGGER

VARIABLE_APPLICATION

public static final String VARIABLE_APPLICATION

See Also:

• Constant Field Values

VARIABLE_REQUEST

public static final String VARIABLE_REQUEST

See Also:

• Constant Field Values

VARIABLE_RESPONSE

public static final String VARIABLE_RESPONSE

See Also:

• Constant Field Values

VARIABLE_PARAMS

public static final String VARIABLE_PARAMS

See Also:

• Constant Field Values

VARIABLE_PATH_VARS

public static final String VARIABLE_PATH_VARS

See Also:

• Constant Field Values

VARIABLE_HEADERS

public static final String VARIABLE_HEADERS

See Also:

• Constant Field Values

VARIABLE_COOKIES

public static final String VARIABLE_COOKIES

See Also:

• Constant Field Values

VARIABLE_SESSION

public static final String VARIABLE_SESSION

See Also:

• Constant Field Values

VARIABLE_LOGGER

public static final String VARIABLE_LOGGER

See Also:

• Constant Field Values

VARIABLE_LOCALE

public static final String VARIABLE_LOCALE

See Also:

• Constant Field Values

VARIABLE_MODEL

@Deprecated
public static final String VARIABLE_MODEL

Deprecated.

See Also:

• Constant Field Values

VARIABLE_TEMPLATE_MODEL

public static final String VARIABLE_TEMPLATE_MODEL

See Also:

• Constant Field Values

VARIABLE_CRAFTER_MODEL

@Deprecated
public static final String VARIABLE_CRAFTER_MODEL

Deprecated.

See Also:

• Constant Field Values

VARIABLE_CONTENT_MODEL

public static final String VARIABLE_CONTENT_MODEL

See Also:

• Constant Field Values

VARIABLE_AUTH

public static final String VARIABLE_AUTH

See Also:

• Constant Field Values

VARIABLE_PROFILE

public static final String VARIABLE_PROFILE

See Also:

• Constant Field Values

VARIABLE_AUTH_TOKEN

public static final String VARIABLE_AUTH_TOKEN

See Also:

• Constant Field Values

VARIABLE_SITE_CONTEXT

public static final String VARIABLE_SITE_CONTEXT

See Also:

• Constant Field Values

VARIABLE_SITE_CONFIG

public static final String VARIABLE_SITE_CONFIG

See Also:

• Constant Field Values

VARIABLE_FILTER_CHAIN

public static final String VARIABLE_FILTER_CHAIN

See Also:

• Constant Field Values

VARIABLE_APPLICATION_CONTEXT

public static final String VARIABLE_APPLICATION_CONTEXT

See Also:

• Constant Field Values

Method Details

addLocaleResolverScriptVariables

public static void addLocaleResolverScriptVariables(Map<String,Object> variables,
 javax.servlet.http.HttpServletRequest request)

addRestScriptVariables

public static void addRestScriptVariables(Map<String,Object> variables,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 javax.servlet.ServletContext servletContext)

addSiteItemScriptVariables

public static void addSiteItemScriptVariables(Map<String,Object> variables,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 javax.servlet.ServletContext servletContext,
 SiteItem item,
 Object templateModel)

addControllerScriptVariables

public static void addControllerScriptVariables(Map<String,Object> variables,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 javax.servlet.ServletContext servletContext,
 Object templateModel)

addFilterScriptVariables

public static void addFilterScriptVariables(Map<String,Object> variables,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response,
 javax.servlet.ServletContext servletContext,
 javax.servlet.FilterChain filterChain)

addHealthCheckScriptVariables

public static void addHealthCheckScriptVariables(Map<String,Object> variables,
 boolean disableVariableRestrictions)

addJobScriptVariables

public static void addJobScriptVariables(Map<String,Object> variables,
 javax.servlet.ServletContext servletContext)

getCompilerConfiguration

public static org.codehaus.groovy.control.CompilerConfiguration getCompilerConfiguration(boolean enableScriptSandbox)