ring-undertow-adapter

ring-undertow-adapter is a Ring server built with Undertow.

Installation

Usage

HTTP Handler

HTTP handler returns an Undertow server instance. To stop call (.stop <handler instance>). The handler is initialized using a map with the following keys:

• :configurator - a function called with the Undertow Builder instance
• :host - the hostname to listen on
• :http? - flag to enable http (defaults to true)
• :port - the port to listen on (defaults to 80)
• :ssl-port - a number, requires either :ssl-context, :keystore, or :key-managers
• :keystore - the filepath (a String) to the keystore
• :key-password - the password for the keystore
• :truststore - if separate from the keystore
• :trust-password - if :truststore passed
• :ssl-context - a valid javax.net.ssl.SSLContext
• :key-managers - a valid javax.net.ssl.KeyManager []
• :trust-managers - a valid javax.net.ssl.TrustManager []
• :http2? - a flag to enable http2. Boolean
• :io-threads - # threads handling IO, defaults to available processors
• :worker-threads - # threads invoking handlers, defaults to (* io-threads 8)
• :buffer-size - a number, defaults to 16k for modern servers
• :direct-buffers? - boolean, defaults to true
• :dispatch? - dispatch handlers off the I/O threads (default: true)
• :websocket? - built-in handler support for websocket callbacks
• :async? - ring async flag. When true, expect a ring async three arity handler function
• :handler-proxy - an optional custom handler proxy function taking handler as single argument
• :max-entity-size - maximum size of a request entity
• :session-manager? - initialize undertow session manager (default: true)
• :custom-manager - custom implementation that extends the io.undertow.server.session.SessionManager interface. Only used if :session-manager? is true. If not provided, defaults to Undertow inmemory SessionManager
• :max-sessions - maximum number of undertow sessions, for use with InMemorySessionManager (default: -1)
• :server-name - for use with InMemorySessionManager (default: "ring-undertow")

(require '[ring.adapter.undertow :refer [run-undertow]])

(defn handler [req]
  {:status 200
   :body "Hello world"})

(run-undertow handler {:port 8080})

WebSocket Handler

A WebSocket handler is created using a Ring handler function that returns a map containing a :undertow/websocket containing the configuration map:

• :on-open - fn taking a map with the key :channel (optional)
• :on-message - fn taking map of keys :channel, :data (optional)
• :on-close-message - fn taking map of keys :channel, :message (optional)
• :on-error - fn taking map of keys :channel, :error (optional)

(require '[ring.adapter.undertow.websocket :as ws])

(fn [request]
  {:undertow/websocket 
   {:on-open (fn [{:keys [channel]}] (println "WS open!"))
    :on-message (fn [{:keys [channel data]}] (ws/send "message received" channel))
    :on-close-message (fn [{:keys [channel message]}] (println "WS closeed!"))}})

If headers are provided in the map returned from the handler function they are included in the response to the WebSocket upgrade request. Handlers relevant to the WebSocket handshake (eg Connection) will be overwritten so that the WebSocket handshake completes correctly:

(defn- websocket-handler-with-headers [request]
  {:headers            {"X-Test-Header" "Hello!"}
   :undertow/websocket {}})

Middleware

Undertow adapter provides session middleware using Undertow session. By default, sessions will timeout after 30 minutes of inactivity.

Supported options:

• :timeout The number of seconds of inactivity before session expires [1800], value less than or equal to zero indicates the session should never expire.
• :cookie-name The name of the cookie that holds the session key ["JSESSIONID"]
• :cookie-attrs A map of attributes to associate with the session cookie with the following options:
  • :path - the subpath the cookie is valid for
  • :domain - the domain the cookie is valid for
  • :max-age - the maximum age in seconds of the cookie
  • :secure - set to true if the cookie requires HTTPS, prevent HTTP access
  • :http-only - set to true if the cookie is valid for HTTP and HTTPS only (ie. prevent JavaScript access)

(require '[ring.adapter.undertow.middleware.session :refer [wrap-session]])

(wrap-session handler {:http-only true})

License

Distributed under MIT License.