http4k-core/org.http4k.filter

Package-level declarations

Types

AllowAllOriginPolicy

object AllowAllOriginPolicy : OriginPolicy

CacheControlHeaderPart

open class CacheControlHeaderPart(val name: String, val value: Duration)

CachingFilters

object CachingFilters

Useful filters for applying Cache-Controls to request/responses

ClientFilters

object ClientFilters

CompressionResult

data class CompressionResult(val body: Body, val contentEncoding: String?)

CorsPolicy

data class CorsPolicy(val originPolicy: OriginPolicy, val headers: List<String>, val methods: List<Method>, val credentials: Boolean = false, val exposedHeaders: List<String> = emptyList(), val maxAge: Int? = null)

DebuggingFilters

object DebuggingFilters

DefaultCacheTimings

data class DefaultCacheTimings(val maxAge: MaxAgeTtl, val staleIfErrorTtl: StaleIfErrorTtl, val staleWhenRevalidateTtl: StaleWhenRevalidateTtl)

FlashAttributesFilter

object FlashAttributesFilter : Filter

GzipCompressionMode

sealed class GzipCompressionMode

GzipCompressionMode represents a choice between working lazily with streams when gzipping or eagerly storing the body contents in memory.

HttpTransactionLabeler

typealias HttpTransactionLabeler = (HttpTransaction) -> HttpTransaction

MaxAgeTtl

data class MaxAgeTtl(valueD: Duration) : CacheControlHeaderPart

OriginPolicy

interface OriginPolicy : Function1<String, Boolean>

For creating custom origin policy for allowing CORS

RequestFilters

object RequestFilters

RequestPredicate

typealias RequestPredicate = (Request) -> Boolean

ResponseFilters

object ResponseFilters

SamplingDecision

data class SamplingDecision(val value: String)

ServerFilters

object ServerFilters

StaleIfErrorTtl

data class StaleIfErrorTtl(valueD: Duration) : CacheControlHeaderPart

StaleWhenRevalidateTtl

data class StaleWhenRevalidateTtl(valueD: Duration) : CacheControlHeaderPart

TraceId

data class TraceId(val value: String)

TrafficFilters

object TrafficFilters

ZipkinTraces

data class ZipkinTraces(val traceId: TraceId, val spanId: TraceId, val parentSpanId: TraceId?, val samplingDecision: SamplingDecision = SAMPLE)

ZipkinTracesStorage

interface ZipkinTracesStorage

Properties

FLASH_COOKIE

const val FLASH_COOKIE: String

Functions

AllowAll

fun OriginPolicy.Companion.AllowAll(): AllowAllOriginPolicy

Allows all origins for CORS

AnyOf

fun OriginPolicy.Companion.AnyOf(vararg allowedOrigins: String): OriginPolicy

fun OriginPolicy.Companion.AnyOf(allowedOrigins: List<String>): OriginPolicy

Allows a given list of origins for CORS

debug

fun HttpHandler.debug(out: PrintStream = System.out, debugStream: Boolean = false): (request: Request) -> Response

fun RoutingHttpHandler.debug(out: PrintStream = System.out, debugStream: Boolean = false): RoutingHttpHandler

ensureCurrentSpan

fun <T> ZipkinTracesStorage.ensureCurrentSpan(fn: (ZipkinTraces) -> T): T

Use this to wrap a block of code and ensure the current span exists at the end.

flash

fun Request.flash(): String?

fun Response.flash(): String?

gunzipped

fun Body.gunzipped(): Body

gunzippedStream

fun Body.gunzippedStream(): Body

gzipped

fun Body.gzipped(compressionLevel: Int = DEFAULT_COMPRESSION): CompressionResult

gzippedStream

fun Body.gzippedStream(compressionLevel: Int = DEFAULT_COMPRESSION): CompressionResult

inChildSpan

fun <T> ZipkinTracesStorage.inChildSpan(fn: (ZipkinTraces) -> T): T

Use this to wrap a block of code in a new span. It rolls the span and sets it for the duration of the passed block.

inIntelliJOnly

fun Filter.inIntelliJOnly(): Filter

Only

fun OriginPolicy.Companion.Only(allowedOrigin: String): OriginPolicy

Allows a given single origin for CORS

Pattern

fun OriginPolicy.Companion.Pattern(originRegex: Regex): OriginPolicy

Allows origin(s) matching a Regex for CORS

removeFlash

fun Response.removeFlash(): Response

thenIf

fun Filter.thenIf(predicate: RequestPredicate, filter: Filter): Filter

thenIfNot

fun Filter.thenIfNot(predicate: RequestPredicate, filter: Filter): Filter

withFlash

fun Request.withFlash(value: String): Request

fun Response.withFlash(value: String): Response