Package groovy.servlet

Class GroovyServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

groovy.servlet.AbstractHttpServlet

groovy.servlet.GroovyServlet

All Implemented Interfaces:

ResourceConnector, jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

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

See Also:

• ServletBinding
• Serialized Form

Field Summary

Fields inherited from class groovy.servlet.AbstractHttpServlet

CONTENT_TYPE_TEXT_HTML, encoding, INC_PATH_INFO, INC_REQUEST_URI, INC_SERVLET_PATH, INIT_PARAM_RESOURCE_NAME_REGEX, INIT_PARAM_RESOURCE_NAME_REGEX_FLAGS, namePrefix, reflection, resourceNamePattern, resourceNameReplaceAll, resourceNameReplacement, servletContext, verbose

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
GroovyServlet()

Method Summary

Modifier and Type	Method	Description
protected GroovyScriptEngine	createGroovyScriptEngine()	Hook method to set up the GroovyScriptEngine to use. Subclasses may override this method to provide a custom engine.
void	init(jakarta.servlet.ServletConfig config)	Initialize the GroovyServlet.
void	service(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handle web requests to the GroovyServlet

Methods inherited from class groovy.servlet.AbstractHttpServlet

applyResourceNameMatcher, generateNamePrefixOnce, getResourceConnection, getScriptUri, getScriptUriAsFile, removeNamePrefix, setVariables

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GroovyServlet

public GroovyServlet()

Method Details

init

public void init(jakarta.servlet.ServletConfig config)
          throws jakarta.servlet.ServletException

Initialize the GroovyServlet.

Specified by:

init in interface jakarta.servlet.Servlet

Overrides:

init in class AbstractHttpServlet

Parameters:

config - the servlet configuration provided by the container

Throws:

jakarta.servlet.ServletException - if this method encountered difficulties

service

public void service(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
             throws IOException

Handle web requests to the GroovyServlet

Overrides:

service in class jakarta.servlet.http.HttpServlet

Throws:

IOException

createGroovyScriptEngine

protected GroovyScriptEngine createGroovyScriptEngine()

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