Package org.craftercms.studio.api.v2.service.scripting

Interface ScriptingService

All Known Implementing Classes:

ScriptingServiceImpl

public interface ScriptingService

Defines all operations related to scripts

Since:

4.0

Author:

joseross

Method Summary

Modifier and Type	Method	Description
Object	executeRestScript(String siteId, String path, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Executes a REST script from the site repository
void	reload(String siteId)	Reloads the classpath for the given site

Method Detail

executeRestScript

Object executeRestScript(String siteId,
                         String path,
                         javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws groovy.util.ResourceException,
                         groovy.util.ScriptException,
                         ConfigurationException

Executes a REST script from the site repository

Parameters:

siteId - the id of the site

path - the path of the script

request - the current request

response - the current response

Returns:

the value returned by the script

Throws:

groovy.util.ResourceException - if there is any error loading the script

groovy.util.ScriptException - if there is any error executing the script

ConfigurationException

reload

void reload(String siteId)

Reloads the classpath for the given site

Parameters:

siteId - the id of the site