http4k-core/org.http4k.lens

Package-level declarations

Types

class BiDiBodyLens<FINAL>(metas: List<Meta>, contentType: ContentType, get: (HttpMessage) -> FINAL, setLens: (FINAL, HttpMessage) -> HttpMessage) : BodyLens<FINAL> , LensInjectorExtractor<HttpMessage, FINAL>

A BiDiBodyLens provides the bi-directional extraction of an entity from a target body, or the insertion of an entity into a target body.

BiDiBodyLensSpec

open class BiDiBodyLensSpec<OUT>(metas: List<Meta>, contentType: ContentType, get: LensGet<HttpMessage, OUT>, set: LensSet<HttpMessage, OUT>) : BodyLensSpec<OUT>

Represents a bi-directional extraction of an entity from a target Body, or an insertion into a target Body.

BiDiLens

class BiDiLens<in IN : Any, FINAL>(meta: Meta, get: (IN) -> FINAL, lensSet: (FINAL, IN) -> IN) : Lens<IN, FINAL> , LensInjectorExtractor<IN, FINAL>

A BiDiLens provides the bi-directional extraction of an entity from a target, or the insertion of an entity into a target.

BiDiLensBuilder

interface BiDiLensBuilder<IN : Any, OUT> : LensBuilder<IN, OUT>

BiDiLensSpec

open class BiDiLensSpec<IN : Any, OUT>(location: String, paramMeta: ParamMeta, get: LensGet<IN, OUT>, set: LensSet<IN, OUT>) : LensSpec<IN, OUT> , BiDiLensBuilder<IN, OUT>

Represents a bi-directional extraction of an entity from a target, or an insertion into a target.

BiDiMapping

open class BiDiMapping<IN, OUT>(val clazz: Class<OUT>, val asOut: (IN) -> OUT, val asIn: (OUT) -> IN)

A BiDiMapping defines a reusable bidirectional transformation between an input and output type

BiDiMultiLensSpec

interface BiDiMultiLensSpec<IN : Any, OUT> : BiDiLensBuilder<IN, List<OUT>>

Represents a bi-directional extraction of a list of entities from a target, or an insertion into a target.

BiDiPathLens

class BiDiPathLens<FINAL>(meta: Meta, get: (String) -> FINAL, set: (FINAL, Request) -> Request) : PathLens<FINAL> , LensInjectorExtractor<Request, FINAL>

BiDiPathLensSpec

open class BiDiPathLensSpec<OUT>(paramMeta: ParamMeta, get: LensGet<String, OUT>, set: LensSet<Request, OUT>) : PathLensSpec<OUT>

BodyLens

open class BodyLens<out FINAL>(val metas: List<Meta>, val contentType: ContentType, getLens: (HttpMessage) -> FINAL) : LensExtractor<HttpMessage, FINAL>

A BodyLens provides the uni-directional extraction of an entity from a target body.

BodyLensSpec

open class BodyLensSpec<out OUT>(metas: List<Meta>, contentType: ContentType, get: LensGet<HttpMessage, OUT>)

Represents a uni-directional extraction of an entity from a target Body.

ContentNegotiation

fun interface ContentNegotiation

Modes for determining if a passed content type is acceptable.

object Cookies : BiDiLensSpec<Request, Cookie>

DelegatedPropertyLensSpec

interface DelegatedPropertyLensSpec<Req, OUT, Opt>

Failure

sealed class Failure

FormField

object FormField : BiDiLensSpec<WebForm, String>

Header

object Header : BiDiLensSpec<HttpMessage, String>

HeaderLens

typealias HeaderLens<T> = Lens<HttpMessage, T>

Invalid

data class Invalid(val meta: Meta) : Failure

Lens

open class Lens<in IN : Any, out FINAL>(val meta: Meta, lensGet: (IN) -> FINAL) : LensExtractor<IN, FINAL> , Iterable<Meta>

A Lens provides the uni-directional extraction of an entity from a target.

LensBuilder

interface LensBuilder<IN : Any, OUT>

Common construction patterns for all lens implementations.

LensExtractor

fun interface LensExtractor<in IN, out OUT> : Function1<IN, OUT>

LensFailure

class LensFailure(val failures: List<Failure>, val cause: Exception? = null, val target: Any? = null, message: String = failures.joinToString { it.toString() }) : Exception

LensFailures

data class LensFailures(val causes: List<LensFailure>) : RuntimeException

LensGet

class LensGet<in IN, out OUT>

LensInjector

interface LensInjector<in IN, in OUT>

LensInjectorExtractor

