spark

Class Spark

java.lang.Object

spark.Spark

public class Spark
extends Object

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!"; }); The public methods and fields in this class should be statically imported for the semantic to make sense. Ie. one should use: 'post("/books")' without the prefix 'Spark.'

Author:

Per Wendel

Field Summary

Fields

Modifier and Type	Field and Description
static Redirect	redirect Statically import this for redirect utility functionality, see Redirect
static Service.StaticFiles	staticFiles Statically import this for static files utility functionality, see Service.StaticFiles

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Spark()

Method Summary

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	awaitInitialization() Waits for the spark server to be initialized.
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	externalStaticFileLocation(String externalFolder) Sets the external folder serving static files.
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 void	init() Initializes the Spark server.
static void	ipAddress(String ipAddress) Set the IP address that Spark should listen on.
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	port(int port) Set the port that Spark should listen on.
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	secure(String keystoreFile, String keystorePassword, String truststoreFile, String truststorePassword) Set the connection to be secure, using the specified keystore and truststore.
static void	setIpAddress(String ipAddress) Deprecated. replaced by ipAddress(String)
static void	setPort(int port) Deprecated. replaced by port(int)
static void	setSecure(String keystoreFile, String keystorePassword, String truststoreFile, String truststorePassword) Deprecated. replaced by secure(String, String, String, String)
static void	staticFileLocation(String folder) Sets the folder in classpath serving static files.
static void	stop() Stops the Spark server and clears all routes
static void	threadPool(int maxThreads) Configures the embedded web server's thread pool.
static void	threadPool(int maxThreads, int minThreads, int idleTimeoutMillis) Configures the embedded web server's thread pool.
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
static void	webSocket(String path, Class<?> handler) Maps the given path to the given WebSocket handler.
static void	webSocketIdleTimeoutMillis(int timeoutMillis) Sets the max idle timeout in milliseconds for WebSocket connections.

Methods inherited from class java.lang.Object

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

Field Detail

redirect

public static final Redirect redirect

Statically import this for redirect utility functionality, see Redirect

staticFiles

public static final Service.StaticFiles staticFiles

Statically import this for static files utility functionality, see Service.StaticFiles

Constructor Detail

Spark

protected Spark()

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

setIpAddress

public static void setIpAddress(String ipAddress)

Deprecated. replaced by ipAddress(String)

Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'. This has to be called before any route mapping is done.

Parameters:

ipAddress - The ipAddress

ipAddress

public static void ipAddress(String ipAddress)

Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'. This has to be called before any route mapping is done.

Parameters:

ipAddress - The ipAddress

setPort

public static void setPort(int port)

Deprecated. replaced by port(int)

Set the port that Spark should listen on. If not called the default port is 4567. This has to be called before any route mapping is done. If provided port = 0 then the an arbitrary available port will be used.

Parameters:

port - The port number

port

public static void port(int port)

Set the port that Spark should listen on. If not called the default port is 4567. This has to be called before any route mapping is done. If provided port = 0 then the an arbitrary available port will be used.

Parameters:

port - The port number

setSecure

public static void setSecure(String keystoreFile,
                             String keystorePassword,
                             String truststoreFile,
                             String truststorePassword)

Deprecated. replaced by secure(String, String, String, String)

Set the connection to be secure, using the specified keystore and truststore. This has to be called before any route mapping is done. You have to supply a keystore file, truststore file is optional (keystore will be reused). This method is only relevant when using embedded Jetty servers. It should not be used if you are using Servlets, where you will need to secure the connection in the servlet container

Parameters:

keystoreFile - The keystore file location as string

keystorePassword - the password for the keystore

truststoreFile - the truststore file location as string, leave null to reuse keystore

truststorePassword - the trust store password

secure

public static void secure(String keystoreFile,
                          String keystorePassword,
                          String truststoreFile,
                          String truststorePassword)

Set the connection to be secure, using the specified keystore and truststore. This has to be called before any route mapping is done. You have to supply a keystore file, truststore file is optional (keystore will be reused). This method is only relevant when using embedded Jetty servers. It should not be used if you are using Servlets, where you will need to secure the connection in the servlet container

Parameters:

keystoreFile - The keystore file location as string

keystorePassword - the password for the keystore

truststoreFile - the truststore file location as string, leave null to reuse keystore

truststorePassword - the trust store password

threadPool

public static void threadPool(int maxThreads)

Configures the embedded web server's thread pool.

Parameters:

maxThreads - max nbr of threads.

threadPool

public static void threadPool(int maxThreads,
                              int minThreads,
                              int idleTimeoutMillis)

Configures the embedded web server's thread pool.

Parameters:

maxThreads - max nbr of threads.

minThreads - min nbr of threads.

idleTimeoutMillis - thread idle timeout (ms).

staticFileLocation

public static void staticFileLocation(String folder)

Sets the folder in classpath serving static files. Observe: this method must be called before all other methods. - Note: contemplate changing tonew static files paradigm Service.StaticFiles

Parameters:

folder - the folder in classpath.

externalStaticFileLocation

public static void externalStaticFileLocation(String externalFolder)

Sets the external folder serving static files. Observe: this method must be called before all other methods. - Note: contemplate use of new static files paradigm Service.StaticFiles

Parameters:

externalFolder - the external folder serving static files.

awaitInitialization

public static void awaitInitialization()

Waits for the spark server to be initialized. If it's already initialized will return immediately

stop

public static void stop()

Stops the Spark server and clears all routes

webSocket

public static void webSocket(String path,
                             Class<?> handler)

Maps the given path to the given WebSocket handler.

This is currently only available in the embedded server mode.

Parameters:

path - the WebSocket path.

handler - the handler class that will manage the WebSocket connection to the given path.

webSocketIdleTimeoutMillis

public static void webSocketIdleTimeoutMillis(int timeoutMillis)

Sets the max idle timeout in milliseconds for WebSocket connections.

Parameters:

timeoutMillis - The max idle timeout in milliseconds.

init

public static void init()

Initializes the Spark server. SHOULD just be used when using the Websockets functionality.

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