io.javalin

Class Javalin

java.lang.Object

io.javalin.Javalin

public class Javalin
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
Javalin	accessManager(AccessManager accessManager) Sets the access manager for the instance.
Javalin	after(Handler handler) Adds an AFTER request handler for all routes in the instance.
Javalin	after(java.lang.String path, Handler handler) Adds an AFTER request handler for the specified path to the instance.
Javalin	before(Handler handler) Adds a BEFORE request handler for all routes in the instance.
Javalin	before(java.lang.String path, Handler handler) Adds a BEFORE request handler for the specified path to the instance.
Javalin	connect(java.lang.String path, Handler handler) Adds a CONNECT request handler for the specified path to the instance.
Javalin	connect(java.lang.String path, Handler handler, java.util.List<Role> permittedRoles) Wraps a CONNECT handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.
java.lang.String	contextPath()
Javalin	contextPath(java.lang.String contextPath) Configure instance to run on specified context path (common prefix).
static Javalin	create() Creates an instance of the application for further configuration.
Javalin	defaultCharacterEncoding(java.lang.String characterEncoding) Configure instance to use the specified character-encoding as a default value for all responses.
Javalin	defaultContentType(java.lang.String contentType) Configure instance to use the specified content-type as a default value for all responses.
Javalin	delete(java.lang.String path, Handler handler) Adds a DELETE request handler for the specified path to the instance.
Javalin	delete(java.lang.String path, Handler handler, java.util.List<Role> permittedRoles) Wraps a DELETE handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.
Javalin	disableRequestCache() Configure instance to not cache any requests.
Javalin	dontIgnoreTrailingSlashes() Configure instance to treat '/test/' and '/test' as different URLs.
Javalin	embeddedServer(io.javalin.embeddedserver.EmbeddedServerFactory embeddedServerFactory) Configure instance to use a custom embedded server.
Javalin	enableCorsForAllOrigins() Configure instance to accept cross origin requests for all origins.
Javalin	enableCorsForOrigin(java.lang.String... origin) Configure instance to accept cross origin requests for specified origins.
Javalin	enableDynamicGzip() Configure instance to use dynamic gzip compression.
Javalin	enableRouteOverview(java.lang.String path) Configure instance to display a visual overview of all its mapped routes on the specified path.
Javalin	enableStandardRequestLogging() Configure instance to use LogLevel.STANDARD for request logs.
Javalin	enableStaticFiles(java.lang.String classpathPath) Configure instance to serves static files from path in classpath.
Javalin	enableStaticFiles(java.lang.String path, io.javalin.embeddedserver.Location location) Configure instance to serves static files from path in the specified location.
Javalin	error(int statusCode, ErrorHandler errorHandler) Adds an error mapper to the instance.
Javalin	event(io.javalin.event.EventType eventType, EventListener eventListener) Adds a lifecycle event listener.
<T extends java.lang.Exception> Javalin	exception(java.lang.Class<T> exceptionClass, ExceptionHandler<? super T> exceptionHandler) Adds an exception mapper to the instance.
Javalin	get(java.lang.String path, Handler handler) Adds a GET request handler for the specified path to the instance.
Javalin	get(java.lang.String path, Handler handler, java.util.List<Role> permittedRoles) Wraps a GET handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.
java.util.List<io.javalin.core.util.RouteOverviewEntry>	getRouteOverviewEntries() Gets the list of RouteOverviewEntry-objects used to build the visual route-overview
Javalin	head(java.lang.String path, Handler handler) Adds a HEAD request handler for the specified path to the instance.
Javalin	head(java.lang.String path, Handler handler, java.util.List<Role> permittedRoles) Wraps a HEAD handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.
Javalin	maxBodySizeForRequestCache(long bodySizeInBytes) Configure instance to stop caching requests larger than the specified body size.
Javalin	options(java.lang.String path, Handler handler) Adds a OPTIONS request handler for the specified path to the instance.
Javalin	options(java.lang.String path, Handler handler, java.util.List<Role> permittedRoles) Wraps a OPTIONS handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.
Javalin	patch(java.lang.String path, Handler handler) Adds a PATCH request handler for the specified path to the instance.
Javalin	patch(java.lang.String path, Handler handler, java.util.List<Role> permittedRoles) Wraps a PATCH handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.
java.lang.String	pathFinder(Handler handler) Finds the mapped path for the specified handler
java.lang.String	pathFinder(Handler handler, io.javalin.core.HandlerType handlerType) Finds the path for the specified handler and handler type (GET, POST, etc)
int	port() Get which port instance is running on Mostly useful if you start the instance with port(0) (random port)
Javalin	port(int port) Configure instance to run on specified port.
Javalin	post(java.lang.String path, Handler handler) Adds a POST request handler for the specified path to the instance.
Javalin	post(java.lang.String path, Handler handler, java.util.List<Role> permittedRoles) Wraps a POST handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.
Javalin	put(java.lang.String path, Handler handler) Adds a PUT request handler for the specified path to the instance.
Javalin	put(java.lang.String path, Handler handler, java.util.List<Role> permittedRoles) Wraps a PUT handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.
Javalin	requestLogLevel(io.javalin.LogLevel logLevel) Configure instance use specified log level for request logs.
Javalin	routes(ApiBuilder.EndpointGroup endpointGroup) Creates a temporary static instance in the scope of the endpointGroup.
Javalin	start() Synchronously starts the application instance.
static Javalin	start(int port) Creates and starts the application with default parameters on the specified port.
Javalin	stop() Synchronously stops the application instance.
Javalin	trace(java.lang.String path, Handler handler) Adds a TRACE request handler for the specified path to the instance.
Javalin	trace(java.lang.String path, Handler handler, java.util.List<Role> permittedRoles) Wraps a TRACE handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.
Javalin	ws(java.lang.String path, java.lang.Class webSocketClass) Adds a Jetty annotated class as a handler for a WebSocket connection on the specified path.
Javalin	ws(java.lang.String path, java.lang.Object webSocketObject) Adds a Jetty WebSocket object as a handler for a WebSocket connection on the specified path.
Javalin	ws(java.lang.String path, WebSocketConfig ws) Adds a lambda handler for a WebSocket connection on the specified path.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Javalin create()