interface LensInjectorExtractor<in IN, OUT> : LensExtractor<IN, OUT> , LensInjector<OUT, IN>

LensSet

class LensSet<IN, in OUT>

LensSpec

open class LensSpec<IN : Any, OUT>(val location: String, paramMeta: ParamMeta, get: LensGet<IN, OUT>) : LensBuilder<IN, OUT>

Represents a uni-directional extraction of an entity from a target.

Functions

fun Request.accept(): Accept?

fun Request.accept(accept: Accept): Request

asResult

fun <IN, OUT> LensExtractor<IN, OUT>.asResult(): LensExtractor<IN, Result<OUT, LensFailure>>

Convert the result of a lens extraction to a Result4k type which

base64

fun <IN : Any> BiDiLensSpec<IN, String>.base64(): BiDiLensSpec<IN, String>

fun Path.base64(): BiDiPathLensSpec<String>

basicAuthentication

fun Request.basicAuthentication(): Credentials?

fun Request.basicAuthentication(credentials: Credentials): Request

basicCredentials

fun <IN : Any> BiDiLensSpec<IN, String>.basicCredentials(): BiDiLensSpec<IN, Credentials>

bearerAuth

fun Request.bearerAuth(token: String, scheme: String = "Bearer"): Request

bearerToken

fun Request.bearerToken(): String?

bigDecimal

fun <IN : Any> BiDiLensSpec<IN, String>.bigDecimal(): BiDiLensSpec<IN, BigDecimal>

fun Path.bigDecimal(): BiDiPathLensSpec<BigDecimal>

bigInteger

fun <IN : Any> BiDiLensSpec<IN, String>.bigInteger(): BiDiLensSpec<IN, BigInteger>

fun Path.bigInteger(): BiDiPathLensSpec<BigInteger>

binary

fun Body.Companion.binary(contentType: ContentType, description: String? = null, contentNegotiation: ContentNegotiation = None): BiDiBodyLensSpec<InputStream>

boolean

fun <IN : Any> BiDiLensSpec<IN, String>.boolean(): BiDiLensSpec<IN, Boolean>

fun Path.boolean(): BiDiPathLensSpec<Boolean>

bytes

fun <IN : Any> BiDiLensSpec<IN, String>.bytes(): LensSpec<IN, ByteArray>

composite

inline fun <TARGET : Any, T> BiDiLensSpec<TARGET, String>.composite(crossinline fn: BiDiLensSpec<TARGET, String>.(TARGET) -> T): Lens<TARGET, T>

This allows creation of a composite object from several values from the same source.

inline fun <TARGET : Any, T> BiDiLensSpec<TARGET, String>.composite(crossinline getFn: BiDiLensSpec<TARGET, String>.(TARGET) -> T, crossinline setFn: T.(TARGET) -> TARGET): BiDiLens<TARGET, T>

contentType

fun HttpMessage.contentType(): ContentType?

fun <T : HttpMessage> T.contentType(contentType: ContentType): T

csv

fun <IN : Any> BiDiLensSpec<IN, String>.csv(delimiter: String = ","): BiDiLensSpec<IN, List<String>>

fun <IN : Any, T : Any> BiDiLensSpec<IN, String>.csv(delimiter: String = ",", mapElement: BiDiMapping<String, T>): BiDiLensSpec<IN, List<T>>

dateTime

fun <IN : Any> BiDiLensSpec<IN, String>.dateTime(formatter: DateTimeFormatter = ISO_LOCAL_DATE_TIME): BiDiLensSpec<IN, LocalDateTime>

fun Path.dateTime(formatter: DateTimeFormatter = ISO_LOCAL_DATE_TIME): BiDiPathLensSpec<LocalDateTime>

double

fun <IN : Any> BiDiLensSpec<IN, String>.double(): BiDiLensSpec<IN, Double>

fun Path.double(): BiDiPathLensSpec<Double>

duration

fun <IN : Any> BiDiLensSpec<IN, String>.duration(): BiDiLensSpec<IN, Duration>

fun Path.duration(): BiDiPathLensSpec<Duration>

enum

inline fun <IN : Any, T : Enum<T>> BiDiLensSpec<IN, String>.enum(): BiDiLensSpec<IN, T>

inline fun <T : Enum<T>> BiDiLensSpec<WebForm, String>.enum(): BiDiLensSpec<WebForm, T>

inline fun <T : Enum<T>> Header.enum(caseSensitive: Boolean = true): BiDiLensSpec<HttpMessage, T>

inline fun <T : Enum<T>> Path.enum(caseSensitive: Boolean = true): BiDiPathLensSpec<T>

