catacumba.impl.context — updcon/catacumba 2.2.2

Functions and helpers for work in a clojure way with ratpack types.

before-send clj

(before-send context callback)

Register a callback in the context that will be called just before send the response to the client. Is a useful hook for set some additional cookies, headers or similar response transformations.

build-context clj

(build-context ctx)

create-context clj

(create-context ctx)

delegate clj

(delegate)

(delegate data)

Delegate handling to the next handler in line.

This function accept an additiona parameter for pass context parameters to the next handlers, and that can be obtained with context-params function.

Returns an instance of DelegatedContext.

delegated-context? clj

(delegated-context? v)

Check if the provided value is a DelegatedContext instance.

get-body! clj

(get-body! context)

Reads asynchronously the body from context. This function return a promise (CompletableFuture instance).

NOTE: it can only be done once, consider using specialized body parsing handlers instead of this. This function should be considered low-level.

get-context* clj

(get-context* context)

get-cookies clj

(get-cookies context)

Get the incoming cookies.

get-formdata clj

(get-formdata {:keys [body] :as context})

get-formdata* clj

(get-formdata* ctx body)

get-headers clj

(get-headers context)

(get-headers context keywordize?)

get-query-params clj

(get-query-params context)

Parse query params from request and return a maybe multivalue map.

get-request* clj

(get-request* context)

get-response* clj

(get-response* context)

get-route-params clj

(get-route-params context)

Return a hash-map with parameters extracted from routing patterns.

on-close clj

(on-close context callback)

Register a callback in the context that will be called when the connection with the client is closed.

public-address clj

(public-address context)

Get the current public address as URI instance.

The default implementation uses a variety of strategies to attempt to provide the desired result most of the time. Information used includes:

• Configured public address URI (optional)
• X-Forwarded-Host header (if included in request)
• X-Forwarded-Proto or X-Forwarded-Ssl headers (if included in request)
• Absolute request URI (if included in request)
• Host header (if included in request)
• Service's bind address and scheme (http vs. https)

resolve-file clj

(resolve-file context path)

Resolve file using the current filesystem binding configuration. The path will be resolved as relative to the filesystem binding root.

set-cookies! clj

(set-cookies! context cookies)

Set the outgoing cookies.

(set-cookies! ctx {:cookiename {:value "value"}})

As well as setting the value of the cookie, you can also set additional attributes:

• :domain - restrict the cookie to a specific domain
• :path - restrict the cookie to a specific path
• :secure - restrict the cookie to HTTPS URLs if true
• :http-only - restrict the cookie to HTTP if true (not accessible via e.g. JavaScript)
• :max-age - the number of seconds until the cookie expires

As you can observe is almost identical hash map structure as used in the ring especification.

set-headers! clj

(set-headers! context headers)

set-status! clj

(set-status! context status)

Set the response http status.