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

A

accessManager(AccessManager) - Method in class io.javalin.core.JavalinConfig

accessManager - Variable in class io.javalin.core.JavalinConfig.Inner

AccessManager - Interface in io.javalin.core.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.

addSinglePageRoot(String, String) - Method in class io.javalin.core.JavalinConfig

addSinglePageRoot(String, String, Location) - Method in class io.javalin.core.JavalinConfig

addStaticFiles(String) - Method in class io.javalin.core.JavalinConfig

addStaticFiles(String, Location) - Method in class io.javalin.core.JavalinConfig

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.core.JavalinConfig.Inner

apply(Javalin) - Method in interface io.javalin.core.plugin.Plugin

Configure the Javalin instance and register handler

applyUserConfig(Javalin, JavalinConfig, Consumer<JavalinConfig>) - Static method in class io.javalin.core.JavalinConfig

asyncRequestTimeout - Variable in class io.javalin.core.JavalinConfig

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.

autogenerateEtags - Variable in class io.javalin.core.JavalinConfig

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.

C

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

config - Variable in class io.javalin.Javalin

contextPath - Variable in class io.javalin.core.JavalinConfig

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

Creates a new instance without any custom configuration.

create(Consumer<JavalinConfig>) - Static method in class io.javalin.Javalin

Creates a new instance with the user provided configuration.

create() - Method in interface io.javalin.plugin.openapi.CreateBaseConfiguration

CreateBaseConfiguration - Interface in io.javalin.plugin.openapi

Create the base open api configuration.

createStandalone(Consumer<JavalinConfig>) - Static method in class io.javalin.Javalin

createStandalone() - Static 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.http.sse.SseClient

D

defaultContentType - Variable in class io.javalin.core.JavalinConfig

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.

dynamicGzip - Variable in class io.javalin.core.JavalinConfig

E

enableCorsForAllOrigins() - Method in class io.javalin.core.JavalinConfig

enableCorsForOrigin(String...) - Method in class io.javalin.core.JavalinConfig

enableDevLogging() - Method in class io.javalin.core.JavalinConfig

enableWebjars() - Method in class io.javalin.core.JavalinConfig

EndpointGroup - Interface in io.javalin.apibuilder

enforceSsl - Variable in class io.javalin.core.JavalinConfig

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

Adds an error mapper to the instance.

ErrorHandler - Interface in io.javalin.http

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

EventListener - Class in io.javalin.core.event

EventListener(EventManager) - Constructor for class io.javalin.core.event.EventListener

eventManager - Variable in class io.javalin.Javalin

events(Consumer<EventListener>) - Method 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.http

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

F

FileRenderer - Interface in io.javalin.plugin.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.

getPlugin(Class<T>) - Method in class io.javalin.core.JavalinConfig

Get a registered plugin

H

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

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

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

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

handle(T, WsContext) - Method in interface io.javalin.websocket.WsExceptionHandler

handleBinaryMessage(WsBinaryMessageContext) - Method in interface io.javalin.websocket.WsBinaryMessageHandler

handleClose(WsCloseContext) - Method in interface io.javalin.websocket.WsCloseHandler

handleConnect(WsConnectContext) - Method in interface io.javalin.websocket.WsConnectHandler

handleError(WsErrorContext) - Method in interface io.javalin.websocket.WsErrorHandler

handleMessage(WsMessageContext) - Method in interface io.javalin.websocket.WsMessageHandler

Handler - Interface in io.javalin.http

Main interface for endpoint actions.

handlerAdded(Consumer<HandlerMetaInfo>) - Method in class io.javalin.core.event.EventListener

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.

I

inner - Variable in class io.javalin.core.JavalinConfig

Inner() - Constructor for class io.javalin.core.JavalinConfig.Inner

io.javalin - package io.javalin

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

io.javalin.core - package io.javalin.core

io.javalin.core.event - package io.javalin.core.event

io.javalin.core.plugin - package io.javalin.core.plugin

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

io.javalin.http - package io.javalin.http

io.javalin.http.sse - package io.javalin.http.sse

io.javalin.plugin.openapi - package io.javalin.plugin.openapi

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

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

J

Javalin - Class in io.javalin

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

Javalin(JavalinServer, JavalinWsServlet) - Constructor for class io.javalin.Javalin

JavalinConfig - Class in io.javalin.core

JavalinConfig() - Constructor for class io.javalin.core.JavalinConfig

JavalinConfig.Inner - Class in io.javalin.core

L

log - Static variable in class io.javalin.Javalin

