Package io.javalin

Class Javalin

java.lang.Object

io.javalin.Javalin

All Implemented Interfaces:

AutoCloseable

public class Javalin
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
JavalinConfig	_conf	Do not use this field unless you know what you're doing.
protected io.javalin.core.event.EventManager	eventManager
protected io.javalin.jetty.JavalinJettyServlet	javalinJettyServlet
protected io.javalin.http.JavalinServlet	javalinServlet
protected io.javalin.jetty.JettyServer	jettyServer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Javalin()
	Javalin(io.javalin.jetty.JettyServer jettyServer, io.javalin.jetty.JavalinJettyServlet jettyServlet)

Method Summary

Modifier and Type	Method	Description
Javalin	addHandler(io.javalin.http.HandlerType httpMethod, String path, Handler handler)	Adds a request handler for the specified handlerType and path to the instance.
Javalin	addHandler(io.javalin.http.HandlerType handlerType, String path, Handler handler, RouteRole... roles)	Adds a request handler for the specified handlerType and path to the instance.
Javalin	after(Handler handler)	Adds an AFTER request handler for all routes in the instance.
Javalin	after(String path, Handler handler)	Adds an AFTER request handler for the specified path to the instance.
<T> T	attribute(String key)	Retrieve an attribute stored on the instance.
Javalin	attribute(String key, Object value)	Registers an attribute on the instance.
Javalin	before(Handler handler)	Adds a BEFORE request handler for all routes in the instance.
Javalin	before(String path, Handler handler)	Adds a BEFORE request handler for the specified path to the instance.
void	close()	Synchronously stops the application instance.
static Javalin	create()	Creates a new instance without any custom configuration.
static Javalin	create(Consumer<JavalinConfig> config)	Creates a new instance with the user provided configuration.
static Javalin	createStandalone()
static Javalin	createStandalone(Consumer<JavalinConfig> config)
Javalin	delete(String path, Handler handler)	Adds a DELETE request handler for the specified path to the instance.
Javalin	delete(String path, Handler handler, RouteRole... roles)	Adds a DELETE request handler with the given roles for the specified path to the instance.
Javalin	error(int statusCode, Handler handler)	Adds an error mapper to the instance.
Javalin	error(int statusCode, String contentType, Handler handler)	Adds an error mapper for the specified content-type to the instance.
Javalin	events(Consumer<EventListener> listener)
<T extends Exception> Javalin	exception(Class<T> exceptionClass, ExceptionHandler<? super T> exceptionHandler)	Adds an exception mapper to the instance.
Javalin	get(String path, Handler handler)	Adds a GET request handler for the specified path to the instance.
Javalin	get(String path, Handler handler, RouteRole... roles)	Adds a GET request handler with the given roles for the specified path to the instance.
Javalin	head(String path, Handler handler)	Adds a HEAD request handler for the specified path to the instance.
Javalin	head(String path, Handler handler, RouteRole... roles)	Adds a HEAD request handler with the given roles for the specified path to the instance.
io.javalin.http.JavalinServlet	javalinServlet()
io.javalin.jetty.JettyServer	jettyServer()
Javalin	options(String path, Handler handler)	Adds a OPTIONS request handler for the specified path to the instance.
Javalin	options(String path, Handler handler, RouteRole... roles)	Adds a OPTIONS request handler with the given roles for the specified path to the instance.
Javalin	patch(String path, Handler handler)	Adds a PATCH request handler for the specified path to the instance.
Javalin	patch(String path, Handler handler, RouteRole... roles)	Adds a PATCH request handler with the given roles for the specified path to the instance.
int	port()	Get which port instance is running on Mostly useful if you start the instance with port(0) (random port)
Javalin	post(String path, Handler handler)	Adds a POST request handler for the specified path to the instance.
Javalin	post(String path, Handler handler, RouteRole... roles)	Adds a POST request handler with the given roles for the specified path to the instance.
Javalin	put(String path, Handler handler)	Adds a PUT request handler for the specified path to the instance.
Javalin	put(String path, Handler handler, RouteRole... roles)	Adds a PUT request handler with the given roles for the specified path to the instance.
Javalin	routes(EndpointGroup endpointGroup)	Creates a temporary static instance in the scope of the endpointGroup.
Javalin	sse(String path, io.javalin.http.sse.SseHandler handler)	Adds a lambda handler for a Server Sent Event connection on the specified path.
Javalin	sse(String path, Consumer<io.javalin.http.sse.SseClient> client)	Adds a lambda handler for a Server Sent Event connection on the specified path.
Javalin	sse(String path, Consumer<io.javalin.http.sse.SseClient> client, RouteRole... roles)	Adds a lambda handler for a Server Sent Event connection on the specified path.
Javalin	start()	Synchronously starts the application instance on the configured port, or on the configured ServerConnectors if the Jetty server has been manually configured.
Javalin	start(int port)	Synchronously starts the application instance on the specified port.
Javalin	start(String host, int port)	Synchronously starts the application instance on the specified port with the given host IP to bind to.
Javalin	stop()	Synchronously stops the application instance.
Javalin	ws(String path, Consumer<WsConfig> ws)	Adds a WebSocket handler on the specified path.
Javalin	ws(String path, Consumer<WsConfig> ws, RouteRole... roles)	Adds a WebSocket handler on the specified path with the specified roles.
Javalin	wsAfter(String path, Consumer<WsConfig> wsConfig)	Adds a WebSocket after handler for the specified path to the instance.
Javalin	wsAfter(Consumer<WsConfig> wsConfig)	Adds a WebSocket after handler for all routes in the instance.
Javalin	wsBefore(String path, Consumer<WsConfig> wsConfig)	Adds a WebSocket before handler for the specified path to the instance.
Javalin	wsBefore(Consumer<WsConfig> wsConfig)	Adds a WebSocket before handler for all routes in the instance.
<T extends Exception> Javalin	wsException(Class<T> exceptionClass, WsExceptionHandler<? super T> exceptionHandler)	Adds a WebSocket exception mapper to the instance.

