Module io.avaje.jex
Package io.avaje.jex

Interface Context

public interface Context
Provides access to functions for handling the request and response.

  • Method Details

    • matchedPath

      String matchedPath()
      Returns the matched path as a raw expression, without any parameter substitution.
      Returns:
      The matched path as a raw string.

    • attribute

      Context attribute(String key, Object value)
      Sets an attribute on the request, accessible to other handlers in the request lifecycle.
      Parameters:
      key - The attribute key.
      value - The attribute value.

    • attribute

      <T> T attribute(String key)
      Gets the attribute with the specified key from the request.
      Type Parameters:
      T - The type of the attribute.
      Parameters:
      key - The attribute key.
      Returns:
      The attribute value, or null if not found.

    • cookie

      String cookie(String name)
      Returns the value of a cookie with the specified name from the request.
      Parameters:
      name - The name of the cookie.
      Returns:
      The value of the cookie, or null if the cookie is not found.

    • cookieMap

      Map<String,String> cookieMap()
      Returns a map containing all the cookie names and their corresponding values from the request.
      Returns:
      A map of cookie names to their values.

    • cookie

      Context cookie(String name, String value)
      Sets a cookie with the specified name and value, with no expiration date.
      Parameters:
      name - The name of the cookie.
      value - The value of the cookie.

    • cookie

      Context cookie(String name, String value, int maxAge)
      Sets a cookie with the specified name, value, and maximum age in seconds.
      Parameters:
      name - The name of the cookie.
      value - The value of the cookie.
      maxAge - The maximum age of the cookie in seconds.

    • cookie

      Context cookie(Context.Cookie cookie)
      Sets a cookie using the provided Context.Cookie object.
      Parameters:
      cookie - The cookie object to set.

    • removeCookie

      Context removeCookie(String name)
      Removes a cookie with the specified name.
      Parameters:
      name - The name of the cookie to remove.

    • removeCookie

      Context removeCookie(String name, String path)
      Removes a cookie with the specified name and path.
      Parameters:
      name - The name of the cookie to remove.
      path - The path of the cookie to remove.

    • redirect

      void redirect(String location)
      Redirects the client to the specified location using a 302 (Found) status code.
      Parameters:
      location - The URL to redirect to.

    • redirect

      void redirect(String location, int httpStatusCode)
      Redirects the client to the specified location using the given HTTP status code.
      Parameters:
      location - The URL to redirect to.
      httpStatusCode - The HTTP status code to use for the redirect.

    • routeRoles

      Set<Role> routeRoles()
      Returns a set of roles associated with the current route.
      Returns:
      A set of roles.

    • bodyAsBytes

      byte[] bodyAsBytes()
      Returns the request body as a byte array.
      Returns:
      The request body as a byte array.

    • bodyAsInputStream

      InputStream bodyAsInputStream()
      Returns the request body as an input stream.
      Returns:
      The request body as an input stream.

    • bodyAsClass

      <T> T bodyAsClass(Class<T> beanType)
      Return the request body as bean.
      Parameters:
      beanType - The bean type

    • bodyAsType

      <T> T bodyAsType(Type beanType)
      Return the request body as bean.
      Parameters:
      beanType - The bean type

    • body

      String body()
      Return the request body as String.

    • contentLength

      long contentLength()
      Return the request content length.

    • contentType

      String contentType()
      Return the request content type.

    • contentType

      Context contentType(String contentType)
      Set the response content type.

    • pathParamMap

      Map<String,String> pathParamMap()
      Return all the path parameters as a map.

    • pathParam

      String pathParam(String name)
      Return the path parameter.
      Parameters:
      name - The path parameter name.

    • queryParam

      String queryParam(String name)
      Return the first query parameter value.
      Parameters:
      name - The query parameter name

    • queryParam

      default String queryParam(String name, String defaultValue)
      Return the first query parameter value or the default value if it does not exist.
      Parameters:
      name - The query parameter name

    • queryParams

      List<String> queryParams(String name)
      Return all the query parameters for the given parameter name.

    • queryParamMap

      Map<String,String> queryParamMap()
      Return all the query parameters as a map.

      Note this returns the first value for any given key if that key has multiple values.

    • queryString

      String queryString()
      Return the request query string, or null.

    • formParam

      default String formParam(String key)
      Return the first form param value for the specified key or null.

    • formParam

      default String formParam(String key, String defaultValue)
      Return the first form param value for the specified key or the default value.

    • formParams

      default List<String> formParams(String key)
      Return the form params for the specified key, or empty list.

    • formParamMap

      Map<String,List<String>> formParamMap()
      Returns a map with all the form param keys and values.

    • exchange

      HttpExchange exchange()
      Return the underlying JDK HttpExchange object backing the context

    • scheme

      String scheme()
      Return the request scheme.

    • url

      String url()
      Return the request url.

    • fullUrl

      default String fullUrl()
      Return the full request url, including query string (if present)

    • contextPath

      String contextPath()
      Return the request context path.

    • userAgent

      default String userAgent()
      Return the request user agent, or null.

    • status

      Context status(int statusCode)
      Set the status code on the response.

    • status

      int status()
      Return the current response status.

    • text

      void text(String content)
      Write plain text content to the response.

    • html

      void html(String content)
      Write html content to the response.

    • json

      void json(Object bean)
      Set the content type as application/json and write the response.
      Parameters:
      bean - the object to serialize and write

    • jsonStream

      <E> void jsonStream(Stream<E> stream)
      Write the stream as a JSON stream with new line delimiters application/x-json-stream.
      Parameters:
      stream - The stream of beans to write as json

    • jsonStream

      <E> void jsonStream(Iterator<E> iterator)
      Write the stream as a JSON stream with new line delimiters application/x-json-stream.
      Parameters:
      iterator - The iterator of beans to write as json

    • write

      void write(String content)
      Writes the given string content directly to the response.
      Parameters:
      content - The string content to write.

    • write

      void write(byte[] bytes)
      Writes the given bytes directly to the response.
      Parameters:
      bytes - The byte array to write.

    • write

      void write(InputStream is)
      Writes the content from the given InputStream directly to the response body.
      Parameters:
      is - The input stream containing the content to write.

    • outputStream

      OutputStream outputStream()
      Return the outputStream to write content. It is expected that the contentType(String) has been set prior to obtaining and writing to the outputStream.
      Returns:
      The outputStream to write content to.

    • render

      default Context render(String name)
      Render a template typically as html.
      Parameters:
      name - The template name

    • render

      Context render(String name, Map<String,Object> model)
      Render a template typically as html with the given model.
      Parameters:
      name - The template name
      model - The model used with the template

    • headerMap

      Map<String,String> headerMap()
      Return all the request headers as a map.
      Returns:
      all the headers as a single value Map

    • headers

      Headers headers()
      Return underlying request headers.
      Returns:
      the request headers

    • header

      String header(String key)
      Return the request header.
      Parameters:
      key - The header key

    • header

      Context header(String key, String value)
      Set the response header.
      Parameters:
      key - The header key
      value - The header value

    • header

      Context header(String key, List<String> value)
      Set the response header.
      Parameters:
      key - The header key
      value - The header value

    • headers

      default Context headers(Map<String,String> headers)
      Add the response headers using the provided map.

    • headerMap

      Context headerMap(Map<String,List<String>> headers)
      Sets the response headers using the provided map.
      Parameters:
      headers - A map containing the header names as keys and their corresponding values as lists.
      Returns:
      The updated context object.

    • responseHeader

      String responseHeader(String key)
      Returns the value of the specified response header.
      Parameters:
      key - The name of the header.
      Returns:
      The value of the header, or null if not found.

    • host

      String host()
      Returns the host name of the request.
      Returns:
      The host name of the request, or null if not available.

    • ip

      String ip()
      Returns the IP address of the client making the request.
      Returns:
      The IP address of the client.

    • method

      String method()
      Returns the HTTP method used in the request (e.g., GET, POST, PUT, DELETE).
      Returns:
      The HTTP method of the request.

    • path

      String path()
      Returns the path part of the request URI.
      Returns:
      The path part of the request URI.

    • port

      int port()
      Returns the port number used in the request.
      Returns:
      The port number of the request.

    • protocol

      String protocol()
      Returns the protocol used in the request (e.g., HTTP/1.1).
      Returns:
      The protocol of the request.

    • basicAuthCredentials

      BasicAuthCredentials basicAuthCredentials()
      Gets basic-auth credentials from the request, or throws.

      Returns a wrapper object containing the Base64 decoded username and password from the Authorization header, or null if basic-auth is not properly configured

    • responseSent

      boolean responseSent()
      Return true if the response has been sent.