io.javalin

Class Javalin

java.lang.Object

io.javalin.Javalin

public class Javalin
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Javalin()

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.Set<Role> permittedRoles) Adds a CONNECT request handler with the given roles for the specified path to the instance.
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	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.Set<Role> permittedRoles) Adds a DELETE request handler with the given roles for the specified path to the instance.
Javalin	disableDynamicGzip() Configure instance to not gzip dynamic responses.
Javalin	disableRequestCache() Configure instance to not cache any requests.
Javalin	disableStartupBanner() Configure instance to not show banner in logs.
Javalin	dontIgnoreTrailingSlashes() Configure instance to treat '/test/' and '/test' as different URLs.
Javalin	enableAutogeneratedEtags() Configure instance to automatically add ETags for GET requests.
Javalin	enableCaseSensitiveUrls() Configure the instance to not use lower-case paths for path matching and parsing.
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	enableDebugLogging() Configure instance to log debug information for each request.
Javalin	enableRouteOverview(java.lang.String path) Configure instance to display a visual overview of all its mapped routes on the specified path.
Javalin	enableRouteOverview(java.lang.String path, java.util.Set<Role> permittedRoles) Configure instance to display a visual overview of all its mapped routes on the specified path with the specified roles The method must be called before start().
Javalin	enableSinglePageMode(java.lang.String path, java.lang.String filePath) Any request that would normally result in a 404 for the path and its subpaths instead results in a 200 with the file-content as response body
Javalin	enableStaticFiles(java.lang.String classpathPath) Configure instance to serve static files from path in classpath.
Javalin	enableStaticFiles(java.lang.String path, io.javalin.staticfiles.Location location) Configure instance to serve static files from path in the specified location.
Javalin	enableWebJars() Configure instance to serve WebJars
Javalin	error(int statusCode, ErrorHandler errorHandler) Adds an error mapper to the instance.
Javalin	event(io.javalin.JavalinEvent javalinEvent, 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.Set<Role> permittedRoles) Adds a GET request handler with the given roles for the specified path to the instance.
java.util.List<io.javalin.HandlerMetaInfo>	getHandlerMetaInfo() Gets the list of HandlerMetaInfo-objects
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.Set<Role> permittedRoles) Adds a HEAD request handler with the given roles for the specified path to 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.Set<Role> permittedRoles) Adds a OPTIONS request handler with the given roles for the specified path to 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.Set<Role> permittedRoles) 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	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.Set<Role> permittedRoles) Adds a POST request handler with the given roles for the specified path to the instance.
Javalin	prefer405over404() Configure the instance to return 405 (Method Not Allowed) instead of 404 (Not Found) whenever a request method doesn't exists but there are handlers for other methods on the same requested path.
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.Set<Role> permittedRoles) Adds a PUT request handler with the given roles for the specified path to the instance.
Javalin	requestLogger(RequestLogger requestLogger) Configure instance use specified request-logger The method must be called before start().
Javalin	routes(EndpointGroup endpointGroup) Creates a temporary static instance in the scope of the endpointGroup.
Javalin	server(java.util.function.Supplier<org.eclipse.jetty.server.Server> server) Configure instance to use a custom jetty Server.
Javalin	sessionHandler(java.util.function.Supplier<org.eclipse.jetty.server.session.SessionHandler> sessionHandler) Configure instance to use a custom jetty SessionHandler.
Javalin	start() Synchronously starts the application instance.
Javalin	start(int port) Synchronously starts the application instance 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.Set<Role> permittedRoles) Adds a TRACE request handler with the given roles for the specified path to the instance.
Javalin	ws(java.lang.String path, java.util.function.Consumer<WsHandler> ws) Adds a WebSocket handler on the specified path.

Methods inherited from class java.lang.Object

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

Constructor Detail

Javalin

protected Javalin()

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 Javalin start(int port)

Synchronously starts the application instance 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.

prefer405over404

public Javalin prefer405over404()

Configure the instance to return 405 (Method Not Allowed) instead of 404 (Not Found) whenever a request method doesn't exists but there are handlers for other methods on the same requested path. The method must be called before start().

enableCaseSensitiveUrls

public Javalin enableCaseSensitiveUrls()

Configure the instance to not use lower-case paths for path matching and parsing. The method must be called before start().

disableStartupBanner

public Javalin disableStartupBanner()

Configure instance to not show banner in logs. The method must be called before start().

dontIgnoreTrailingSlashes

public Javalin dontIgnoreTrailingSlashes()

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

server

public Javalin server(@NotNull
                      java.util.function.Supplier<org.eclipse.jetty.server.Server> server)

Configure instance to use a custom jetty Server.

See Also:

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

sessionHandler

public Javalin sessionHandler(@NotNull
                              java.util.function.Supplier<org.eclipse.jetty.server.session.SessionHandler> sessionHandler)

Configure instance to use a custom jetty SessionHandler. The method must be called before start().

enableStaticFiles

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

Configure instance to serve 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.staticfiles.Location location)

Configure instance to serve 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

enableWebJars

public Javalin enableWebJars()

Configure instance to serve WebJars

enableSinglePageMode

public Javalin enableSinglePageMode(@NotNull
                                    java.lang.String path,
                                    @NotNull
                                    java.lang.String filePath)

Any request that would normally result in a 404 for the path and its subpaths instead results in a 200 with the file-content as response body

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().

enableDebugLogging

public Javalin enableDebugLogging()

Configure instance to log debug information for each request. The method must be called before start().

requestLogger

public Javalin requestLogger(@NotNull
                             RequestLogger requestLogger)

Configure instance use specified request-logger The method must be called before start(). Will override the default logger of enableDebugLogging().

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().

disableDynamicGzip

public Javalin disableDynamicGzip()

Configure instance to not gzip dynamic responses. By default Javalin gzips all responses larger than 1500 bytes. The method must be called before start().

enableAutogeneratedEtags

public Javalin enableAutogeneratedEtags()

Configure instance to automatically add ETags for GET requests. Static files already have ETags, this will calculate a checksum for dynamic GET responses and return 304 if the content has not changed. 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().

enableRouteOverview

public Javalin enableRouteOverview(@NotNull
                                   java.lang.String path,
                                   @NotNull
                                   java.util.Set<Role> permittedRoles)

Configure instance to display a visual overview of all its mapped routes on the specified path with the specified roles 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().

maxBodySizeForRequestCache

public Javalin maxBodySizeForRequestCache(long bodySizeInBytes)

Configure instance to stop caching requests larger than the specified body size. The default value is 4096 bytes. 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.JavalinEvent javalinEvent,
                     @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
                      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.Set<Role> permittedRoles)

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, accessManager(AccessManager), Handlers in docs

post

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

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, accessManager(AccessManager), Handlers in docs

put

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

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, accessManager(AccessManager), Handlers in docs

patch

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

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, accessManager(AccessManager), Handlers in docs

delete

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

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, accessManager(AccessManager), Handlers in docs

head

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

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, accessManager(AccessManager), Handlers in docs

trace

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

Adds a TRACE 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, accessManager(AccessManager), Handlers in docs

connect

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

Adds a CONNECT 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, accessManager(AccessManager), Handlers in docs

options

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

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, 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

ws

public Javalin ws(@NotNull
                  java.lang.String path,
                  @NotNull
                  java.util.function.Consumer<WsHandler> ws)

Adds a WebSocket handler on the specified path.

See Also:

WebSockets in docs

getHandlerMetaInfo

public java.util.List<io.javalin.HandlerMetaInfo> getHandlerMetaInfo()

Gets the list of HandlerMetaInfo-objects