logIfServerNotStarted - Variable in class io.javalin.core.JavalinConfig

M

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

N

noopConfig - Static variable in class io.javalin.core.JavalinConfig

O

onBinaryMessage(WsBinaryMessageHandler) - Method in class io.javalin.websocket.WsHandler

Add a WsBinaryMessageHandler to the WsHandler.

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

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

Add a WsCloseHandler to the WsHandler.

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

Add a WsConnectHandler to the WsHandler.

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

Add a wsErrorHandler to the WsHandler.

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

Add a WsMessageHandler 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.

Plugin - Interface in io.javalin.core.plugin

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

plugins - Variable in class io.javalin.core.JavalinConfig.Inner

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)

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.core.JavalinConfig

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

registerPlugin(Plugin) - Method in class io.javalin.core.JavalinConfig

Register a new plugin.

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

requestCacheSize - Variable in class io.javalin.core.JavalinConfig

requestLogger - Variable in class io.javalin.core.JavalinConfig.Inner

requestLogger(RequestLogger) - Method in class io.javalin.core.JavalinConfig

RequestLogger - Interface in io.javalin.http

Interface for logging requests.

resourceHandler - Variable in class io.javalin.core.JavalinConfig.Inner

Role - Interface in io.javalin.core.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.http.sse.SseClient

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

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

server - Variable in class io.javalin.core.JavalinConfig.Inner

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

server - Variable in class io.javalin.Javalin

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

Get the JavalinServer

serverStarted(Runnable) - Method in class io.javalin.core.event.EventListener

serverStartFailed(Runnable) - Method in class io.javalin.core.event.EventListener

serverStarting(Runnable) - Method in class io.javalin.core.event.EventListener

serverStopped(Runnable) - Method in class io.javalin.core.event.EventListener

serverStopping(Runnable) - Method in class io.javalin.core.event.EventListener

servlet - Variable in class io.javalin.Javalin

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

sessionHandler - Variable in class io.javalin.core.JavalinConfig.Inner

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

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

showJavalinBanner - Variable in class io.javalin.core.JavalinConfig

singlePageHandler - Variable in class io.javalin.core.JavalinConfig.Inner

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

sse(String, Consumer<SseClient>, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

sse(Consumer<SseClient>) - Static method in class io.javalin.apibuilder.ApiBuilder

sse(Consumer<SseClient>, Set<Role>) - Static method in class io.javalin.apibuilder.ApiBuilder

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.http.sse

SseClient(Context) - Constructor for class io.javalin.http.sse.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.

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

Synchronously stops the application instance.

W

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

Adds a WebSocket handler on the specified path.

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

Adds a WebSocket handler with the given roles for the specified path.

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

Adds a WebSocket handler on the current path.

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

Adds a WebSocket handler with the given roles for the current path.

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

Adds a WebSocket handler on the specified path.

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

Adds a WebSocket handler on the specified path with the specified roles.

wsAfter(String, Consumer<WsHandler>) - Method in class io.javalin.apibuilder.ApiBuilder

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

wsAfter(Consumer<WsHandler>) - Method in class io.javalin.apibuilder.ApiBuilder

Adds a WebSocket after handler for the current path to the Javalin instance.

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

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

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

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

wsBefore(String, Consumer<WsHandler>) - Method in class io.javalin.apibuilder.ApiBuilder

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

wsBefore(Consumer<WsHandler>) - Method in class io.javalin.apibuilder.ApiBuilder

Adds a WebSocket before handler for the current path to the Javalin instance.

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

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

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

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

WsBinaryMessageHandler - Interface in io.javalin.websocket

WsCloseHandler - Interface in io.javalin.websocket

WsConnectHandler - Interface in io.javalin.websocket

wsContextPath - Variable in class io.javalin.core.JavalinConfig

WsErrorHandler - Interface in io.javalin.websocket

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

Adds a WebSocket exception mapper to the instance.

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

A handler for use with Javalin.wsException(Class, WsExceptionHandler).

wsFactoryConfig - Variable in class io.javalin.core.JavalinConfig.Inner

wsFactoryConfig(Consumer<WebSocketServletFactory>) - Method in class io.javalin.core.JavalinConfig

WsHandler - Class in io.javalin.websocket

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

wsHandlerAdded(Consumer<WsHandlerMetaInfo>) - Method in class io.javalin.core.event.EventListener

wsLogger - Variable in class io.javalin.core.JavalinConfig.Inner

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

WsMessageHandler - Interface in io.javalin.websocket

wsServlet - Variable in class io.javalin.Javalin

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