Methods inherited from class java.lang.Object

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

Field Detail

_conf

public JavalinConfig _conf

Do not use this field unless you know what you're doing. Application config should be declared in create(Consumer)

jettyServer

protected io.javalin.jetty.JettyServer jettyServer

javalinJettyServlet

protected io.javalin.jetty.JavalinJettyServlet javalinJettyServlet

javalinServlet

protected io.javalin.http.JavalinServlet javalinServlet

eventManager

protected io.javalin.core.event.EventManager eventManager

Constructor Detail

Javalin

protected Javalin()

Javalin

public Javalin(io.javalin.jetty.JettyServer jettyServer,
               io.javalin.jetty.JavalinJettyServlet jettyServlet)

Method Detail

create

public static Javalin create()

Creates a new instance without any custom configuration.

See Also:

create(Consumer)

create

public static Javalin create(Consumer<JavalinConfig> config)

Creates a new instance with the user provided configuration. The server does not run until start() is called.

Returns:

application instance.

See Also:

start(), start(int)

createStandalone

public static Javalin createStandalone(Consumer<JavalinConfig> config)

createStandalone

public static Javalin createStandalone()

javalinServlet

public io.javalin.http.JavalinServlet javalinServlet()

jettyServer

@Nullable
public io.javalin.jetty.JettyServer jettyServer()

start

public Javalin start(String host,
                     int port)

Synchronously starts the application instance on the specified port with the given host IP to bind to.

Parameters:

host - The host IP to bind to

port - to run on

Returns:

running application instance.

See Also:

create(), start()

start

public Javalin start(int port)

Synchronously starts the application instance on the specified port. Use port 0 to start the application instance on a random available port.

Parameters:

port - to run on

Returns:

running application instance.

See Also:

create(), start()

start

public Javalin start()

Synchronously starts the application instance on the configured port, or on the configured ServerConnectors if the Jetty server has been manually configured. If no port or connector is configured, the instance will start on port 8080.

Returns:

running application instance.

See Also:

create()

stop

public Javalin stop()

Synchronously stops the application instance. Recommended to use close() instead with Java's try-with-resources or Kotlin's use. This differs from close() by firing lifecycle events even if the server is stopping or already stopped. This could cause your listeners to observe nonsensical state transitions. E.g. started -> stopping -> stopped -> stopping -> stopped.

Returns:

stopped application instance.

See Also:

close()

close

public void close()

Synchronously stops the application instance. Can safely be called multiple times.

Specified by:

close in interface AutoCloseable

events

public Javalin events(Consumer<EventListener> listener)

port

public int port()

