A B C D E F G H I J M O P R S T W

A

accessManager - Variable in class io.javalin.Javalin

accessManager(AccessManager) - Method in class io.javalin.Javalin

Sets the access manager for the instance.

AccessManager - Interface in io.javalin.security

The access manager is a way of implementing per-endpoint security management.

addEndpoints() - Method in interface io.javalin.apibuilder.EndpointGroup

addHandler(HandlerType, String, Handler, Set<Role>) - Method in class io.javalin.Javalin

Adds a request handler for the specified handlerType and path to the instance.

addHandler(HandlerType, String, Handler) - Method in class io.javalin.Javalin

Adds a request handler for the specified handlerType and path to the instance.

after(String, Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

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

after(Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a AFTER request handler for the current path to the Javalin instance.

after(String, Handler) - Method in class io.javalin.Javalin

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

after(Handler) - Method in class io.javalin.Javalin

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

ApiBuilder - Class in io.javalin.apibuilder

Static methods for route declarations in Javalin

ApiBuilder() - Constructor for class io.javalin.apibuilder.ApiBuilder

appAttributes - Variable in class io.javalin.Javalin

attribute(Class, Object) - Method in class io.javalin.Javalin

Registers an attribute on the instance.

attribute(Class<T>) - Method in class io.javalin.Javalin

Retrieve an attribute stored on the instance.

autogeneratedEtagsEnabled - Variable in class io.javalin.Javalin

B

before(String, Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

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

before(Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a BEFORE request handler for the current path to the Javalin instance.

before(String, Handler) - Method in class io.javalin.Javalin

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

before(Handler) - Method in class io.javalin.Javalin

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

BinaryMessageHandler - Interface in io.javalin.websocket

C

caseSensitiveUrls - Variable in class io.javalin.Javalin

clearStaticJavalin() - Static method in class io.javalin.apibuilder.ApiBuilder

CloseHandler - Interface in io.javalin.websocket

connect(String, Handler) - Method in class io.javalin.Javalin

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

connect(String, Handler, Set<Role>) - Method in class io.javalin.Javalin

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

ConnectHandler - Interface in io.javalin.websocket

contextPath - Variable in class io.javalin.Javalin

contextPath(String) - Method in class io.javalin.Javalin

Configure instance to run on specified context path (common prefix).

create() - Static method in class io.javalin.Javalin

Creates an instance of the application for further configuration.

createServlet() - Method in class io.javalin.Javalin

crud(String, CrudHandler) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a CrudHandler handler to the specified path to the instance.

crud(String, CrudHandler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a CrudHandler handler to the specified path with the given roles to the instance.

ctx - Variable in class io.javalin.serversentevent.SseClient

D

debugLogging - Variable in class io.javalin.Javalin

defaultContentType - Variable in class io.javalin.Javalin

defaultContentType(String) - Method in class io.javalin.Javalin

Configure instance to use the specified content-type as a default value for all responses.

delete(String, Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

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

delete(String, Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

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

delete(Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a DELETE request handler for the current path to the Javalin instance.

delete(Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a DELETE request handler with the given roles for the current path to the instance.

delete(String, Handler) - Method in class io.javalin.Javalin

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

delete(String, Handler, Set<Role>) - Method in class io.javalin.Javalin

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

disableDynamicGzip() - Method in class io.javalin.Javalin

Configure instance to not gzip dynamic responses.

disableRequestCache() - Method in class io.javalin.Javalin

Configure instance to not cache any requests.

disableStartupBanner() - Method in class io.javalin.Javalin

Configure instance to not show banner in logs.

dontIgnoreTrailingSlashes() - Method in class io.javalin.Javalin

Configure instance to treat '/test/' and '/test' as different URLs.

dynamicGzipEnabled - Variable in class io.javalin.Javalin

E

enableAutogeneratedEtags() - Method in class io.javalin.Javalin

Configure instance to automatically add ETags for GET requests.

enableCaseSensitiveUrls() - Method in class io.javalin.Javalin

Configure the instance to not use lower-case paths for path matching and parsing.

enableCorsForAllOrigins() - Method in class io.javalin.Javalin

Configure instance to accept cross origin requests for all origins.

enableCorsForOrigin(String...) - Method in class io.javalin.Javalin

Configure instance to accept cross origin requests for specified origins.

enableDebugLogging() - Method in class io.javalin.Javalin

Configure instance to log debug information for each request.

enableRouteOverview(String) - Method in class io.javalin.Javalin

Configure instance to display a visual overview of all its mapped routes on the specified path.

enableRouteOverview(String, Set<Role>) - Method in class io.javalin.Javalin

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

enableSinglePageMode(String, String) - Method in class io.javalin.Javalin

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

enableSinglePageMode(String, String, Location) - Method in class io.javalin.Javalin

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.

enableStaticFiles(String) - Method in class io.javalin.Javalin

Configure instance to serve static files from path in classpath.

enableStaticFiles(String, Location) - Method in class io.javalin.Javalin

Configure instance to serve static files from path in the specified location.

enableWebJars() - Method in class io.javalin.Javalin

Configure instance to serve WebJars.

EndpointGroup - Interface in io.javalin.apibuilder

error(int, ErrorHandler) - Method in class io.javalin.Javalin

Adds an error mapper to the instance.

ErrorHandler - Interface in io.javalin

A handler for use with Javalin.error(int, ErrorHandler).

ErrorHandler - Interface in io.javalin.websocket

errorMapper - Variable in class io.javalin.Javalin

event(JavalinEvent, EventListener) - Method in class io.javalin.Javalin

Adds a lifecycle event listener.

EventListener - Interface in io.javalin

A listener for use with Javalin.event(io.javalin.JavalinEvent, io.javalin.EventListener).

eventManager - Variable in class io.javalin.Javalin

exception(Class<T>, ExceptionHandler<? super T>) - Method in class io.javalin.Javalin

Adds an exception mapper to the instance.

ExceptionHandler<T extends java.lang.Exception> - Interface in io.javalin

A handler for use with Javalin.exception(Class, ExceptionHandler).

exceptionMapper - Variable in class io.javalin.Javalin

Extension - Interface in io.javalin

An extension is a modular way of adding functionality to a Javalin instance.

F

FileRenderer - Interface in io.javalin.rendering

Interface for creating renderers to be used with Context.render(java.lang.String, java.util.Map<java.lang.String, ? extends java.lang.Object>).

G

get(String, Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

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

get(String, Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

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

get(Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a GET request handler for the current path to the Javalin instance.

get(Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a GET request handler with the given roles for the current path to the instance.

get(String, Handler) - Method in class io.javalin.Javalin

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

get(String, Handler, Set<Role>) - Method in class io.javalin.Javalin

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

getHandlerMetaInfo() - Method in class io.javalin.Javalin

Gets the list of HandlerMetaInfo-objects

H

handle(Context) - Method in interface io.javalin.ErrorHandler

handle(T, Context) - Method in interface io.javalin.ExceptionHandler

handle(Context) - Method in interface io.javalin.Handler

handle(Context, Float) - Method in interface io.javalin.RequestLogger

handle(WsSession, Byte[], int, int) - Method in interface io.javalin.websocket.BinaryMessageHandler

handle(WsSession, int, String) - Method in interface io.javalin.websocket.CloseHandler

handle(WsSession) - Method in interface io.javalin.websocket.ConnectHandler

handle(WsSession, Throwable) - Method in interface io.javalin.websocket.ErrorHandler

handle(WsSession, String) - Method in interface io.javalin.websocket.MessageHandler

handleEvent() - Method in interface io.javalin.EventListener

Handler - Interface in io.javalin

Main interface for endpoint actions.

handlerMetaInfo - Variable in class io.javalin.Javalin

head(String, Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

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

head(String, Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

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

head(Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a HEAD request handler for the current path to the Javalin instance.

head(Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a HEAD request handler with the given roles for the current path to the instance.

head(String, Handler) - Method in class io.javalin.Javalin

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

head(String, Handler, Set<Role>) - Method in class io.javalin.Javalin

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

hideBanner - Variable in class io.javalin.Javalin

I

ignoreTrailingSlashes - Variable in class io.javalin.Javalin

io.javalin - package io.javalin

io.javalin.apibuilder - package io.javalin.apibuilder

io.javalin.rendering - package io.javalin.rendering

io.javalin.security - package io.javalin.security

io.javalin.serversentevent - package io.javalin.serversentevent

io.javalin.websocket - package io.javalin.websocket

J

Javalin - Class in io.javalin

Javalin(Server, SessionHandler) - Constructor for class io.javalin.Javalin

Javalin() - Constructor for class io.javalin.Javalin

jettyServer - Variable in class io.javalin.Javalin

jettySessionHandler - Variable in class io.javalin.Javalin

M

manage(Handler, Context, Set<Role>) - Method in interface io.javalin.security.AccessManager

maxBodySizeForRequestCache(long) - Method in class io.javalin.Javalin

Configure instance to stop caching requests larger than the specified body size.

maxRequestCacheBodySize - Variable in class io.javalin.Javalin

MessageHandler - Interface in io.javalin.websocket

O

onClose(Runnable) - Method in class io.javalin.serversentevent.SseClient

onClose(CloseHandler) - Method in class io.javalin.websocket.WsHandler

Add a CloseHandler to the WsHandler.

onConnect(ConnectHandler) - Method in class io.javalin.websocket.WsHandler

Add a ConnectHandler to the WsHandler.

onError(ErrorHandler) - Method in class io.javalin.websocket.WsHandler

Add a errorHandler to the WsHandler.

onMessage(MessageHandler) - Method in class io.javalin.websocket.WsHandler

Add a MessageHandler to the WsHandler.

onMessage(BinaryMessageHandler) - Method in class io.javalin.websocket.WsHandler

Add a BinaryMessageHandler to the WsHandler.

options(String, Handler) - Method in class io.javalin.Javalin

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

options(String, Handler, Set<Role>) - Method in class io.javalin.Javalin

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

P

patch(String, Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

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

patch(String, Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

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

patch(Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a PATCH request handler for the current path to the Javalin instance.

patch(Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a PATCH request handler with the given roles for the current path to the instance.

patch(String, Handler) - Method in class io.javalin.Javalin

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

patch(String, Handler, Set<Role>) - Method in class io.javalin.Javalin

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

path(String, EndpointGroup) - Static method in class io.javalin.apibuilder.ApiBuilder

Prefixes all handlers defined in its scope with the specified path.

pathMatcher - Variable in class io.javalin.Javalin

port - Variable in class io.javalin.Javalin

port() - Method in class io.javalin.Javalin

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

port(int) - Method in class io.javalin.Javalin

Configure instance to run on specified port.

post(String, Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

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

post(String, Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

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

post(Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a POST request handler for the current path to the Javalin instance.

post(Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a POST request handler with the given roles for the current path to the instance.

post(String, Handler) - Method in class io.javalin.Javalin

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

post(String, Handler, Set<Role>) - Method in class io.javalin.Javalin

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

prefer405over404 - Variable in class io.javalin.Javalin

prefer405over404() - Method in class io.javalin.Javalin

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.

put(String, Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

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

put(String, Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

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

put(Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a PUT request handler for the current path to the Javalin instance.

put(Handler, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a PUT request handler with the given roles for the current path to the instance.

put(String, Handler) - Method in class io.javalin.Javalin

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

put(String, Handler, Set<Role>) - Method in class io.javalin.Javalin

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

R

register(Extension) - Method in class io.javalin.Javalin

Registers an Extension with the instance.

registerOnJavalin(Javalin) - Method in interface io.javalin.Extension

render(String, Map<String, Object>) - Method in interface io.javalin.rendering.FileRenderer

requestLogger - Variable in class io.javalin.Javalin

requestLogger(RequestLogger) - Method in class io.javalin.Javalin

Configure instance use specified request-logger The method must be called before Javalin.start().

RequestLogger - Interface in io.javalin

Interface for logging requests.

Role - Interface in io.javalin.security

Empty interface for roles used in AccessManager.

routes(EndpointGroup) - Method in class io.javalin.Javalin

Creates a temporary static instance in the scope of the endpointGroup.

S

sendEvent(String) - Method in class io.javalin.serversentevent.SseClient

sendEvent(String, String) - Method in class io.javalin.serversentevent.SseClient

sendEvent(String, String, String) - Method in class io.javalin.serversentevent.SseClient

server(Supplier<Server>) - Method in class io.javalin.Javalin

Configure instance to use a custom jetty Server.

sessionHandler(Supplier<SessionHandler>) - Method in class io.javalin.Javalin

Configure instance to use a custom jetty SessionHandler.

setStaticJavalin(Javalin) - Static method in class io.javalin.apibuilder.ApiBuilder

singlePageHandler - Variable in class io.javalin.Javalin

sse(String, Consumer<SseClient>) - Method in class io.javalin.Javalin

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

sse(String, Consumer<SseClient>, Set<Role>) - Method in class io.javalin.Javalin

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

SseClient - Class in io.javalin.serversentevent

SseClient(Context) - Constructor for class io.javalin.serversentevent.SseClient

start(int) - Method in class io.javalin.Javalin

Synchronously starts the application instance on the specified port.

start() - Method in class io.javalin.Javalin

Synchronously starts the application instance.

started - Variable in class io.javalin.Javalin

staticFileConfig - Variable in class io.javalin.Javalin

stop() - Method in class io.javalin.Javalin

Synchronously stops the application instance.

T

trace(String, Handler) - Method in class io.javalin.Javalin

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

trace(String, Handler, Set<Role>) - Method in class io.javalin.Javalin

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

W

ws(String, Consumer<WsHandler>) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a WebSocket handler on the specified path.

ws(Consumer<WsHandler>) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a WebSocket handler on the current path.

ws(String, Consumer<WsHandler>) - Method in class io.javalin.Javalin

Adds a WebSocket handler on the specified path.

WsHandler - Class in io.javalin.websocket

WsHandler() - Constructor for class io.javalin.websocket.WsHandler

wsLogger(Consumer<WsHandler>) - Method in class io.javalin.Javalin

Configures a web socket handler to be called after every web socket event The method must be called before Javalin.start().

wsPathMatcher - Variable in class io.javalin.Javalin

A B C D E F G H I J M O P R S T W