Constructor Detail

• JavalinServletContext

  JavalinServletContext(JavalinServletContextConfig cfg, Deque<Task> tasks, Boolean exceptionOccurred, AtomicBoolean responseWritten, HttpServletRequest req, HttpServletResponse res, Long startTimeNanos, HandlerType handlerType, Set<RouteRole> routeRoles, String matchedPath, Map<String, String> pathParamMap, String endpointHandlerPath, Supplier<out CompletableFuture<?>> userFutureSupplier, InputStream resultStream, Integer minSizeForCompression)

Method Detail

• getTasks

   final Deque<Task> getTasks()

• getExceptionOccurred

   final Boolean getExceptionOccurred()

• setExceptionOccurred

   final Unit setExceptionOccurred(Boolean exceptionOccurred)

• getResponseWritten

   final AtomicBoolean getResponseWritten()

• executionTimeMs

   final Float executionTimeMs()

• changeBaseRequest

   final JavalinServletContext changeBaseRequest(HttpServletRequest req)

• update

   final JavalinServletContext update(ParsedEndpoint parsedEndpoint, String requestUri)

• req

   HttpServletRequest req()

  Servlet request

• res

   HttpServletResponse res()

  Servlet response

• appData

   <T extends Any> T appData(Key<T> key)

  Get app data by key

• with

   <T extends Any> T with(Class<out ContextPlugin<?, T>> clazz)

  Fetch the context extension for a plugin

• jsonMapper

   JsonMapper jsonMapper()

  Get configured JsonMapper

• endpointHandlerPath

   String endpointHandlerPath()

  Gets the endpoint path that was used to match request (null in before, available in endpoint/after)

• characterEncoding

   String characterEncoding()

  Try to obtain request encoding from Header.CONTENT_TYPE header

• cookieStore

   CookieStore cookieStore()

  Gets cookie store used by this request

• method

   HandlerType method()

  Gets the request method.

• handlerType

   HandlerType handlerType()

  Gets the handler type of the current handler

• matchedPath

   String matchedPath()

  Gets the path that was used to match request (also includes before/after paths)

• bodyAsBytes

   ByteArray bodyAsBytes()

  Gets the request body as a ByteArray. Calling this method returns the body as a ByteArray. If io.javalin.config.HttpConfig.maxRequestSize is set and body is bigger than its value, a io.javalin.http.HttpResponseException is throw, with status 413 CONTENT_TOO_LARGE.

• formParamMap

   Map<String, List<String>> formParamMap()

  Gets a map with all the form param keys and values.

• pathParamMap

   Map<String, String> pathParamMap()

  Gets a map of all the pathParamAsClass keys and values.

• pathParam

   String pathParam(String key)

  Gets a path param by name (ex: pathParam("param").

  Ex: If the handler path is /users/{user-id}, and a browser GETs /users/123, pathParam("user-id") will return "123"

• queryParamMap

   Map<String, List<String>> queryParamMap()

  Gets a map with all the query param keys and values.

• outputStream

   ServletOutputStream outputStream()

  Gets the output stream you can write to. This stream by default uses compression specified in the Javalin configuration. If you're looking for the servlet's raw, uncompressed output stream, use ctx.res().outputStream.

• minSizeForCompression

   JavalinServletContext minSizeForCompression(Integer minSizeForCompression)

  The output stream returned by outputStream() will use compression (as specified in Javalin configuration), but compression will happen only if the first write to the output stream is larger than minSizeForCompression. Calling this function with a value of zero will cause compression to always be used. The default value is set to the value of io.javalin.compression.CompressionStrategy.defaultMinSizeForCompression. This function must be called before calling outputStream for the first time.

• redirect

   Unit redirect(String location, HttpStatus status)

  Redirects to location with given status. Skips HTTP handler if called in before-handler

• result

   Context result(InputStream resultStream)

  Sets context result to the specified InputStream. Will overwrite the current result if there is one.

• resultInputStream

   InputStream resultInputStream()

  Gets the underlying InputStream for the result (io.javalin.http.servlet.JavalinServletContext.resultInputStream)

• future

   Unit future(Supplier<out CompletableFuture<?>> future)

  The main entrypoint for all async related functionalities exposed by Context.

  Parameters:

  future - Future represents any delayed in time result.

• skipRemainingHandlers

   Context skipRemainingHandlers()

• routeRoles

   Set<RouteRole> routeRoles()

• writeJsonStream

   Unit writeJsonStream(Stream<?> stream)

  Consumes the specified stream with the configured JsonMapper, which transforms the stream's content to JSON, writing the results directly to the response's outputStream as the stream is consumed. This function call is synchronous, and may be wrapped in ctx.async { } if needed. The response will always be compressed regardless of size, given that compression is enabled in the Javalin configuration.