Creates an instance of the application for further configuration. The server does not run until start() is called.

Returns:

instance of application for configuration.

See Also:

start(), start(int)

start

public static Javalin start(int port)

Creates and starts the application with default parameters on the specified port.

Parameters:

port - to run on

Returns:

running application instance.

See Also:

create(), start()

start

public Javalin start()

Synchronously starts the application instance.

Returns:

running application instance.

See Also:

create()

stop

public Javalin stop()

Synchronously stops the application instance.

Returns:

stopped application instance.

dontIgnoreTrailingSlashes

public Javalin dontIgnoreTrailingSlashes()

Configure instance to treat '/test/' and '/test' as different URLs. The method must be called before start().

embeddedServer

public Javalin embeddedServer(@NotNull
                              io.javalin.embeddedserver.EmbeddedServerFactory embeddedServerFactory)

Configure instance to use a custom embedded server.

See Also:

Documentation example The method must be called before {@link Javalin#start()}.

enableStaticFiles

public Javalin enableStaticFiles(@NotNull
                                 java.lang.String classpathPath)

Configure instance to serves static files from path in classpath. The method can be called multiple times for different locations. The method must be called before start().

See Also:

Static files in docs

enableStaticFiles

public Javalin enableStaticFiles(@NotNull
                                 java.lang.String path,
                                 @NotNull
                                 io.javalin.embeddedserver.Location location)

Configure instance to serves static files from path in the specified location. The method can be called multiple times for different locations. The method must be called before start().

See Also:

Static files in docs

contextPath

public java.lang.String contextPath()

contextPath

public Javalin contextPath(@NotNull
                           java.lang.String contextPath)

Configure instance to run on specified context path (common prefix). The method must be called before start().

port

public int port()

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

port

public Javalin port(int port)

Configure instance to run on specified port. The method must be called before start().

enableStandardRequestLogging

public Javalin enableStandardRequestLogging()

Configure instance to use LogLevel.STANDARD for request logs. The method must be called before start().

requestLogLevel

public Javalin requestLogLevel(@NotNull
                               io.javalin.LogLevel logLevel)

Configure instance use specified log level for request logs. The method must be called before start().

enableCorsForOrigin

public Javalin enableCorsForOrigin(@NotNull
                                   java.lang.String... origin)

Configure instance to accept cross origin requests for specified origins. The method must be called before start().

enableCorsForAllOrigins

public Javalin enableCorsForAllOrigins()

Configure instance to accept cross origin requests for all origins. The method must be called before start().

enableDynamicGzip

public Javalin enableDynamicGzip()

Configure instance to use dynamic gzip compression. This will compress all responses larger than 1500 bytes. The method must be called before start().

enableRouteOverview

public Javalin enableRouteOverview(@NotNull
                                   java.lang.String path)

Configure instance to display a visual overview of all its mapped routes on the specified path. The method must be called before start().

defaultContentType

public Javalin defaultContentType(@NotNull
                                  java.lang.String contentType)

Configure instance to use the specified content-type as a default value for all responses. This can be overridden in any Handler. The method must be called before start().

defaultCharacterEncoding

public Javalin defaultCharacterEncoding(@NotNull
                                        java.lang.String characterEncoding)

Configure instance to use the specified character-encoding as a default value for all responses. This can be overridden in any Handler. The method must be called before start().

maxBodySizeForRequestCache

public Javalin maxBodySizeForRequestCache(long bodySizeInBytes)

Configure instance to stop caching requests larger than the specified body size. The default value is Long.MAX_VALUE The method must be called before start().

disableRequestCache

public Javalin disableRequestCache()

Configure instance to not cache any requests. If you call this method you will not be able to log request-bodies. The method must be called before start().

accessManager

public Javalin accessManager(@NotNull
                             AccessManager accessManager)

Sets the access manager for the instance. Secured endpoints require one to be set.

See Also:

Access manager in docs, AccessManager

exception

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

Adds an exception mapper to the instance. Useful for turning exceptions into standardized errors/messages/pages

See Also:

Exception mapping in docs

event

public Javalin event(@NotNull
                     io.javalin.event.EventType eventType,
                     @NotNull
                     EventListener eventListener)

Adds a lifecycle event listener. The method must be called before start().

See Also:

Events in docs

error

public Javalin error(int statusCode,
                     @NotNull
                     ErrorHandler errorHandler)

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

See Also:

Error mapping in docs

routes

public Javalin routes(@NotNull
                      ApiBuilder.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

get

public Javalin get(@NotNull
                   java.lang.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
                    java.lang.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
                   java.lang.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
                     java.lang.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
                      java.lang.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
                    java.lang.String path,
                    @NotNull
                    Handler handler)

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

See Also:

Handlers in docs

trace

public Javalin trace(@NotNull
                     java.lang.String path,
                     @NotNull
                     Handler handler)

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

See Also:

Handlers in docs

connect

public Javalin connect(@NotNull
                       java.lang.String path,
                       @NotNull
                       Handler handler)

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

See Also:

Handlers in docs

options

public Javalin options(@NotNull
                       java.lang.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
                   java.lang.String path,
                   @NotNull
                   Handler handler,
                   @NotNull
                   java.util.List<Role> permittedRoles)

Wraps a GET handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.

See Also:

AccessManager, accessManager(AccessManager), Handlers in docs

post

public Javalin post(@NotNull
                    java.lang.String path,
                    @NotNull
                    Handler handler,
                    @NotNull
                    java.util.List<Role> permittedRoles)

Wraps a POST handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.

See Also:

AccessManager, accessManager(AccessManager), Handlers in docs

put

public Javalin put(@NotNull
                   java.lang.String path,
                   @NotNull
                   Handler handler,
                   @NotNull
                   java.util.List<Role> permittedRoles)

Wraps a PUT handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.

See Also:

AccessManager, accessManager(AccessManager), Handlers in docs

patch

public Javalin patch(@NotNull
                     java.lang.String path,
                     @NotNull
                     Handler handler,
                     @NotNull
                     java.util.List<Role> permittedRoles)

Wraps a PATCH handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.

See Also:

AccessManager, accessManager(AccessManager), Handlers in docs

delete

public Javalin delete(@NotNull
                      java.lang.String path,
                      @NotNull
                      Handler handler,
                      @NotNull
                      java.util.List<Role> permittedRoles)

Wraps a DELETE handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.

See Also:

AccessManager, accessManager(AccessManager), Handlers in docs

head

public Javalin head(@NotNull
                    java.lang.String path,
                    @NotNull
                    Handler handler,
                    @NotNull
                    java.util.List<Role> permittedRoles)

Wraps a HEAD handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.

See Also:

AccessManager, accessManager(AccessManager), Handlers in docs

trace

public Javalin trace(@NotNull
                     java.lang.String path,
                     @NotNull
                     Handler handler,
                     @NotNull
                     java.util.List<Role> permittedRoles)

Wraps a TRACE handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.

See Also:

AccessManager, accessManager(AccessManager), Handlers in docs

connect

public Javalin connect(@NotNull
                       java.lang.String path,
                       @NotNull
                       Handler handler,
                       @NotNull
                       java.util.List<Role> permittedRoles)

Wraps a CONNECT handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.

See Also:

AccessManager, accessManager(AccessManager), Handlers in docs

options

public Javalin options(@NotNull
                       java.lang.String path,
                       @NotNull
                       Handler handler,
                       @NotNull
                       java.util.List<Role> permittedRoles)

Wraps a OPTIONS handler using the current AccessManager and adds it to the instance Requires an access manager to be set on the instance.

See Also:

AccessManager, accessManager(AccessManager), Handlers in docs

before

public Javalin before(@NotNull
                      java.lang.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
                     java.lang.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

pathFinder

public java.lang.String pathFinder(@NotNull
                                   Handler handler)

Finds the mapped path for the specified handler

pathFinder

public java.lang.String pathFinder(@NotNull
                                   Handler handler,
                                   @NotNull
                                   io.javalin.core.HandlerType handlerType)

Finds the path for the specified handler and handler type (GET, POST, etc)

See Also:

HandlerType

ws

public Javalin ws(@NotNull
                  java.lang.String path,
                  @NotNull
                  WebSocketConfig ws)

Adds a lambda handler for a WebSocket connection on the specified path. Has some added functionality (path params, wrapped session) compared to the other ws methods.

See Also:

WebSockets in docs

ws

public Javalin ws(@NotNull
                  java.lang.String path,
                  @NotNull
                  java.lang.Class webSocketClass)

Adds a Jetty annotated class as a handler for a WebSocket connection on the specified path. The method must be called before start().

See Also:

WebSockets in docs

ws

public Javalin ws(@NotNull
                  java.lang.String path,
                  @NotNull
                  java.lang.Object webSocketObject)

Adds a Jetty WebSocket object as a handler for a WebSocket connection on the specified path. The method must be called before start().

See Also:

WebSockets in docs

getRouteOverviewEntries

public java.util.List<io.javalin.core.util.RouteOverviewEntry> getRouteOverviewEntries()

Gets the list of RouteOverviewEntry-objects used to build the visual route-overview