GroovyPagesServlet (Groovy Server Pages (GSP)

org.grails.web.pages.GroovyPagesServlet

All Implemented Interfaces and Traits:: PluginManagerAware

public class GroovyPagesServlet
extends FrameworkServlet
implements PluginManagerAware

NOTE: Based on work done by on the GSP standalone project (https://gsp.dev.java.net/) Main servlet class. Example usage in web.xml:

 <servlet>
       <servlet-name>GroovyPagesServlet</servlet-name>
       <servlet-class>GroovyPagesServlet</servlet-class>
        <init-param>
            <param-name>showSource</param-name>
            <param-value>1</param-value>
            <description>
             Allows developers to view the intermediade source code, when they pass
                a showSource argument in the URL (eg /edit/list?showSource=true.
          </description>
        </init-param>
    </servlet>

Authors:: Troy Heninger; Graeme Rocher Date: Jan 10, 2004

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`SERVLET_INSTANCE`	The size of the buffer used when formulating the response

Constructor Summary

Constructors
Constructor and description
`GroovyPagesServlet ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected ServletRequestAttributes`	`buildRequestAttributes(HttpServletRequest request, HttpServletResponse response, RequestAttributes previousAttributes)`
	`protected GSPResponseWriter`	`createResponseWriter(HttpServletResponse response)` Creates a response writer for the given response object
	`protected void`	`doService(HttpServletRequest request, HttpServletResponse response)`
	`protected GroovyPageScriptSource`	`findPageInBinaryPlugins(java.lang.String pageName)`
	`protected java.lang.String`	`getCurrentRequestUri(HttpServletRequest request)`
	`public GroovyPagesTemplateEngine`	`getGroovyPagesTemplateEngine()`
	`protected void`	`initFrameworkServlet()`
	`protected boolean`	`isSecurePath(java.lang.String pageName)`
	`protected void`	`renderPageWithEngine(GroovyPagesTemplateEngine engine, HttpServletRequest request, HttpServletResponse response, GroovyPageScriptSource scriptSource)` Attempts to render the page with the given arguments
	`protected void`	`sendNotFound(HttpServletResponse response, java.lang.String pageName)`
	`public void`	`setGroovyPagesTemplateEngine(GroovyPagesTemplateEngine groovyPagesTemplateEngine)`
	`public void`	`setPluginManager(GrailsPluginManager pluginManager)`

- Field Detail
  - public static final java.lang.String SERVLET_INSTANCE
    
    The size of the buffer used when formulating the response
- Constructor Detail
  - public GroovyPagesServlet()
- Method Detail
  - @java.lang.Override protected ServletRequestAttributes buildRequestAttributes(HttpServletRequest request, HttpServletResponse response, RequestAttributes previousAttributes)
  - protected GSPResponseWriter createResponseWriter(HttpServletResponse response)
    
    Creates a response writer for the given response object
    Parameters:
    response - The HttpServletResponse
    Returns:
    The created java.io.Writer
  - @java.lang.Override protected void doService(HttpServletRequest request, HttpServletResponse response)
  - protected GroovyPageScriptSource findPageInBinaryPlugins(java.lang.String pageName)
  - protected java.lang.String getCurrentRequestUri(HttpServletRequest request)
  - public GroovyPagesTemplateEngine getGroovyPagesTemplateEngine()
  - @java.lang.Override protected void initFrameworkServlet()
  - protected boolean isSecurePath(java.lang.String pageName)
  - protected void renderPageWithEngine(GroovyPagesTemplateEngine engine, HttpServletRequest request, HttpServletResponse response, GroovyPageScriptSource scriptSource)
    
    Attempts to render the page with the given arguments
    throws:
    IOException Thrown when an I/O exception occurs rendering the page
    
    Parameters:
    engine - The GroovyPagesTemplateEngine to use
    request - The HttpServletRequest
    response - The HttpServletResponse
    scriptSource - The template
  - protected void sendNotFound(HttpServletResponse response, java.lang.String pageName)
  - public void setGroovyPagesTemplateEngine(GroovyPagesTemplateEngine groovyPagesTemplateEngine)
  - public void setPluginManager(GrailsPluginManager pluginManager)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class GroovyPagesServlet

Field Summary

Constructor Summary

Methods Summary

Field Detail

public static final java.lang.String SERVLET_INSTANCE

Constructor Detail

public GroovyPagesServlet()

Method Detail

@java.lang.Override protected ServletRequestAttributes buildRequestAttributes(HttpServletRequest request, HttpServletResponse response, RequestAttributes previousAttributes)

protected GSPResponseWriter createResponseWriter(HttpServletResponse response)

@java.lang.Override protected void doService(HttpServletRequest request, HttpServletResponse response)

protected GroovyPageScriptSource findPageInBinaryPlugins(java.lang.String pageName)

protected java.lang.String getCurrentRequestUri(HttpServletRequest request)

public GroovyPagesTemplateEngine getGroovyPagesTemplateEngine()

@java.lang.Override protected void initFrameworkServlet()

protected boolean isSecurePath(java.lang.String pageName)

protected void renderPageWithEngine(GroovyPagesTemplateEngine engine, HttpServletRequest request, HttpServletResponse response, GroovyPageScriptSource scriptSource)

protected void sendNotFound(HttpServletResponse response, java.lang.String pageName)

public void setGroovyPagesTemplateEngine(GroovyPagesTemplateEngine groovyPagesTemplateEngine)

public void setPluginManager(GrailsPluginManager pluginManager)