A B C D E F G H I J M O P R S T V W _
All Classes All Packages

A

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

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

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) - Method in class io.javalin.Javalin

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

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

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

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

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

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

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

addStaticFiles(Consumer<StaticFileConfig>) - Method in class io.javalin.core.JavalinConfig

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

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

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

Adds an AFTER request handler for all routes in 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(String, Handler) - Method in class io.javalin.Javalin

Adds an AFTER request handler for the specified path to 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

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

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

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

Retrieve an attribute stored on the instance.

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

Registers an attribute on the instance.

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

B

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

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

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

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

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(String, Handler) - Method in class io.javalin.Javalin

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

C

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

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

Synchronously stops the application instance.

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

compressionStrategy(Brotli, Gzip) - Method in class io.javalin.core.JavalinConfig

compressionStrategy(CompressionStrategy) - Method in class io.javalin.core.JavalinConfig

configureServletContextHandler(Consumer<ServletContextHandler>) - Method in class io.javalin.core.JavalinConfig

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

contextResolvers(Consumer<ContextResolver>) - Method 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.

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

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

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

Adds a CrudHandler handler to the current path to the Javalin instance.

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

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

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

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

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

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

D

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

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, RouteRole...) - 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) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a DELETE request handler for the specified path to the Javalin 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, RouteRole...) - 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(String, Handler, RouteRole...) - Method in class io.javalin.Javalin

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

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

enableHttpAllowedMethodsOnRoutes() - 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, Handler) - Method in class io.javalin.Javalin

Adds an error mapper to the instance.

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

Adds an error mapper for the specified content-type to the instance.

EventHandler - Interface in io.javalin.core.event

Main interface for Lifecycle Event Handlers.

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

fromJsonStream(InputStream, Class<T>) - Method in interface io.javalin.plugin.json.JsonMapper

If implemented, Javalin will use this method instead of JsonMapper.fromJsonString(String, Class) when mapping request bodies to JSON through Context.bodyAsClass(Class).

fromJsonString(String, Class<T>) - Method in interface io.javalin.plugin.json.JsonMapper

If JsonMapper.fromJsonStream(InputStream, Class) is not implemented, Javalin will use this method when mapping request bodies to JSON through Context.bodyAsClass(Class).

G

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, RouteRole...) - 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) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a GET request handler for the specified path to the Javalin 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, RouteRole...) - 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(String, Handler, RouteRole...) - 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

globalHeaders(Supplier<Headers>) - Method in class io.javalin.core.JavalinConfig

H

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

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

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

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

handleEvent() - Method in interface io.javalin.core.event.EventHandler

Handler - Interface in io.javalin.http

Main interface for endpoint actions.

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

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, RouteRole...) - 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) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a HEAD request handler for the specified path to the Javalin 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, RouteRole...) - 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(String, Handler, RouteRole...) - Method in class io.javalin.Javalin

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

I

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

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.plugin.json - package io.javalin.plugin.json

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

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

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

J

Javalin - Class in io.javalin

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

Javalin(JettyServer, JavalinJettyServlet) - 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

javalinJettyServlet - Variable in class io.javalin.Javalin

javalinServlet - Variable in class io.javalin.Javalin

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

jettyServer - Variable in class io.javalin.Javalin

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

jsonMapper(JsonMapper) - Method in class io.javalin.core.JavalinConfig

JsonMapper - Interface in io.javalin.plugin.json

M

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

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

O

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

Add a WsBinaryMessageHandler to the WsHandler.

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

Add a WsCloseHandler to the WsHandler.

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

Add a WsConnectHandler to the WsHandler.

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

Add a wsErrorHandler to the WsHandler.

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

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, RouteRole...) - Method in class io.javalin.Javalin

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

P

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, RouteRole...) - 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) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a PATCH request handler for the specified path to the Javalin 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, RouteRole...) - 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(String, Handler, RouteRole...) - 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(Handler) - Static method in class io.javalin.apibuilder.ApiBuilder

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

post(Handler, RouteRole...) - 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) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a POST request handler for the specified path to the Javalin 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, RouteRole...) - 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(String, Handler, RouteRole...) - 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

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

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, RouteRole...) - 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) - Static method in class io.javalin.apibuilder.ApiBuilder

Adds a PUT request handler for the specified path to the Javalin 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, RouteRole...) - 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(String, Handler, RouteRole...) - 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>, Context) - Method in interface io.javalin.plugin.rendering.FileRenderer

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.

resolve(String) - Method in class io.javalin.plugin.rendering.vue.VueDependencyResolver

Build the HTML of components needed for this component

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

RouteRole - Interface in io.javalin.core.security

Marker 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

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

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

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

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

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

serverStopFailed(EventHandler) - Method in class io.javalin.core.event.EventListener

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

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

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

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, SseHandler) - Method in class io.javalin.Javalin

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

sse(String, Consumer<SseClient>) - 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>, RouteRole...) - Static method in class io.javalin.apibuilder.ApiBuilder

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

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

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

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

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

Synchronously starts the application instance on the configured port, or on the configured ServerConnectors if the Jetty server has been manually configured.

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

Synchronously starts the application instance on the specified port.

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

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

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

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

Synchronously stops the application instance.

T

toJsonStream(Object) - Method in interface io.javalin.plugin.json.JsonMapper

Javalin uses this method for Context.json(Object), if called with useStreamingMapper = true.

toJsonString(Object) - Method in interface io.javalin.plugin.json.JsonMapper

Javalin uses this method for Context.json(Object), as well as the CookieStore class, WebSockets messaging, and JavalinVue.

V

VueDependencyResolver - Class in io.javalin.plugin.rendering.vue

VueDependencyResolver(Set<Path>, String) - Constructor for class io.javalin.plugin.rendering.vue.VueDependencyResolver

W

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

Adds a WebSocket handler on the specified path.

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

Adds a WebSocket handler on the specified path.

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

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

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

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

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

Adds a WebSocket handler on the current path.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

WsConfig - Class in io.javalin.websocket

Holds the different WebSocket handlers for a specific WsEntry or the WebSocket logger.

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

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

Adds a WebSocket exception mapper to the instance.

WsExceptionHandler<T extends 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

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

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

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

_

_conf - Variable in class io.javalin.Javalin

Do not use this field unless you know what you're doing.

A B C D E F G H I J M O P R S T V W _
All Classes All Packages