Get which port instance is running on Mostly useful if you start the instance with port(0) (random port)

attribute

public Javalin attribute(String key,
                         Object value)

Registers an attribute on the instance. Instance is available on the Context through Context.appAttribute(java.lang.String). Ex: app.attribute(MyExt.class, myExtInstance()) The method must be called before start().

attribute

public <T> T attribute(String key)

Retrieve an attribute stored on the instance. Available on the Context through Context.appAttribute(java.lang.String). Ex: app.attribute(MyExt.class).myMethod() Ex: ctx.appAttribute(MyExt.class).myMethod()

routes

public Javalin routes(@NotNull
                      EndpointGroup endpointGroup)

Creates a temporary static instance in the scope of the endpointGroup. Allows you to call get(handler), post(handler), etc. without without using the instance prefix.

See Also:

Handler groups in documentation, ApiBuilder

exception

public <T extends Exception> Javalin exception(@NotNull
                                               Class<T> exceptionClass,
                                               @NotNull
                                               ExceptionHandler<? super T> exceptionHandler)

Adds an exception mapper to the instance.

See Also:

Exception mapping in docs

error

public Javalin error(int statusCode,
                     @NotNull
                     Handler handler)

Adds an error mapper to the instance. Useful for turning error-codes (404, 500) into standardized messages/pages

See Also:

Error mapping in docs

error

public Javalin error(int statusCode,
                     @NotNull
                     String contentType,
                     @NotNull
                     Handler handler)

Adds an error mapper for the specified content-type to the instance. Useful for turning error-codes (404, 500) into standardized messages/pages

See Also:

Error mapping in docs

addHandler

public Javalin addHandler(@NotNull
                          io.javalin.http.HandlerType handlerType,
                          @NotNull
                          String path,
                          @NotNull
                          Handler handler,
                          @NotNull
                          RouteRole... roles)

Adds a request handler for the specified handlerType and path to the instance. Requires an access manager to be set on the instance. This is the method that all the verb-methods (get/post/put/etc) call.

See Also:

AccessManager, Handlers in docs

addHandler

public Javalin addHandler(@NotNull
                          io.javalin.http.HandlerType httpMethod,
                          @NotNull
                          String path,
                          @NotNull
                          Handler handler)

Adds a request handler for the specified handlerType and path to the instance. This is the method that all the verb-methods (get/post/put/etc) call.

See Also:

Handlers in docs

get

public Javalin get(@NotNull
                   String path,
                   @NotNull
                   Handler handler)

Adds a GET request handler for the specified path to the instance.

See Also:

Handlers in docs

post

public Javalin post(@NotNull
                    String path,
                    @NotNull
                    Handler handler)

Adds a POST request handler for the specified path to the instance.

See Also:

Handlers in docs

put

public Javalin put(@NotNull
                   String path,
                   @NotNull
                   Handler handler)

Adds a PUT request handler for the specified path to the instance.

See Also:

Handlers in docs

patch

public Javalin patch(@NotNull
                     String path,
                     @NotNull
                     Handler handler)

Adds a PATCH request handler for the specified path to the instance.

See Also:

Handlers in docs

delete

public Javalin delete(@NotNull
                      String path,
                      @NotNull
                      Handler handler)

Adds a DELETE request handler for the specified path to the instance.

See Also:

Handlers in docs

head

public Javalin head(@NotNull
                    String path,
                    @NotNull
                    Handler handler)

Adds a HEAD request handler for the specified path to the instance.

See Also:

Handlers in docs

options

public Javalin options(@NotNull
                       String path,
                       @NotNull
                       Handler handler)

Adds a OPTIONS request handler for the specified path to the instance.

See Also:

Handlers in docs

get

public Javalin get(@NotNull
                   String path,
                   @NotNull
                   Handler handler,
                   @NotNull
                   RouteRole... roles)

Adds a GET request handler with the given roles for the specified path to the instance. Requires an access manager to be set on the instance.

See Also:

AccessManager, Handlers in docs

post

public Javalin post(@NotNull
                    String path,
                    @NotNull
                    Handler handler,
                    @NotNull
                    RouteRole... roles)

Adds a POST request handler with the given roles for the specified path to the instance. Requires an access manager to be set on the instance.

See Also:

AccessManager, Handlers in docs

put

public Javalin put(@NotNull
                   String path,
                   @NotNull
                   Handler handler,
                   @NotNull
                   RouteRole... roles)

