api

All Types

Name Summary
org.http4k.security.AccessTokenContainer  
org.http4k.client.ApacheAsyncClient  
org.http4k.client.ApacheClient  
org.http4k.server.ApacheServer  
org.http4k.contract.ApiInfo  
org.http4k.contract.ApiKey Checks the presence of the named Api Key parameter. Filter returns 401 if Api-Key is not found in request.
org.http4k.serverless.AppLoader Http4k app loader - instantiate the application from the environment config
org.http4k.util.Appendable  
io.ktor.request.ApplicationRequest (extensions in package org.http4k.server)  
io.ktor.response.ApplicationResponse (extensions in package org.http4k.server)  
org.http4k.format.Argo  
org.http4k.client.AsyncHttpClient  
org.http4k.cloudnative.env.Authority  
org.http4k.format.AutoMappingConfiguration This is the generic interface used to configure auto-mapping functionality for message format libraries. The various methods here can be used to provide custom mapping behaviour (say for domain classes).
org.http4k.format.AutoMarshallingJson  
org.http4k.format.AutoMarshallingXml  
org.http4k.aws.AwsCredentialScope  
org.http4k.aws.AwsCredentials  
org.http4k.aws.AwsHmacSha256  
org.http4k.cloudnative.BadGateway  
org.http4k.cloudnative.BadRequest  
org.http4k.filter.cookie.BasicCookieStorage  
org.http4k.chaos.Behaviour Encapsulates the type of bad behaviour to apply to the response.
org.http4k.lens.BiDiBodyLens A BiDiBodyLens provides the bi-directional extraction of an entity from a target body, or the insertion of an entity into a target body.
org.http4k.lens.BiDiBodyLensSpec Represents a bi-directional extraction of an entity from a target Body, or an insertion into a target Body.
org.http4k.lens.BiDiLens A BiDiLens provides the bi-directional extraction of an entity from a target, or the insertion of an entity into a target.
org.http4k.lens.BiDiLensSpec Represents a bi-directional extraction of an entity from a target, or an insertion into a target.
org.http4k.lens.BiDiMapping A BiDiMapping defines a reusable bidirectional transformation between an input and output type
org.http4k.lens.BiDiMultiLensSpec Represents a bi-directional extraction of a list of entities from a target, or an insertion into a target.
org.http4k.lens.BiDiPathLens  
org.http4k.lens.BiDiPathLensSpec  
org.http4k.lens.BiDiWsMessageLens A BiDiWsMessageLens provides the bi-directional extraction of an entity from a target body, or the insertion of an entity into a target WsMessage.
org.http4k.lens.BiDiWsMessageLensSpec Represents a bi-directional extraction of an entity from a target Body, or an insertion into a target WsMessage.
org.http4k.core.Body If this Body is NOT being returned to the caller (via a Server implementation or otherwise), close() should be called.
org.http4k.lens.BodyLens A BodyLens provides the uni-directional extraction of an entity from a target body.
org.http4k.lens.BodyLensSpec Represents a uni-directional extraction of an entity from a target Body.
org.http4k.core.BodyMode  
org.http4k.serverless.BootstrapAppLoader  
org.http4k.serverless.BootstrapException  
com.squareup.moshi.Moshi.Builder (extensions in package org.http4k.format)  
java.nio.ByteBuffer (extensions in package org.http4k)  
org.http4k.filter.CacheControlHeaderPart  
org.http4k.filter.CachingFilters Useful filters for applying Cache-Controls to request/responses
org.http4k.filter.CanonicalPayload  
org.http4k.chaos.ChaosBehaviours  
org.http4k.chaos.ChaosEngine Adds a set of endpoints to an application which will control the switching on/off of chaos behaviour. The added endpoints are: GET //status <- check the on off/status of the injected chaos POST //activate <- turn on the chaos. optionally POST a JSON body to set a list of new stages to use. POST //deactivate <- turn off the chaos POST //toggle <- toggle the chaos
org.http4k.chaos.ChaosStages  
org.http4k.chaos.ChaosTriggers  
org.http4k.filter.ClientFilters  
org.http4k.cloudnative.ClientTimeout  
org.http4k.testing.ClosedWebsocket  
org.http4k.cloudnative.health.Completed  
org.http4k.cloudnative.health.Composite Result of multiple checks, for which it reports an overall result (ie. any failure is fatal).
org.http4k.format.ConfigurableGson  
org.http4k.format.ConfigurableJackson  
org.http4k.format.ConfigurableJacksonXml  
org.http4k.format.ConfigurableMoshi  
org.http4k.cloudnative.Conflict  
org.http4k.server.ConnectorBuilder  
org.http4k.lens.ContentNegotiation Modes for determining if a passed content type is acceptable.
org.http4k.core.ContentType  
org.http4k.contract.ContractBuilder  
org.http4k.contract.ContractRenderer  
org.http4k.contract.ContractRoute  
org.http4k.contract.ContractRouteSpec  
org.http4k.contract.ContractRouteSpec0  
org.http4k.contract.ContractRouteSpec1  
org.http4k.contract.ContractRouteSpec10  
org.http4k.contract.ContractRouteSpec2  
org.http4k.contract.ContractRouteSpec3  
org.http4k.contract.ContractRouteSpec4  
org.http4k.contract.ContractRouteSpec5  
org.http4k.contract.ContractRouteSpec6  
org.http4k.contract.ContractRouteSpec7  
org.http4k.contract.ContractRouteSpec8  
org.http4k.contract.ContractRouteSpec9  
org.http4k.contract.ContractRoutingHttpHandler  
org.http4k.core.cookie.Cookie  
org.http4k.filter.cookie.CookieStorage  
org.http4k.lens.Cookies  
org.http4k.filter.CorsPolicy  
org.http4k.core.Credentials  
org.http4k.security.CrossSiteRequestForgeryToken  
org.http4k.security.CsrfGenerator  
org.http4k.filter.DebuggingFilters  
org.http4k.filter.DefaultCacheTimings  
org.http4k.cloudnative.health.DefaultReadinessCheckResultRenderer Basic reporting of ReadinessCheckResults
org.http4k.routing.experimental.DirectoryRenderer  
org.http4k.client.DualSyncAsyncHttpHandler  
org.http4k.template.dust.Dust  
org.http4k.template.DustTemplates  
org.http4k.core.etag.ETag  
org.http4k.core.etag.ETagValidationRequestParser Implemented according to https://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11
org.http4k.cloudnative.env.Environment This models the runtime environment of the shell where the app is running. Optionally pass a separator to use for multi-values otherwise a standard comma is used - this means you MUST override the separator if you have single values which contain commas, otherwise singular environment keys will just retrieve the first value.
org.http4k.cloudnative.env.EnvironmentKey This models the key used to get a value out of the Environment using the standard Lens mechanic. Note that if your values contain commas, either use a EnvironmentKey.(mapping).multi.required()/optional()/defaulted() to retrieve the entire list, or override the comma separator in your initial Environment.
org.http4k.jsonrpc.ErrorHandler  
org.http4k.jsonrpc.ErrorMessage  
org.http4k.core.Event  
org.http4k.core.EventCategory  
org.http4k.core.Events  
org.http4k.cloudnative.health.Failed  
org.http4k.lens.Failure  
org.http4k.webdriver.FeatureNotImplementedYet  
org.http4k.core.etag.FieldValue  
org.http4k.core.Filter  
org.http4k.core.body.Form  
org.http4k.lens.FormField  
org.http4k.core.FormFile  
org.http4k.template.FreemarkerTemplates  
kotlin.Function1 (extensions in package org.http4k.client)  
kotlin.Function1 (extensions in package org.http4k.cloudnative)  
kotlin.Function1 (extensions in package org.http4k.core)  
kotlin.Function1 (extensions in package org.http4k.server)  
kotlin.Function1 (extensions in package org.http4k.servlet)  
kotlin.Function1 (extensions in package org.http4k.template)  
kotlin.Function1 (extensions in package org.http4k.testing)  
kotlin.Function1 (extensions in package org.http4k.chaos)  
org.http4k.filter.GenerateDataClasses This Filter is used to generate Data class definitions from a Response containing JSON. The Filter will try and reduce the number of class definitions by selecting the definition with the most fields (for cases where lists of items have different fields).
org.http4k.filter.GenerateXmlDataClasses  
org.http4k.webdriver.GetURL  
org.http4k.format.Gson To implement custom JSON configuration, create your own object singleton. Extra mappings can be added before done() is called.
com.google.gson.GsonBuilder (extensions in package org.http4k.format)  
org.http4k.template.HandlebarsTemplates Handlebars templating support. Use the function in the constructor to configure the instance.
org.http4k.lens.Header  
org.http4k.lens.HeaderLens  
org.http4k.core.Headers  
org.http4k.cloudnative.health.Health Represents the set of operational endpoints to ensure that a particular app is working ok. By default provides Readiness and Liveness endpoints, but extra routes can be passed, as can a different renderer implementation for the ReadinessCheck results.
org.http4k.cloudnative.env.Host  
org.http4k.webdriver.Http4KNavigation  
org.http4k.server.Http4kChannelHandler Exposed to allow for insertion into a customised Netty server instance
org.http4k.cloudnative.Http4kK8sServer A K8S server consists of a main application and a health application, running on 2 different ports. This class provides unified start/stop control.
org.http4k.server.Http4kRequestHandler Exposed to allow for insertion into a customised Apache WebServer instance
org.http4k.server.Http4kServer  
org.http4k.webdriver.Http4kWebDriver  
org.http4k.core.HttpHandler  
org.http4k.servlet.HttpHandlerServlet  
org.http4k.core.HttpMessage  
org.http4k.contract.HttpMessageMeta  
org.http4k.core.HttpTransaction  
org.http4k.filter.HttpTransactionLabeller  
org.http4k.server.HttpUndertowHandler Exposed to allow for insertion into a customised Undertow server instance
org.http4k.util.IllegalSchemaException  
org.http4k.routing.experimental.InMemoryResource  
org.http4k.security.InsecureCookieBasedOAuthPersistence This is an example implementation which stores CSRF and AccessTokenEnvelope values in an INSECURE client-side cookie. Access-tokens for end-services are fully available to the browser so do not use this in production!
org.http4k.cloudnative.InternalServerError  
org.http4k.lens.Invalid  
org.http4k.format.InvalidJsonException  
org.http4k.webdriver.JSoupWebElement  
org.http4k.format.Jackson To implement custom JSON configuration, create your own object singleton. Extra mappings can be added before done() is called.
org.http4k.format.JacksonXml To implement custom XML configuration, create your own object singleton. Extra mappings can be added before done() is called.
org.http4k.client.JavaHttpClient  
org.http4k.server.Jetty  
org.http4k.client.JettyClient  
org.http4k.format.Json This is the contract for all JSON implementations
org.http4k.format.JsonErrorResponseRenderer  
org.http4k.format.JsonLibAutoMarshallingJson  
com.fasterxml.jackson.databind.JsonNode (extensions in package org.http4k.chaos)  
org.http4k.cloudnative.health.JsonReadinessCheckResultRenderer Reporting of ReadinessCheckResults in a JSON tree
org.http4k.jsonrpc.JsonRpc  
org.http4k.jsonrpc.JsonRpcHandler  
org.http4k.jsonrpc.JsonRpcMethodBinding  
org.http4k.jsonrpc.JsonRpcService  
org.http4k.util.JsonSchema  
org.http4k.util.JsonToJsonSchema  
org.http4k.format.JsonType  
com.fasterxml.jackson.module.kotlin.KotlinModule (extensions in package org.http4k.format)  
org.http4k.server.KtorCIO  
org.http4k.serverless.lambda.LambdaFunction This is the main entry point for the lambda. It uses the local environment to instantiate the Http4k handler which can be used for further invocations.
org.http4k.lens.Lens A Lens provides the uni-directional extraction of an entity from a target.
org.http4k.lens.LensExtractor  
org.http4k.lens.LensFailure  
org.http4k.lens.LensGet  
org.http4k.lens.LensInjector  
org.http4k.lens.LensSet  
org.http4k.lens.LensSpec Represents a uni-directional extraction of an entity from a target.
kotlin.collections.List (extensions in package org.http4k.core)  
kotlin.collections.List (extensions in package org.http4k.core.body)  
org.http4k.cloudnative.health.Liveness The Liveness check is used to determine if an app is alive.
org.http4k.filter.cookie.LocalCookie  
kotlin.collections.Map (extensions in package org.http4k.core)  
org.http4k.jsonrpc.Mapping  
org.http4k.filter.MaxAgeTtl  
org.http4k.core.MemoryBody Represents a body that is backed by an in-memory ByteBuffer. Closing this has no effect.
org.http4k.core.MemoryRequest  
org.http4k.core.MemoryResponse  
org.http4k.lens.Meta  
org.http4k.core.Method  
org.http4k.jsonrpc.MethodBindings  
org.http4k.filter.MetricFilters  
org.http4k.core.MimeTypes  
org.http4k.lens.Missing  
org.http4k.format.Moshi To implement custom JSON configuration, create your own object singleton. Extra mappings can be added before done() is called.
org.http4k.lens.MultiLensSpec Represents a uni-directional extraction of a list of entities from a target.
org.http4k.core.MultipartEntity  
org.http4k.lens.MultipartForm  
org.http4k.core.MultipartFormBody Represents a Multi-part that is backed by a stream, which should be closed after handling the content. The gotchas which apply to StreamBody also apply here..
org.http4k.lens.MultipartFormField  
org.http4k.lens.MultipartFormFile  
org.http4k.webdriver.Navigate  
org.http4k.server.Netty  
org.http4k.contract.NoRenderer  
org.http4k.contract.NoSecurity Default NoOp security filter. Filter allows all traffic through.
org.http4k.cloudnative.NotFound  
org.http4k.security.OAuthCallback  
org.http4k.security.OAuthPersistence Provides persistence for OAuth lifecycle values:
org.http4k.security.OAuthProvider Provides a configured set of objects for use with an OAuth2 provider.
org.http4k.security.OAuthProviderConfig  
org.http4k.security.OAuthRedirectionFilter  
org.http4k.client.OkHttp  
org.http4k.contract.OpenApi  
org.http4k.webdriver.Page  
org.http4k.lens.ParamMeta  
org.http4k.core.Parameters  
org.http4k.lens.Path  
org.http4k.lens.PathLens  
org.http4k.lens.PathLensSpec Represents a uni-directional extraction of an entity from a target path segment.
org.http4k.routing.PathMethod  
org.http4k.contract.PathSegments  
org.http4k.filter.Payload  
org.http4k.template.PebbleTemplates  
org.http4k.websocket.PolyHandler A PolyHandler represents the combined routing logic of an Http handler and a Websocket handler. ws:// and http:// protocol calls are passed relevantly.
org.http4k.cloudnative.env.Port  
org.http4k.contract.PreFlightExtraction Determines which parts of the request should be pre-extracted to check for presence before being passed to the ultimate HttpHandler for this route. Choice will be determined by two competing scenarios:
org.http4k.websocket.PushPullAdaptingWebSocket  
org.http4k.lens.Query  
org.http4k.lens.QueryLens  
org.http4k.traffic.ReadWriteCache Combined Read/Write storage models, optimised for retrieval.
org.http4k.traffic.ReadWriteStream Combined Read/Write storage models, optimised for replay.
org.http4k.cloudnative.health.Readiness The Readiness check is used to determine if an app is prepared to receive live traffic.
org.http4k.cloudnative.health.ReadinessCheck A Readiness check is used to determine if the pod is ready to receive traffic. An example is to test if the app can talk to it’s database.
org.http4k.cloudnative.health.ReadinessCheckResult The result of a Readiness check. Checks can be combined together with +() to provide an overall result.
org.http4k.cloudnative.health.ReadinessCheckResultRenderer Renders the results of a readiness check
org.http4k.testing.RecordingEvents Simple recording events that can be used in tests
org.http4k.traffic.Replay Provides a stream of traffic for replaying purposes.
org.http4k.core.Request  
org.http4k.core.RequestContext  
org.http4k.lens.RequestContextKey  
org.http4k.lens.RequestContextLens  
org.http4k.core.RequestContexts In-memory RequestContext store.
org.http4k.filter.RequestFilters  
org.http4k.contract.RequestMeta  
org.http4k.filter.ResilienceFilters  
org.http4k.routing.experimental.Resource  
org.http4k.routing.experimental.ResourceListingHandler  
org.http4k.routing.ResourceLoader  
org.http4k.routing.experimental.ResourceLoaders  
org.http4k.routing.experimental.ResourceLoading A little convenience thunk to simplify implementing Router for resource loaders.
org.http4k.routing.experimental.ResourceSummary  
org.http4k.traffic.Responder Provides HTTP Handlers which respond using pre-stored Requests.
org.http4k.core.Response  
org.http4k.filter.ResponseFilters  
org.http4k.contract.ResponseMeta  
org.http4k.contract.Root  
org.http4k.contract.RouteMeta  
org.http4k.contract.RouteMetaDsl  
org.http4k.routing.RoutedRequest  
org.http4k.routing.RoutedResponse  
org.http4k.routing.Router Provides matching of a Request to an HttpHandler which can service it.
org.http4k.routing.RoutingHttpHandler Composite HttpHandler which can potentially service many different URL patterns. Should return a 404 Response if it cannot service a particular Request.
org.http4k.routing.RoutingWsHandler  
org.http4k.filter.SamplingDecision  
org.http4k.cloudnative.env.Secret A secret is a value which tries very hard not to expose itself as a string, by storing it’s value in a byte array. You can “use” the value only once, after which the value is destroyed
org.http4k.contract.Security Endpoint security. Provides filter to be applied to endpoints for all requests.
org.http4k.server.ServerConfig Standard interface for creating a configured WebServer
org.http4k.filter.ServerFilters  
org.http4k.cloudnative.ServiceUnavailable  
org.http4k.contract.SimpleJson  
org.http4k.traffic.Sink Consumes HTTP traffic for storage.
org.http4k.contract.Slash  
org.http4k.traffic.Source Tries to retrieve a stored response for a given request.
org.http4k.chaos.Stage Defines a periodic element during which a particular ChaosBehaviour is active.
org.http4k.filter.StaleIfErrorTtl  
org.http4k.filter.StaleWhenRevalidateTtl  
org.http4k.core.Status  
org.http4k.core.Store  
org.http4k.core.StreamBody Represents a body that is backed by a (lazy) InputStream. Operating with StreamBody has a number of potential gotchas:
kotlin.String (extensions in package org.http4k.core)  
kotlin.String (extensions in package org.http4k.contract)  
kotlin.String (extensions in package org.http4k)  
kotlin.String (extensions in package org.http4k.routing)  
org.http4k.lens.StringBiDiMappings A set of standardised String <-> Type conversions which are used throughout http4k
java.lang.StringBuilder (extensions in package org.http4k)  
org.http4k.server.SunHttp  
org.http4k.chaos.SwitchTrigger Simple toggleable trigger to turn ChaosBehaviour on/off
org.http4k.contract.Tag  
org.http4k.template.dust.TemplateExpansion  
org.http4k.template.dust.TemplateExpansionService  
org.http4k.template.dust.TemplateLoader  
org.http4k.template.TemplateRenderer  
org.http4k.template.Templates Supported template implementations for templating engine implementations
org.http4k.testing.TestWsClient A class that is used for offline testing of a routed Websocket, without starting up a Server. Calls are routed synchronously to the receiving Websocket, and error are propagated to the caller.
org.http4k.template.ThymeleafTemplates  
org.http4k.cloudnative.env.Timeout  
org.http4k.filter.TraceId  
org.http4k.filter.TrafficFilters  
org.http4k.chaos.Trigger  
org.http4k.routing.experimental.URLResource  
org.http4k.server.Undertow  
org.http4k.lens.Unsupported  
org.http4k.cloudnative.UpstreamRequestFailed This hierarchy of exceptions should be used to indicate that an upstream remote system has failed with a non-successful status code which caused us to stop processing. They are designed to be used with the Server and Client filters which will allow automatic handling and propagation of erroneous responses from upstream.
org.http4k.core.Uri  
org.http4k.core.UriTemplate  
org.http4k.lens.Validator Runs through a list of lenses and extracts the values from each one, collecting the errors
org.http4k.template.ViewModel  
org.http4k.template.ViewNotFound  
org.http4k.lens.WebForm  
org.http4k.websocket.Websocket Represents a connected Websocket instance, and can be passed around an application. This is configured to react to events on the WS event stream by attaching listeners.
org.http4k.client.WebsocketClient  
org.http4k.websocket.WsClient  
org.http4k.websocket.WsConsumer  
org.http4k.websocket.WsHandler  
org.http4k.websocket.WsMessage  
org.http4k.lens.WsMessageLens A WsMessageLens provides the extraction of an entity from a target WsMessage.
org.http4k.lens.WsMessageLensSpec Represents a extraction of an entity from a target WsMessage.
org.http4k.server.WsServerConfig Standard interface for creating a configured WebServer which supports Websockets
org.http4k.websocket.WsStatus  
org.http4k.format.Xml  
org.http4k.filter.ZipkinTraces