Groovy Documentation

## groovy.servlet
[Java] Class GroovyServlet

    java.lang.Object
      javax.servlet.http.HttpServlet
          groovy.servlet.AbstractHttpServlet
              groovy.servlet.GroovyServlet

    public class GroovyServlet
    extends AbstractHttpServlet

This servlet will run Groovy scripts as Groovlets. Groovlets are scripts with these objects implicit in their scope:

- request - the HttpServletRequest
- response - the HttpServletResponse
- application - the ServletContext associated with the servlet
- session - the HttpSession associated with the HttpServletRequest
- out - the PrintWriter associated with the ServletRequest

Your script sources can be placed either in your web application's normal web root (allows for subdirectories) or in /WEB-INF/groovy/* (also allows subdirectories).

To make your web application more groovy, you must add the GroovyServlet to your application's web.xml configuration using any mapping you like, so long as it follows the pattern *.* (more on this below). Here is the web.xml entry:

        <servlet>
          <servlet-name>Groovy</servlet-name>
          <servlet-class>groovy.servlet.GroovyServlet</servlet-class>
        </servlet>

        <servlet-mapping>
          <servlet-name>Groovy</servlet-name>
          <url-pattern>*.groovy</url-pattern>
          <url-pattern>*.gdo</url-pattern>
        </servlet-mapping>

The URL pattern does not require the "*.groovy" mapping. You can, for example, make it more Struts-like but groovy by making your mapping "*.gdo".

Authors:
  Sam Pullara
  Mark Turansky (markturansky at hotmail.com)
  Guillaume Laforge
  Christian Stein
  Marcel Overdijk

See Also:
  ServletBinding

Field Summary

Fields inherited from class AbstractHttpServlet
CONTENT_TYPE_TEXT_HTML, INC_PATH_INFO, INC_REQUEST_URI, INC_SERVLET_PATH, encoding, reflection, resourceNameMatcher, resourceNameReplaceAll, resourceNameReplacement, servletContext, verbose

Method Summary
`protected GroovyScriptEngine` | `createGroovyScriptEngine()` Hook method to setup the GroovyScriptEngine to use.
`void` | `init(ServletConfig config)` Initialize the GroovyServlet.
`void` | `service(HttpServletRequest request, HttpServletResponse response)` Handle web requests to the GroovyServlet

Methods inherited from class AbstractHttpServlet
getResourceConnection, getScriptUri, getScriptUriAsFile, init, setVariables

Method Detail

### createGroovyScriptEngine

    protected GroovyScriptEngine createGroovyScriptEngine()

  Hook method to setup the GroovyScriptEngine to use.
  Subclasses may override this method to provide a custom engine.

### init

    public void init(ServletConfig config)

  Initialize the GroovyServlet.
  throws:
    ServletException if this method encountered difficulties

### service

    public void service(HttpServletRequest request, HttpServletResponse response)

  Handle web requests to the GroovyServlet

Groovy Documentation