io.javalin.core

Class JavalinConfig

java.lang.Object

io.javalin.core.JavalinConfig

public class JavalinConfig
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JavalinConfig.Inner

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Long	asyncRequestTimeout
boolean	autogenerateEtags
java.lang.String	contextPath
java.lang.String	defaultContentType
boolean	dynamicGzip Deprecated.
boolean	enforceSsl
JavalinConfig.Inner	inner
boolean	logIfServerNotStarted
static java.util.function.Consumer<JavalinConfig>	noopConfig
boolean	precompressStaticFiles
boolean	prefer405over404
java.lang.Long	requestCacheSize
boolean	showJavalinBanner

Constructor Summary

Constructors

Constructor and Description
JavalinConfig()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

noopConfig

public static java.util.function.Consumer<JavalinConfig> noopConfig

dynamicGzip

@Deprecated
public boolean dynamicGzip

Deprecated.

autogenerateEtags

public boolean autogenerateEtags

prefer405over404

public boolean prefer405over404

enforceSsl

public boolean enforceSsl

precompressStaticFiles

public boolean precompressStaticFiles

showJavalinBanner

public boolean showJavalinBanner

logIfServerNotStarted

public boolean logIfServerNotStarted

defaultContentType

@NotNull
public java.lang.String defaultContentType

contextPath

@NotNull
public java.lang.String contextPath

requestCacheSize

@NotNull
public java.lang.Long requestCacheSize

asyncRequestTimeout

@NotNull
public java.lang.Long asyncRequestTimeout

inner

@NotNull
public JavalinConfig.Inner inner

Constructor Detail

JavalinConfig

public JavalinConfig()

Method Detail

registerPlugin

public JavalinConfig registerPlugin(@NotNull
                                    Plugin plugin)

Register a new plugin.

getPlugin

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

Get a registered plugin

enableDevLogging

public JavalinConfig enableDevLogging()

enableWebjars

public JavalinConfig enableWebjars()

addStaticFiles

public JavalinConfig addStaticFiles(@NotNull
                                    java.lang.String classpathPath)

addStaticFiles

public JavalinConfig addStaticFiles(@NotNull
                                    java.lang.String path,
                                    @NotNull
                                    io.javalin.http.staticfiles.Location location)

addStaticFiles

public JavalinConfig addStaticFiles(@NotNull
                                    java.lang.String urlPathPrefix,
                                    @NotNull
                                    java.lang.String path,
                                    @NotNull
                                    io.javalin.http.staticfiles.Location location)

addSinglePageRoot

public JavalinConfig addSinglePageRoot(@NotNull
                                       java.lang.String path,
                                       @NotNull
                                       java.lang.String filePath)

addSinglePageRoot

public JavalinConfig addSinglePageRoot(@NotNull
                                       java.lang.String path,
                                       @NotNull
                                       java.lang.String filePath,
                                       @NotNull
                                       io.javalin.http.staticfiles.Location location)

addSinglePageHandler

public JavalinConfig addSinglePageHandler(@NotNull
                                          java.lang.String path,
                                          @NotNull
                                          Handler customHandler)

enableCorsForAllOrigins

public JavalinConfig enableCorsForAllOrigins()

enableCorsForOrigin

public JavalinConfig enableCorsForOrigin(@NotNull
                                         java.lang.String... origins)

accessManager

public JavalinConfig accessManager(@NotNull
                                   AccessManager accessManager)

requestLogger

public JavalinConfig requestLogger(@NotNull
                                   RequestLogger requestLogger)

sessionHandler

public JavalinConfig sessionHandler(@NotNull
                                    java.util.function.Supplier<org.eclipse.jetty.server.session.SessionHandler> sessionHandlerSupplier)

wsFactoryConfig

public JavalinConfig wsFactoryConfig(@NotNull
                                     java.util.function.Consumer<org.eclipse.jetty.websocket.servlet.WebSocketServletFactory> wsFactoryConfig)

wsLogger

public JavalinConfig wsLogger(@NotNull
                              java.util.function.Consumer<WsHandler> ws)

server

public JavalinConfig server(java.util.function.Supplier<org.eclipse.jetty.server.Server> server)

configureServletContextHandler

public JavalinConfig configureServletContextHandler(java.util.function.Consumer<org.eclipse.jetty.servlet.ServletContextHandler> consumer)

compressionStrategy

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

compressionStrategy

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

applyUserConfig

public static void applyUserConfig(Javalin app,
                                   JavalinConfig config,
                                   java.util.function.Consumer<JavalinConfig> userConfig)