Getting started

First, setup the JCenter respository.

Then, add the Sabina maven dependency:


Or with Gradle:

dependencies {
    compile ('sabina:http:2.4.0') { transitive = false }
    // Import the backend you are going to use
    compile 'io.undertow:undertow-servlet:1.2.8.Final'

And start coding:

import static sabina.Sabina.*;

public class HiWorld {
    public static void main(String[] args) {
        get("/hello", it -> "Hi World!").start ();

Ignite and view at



The main building block of a Sabina application is a set of routes. A route is made up of three
simple pieces:

A verb (get, post, put, delete, head, trace, connect, options)
A path (/hello, /users/:name)
A callback (request -> { })

NOTE! Routes are matched in the order they are defined. The first route that matches the
request is invoked.

get ("/", it -> {
    // Show something ...

post ("/", it -> {
    // Create something ...

put ("/", it -> {
    // Update something ...

delete ("/", it -> {
    // Annihilate something ...

options ("/", it -> {
    // Appease something ...

Route patterns may include named parameters, accessible via the params method on the request

 * Matches "GET /hello/foo" and "GET /hello/bar"
 * it.request.params(":name") is 'foo' or 'bar'
get ("/hello/:name", it -> {
    return "Hello: " + it.request.params(":name");

Route patterns may also include splat (or wildcard) parameters, accessible via the splat method
on the request object:

 * Matches "GET /say/hello/to/world"
 * it.request.splat()[0] is 'hello' and request.splat()[1] 'world'
get ("/say/*/to/*", it -> {
    return "Nbr of splat parameters: " + it.request.splat().length;


In the handle method request information and functionality is provided by the request

request.body();                // Request body sent by the client
request.cookies();             // Request cookies sent by the client
request.contentLength();       // Length of request body
request.contentType();         // Content type of request.body
request.headers();             // The HTTP header list
request.headers("BAR");        // Value of BAR header
request.attributes();          // The attributes list
request.attribute("foo");      // Value of foo attribute
request.attribute("A", "V");   // Sets value of attribute A to V;                // ""
request.ip();                  // Client IP address
request.pathInfo();            // The path info
request.params("foo");         // Value of foo path parameter
request.params();              // Map with all parameters
request.port();                // The server port
request.queryMap();            // The query map
request.queryMap("foo");       // Query map for a certain parameter
request.queryParams("FOO");    // Value of FOO query param
request.queryParams();         // The query param list
request.raw();                 // Raw request handed in by Jetty
request.requestMethod();       // The HTTP method (GET, ..etc)
request.scheme();              // "http"
request.session();             // Session management
request.splat();               // Splat (*) parameters
request.url();                 // ""
request.userAgent();           // User agent


In the handle method response information and functionality is provided by the response

response.body ("Hello");           // Sets content to Hello
response.header ("FOO", "bar");    // Sets header FOO with value bar
response.raw ();                   // Raw response handed in by Jetty
response.redirect ("/example");    // Browser redirect to /example
response.status (401);             // Set status code to 401
response.type ("text/xml");        // Set content type to text/xml

Stopping the server

By calling the stop () method the server is stopped and all routes are cleared.


Handling cookies can be done via sabina request and response objects.

request.cookies ();                            // Get map of all request cookies
request.cookie ("foo");                        // Access request cookie by name

response.cookie ("foo", "bar");                // Set cookie with a value
response.cookie ("foo", "bar", 3600);          // Set cookie with a max-age
response.cookie ("foo", "bar", 3600, true);    // Secure cookie
response.removeCookie ("foo");                 // Remove cookie

Session management

Every request has access to the session created on the server side, provided with the following

request.session (true);                             // Create (first time) and return session
request.session ().attribute ("user");              // Get session attribute 'user'
request.session ().attribute ("user", "foo");       // Set session attribute 'user'
request.session ().removeAttribute ("user", "foo"); // Remove session attribute 'user'
request.session ().attributes ();                   // Get all session attributes
request.session ().id ();                           // Get session id
request.session ().isNew ();                        // Check is session is new
request.session ().raw ();                          // Return servlet object


To immediately stop a request within a filter or route use:

halt ();

You can also specify the status when halting:

halt (401);

Or the body:

halt ("This is the body");

Or both:

halt (401, "Go Away!");


Before filters are evaluated before each request and can read the request and read/modify the

To stop execution, use halt:

before (it -> {
    boolean authenticated;
    // Check if authenticated
    if (!authenticated) {
        halt (401, "You are not welcome here");

After filters are evaluated after each request and can read the request and read/modify the

after (it -> {
    response.header("foo", "set by after filter");

Filters optionally take a pattern, causing them to be evaluated only if the request path
matches that pattern:

before ("/protected/*", it -> {
    // Check if authenticated
    halt (401, "Go Away!");

Browser Redirect

You can trigger a browser redirect with the redirect helper method:

response.redirect ("/bar");

You can also trigger a browser redirect with specific http 3XX status code:

response.redirect ("/bar", 301); // moved permanently

Exception Mapping

To handle exceptions of a configured type for all routes and filters:

get ("/throwexception", it -> {
    throw new NotFoundException ();

exception (NotFoundException.class, (e, request, response) -> {
    response.status (404);
    response.body ("Resource not found");

Static files

Assign a folder in the classpath serving static files with the staticFileLocation method.

staticFileLocation ("/public"); // Static resources

Note that the public directory name is not included in the URL. A file /public/css/style.css
is made available as http://<host>:<port>/css/style.css

You can also assign an external folder (not in the classpath) serving static files with the
externalStaticFileLocation method.

externalStaticFileLocation ("/var/www/public"); // Static files

Content Serialization

To be documented...

Views / Templates - TemplateEngine

To be documented...


To be documented...


By default, Sabina runs on port 4567. If you want to set another port use setPort.
This has to be done before using routes and filters:

setPort (9090); // Sabina will run on port 9090

Embedded Web Server

Standalone Sabina runs on an embedded Undertow web server (by default) or a Jetty container
depending on the sabina.backend system variable. Start with:


Javadoc is available at


Examples can be found on the project's page at Github