[Java] Class GroovyServlet

  • groovy.servlet.GroovyServlet

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".

See Also:
ServletBinding
Inherited fields
Fields inherited from class Fields
class AbstractHttpServlet CONTENT_TYPE_TEXT_HTML, INC_PATH_INFO, INC_REQUEST_URI, INC_SERVLET_PATH, INIT_PARAM_RESOURCE_NAME_REGEX, INIT_PARAM_RESOURCE_NAME_REGEX_FLAGS, encoding, namePrefix, reflection, resourceNamePattern, resourceNameReplaceAll, resourceNameReplacement, servletContext, verbose

Methods Summary

Methods
Type Params Return Type Name and description
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

Inherited Methods Summary

Inherited Methods
Methods inherited from class Name
class AbstractHttpServlet applyResourceNameMatcher, generateNamePrefixOnce, getResourceConnection, getScriptUri, getScriptUriAsFile, init, removeNamePrefix, setVariables

Method Detail

protected GroovyScriptEngine createGroovyScriptEngine()

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

public void init(ServletConfig config)

Initialize the GroovyServlet.

throws:
ServletException if this method encountered difficulties

public void service(HttpServletRequest request, HttpServletResponse response)

Handle web requests to the GroovyServlet

© 2003-2020 The Apache Software Foundation
Licensed under the Apache license.
https://docs.groovy-lang.org/2.5.14/html/gapi/groovy/servlet/GroovyServlet.html