Package io.javalin.core

Class JavalinConfig

java.lang.Object

io.javalin.core.JavalinConfig

public class JavalinConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavalinConfig.Inner

Field Summary

Fields

Modifier and Type	Field	Description
Long	asyncRequestTimeout
boolean	autogenerateEtags
String	contextPath
String	defaultContentType
boolean	enforceSsl
boolean	ignoreTrailingSlashes
JavalinConfig.Inner	inner
Long	maxRequestSize
boolean	prefer405over404
boolean	showJavalinBanner

Constructor Summary

Constructors

Constructor	Description
JavalinConfig()

Method Summary

Modifier and Type	Method	Description
void	accessManager(AccessManager accessManager)
void	addSinglePageHandler(String hostedPath, Handler customHandler)
void	addSinglePageRoot(String hostedPath, String filePath)
void	addSinglePageRoot(String hostedPath, String filePath, io.javalin.http.staticfiles.Location location)
void	addStaticFiles(String directory, io.javalin.http.staticfiles.Location location)
void	addStaticFiles(Consumer<io.javalin.http.staticfiles.StaticFileConfig> userConfig)
static void	applyUserConfig(Javalin app, JavalinConfig config, Consumer<JavalinConfig> userConfig)
void	compressionStrategy(io.javalin.core.compression.Brotli brotli, io.javalin.core.compression.Gzip gzip)
void	compressionStrategy(io.javalin.core.compression.CompressionStrategy compressionStrategy)
void	configureServletContextHandler(Consumer<org.eclipse.jetty.servlet.ServletContextHandler> consumer)
void	contextResolvers(Consumer<io.javalin.http.ContextResolver> userResolver)
void	enableCorsForAllOrigins()
void	enableCorsForOrigin(String... origins)
void	enableDevLogging()
void	enableHttpAllowedMethodsOnRoutes()
void	enableWebjars()
<T extends Plugin> T	getPlugin(Class<T> pluginClass)	Get a registered plugin
void	globalHeaders(Supplier<io.javalin.core.util.Headers> headers)
void	jsonMapper(JsonMapper jsonMapper)
void	registerPlugin(Plugin plugin)	Register a new plugin.
void	requestLogger(RequestLogger requestLogger)
void	server(Supplier<org.eclipse.jetty.server.Server> server)
void	sessionHandler(Supplier<org.eclipse.jetty.server.session.SessionHandler> sessionHandlerSupplier)
void	wsFactoryConfig(Consumer<org.eclipse.jetty.websocket.servlet.WebSocketServletFactory> wsFactoryConfig)
void	wsLogger(Consumer<WsConfig> ws)

Methods inherited from class java.lang.Object

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

Field Detail

autogenerateEtags

public boolean autogenerateEtags

prefer405over404

public boolean prefer405over404

enforceSsl

public boolean enforceSsl

showJavalinBanner

public boolean showJavalinBanner

ignoreTrailingSlashes

public boolean ignoreTrailingSlashes

defaultContentType

@NotNull
public String defaultContentType

contextPath

@NotNull
public String contextPath

maxRequestSize

public Long maxRequestSize

asyncRequestTimeout

@NotNull
public Long asyncRequestTimeout

inner

@NotNull
public JavalinConfig.Inner inner

Constructor Detail

JavalinConfig

public JavalinConfig()

Method Detail

registerPlugin

public void registerPlugin(@NotNull
                           Plugin plugin)

Register a new plugin.

getPlugin

public <T extends Plugin> T getPlugin(@NotNull
                                      Class<T> pluginClass)

Get a registered plugin

enableDevLogging

public void enableDevLogging()

enableWebjars

public void enableWebjars()

addStaticFiles

public void addStaticFiles(@NotNull
                           String directory,
                           @NotNull
                           io.javalin.http.staticfiles.Location location)

addStaticFiles

public void addStaticFiles(@NotNull
                           Consumer<io.javalin.http.staticfiles.StaticFileConfig> userConfig)

addSinglePageRoot

public void addSinglePageRoot(@NotNull
                              String hostedPath,
                              @NotNull
                              String filePath)

addSinglePageRoot

public void addSinglePageRoot(@NotNull
                              String hostedPath,
                              @NotNull
                              String filePath,
                              @NotNull
                              io.javalin.http.staticfiles.Location location)

addSinglePageHandler

public void addSinglePageHandler(@NotNull
                                 String hostedPath,
                                 @NotNull
                                 Handler customHandler)

enableCorsForAllOrigins

public void enableCorsForAllOrigins()

enableCorsForOrigin

public void enableCorsForOrigin(@NotNull
                                String... origins)

accessManager

public void accessManager(@NotNull
                          AccessManager accessManager)

requestLogger

public void requestLogger(@NotNull
                          RequestLogger requestLogger)

sessionHandler

public void sessionHandler(@NotNull
                           Supplier<org.eclipse.jetty.server.session.SessionHandler> sessionHandlerSupplier)

wsFactoryConfig

public void wsFactoryConfig(@NotNull
                            Consumer<org.eclipse.jetty.websocket.servlet.WebSocketServletFactory> wsFactoryConfig)

wsLogger

public void wsLogger(@NotNull
                     Consumer<WsConfig> ws)

server

public void server(Supplier<org.eclipse.jetty.server.Server> server)

configureServletContextHandler

public void configureServletContextHandler(Consumer<org.eclipse.jetty.servlet.ServletContextHandler> consumer)

compressionStrategy

public void compressionStrategy(io.javalin.core.compression.Brotli brotli,
                                io.javalin.core.compression.Gzip gzip)

compressionStrategy

public void compressionStrategy(io.javalin.core.compression.CompressionStrategy compressionStrategy)

globalHeaders

public void globalHeaders(Supplier<io.javalin.core.util.Headers> headers)

jsonMapper

public void jsonMapper(JsonMapper jsonMapper)

applyUserConfig

public static void applyUserConfig(Javalin app,
                                   JavalinConfig config,
                                   Consumer<JavalinConfig> userConfig)

contextResolvers

public void contextResolvers(@NotNull
                             Consumer<io.javalin.http.ContextResolver> userResolver)

enableHttpAllowedMethodsOnRoutes

public void enableHttpAllowedMethodsOnRoutes()