Class GroovyServlet

java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
groovy.servlet.AbstractHttpServlet
groovy.servlet.GroovyServlet
All Implemented Interfaces:
ResourceConnector, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

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

Author:
Sam Pullara, Mark Turansky (markturansky at hotmail.com), Guillaume Laforge, Christian Stein, Marcel Overdijk
See Also:
  • Constructor Details

    • GroovyServlet

      public GroovyServlet()
  • Method Details

    • init

      public void init(javax.servlet.ServletConfig config) throws javax.servlet.ServletException
      Initialize the GroovyServlet.
      Specified by:
      init in interface javax.servlet.Servlet
      Overrides:
      init in class AbstractHttpServlet
      Parameters:
      config - the servlet configuration provided by the container
      Throws:
      javax.servlet.ServletException - if this method encountered difficulties
      See Also:
      • UnavailableException
    • service

      public void service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws IOException
      Handle web requests to the GroovyServlet
      Overrides:
      service in class javax.servlet.http.HttpServlet
      Parameters:
      request - the HttpServletRequest object that contains the request the client made of the servlet
      response - the HttpServletResponse object that contains the response the servlet returns to the client
      Throws:
      IOException - if an input or output error occurs while the servlet is handling the HTTP request
      See Also:
      • Servlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
    • createGroovyScriptEngine

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