inline fun <T : Enum<T>> Query.enum(caseSensitive: Boolean = true): BiDiLensSpec<Request, T>

inline fun <IN : Any, T : Enum<T>> BiDiLensSpec<IN, String>.enum(noinline nextOut: (String) -> T, noinline nextIn: (T) -> String): BiDiLensSpec<IN, T>

inline fun <T : Enum<T>> Path.enum(noinline nextOut: (String) -> T, noinline nextIn: (T) -> String): BiDiPathLensSpec<T>

float

fun <IN : Any> BiDiLensSpec<IN, String>.float(): BiDiLensSpec<IN, Float>

fun Path.float(): BiDiPathLensSpec<Float>

httpBodyRoot

fun httpBodyRoot(metas: List<Meta>, acceptedContentType: ContentType, contentNegotiation: ContentNegotiation): BiDiBodyLensSpec<Body>

instant

fun <IN : Any> BiDiLensSpec<IN, String>.instant(): BiDiLensSpec<IN, Instant>

fun Path.instant(): BiDiPathLensSpec<Instant>

int

fun <IN : Any> BiDiLensSpec<IN, String>.int(): BiDiLensSpec<IN, Int>

fun Path.int(): BiDiPathLensSpec<Int>

localDate

fun <IN : Any> BiDiLensSpec<IN, String>.localDate(formatter: DateTimeFormatter = ISO_LOCAL_DATE): BiDiLensSpec<IN, LocalDate>

fun Path.localDate(formatter: DateTimeFormatter = ISO_LOCAL_DATE): BiDiPathLensSpec<LocalDate>

locale

fun <IN : Any> BiDiLensSpec<IN, String>.locale(): BiDiLensSpec<IN, Locale>

localTime

fun <IN : Any> BiDiLensSpec<IN, String>.localTime(formatter: DateTimeFormatter = ISO_LOCAL_TIME): BiDiLensSpec<IN, LocalTime>

fun Path.localTime(formatter: DateTimeFormatter = ISO_LOCAL_TIME): BiDiPathLensSpec<LocalTime>

location

fun Response.location(): Uri

fun Response.location(uri: Uri): Response

long

fun <IN : Any> BiDiLensSpec<IN, String>.long(): BiDiLensSpec<IN, Long>

fun Path.long(): BiDiPathLensSpec<Long>

main

fun main()

map

fun <NEXT, IN : Any, OUT> BiDiLensSpec<IN, OUT>.map(mapping: BiDiMapping<OUT, NEXT>): BiDiLensSpec<IN, NEXT>

mapWithNewMeta

fun <NEXT, IN : Any, OUT> BiDiLensSpec<IN, OUT>.mapWithNewMeta(mapping: BiDiMapping<OUT, NEXT>, paramMeta: ParamMeta): BiDiLensSpec<IN, NEXT>

fun <IN, NEXT> BiDiPathLensSpec<IN>.mapWithNewMeta(mapping: BiDiMapping<IN, NEXT>, paramMeta: ParamMeta): BiDiPathLensSpec<NEXT>

matches

fun <T> Lens<Request, T>.matches(fn: (T) -> Boolean): Router

Check the content of any lens on a request for routing purposes.

nonBlankString

fun <IN : Any> BiDiLensSpec<IN, String>.nonBlankString(): BiDiLensSpec<IN, String>

fun Path.nonBlankString(): BiDiPathLensSpec<String>

fun Body.Companion.nonBlankString(contentType: ContentType, description: String? = null, contentNegotiation: ContentNegotiation = None): BiDiBodyLensSpec<String>

nonEmptyString

fun <IN : Any> BiDiLensSpec<IN, String>.nonEmptyString(): BiDiLensSpec<IN, String>

fun Path.nonEmptyString(): BiDiPathLensSpec<String>

fun Body.Companion.nonEmptyString(contentType: ContentType, description: String? = null, contentNegotiation: ContentNegotiation = None): BiDiBodyLensSpec<String>

@JvmName(name = "namedBiDi")

fun <IN : Any, OUT, L : BiDiLensBuilder<IN, OUT>> L.of(): DelegatedPropertyLensSpec<BiDiLens<IN, OUT>, OUT, BiDiLens<IN, OUT?>>

@JvmName(name = "namedBiDiList")

fun <IN : Any, OUT, L : BiDiLensBuilder<IN, List<OUT>>> L.of(): DelegatedPropertyLensSpec<BiDiLens<IN, List<OUT>>, List<OUT>, BiDiLens<IN, List<OUT>?>>

@JvmName(name = "named")