Adds a PUT request handler with the given roles for the specified path to the instance. Requires an access manager to be set on the instance.

See Also:

AccessManager, Handlers in docs

patch

public Javalin patch(@NotNull
                     String path,
                     @NotNull
                     Handler handler,
                     @NotNull
                     RouteRole... roles)

Adds a PATCH request handler with the given roles for the specified path to the instance. Requires an access manager to be set on the instance.

See Also:

AccessManager, Handlers in docs

delete

public Javalin delete(@NotNull
                      String path,
                      @NotNull
                      Handler handler,
                      @NotNull
                      RouteRole... roles)

Adds a DELETE request handler with the given roles for the specified path to the instance. Requires an access manager to be set on the instance.

See Also:

AccessManager, Handlers in docs

head

public Javalin head(@NotNull
                    String path,
                    @NotNull
                    Handler handler,
                    @NotNull
                    RouteRole... roles)

Adds a HEAD request handler with the given roles for the specified path to the instance. Requires an access manager to be set on the instance.

See Also:

AccessManager, Handlers in docs

options

public Javalin options(@NotNull
                       String path,
                       @NotNull
                       Handler handler,
                       @NotNull
                       RouteRole... roles)

Adds a OPTIONS request handler with the given roles for the specified path to the instance. Requires an access manager to be set on the instance.

See Also:

AccessManager, Handlers in docs

sse

public Javalin sse(@NotNull
                   String path,
                   @NotNull
                   Consumer<io.javalin.http.sse.SseClient> client)

Adds a lambda handler for a Server Sent Event connection on the specified path.

sse

public Javalin sse(@NotNull
                   String path,
                   @NotNull
                   io.javalin.http.sse.SseHandler handler)

Adds a lambda handler for a Server Sent Event connection on the specified path.

sse

public Javalin sse(@NotNull
                   String path,
                   @NotNull
                   Consumer<io.javalin.http.sse.SseClient> client,
                   @NotNull
                   RouteRole... roles)

Adds a lambda handler for a Server Sent Event connection on the specified path. Requires an access manager to be set on the instance.

before

public Javalin before(@NotNull
                      String path,
                      @NotNull
                      Handler handler)

Adds a BEFORE request handler for the specified path to the instance.

See Also:

Handlers in docs

before

public Javalin before(@NotNull
                      Handler handler)

Adds a BEFORE request handler for all routes in the instance.

See Also:

Handlers in docs

after

public Javalin after(@NotNull
                     String path,
                     @NotNull
                     Handler handler)

Adds an AFTER request handler for the specified path to the instance.

See Also:

Handlers in docs

after

public Javalin after(@NotNull
                     Handler handler)

Adds an AFTER request handler for all routes in the instance.

See Also:

Handlers in docs

wsException

public <T extends Exception> Javalin wsException(@NotNull
                                                 Class<T> exceptionClass,
                                                 @NotNull
                                                 WsExceptionHandler<? super T> exceptionHandler)

Adds a WebSocket exception mapper to the instance.

See Also:

Exception mapping in docs

ws

public Javalin ws(@NotNull
                  String path,
                  @NotNull
                  Consumer<WsConfig> ws)

Adds a WebSocket handler on the specified path.

See Also:

WebSockets in docs

ws

public Javalin ws(@NotNull
                  String path,
                  @NotNull
                  Consumer<WsConfig> ws,
                  @NotNull
                  RouteRole... roles)

Adds a WebSocket handler on the specified path with the specified roles. Requires an access manager to be set on the instance.

See Also:

AccessManager, WebSockets in docs

wsBefore

public Javalin wsBefore(@NotNull
                        String path,
                        @NotNull
                        Consumer<WsConfig> wsConfig)

Adds a WebSocket before handler for the specified path to the instance.

wsBefore

public Javalin wsBefore(@NotNull
                        Consumer<WsConfig> wsConfig)

Adds a WebSocket before handler for all routes in the instance.

wsAfter

public Javalin wsAfter(@NotNull
                       String path,
                       @NotNull
                       Consumer<WsConfig> wsConfig)

Adds a WebSocket after handler for the specified path to the instance.

wsAfter

public Javalin wsAfter(@NotNull
                       Consumer<WsConfig> wsConfig)

Adds a WebSocket after handler for all routes in the instance.