GServlet API

Table of Contents

1. Introduction
2. Getting Started
3. Documentation
4. Download
5. Changelogs
6. Support
7. Contribute

Introduction

GServlet is an open source project inspired from the Groovlets, which aims to use the Groovy language and its provided modules to simplify Servlet API web development. Groovlets are Groovy scripts executed by a servlet. They are run on request, having the whole web context (request, response, etc.) bound to the evaluation context. They are much more suitable for smaller web applications. Compared to Java Servlets, coding in Groovy can be much simpler. It has a couple of implicit variables we can use, for example, request, response to access the HttpServletRequest, and HttpServletResponse objects. We have access to the HttpSession with the session variable. If we want to output data, we can use out, sout, and html. This is more like a script as it does not have a class wrapper.

Groovlet

if (!session) {
    session = request.getSession(true)
}
if (!session.counter) {
    session.counter = 1
}
html.html {
  head {
      title('Groovy Servlet')
  }
  body {
    p("Hello, ${request.remoteHost}: ${session.counter}! ${new Date()}")
  }
}
session.counter = session.counter + 1

The same philosophy has been followed in the design of this API while maintaining a class-based programming approach.

SessionCounterServlet.groovy

import org.gservlet.annotation.Servlet

@Servlet("/counter")
class SessionCounterServlet {

  void get() {
    if (!session.counter) {
      session.counter = 1
    }
    html.html {
      head {
        title('Groovy Servlet')
      }
      body {
        p("Hello, ${request.remoteHost}: ${session.counter}! ${new Date()}")
      }
    }
    session.counter = session.counter + 1
  }

}

Getting Started

Get ready to get started and running in less than 5 minutes. We provide in our getting started page a step-by-step guide.

Documentation

In our documentation page, you’ll find all the documentation for in-depth knowledge of this project. The javadocs for a particular release can be found as well.

Download

If you want to download the artifact without a dependency management tool or want to build it from the source, we cover how to achieve it in our download page. The current version of GServlet is 1.0.1. You can search for previous releases on Maven Central.

Changelogs

Here you can find the changelogs for the past GServlet releases.

Support

There are numerous ways to get help with GServlet. Find out how in our support page.

Contribute

Would you like to contribute to the project? There are many ways in which you can bring your participation. We provide more information about how to get involved in our contribute page. GServlet is an Open Source software released under the Apache 2.0 license and it can be found on GitHub.