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

A

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

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

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

after(Handler) - Static method in class io.javalin.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

Static methods for routes definitions in Javalin

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

ApiBuilder.EndpointGroup - Interface in io.javalin

B

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

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

before(Handler) - Static method in class io.javalin.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

CloseHandler - Interface in io.javalin.embeddedserver.jetty.websocket.interfaces

configure(WebSocketHandler) - Method in interface io.javalin.embeddedserver.jetty.websocket.WebSocketConfig

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

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

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

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

ConnectHandler - Interface in io.javalin.embeddedserver.jetty.websocket.interfaces

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

D

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

Configure instance to use the specified character-encoding as a default value for all responses.

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

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

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

Wraps a DELETE handler using the current AccessManager and adds it to the instance The method can only be called inside a Javalin#routes(EndpointGroup).

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

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

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

Wraps a DELETE handler using the current AccessManager and adds it to the instance using the current path The method can only be called inside a Javalin#routes(EndpointGroup).

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

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

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

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

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

Configure instance to not cache any requests.

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

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

E

embeddedServer(EmbeddedServerFactory) - Method in class io.javalin.Javalin

Configure instance to use a custom embedded server.

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.

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

Configure instance to use dynamic gzip compression.

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

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

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

Configure instance to use LogLevel.STANDARD for request logs.

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

Configure instance to serves static files from path in classpath.

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

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

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

Adds an error mapper to the instance.

ErrorHandler - Interface in io.javalin.embeddedserver.jetty.websocket.interfaces

ErrorHandler - Interface in io.javalin

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

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

Adds a lifecycle event listener.

EventListener - Interface in io.javalin.event

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

G

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

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

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

Wraps a GET handler using the current AccessManager and adds it to the instance The method can only be called inside a Javalin#routes(EndpointGroup).

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

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

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

Wraps a GET handler using the current AccessManager and adds it to the instance using the current path The method can only be called inside a Javalin#routes(EndpointGroup).

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

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

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

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

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

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

H

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

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

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

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

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

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

Handler - Interface in io.javalin

Main interface for endpoint actions.

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

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

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

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

I

io.javalin - package io.javalin

io.javalin.embeddedserver.jetty.websocket - package io.javalin.embeddedserver.jetty.websocket

io.javalin.embeddedserver.jetty.websocket.interfaces - package io.javalin.embeddedserver.jetty.websocket.interfaces

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

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

J

Javalin - Class in io.javalin

M

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

matches(String) - Method in class io.javalin.embeddedserver.jetty.websocket.WebSocketHandler

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

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

MessageHandler - Interface in io.javalin.embeddedserver.jetty.websocket.interfaces

O

onClose(CloseHandler) - Method in class io.javalin.embeddedserver.jetty.websocket.WebSocketHandler

Add a CloseHandler to the WebSocketHandler.

onConnect(ConnectHandler) - Method in class io.javalin.embeddedserver.jetty.websocket.WebSocketHandler

Add a ConnectHandler to the WebSocketHandler.

onError(ErrorHandler) - Method in class io.javalin.embeddedserver.jetty.websocket.WebSocketHandler

Add a errorHandler to the WebSocketHandler.

onMessage(MessageHandler) - Method in class io.javalin.embeddedserver.jetty.websocket.WebSocketHandler

Add a MessageHandler to the WebSocketHandler.

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

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

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

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

P

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

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

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

Wraps a PATCH handler using the current AccessManager and adds it to the instance The method can only be called inside a Javalin#routes(EndpointGroup).

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

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

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

Wraps a PATCH handler using the current AccessManager and adds it to the instance using the current path The method can only be called inside a Javalin#routes(EndpointGroup).

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

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

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

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

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

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

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

Finds the mapped path for the specified handler

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

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

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

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

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

Wraps a POST handler using the current AccessManager and adds it to the instance The method can only be called inside a Javalin#routes(EndpointGroup).

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

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

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

Wraps a POST handler using the current AccessManager and adds it to the instance using the current path The method can only be called inside a Javalin#routes(EndpointGroup).

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

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

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

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

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

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

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

Wraps a PUT handler using the current AccessManager and adds it to the instance The method can only be called inside a Javalin#routes(EndpointGroup).

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

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

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

Wraps a PUT handler using the current AccessManager and adds it to the instance using the current path The method can only be called inside a Javalin#routes(EndpointGroup).

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

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

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

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

R

requestLogLevel(LogLevel) - Method in class io.javalin.Javalin

Configure instance use specified log level for request logs.

Role - Interface in io.javalin.security

Base interface for role used in AccessManager.

roles(Role...) - Static method in interface io.javalin.security.Role

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

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

S

start(int) - Static method in class io.javalin.Javalin

Creates and starts the application with default parameters 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.

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

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

W

WebSocketConfig - Interface in io.javalin.embeddedserver.jetty.websocket

WebSocketConfig is a functional interface which is used to configure a WebSocketHandler.

WebSocketHandler - Class in io.javalin.embeddedserver.jetty.websocket

WebSocketHandler(String, String) - Constructor for class io.javalin.embeddedserver.jetty.websocket.WebSocketHandler

ws(String, WebSocketConfig) - Static method in class io.javalin.ApiBuilder

Adds a lambda handler for a WebSocket connection on the specified path.

ws(String, Class) - Static method in class io.javalin.ApiBuilder

Adds a Jetty annotated class as a handler for a WebSocket connection on the specified path.

ws(String, Object) - Static method in class io.javalin.ApiBuilder

Adds a Jetty WebSocket object as a handler for a WebSocket connection on the specified path.

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

Adds a lambda handler for a WebSocket connection on the specified path.

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

Adds a Jetty annotated class as a handler for a WebSocket connection on the specified path.

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

Adds a Jetty WebSocket object as a handler for a WebSocket connection on the specified path.

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