fun <IN : Any, OUT, L : LensBuilder<IN, OUT>> L.of(): DelegatedPropertyLensSpec<Lens<IN, OUT>, OUT, Lens<IN, OUT?>>

@JvmName(name = "namedList")

fun <IN : Any, OUT, L : LensBuilder<IN, List<OUT>>> L.of(): DelegatedPropertyLensSpec<Lens<IN, List<OUT>>, List<OUT>, Lens<IN, List<OUT>?>>

offsetDateTime

fun <IN : Any> BiDiLensSpec<IN, String>.offsetDateTime(formatter: DateTimeFormatter = ISO_OFFSET_DATE_TIME): BiDiLensSpec<IN, OffsetDateTime>

offsetTime

fun <IN : Any> BiDiLensSpec<IN, String>.offsetTime(formatter: DateTimeFormatter = ISO_OFFSET_TIME): BiDiLensSpec<IN, OffsetTime>

ofOrLensFailure

fun <IN : Any, VALUE : Value<T>, T : Any> Lens<IN, String>.ofOrLensFailure(vf: ValueFactory<VALUE, T>, value: String): VALUE

Convert ot throw a lens failure when constructing a value type

regex

fun <IN : Any> BiDiLensSpec<IN, String>.regex(pattern: String, group: Int = 1): BiDiLensSpec<IN, String>

fun Path.regex(pattern: String, group: Int = 1): BiDiPathLensSpec<String>

fun Body.Companion.regex(pattern: String, group: Int = 1, contentType: ContentType = ContentType.TEXT_PLAIN, description: String? = null, contentNegotiation: ContentNegotiation = None): BiDiBodyLensSpec<String>

regexObject

fun <IN : Any> BiDiLensSpec<IN, String>.regexObject(): BiDiLensSpec<IN, Regex>

fun Path.regexObject(): BiDiPathLensSpec<Regex>

string

fun <IN : Any> BiDiLensSpec<IN, String>.string(): BiDiLensSpec<IN, String>

fun Path.string(): Path

fun Body.Companion.string(contentType: ContentType, description: String? = null, contentNegotiation: ContentNegotiation = None): BiDiBodyLensSpec<String>

uri

fun <IN : Any> BiDiLensSpec<IN, String>.uri(): BiDiLensSpec<IN, Uri>

fun Path.uri(): BiDiPathLensSpec<Uri>

urlEncoded

fun <IN : Any> BiDiLensSpec<IN, String>.urlEncoded(): BiDiLensSpec<IN, String>

fun Path.urlEncoded(): BiDiPathLensSpec<String>

uuid

fun <IN : Any> BiDiLensSpec<IN, String>.uuid(): BiDiLensSpec<IN, UUID>

fun Path.uuid(): BiDiPathLensSpec<UUID>

value

fun <M : Any, VALUE : Value<T>, T : Any> BiDiLensSpec<M, String>.value(vf: ValueFactory<VALUE, T>): BiDiLensSpec<M, VALUE>

Custom lens for mapping to values4k Value

fun <VALUE : Value<T>, T : Any> BiDiPathLensSpec<String>.value(vf: ValueFactory<VALUE, T>): BiDiPathLensSpec<VALUE>

Custom lens for mapping Path to values4k Value

webForm

fun <R : HttpMessage> R.webForm(t: WebForm): R

Convenience function to write the WebForm to the message body and set the content type.

fun Body.Companion.webForm(validator: Validator, vararg formFields: Lens<WebForm, *>): BiDiBodyLensSpec<WebForm>

fun Body.Companion.webForm(validator: Validator, contentNegotiation: ContentNegotiation, vararg formFields: Lens<WebForm, *>): BiDiBodyLensSpec<WebForm>

yearMonth

fun <IN : Any> BiDiLensSpec<IN, String>.yearMonth(): BiDiLensSpec<IN, YearMonth>

fun Path.yearMonth(): BiDiPathLensSpec<YearMonth>

zonedDateTime

fun <IN : Any> BiDiLensSpec<IN, String>.zonedDateTime(formatter: DateTimeFormatter = ISO_ZONED_DATE_TIME): BiDiLensSpec<IN, ZonedDateTime>

fun Path.zonedDateTime(formatter: DateTimeFormatter = ISO_ZONED_DATE_TIME): BiDiPathLensSpec<ZonedDateTime>

zoneId

fun <IN : Any> BiDiLensSpec<IN, String>.zoneId(): BiDiLensSpec<IN, ZoneId>

zoneOffset

fun <IN : Any> BiDiLensSpec<IN, String>.zoneOffset(): BiDiLensSpec<IN, ZoneOffset>