Spark (Spark 2.1 API)

java.lang.Object
- spark.SparkBase
- - spark.Spark

```
public final class Spark
extends SparkBase
```
The main building block of a Spark 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, response)
Example: get("/hello", (request, response) -> { return "Hello World!"; });
Author:

Per Wendel

Field Summary
- Fields inherited from class spark.SparkBase
  DEFAULT_ACCEPT_TYPE, externalStaticFileFolder, initialized, ipAddress, keystoreFile, keystorePassword, port, routeMatcher, server, SPARK_DEFAULT_PORT, staticFileFolder, truststoreFile, truststorePassword

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`after(Filter filter)` Maps a filter to be executed after any matching routes
`static void`	`after(String path, Filter filter)` Maps a filter to be executed after any matching routes
`static void`	`after(String path, String acceptType, Filter filter)` Maps a filter to be executed after any matching routes
`static void`	`before(Filter filter)` Maps a filter to be executed before any matching routes
`static void`	`before(String path, Filter filter)` Maps a filter to be executed before any matching routes
`static void`	`before(String path, String acceptType, Filter filter)` Maps a filter to be executed before any matching routes
`static void`	`connect(String path, Route route)` Map the route for HTTP CONNECT requests
`static void`	`connect(String path, Route route, ResponseTransformer transformer)` Map the route for HTTP CONNECT requests
`static void`	`connect(String path, String acceptType, Route route)` Map the route for HTTP CONNECT requests
`static void`	`connect(String path, String acceptType, Route route, ResponseTransformer transformer)` Map the route for HTTP CONNECT requests
`static void`	`connect(String path, String acceptType, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP CONNECT requests
`static void`	`connect(String path, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP CONNECT requests
`static void`	`delete(String path, Route route)` Map the route for HTTP DELETE requests
`static void`	`delete(String path, Route route, ResponseTransformer transformer)` Map the route for HTTP DELETE requests
`static void`	`delete(String path, String acceptType, Route route)` Map the route for HTTP DELETE requests
`static void`	`delete(String path, String acceptType, Route route, ResponseTransformer transformer)` Map the route for HTTP DELETE requests
`static void`	`delete(String path, String acceptType, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP DELETE requests
`static void`	`delete(String path, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP DELETE requests
`static void`	`exception(Class<? extends Exception> exceptionClass, ExceptionHandler handler)` Maps an exception handler to be executed when an exception occurs during routing
`static void`	`get(String path, Route route)` Map the route for HTTP GET requests
`static void`	`get(String path, Route route, ResponseTransformer transformer)` Map the route for HTTP GET requests
`static void`	`get(String path, String acceptType, Route route)` Map the route for HTTP GET requests
`static void`	`get(String path, String acceptType, Route route, ResponseTransformer transformer)` Map the route for HTTP GET requests
`static void`	`get(String path, String acceptType, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP GET requests
`static void`	`get(String path, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP GET requests
`static void`	`halt()` Immediately stops a request within a filter or route NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise halt will not work
`static void`	`halt(int status)` Immediately stops a request within a filter or route with specified status code NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise halt will not work
`static void`	`halt(int status, String body)` Immediately stops a request within a filter or route with specified status code and body content NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise halt will not work
`static void`	`halt(String body)` Immediately stops a request within a filter or route with specified body content NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise halt will not work
`static void`	`head(String path, Route route)` Map the route for HTTP HEAD requests
`static void`	`head(String path, Route route, ResponseTransformer transformer)` Map the route for HTTP HEAD requests
`static void`	`head(String path, String acceptType, Route route)` Map the route for HTTP HEAD requests
`static void`	`head(String path, String acceptType, Route route, ResponseTransformer transformer)` Map the route for HTTP HEAD requests
`static void`	`head(String path, String acceptType, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP HEAD requests
`static void`	`head(String path, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP HEAD requests
`static ModelAndView`	`modelAndView(Object model, String viewName)` Constructs a ModelAndView with the provided model and view name
`static void`	`options(String path, Route route)` Map the route for HTTP OPTIONS requests
`static void`	`options(String path, Route route, ResponseTransformer transformer)` Map the route for HTTP OPTIONS requests
`static void`	`options(String path, String acceptType, Route route)` Map the route for HTTP OPTIONS requests
`static void`	`options(String path, String acceptType, Route route, ResponseTransformer transformer)` Map the route for HTTP OPTIONS requests
`static void`	`options(String path, String acceptType, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP OPTIONS requests
`static void`	`options(String path, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP OPTIONS requests
`static void`	`patch(String path, Route route)` Map the route for HTTP PATCH requests
`static void`	`patch(String path, Route route, ResponseTransformer transformer)` Map the route for HTTP PATCH requests
`static void`	`patch(String path, String acceptType, Route route)` Map the route for HTTP PATCH requests
`static void`	`patch(String path, String acceptType, Route route, ResponseTransformer transformer)` Map the route for HTTP PATCH requests
`static void`	`patch(String path, String acceptType, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP PATCH requests
`static void`	`patch(String path, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP PATCH requests
`static void`	`post(String path, Route route)` Map the route for HTTP POST requests
`static void`	`post(String path, Route route, ResponseTransformer transformer)` Map the route for HTTP POST requests
`static void`	`post(String path, String acceptType, Route route)` Map the route for HTTP POST requests
`static void`	`post(String path, String acceptType, Route route, ResponseTransformer transformer)` Map the route for HTTP POST requests
`static void`	`post(String path, String acceptType, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP POST requests
`static void`	`post(String path, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP POST requests
`static void`	`put(String path, Route route)` Map the route for HTTP PUT requests
`static void`	`put(String path, Route route, ResponseTransformer transformer)` Map the route for HTTP PUT requests
`static void`	`put(String path, String acceptType, Route route)` Map the route for HTTP PUT requests
`static void`	`put(String path, String acceptType, Route route, ResponseTransformer transformer)` Map the route for HTTP PUT requests
`static void`	`put(String path, String acceptType, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP PUT requests
`static void`	`put(String path, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP PUT requests
`static void`	`trace(String path, Route route)` Map the route for HTTP TRACE requests
`static void`	`trace(String path, Route route, ResponseTransformer transformer)` Map the route for HTTP TRACE requests
`static void`	`trace(String path, String acceptType, Route route)` Map the route for HTTP TRACE requests
`static void`	`trace(String path, String acceptType, Route route, ResponseTransformer transformer)` Map the route for HTTP TRACE requests
`static void`	`trace(String path, String acceptType, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP TRACE requests
`static void`	`trace(String path, TemplateViewRoute route, TemplateEngine engine)` Map the route for HTTP TRACE requests

Methods inherited from class spark.SparkBase
addFilter, addRoute, externalStaticFileLocation, ipAddress, port, secure, setIpAddress, setPort, setSecure, staticFileLocation, stop, wrap, wrap, wrap, wrap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public static void get(String path,
                       Route route)

Map the route for HTTP GET requests

Parameters:: path - the path; route - The route

post

public static void post(String path,
                        Route route)

Map the route for HTTP POST requests

Parameters:: path - the path; route - The route

put

public static void put(String path,
                       Route route)

Map the route for HTTP PUT requests

Parameters:: path - the path; route - The route

patch

public static void patch(String path,
                         Route route)

Map the route for HTTP PATCH requests

Parameters:: path - the path; route - The route

delete

public static void delete(String path,
                          Route route)

Map the route for HTTP DELETE requests

Parameters:: path - the path; route - The route

head

public static void head(String path,
                        Route route)

Map the route for HTTP HEAD requests

Parameters:: path - the path; route - The route

trace

public static void trace(String path,
                         Route route)

Map the route for HTTP TRACE requests

Parameters:: path - the path; route - The route

connect

public static void connect(String path,
                           Route route)

Map the route for HTTP CONNECT requests

Parameters:: path - the path; route - The route

options

public static void options(String path,
                           Route route)

Map the route for HTTP OPTIONS requests

Parameters:: path - the path; route - The route

before

public static void before(String path,
                          Filter filter)

Maps a filter to be executed before any matching routes

Parameters:: path - the path; filter - The filter

after

public static void after(String path,
                         Filter filter)

Maps a filter to be executed after any matching routes

Parameters:: path - the path; filter - The filter

get

public static void get(String path,
                       String acceptType,
                       Route route)

Map the route for HTTP GET requests

Parameters:: path - the path; acceptType - the accept type; route - The route

post

public static void post(String path,
                        String acceptType,
                        Route route)

Map the route for HTTP POST requests

Parameters:: path - the path; acceptType - the accept type; route - The route

put

public static void put(String path,
                       String acceptType,
                       Route route)

Map the route for HTTP PUT requests

Parameters:: path - the path; acceptType - the accept type; route - The route

patch

public static void patch(String path,
                         String acceptType,
                         Route route)

Map the route for HTTP PATCH requests

Parameters:: path - the path; acceptType - the accept type; route - The route

delete

public static void delete(String path,
                          String acceptType,
                          Route route)

Map the route for HTTP DELETE requests

Parameters:: path - the path; acceptType - the accept type; route - The route

head

public static void head(String path,
                        String acceptType,
                        Route route)

Map the route for HTTP HEAD requests

Parameters:: path - the path; acceptType - the accept type; route - The route

trace

public static void trace(String path,
                         String acceptType,
                         Route route)

Map the route for HTTP TRACE requests

Parameters:: path - the path; acceptType - the accept type; route - The route

connect

public static void connect(String path,
                           String acceptType,
                           Route route)

Map the route for HTTP CONNECT requests

Parameters:: path - the path; acceptType - the accept type; route - The route

options

public static void options(String path,
                           String acceptType,
                           Route route)

Map the route for HTTP OPTIONS requests

Parameters:: path - the path; acceptType - the accept type; route - The route

before
```
public static void before(Filter filter)
```
Maps a filter to be executed before any matching routes

Parameters:

filter - The filter

after
```
public static void after(Filter filter)
```
Maps a filter to be executed after any matching routes

Parameters:

filter - The filter

before

public static void before(String path,
                          String acceptType,
                          Filter filter)

Maps a filter to be executed before any matching routes

Parameters:: path - the path; acceptType - the accept type; filter - The filter

after

public static void after(String path,
                         String acceptType,
                         Filter filter)

Maps a filter to be executed after any matching routes

Parameters:: path - the path; acceptType - the accept type; filter - The filter

get

public static void get(String path,
                       TemplateViewRoute route,
                       TemplateEngine engine)

Map the route for HTTP GET requests

Parameters:: path - the path; route - The route; engine - the template engine

get

public static void get(String path,
                       String acceptType,
                       TemplateViewRoute route,
                       TemplateEngine engine)

Map the route for HTTP GET requests

Parameters:: path - the path; acceptType - the accept type; route - The route; engine - the template engine

post

public static void post(String path,
                        TemplateViewRoute route,
                        TemplateEngine engine)

Map the route for HTTP POST requests

Parameters:: path - the path; route - The route; engine - the template engine

post

public static void post(String path,
                        String acceptType,
                        TemplateViewRoute route,
                        TemplateEngine engine)

Map the route for HTTP POST requests

Parameters:: path - the path; acceptType - the accept type; route - The route; engine - the template engine

put

public static void put(String path,
                       TemplateViewRoute route,
                       TemplateEngine engine)

Map the route for HTTP PUT requests

Parameters:: path - the path; route - The route; engine - the template engine

put

public static void put(String path,
                       String acceptType,
                       TemplateViewRoute route,
                       TemplateEngine engine)

Map the route for HTTP PUT requests

Parameters:: path - the path; acceptType - the accept type; route - The route; engine - the template engine

delete

public static void delete(String path,
                          TemplateViewRoute route,
                          TemplateEngine engine)

Map the route for HTTP DELETE requests

Parameters:: path - the path; route - The route; engine - the template engine

delete

public static void delete(String path,
                          String acceptType,
                          TemplateViewRoute route,
                          TemplateEngine engine)

Map the route for HTTP DELETE requests

Parameters:: path - the path; acceptType - the accept type; route - The route; engine - the template engine

patch

public static void patch(String path,
                         TemplateViewRoute route,
                         TemplateEngine engine)

Map the route for HTTP PATCH requests

Parameters:: path - the path; route - The route; engine - the template engine

patch

public static void patch(String path,
                         String acceptType,
                         TemplateViewRoute route,
                         TemplateEngine engine)

Map the route for HTTP PATCH requests

Parameters:: path - the path; acceptType - the accept type; route - The route; engine - the template engine

head

public static void head(String path,
                        TemplateViewRoute route,
                        TemplateEngine engine)

Map the route for HTTP HEAD requests

Parameters:: path - the path; route - The route; engine - the template engine

head

public static void head(String path,
                        String acceptType,
                        TemplateViewRoute route,
                        TemplateEngine engine)

Map the route for HTTP HEAD requests

Parameters:: path - the path; acceptType - the accept type; route - The route; engine - the template engine

trace

public static void trace(String path,
                         TemplateViewRoute route,
                         TemplateEngine engine)

Map the route for HTTP TRACE requests

Parameters:: path - the path; route - The route; engine - the template engine

trace

public static void trace(String path,
                         String acceptType,
                         TemplateViewRoute route,
                         TemplateEngine engine)

Map the route for HTTP TRACE requests

Parameters:: path - the path; acceptType - the accept type; route - The route; engine - the template engine

connect

public static void connect(String path,
                           TemplateViewRoute route,
                           TemplateEngine engine)

Map the route for HTTP CONNECT requests

Parameters:: path - the path; route - The route; engine - the template engine

connect

public static void connect(String path,
                           String acceptType,
                           TemplateViewRoute route,
                           TemplateEngine engine)

Map the route for HTTP CONNECT requests

Parameters:: path - the path; acceptType - the accept type; route - The route; engine - the template engine

options

public static void options(String path,
                           TemplateViewRoute route,
                           TemplateEngine engine)

Map the route for HTTP OPTIONS requests

Parameters:: path - the path; route - The route; engine - the template engine

options

public static void options(String path,
                           String acceptType,
                           TemplateViewRoute route,
                           TemplateEngine engine)

Map the route for HTTP OPTIONS requests

Parameters:: path - the path; acceptType - the accept type; route - The route; engine - the template engine

get

public static void get(String path,
                       Route route,
                       ResponseTransformer transformer)

Map the route for HTTP GET requests

Parameters:: path - the path; route - The route; transformer - the response transformer

get

public static void get(String path,
                       String acceptType,
                       Route route,
                       ResponseTransformer transformer)

Map the route for HTTP GET requests

Parameters:: path - the path; acceptType - the accept type; route - The route; transformer - the response transformer

post

public static void post(String path,
                        Route route,
                        ResponseTransformer transformer)

Map the route for HTTP POST requests

Parameters:: path - the path; route - The route; transformer - the response transformer

post

public static void post(String path,
                        String acceptType,
                        Route route,
                        ResponseTransformer transformer)

Map the route for HTTP POST requests

Parameters:: path - the path; acceptType - the accept type; route - The route; transformer - the response transformer

put

public static void put(String path,
                       Route route,
                       ResponseTransformer transformer)

Map the route for HTTP PUT requests

Parameters:: path - the path; route - The route; transformer - the response transformer

put

public static void put(String path,
                       String acceptType,
                       Route route,
                       ResponseTransformer transformer)

Map the route for HTTP PUT requests

Parameters:: path - the path; acceptType - the accept type; route - The route; transformer - the response transformer

delete

public static void delete(String path,
                          Route route,
                          ResponseTransformer transformer)

Map the route for HTTP DELETE requests

Parameters:: path - the path; route - The route; transformer - the response transformer

delete

public static void delete(String path,
                          String acceptType,
                          Route route,
                          ResponseTransformer transformer)

Map the route for HTTP DELETE requests

Parameters:: path - the path; acceptType - the accept type; route - The route; transformer - the response transformer

head

public static void head(String path,
                        Route route,
                        ResponseTransformer transformer)

Map the route for HTTP HEAD requests

Parameters:: path - the path; route - The route; transformer - the response transformer

head

public static void head(String path,
                        String acceptType,
                        Route route,
                        ResponseTransformer transformer)

Map the route for HTTP HEAD requests

Parameters:: path - the path; acceptType - the accept type; route - The route; transformer - the response transformer

connect

public static void connect(String path,
                           Route route,
                           ResponseTransformer transformer)

Map the route for HTTP CONNECT requests

Parameters:: path - the path; route - The route; transformer - the response transformer

connect

public static void connect(String path,
                           String acceptType,
                           Route route,
                           ResponseTransformer transformer)

Map the route for HTTP CONNECT requests

Parameters:: path - the path; acceptType - the accept type; route - The route; transformer - the response transformer

trace

public static void trace(String path,
                         Route route,
                         ResponseTransformer transformer)

Map the route for HTTP TRACE requests

Parameters:: path - the path; route - The route; transformer - the response transformer

trace

public static void trace(String path,
                         String acceptType,
                         Route route,
                         ResponseTransformer transformer)

Map the route for HTTP TRACE requests

Parameters:: path - the path; acceptType - the accept type; route - The route; transformer - the response transformer

options

public static void options(String path,
                           Route route,
                           ResponseTransformer transformer)

Map the route for HTTP OPTIONS requests

Parameters:: path - the path; route - The route; transformer - the response transformer

options

public static void options(String path,
                           String acceptType,
                           Route route,
                           ResponseTransformer transformer)

Map the route for HTTP OPTIONS requests

Parameters:: path - the path; acceptType - the accept type; route - The route; transformer - the response transformer

patch

public static void patch(String path,
                         Route route,
                         ResponseTransformer transformer)

Map the route for HTTP PATCH requests

Parameters:: path - the path; route - The route; transformer - the response transformer

patch

public static void patch(String path,
                         String acceptType,
                         Route route,
                         ResponseTransformer transformer)

Map the route for HTTP PATCH requests

Parameters:: path - the path; acceptType - the accept type; route - The route; transformer - the response transformer

exception

public static void exception(Class<? extends Exception> exceptionClass,
                             ExceptionHandler handler)

Maps an exception handler to be executed when an exception occurs during routing

Parameters:: exceptionClass - the exception class; handler - The handler

halt
```
public static void halt()
```
Immediately stops a request within a filter or route NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise halt will not work

halt
```
public static void halt(int status)
```
Immediately stops a request within a filter or route with specified status code NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise halt will not work

Parameters:

status - the status code

halt
```
public static void halt(String body)
```
Immediately stops a request within a filter or route with specified body content NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise halt will not work

Parameters:

body - The body content

halt
```
public static void halt(int status,
                        String body)
```
Immediately stops a request within a filter or route with specified status code and body content NOTE: When using this don't catch exceptions of type HaltException, or if catched, re-throw otherwise halt will not work

Parameters:

status - The status code

body - The body content

modelAndView

public static ModelAndView modelAndView(Object model,
                                        String viewName)

Constructs a ModelAndView with the provided model and view name

Parameters:: model - the model; viewName - the view name
Returns:: the model and view

Class Spark

Field Summary

Fields inherited from class spark.SparkBase

Method Summary

Methods inherited from class spark.SparkBase

Methods inherited from class java.lang.Object

Method Detail

get

post

put

patch

delete

head

trace

connect

options

before

after

get

post

put

patch

delete

head

trace

connect

options

before

after

before

after

get

get

post

post

put

put

delete

delete

patch

patch

head

head

trace

trace

connect

connect

options

options

get

get

post

post

put

put

delete

delete

head

head

connect

connect

trace

trace

options

options

patch

patch

exception

halt

halt

halt

halt

modelAndView