io.pedestal libraries 0.8.0-alpha-1

Namespaces

io.pedestal.connector

Replacement for io.pedestal.http that is not (directly) linked to the Jakarta Servlet API and is generally simpler to use.

io.pedestal.connector.dev

Optional interceptors and support code used when developing and debugging.

io.pedestal.connector.specs

Public variables and functions:

    io.pedestal.environment

    Information about the running environment for the Pedestal application.

    Public variables and functions:

    io.pedestal.http

    This namespace ties together the many other namespaces to make it possible to succinctly define a service and start and stop a server for that service.

    io.pedestal.http.body-params

    Provides interceptors and support for parsing the body of a request, generally according to the content type header. This results in new keys on the request map, depending on the type of data parsed.

    io.pedestal.http.container

    Deeper Pedestal<->Container integration and cooperation for HTTP handling

    Public variables and functions:

    io.pedestal.http.content-negotiation

    io.pedestal.http.cors

    Public variables and functions:

    io.pedestal.http.csrf

    CSRF protection interceptor support, compatible with ring-anti-forgery

    io.pedestal.http.http-kit

    Support for Http-Kit as a network connector.

    Public variables and functions:

    io.pedestal.http.http-kit.response

    Utilities for converting Pedestal response :body types to those compatible with Http-Kit.

    Public variables and functions:

    io.pedestal.http.http-kit.specs

    Public variables and functions:

      io.pedestal.http.impl.servlet-interceptor

      Interceptors for adapting the Java HTTP Servlet interfaces.

      io.pedestal.http.impl.servlet-interceptor.specs

      Public variables and functions:

        io.pedestal.http.jetty

        Jetty adaptor for Pedestal.

        Public variables and functions:

        io.pedestal.http.jetty.container

        Extends Pedestal protocols onto Jetty container classes.

        Public variables and functions:

          io.pedestal.http.jetty.specs

          Public variables and functions:

            io.pedestal.http.jetty.util

            io.pedestal.http.params

            io.pedestal.http.request.map

            Responsible for converting incoming HttpServletRequest into a Ring-compatible request map.

            Public variables and functions:

            io.pedestal.http.response

            Utilities used to write Ring responses.

            io.pedestal.http.ring-middlewares

            This namespace creates interceptors for ring-core middlewares.

            io.pedestal.http.route

            io.pedestal.http.route.definition

            Constants and utilities used when implementing a routing specification, routing definition, or router.

            io.pedestal.http.route.definition.table

            Public variables and functions:

            io.pedestal.http.route.definition.terse

            io.pedestal.http.route.definition.verbose

            Implementation of the verbose routing syntax.

            Public variables and functions:

            io.pedestal.http.route.linear-search

            Public variables and functions:

            io.pedestal.http.route.map-tree

            Public variables and functions:

            io.pedestal.http.route.path

            Public variables and functions:

            io.pedestal.http.route.prefix-tree

            io.pedestal.http.route.sawtooth

            Public variables and functions:

            io.pedestal.http.route.specs

            Clojure spec definitions related to routing descriptions and routing tables.

            Public variables and functions:

              io.pedestal.http.route.types

              Home for protocols related to routes (that aren’t elsewhere for historical reasons).

              Public variables and functions:

              io.pedestal.http.secure-headers

              Secure header settings applied in interceptors

              io.pedestal.http.servlet

              Generic Servlet adapter that closes over its implementation functions; this dynamically creates a Servlet instance that can be used with a servlet container such as Jetty.

              Public variables and functions:

              io.pedestal.http.specs

              Public variables and functions:

                io.pedestal.http.sse

                Support for Server Sent Events.

                io.pedestal.http.tracing

                HTTP request tracing based on Open Telemetry.

                Public variables and functions:

                io.pedestal.interceptor

                Public API for creating interceptors, and various utility fns for common interceptor creation patterns.

                io.pedestal.interceptor.chain

                The implementation of the interceptor pattern, where a context map is passed through callbacks supplied by an extensible queue of interceptors, with provisions for error handling, observations, asynchronous executions, and other factors.

                io.pedestal.interceptor.chain.debug

                Tools to help debug interceptor chain execution.

                Public variables and functions:

                io.pedestal.interceptor.error

                Public variables and functions:

                io.pedestal.interceptor.specs

                Public variables and functions:

                  io.pedestal.log

                  A logging wrapper around SLF4J (but adaptable to other logging systems). Primary macros are trace, debug, info, warn, and error.

                  io.pedestal.metrics

                  Metrics functionality, built on the metrics SPI (service provider interface).

                  io.pedestal.metrics.otel

                  Default metrics implementation based on OpenTelemetry.

                  Public variables and functions:

                  io.pedestal.metrics.spi

                  Service Provider Interface for metrics providers; protocols that providers should expose and implement.

                  Public variables and functions:

                  io.pedestal.service.data

                  Utilities for converting to and from specific data types.

                  Public variables and functions:

                  io.pedestal.service.interceptors

                  io.pedestal.service.protocols

                  Public variables and functions:

                  io.pedestal.service.resources

                  Creation of routes to expose file system or classpath resources as GET-able URIs.

                  Public variables and functions:

                  io.pedestal.service.test

                  Utilities for PedestalConnectors to implement testing, and functions used when writing such tests.

                  io.pedestal.service.websocket

                  WebSocket support abstracted away from the Servlet API.

                  io.pedestal.telemetry.otel-global-init

                  Uses GlobalOpenTelemetry to provide defaults for metrics source and tracing source.

                  Public variables and functions:

                  io.pedestal.test

                  Pedestal testing utilities; mock implementations of the core Servlet API objects, to support fast integration testing without starting a servlet container, or opening a port for HTTP traffic.

                  io.pedestal.tracing

                  Wrappers around Open Telemetry tracing.

                  io.pedestal.tracing.spi

                  Defines the TracingSource protocol, and provides implementations on nil and on OpenTelemetry’s Tracer.

                  Public variables and functions:

                  io.pedestal.websocket

                  Utilities needed by servlet-based Pedestal containers (such as io.pedestal.http.jetty) to implement WebSocket support using default Servlet API functionality, as well as utilities for applications that make use Pedestal’s websocket support.

                  io.pedestal.websocket.specs

                  Public variables and functions: