spring-webflux/org.springframework.web.reactive.function.server

Package-level declarations

Types

CoRouterFunctionDsl

class CoRouterFunctionDsl

Provide a WebFlux.fn RouterFunction Coroutines Kotlin DSL created by coRouter { } in order to be able to write idiomatic Kotlin code.

RouterFunctionDsl

class RouterFunctionDsl

Provide a WebFlux.fn RouterFunction Reactive Kotlin DSL created by router { } in order to be able to write idiomatic Kotlin code.

Functions

attributeOrNull

fun ServerRequest.attributeOrNull(name: String): Any?

Nullable variant of ServerRequest.attribute

inline suspend fun <T : Any> ServerRequest.awaitBody(): T

Non-nullable Coroutines variant of ServerRequest.bodyToMono.

suspend fun <T : Any> ServerRequest.awaitBody(clazz: KClass<T>): T

KClass non-nullable Coroutines variant of ServerRequest.bodyToMono. Please consider awaitBody<Foo> variant if possible.

awaitBodyOrNull

inline suspend fun <T : Any> ServerRequest.awaitBodyOrNull(): T?

Nullable Coroutines variant of ServerRequest.bodyToMono.

suspend fun <T : Any> ServerRequest.awaitBodyOrNull(clazz: KClass<T>): T?

KClass nullable Coroutines variant of ServerRequest.bodyToMono. Please consider awaitBodyOrNull<Foo> variant if possible.

suspend fun ServerRequest.awaitFormData(): MultiValueMap<String, String>

Coroutines variant of ServerRequest.formData.

awaitMultipartData

suspend fun ServerRequest.awaitMultipartData(): MultiValueMap<String, Part>

Coroutines variant of ServerRequest.multipartData.

suspend fun ServerRequest.awaitPrincipal(): Principal?

Coroutines variant of ServerRequest.principal.

suspend fun ServerRequest.awaitSession(): WebSession

Coroutines variant of ServerRequest.session.

inline fun <T : Any> ServerResponse.BodyBuilder.body(producer: Any): Mono<ServerResponse>

Extension for ServerResponse.BodyBuilder.body providing a body<T>(Any) variant leveraging Kotlin reified type parameters. This extension is not subject to type erasure and retains actual generic type arguments.

inline fun <T : Any> ServerResponse.BodyBuilder.body(publisher: Publisher<T>): Mono<ServerResponse>

Extension for ServerResponse.BodyBuilder.body providing a body(Publisher<T>) variant. This extension is not subject to type erasure and retains actual generic type arguments.

inline suspend fun <T : Any> ServerResponse.BodyBuilder.bodyAndAwait(flow: Flow<T>): ServerResponse

Coroutines variant of ServerResponse.BodyBuilder.body with Any and ParameterizedTypeReference parameters providing a bodyAndAwait(Flow<T>) variant. This extension is not subject to type erasure and retains actual generic type arguments.

inline fun <T : Any> ServerRequest.bodyToFlow(): Flow<T>

Coroutines kotlinx.coroutines.flow.Flow based variant of ServerRequest.bodyToFlux.

fun <T : Any> ServerRequest.bodyToFlow(clazz: KClass<T>): Flow<T>

KClass coroutines kotlinx.coroutines.flow.Flow based variant of ServerRequest.bodyToFlux. Please consider bodyToFlow<Foo> variant if possible.

inline fun <T : Any> ServerRequest.bodyToFlux(): Flux<T>

Extension for ServerRequest.bodyToFlux providing a bodyToFlux<Foo>() variant leveraging Kotlin reified type parameters. This extension is not subject to type erasure and retains actual generic type arguments.

inline fun <T : Any> ServerRequest.bodyToMono(): Mono<T>

Extension for ServerRequest.bodyToMono providing a bodyToMono<Foo>() variant leveraging Kotlin reified type parameters. This extension is not subject to type erasure and retains actual generic type arguments.

bodyToServerSentEvents

inline fun <T : Any> ServerResponse.BodyBuilder.~~bodyToServerSentEvents~~(publisher: Publisher<T>): Mono<ServerResponse>

Extension for ServerResponse.BodyBuilder.body providing a bodyToServerSentEvents(Publisher<T>) variant. This extension is not subject to type erasure and retains actual generic type arguments.

bodyValueAndAwait

suspend fun ServerResponse.BodyBuilder.bodyValueAndAwait(body: Any): ServerResponse

Coroutines variant of ServerResponse.BodyBuilder.bodyValue.

suspend fun RenderingResponse.Builder.buildAndAwait(): RenderingResponse

Coroutines variant of RenderingResponse.Builder.build.

suspend fun ServerResponse.HeadersBuilder<out ServerResponse.HeadersBuilder<*>>.buildAndAwait(): ServerResponse

Coroutines variant of ServerResponse.HeadersBuilder.build.

contentLengthOrNull

fun ServerRequest.Headers.contentLengthOrNull(): Long?

Nullable variant of ServerRequest.Headers.contentLength

contentTypeOrNull

fun ServerRequest.Headers.contentTypeOrNull(): MediaType?

Nullable variant of ServerRequest.Headers.contentType

fun coRouter(routes: CoRouterFunctionDsl.() -> Unit): RouterFunction<ServerResponse>

Allow to create easily a WebFlux.fn RouterFunction with a Coroutines router Kotlin DSL.

fun ServerResponse.BodyBuilder.html(): ServerResponse.BodyBuilder

Shortcut for setting MediaType.TEXT_HTML Content-Type header.

fun ServerResponse.BodyBuilder.json(): ServerResponse.BodyBuilder

Shortcut for setting MediaType.APPLICATION_JSON Content-Type header.

operator fun <T : ServerResponse> RouterFunction<T>.plus(other: RouterFunction<T>): RouterFunction<T>

Equivalent to RouterFunction.and.

queryParamOrNull

fun ServerRequest.queryParamOrNull(name: String): String?

Nullable variant of ServerRequest.queryParam

remoteAddressOrNull

fun ServerRequest.remoteAddressOrNull(): InetSocketAddress?

Nullable variant of ServerRequest.remoteAddress

suspend fun ServerResponse.BodyBuilder.renderAndAwait(name: String, vararg modelAttributes: String): ServerResponse

suspend fun ServerResponse.BodyBuilder.renderAndAwait(name: String, model: Map<String, *>): ServerResponse

Coroutines variant of ServerResponse.BodyBuilder.render.

fun router(routes: RouterFunctionDsl.() -> Unit): RouterFunction<ServerResponse>

Allow to create easily a WebFlux.fn RouterFunction with a Reactive router Kotlin DSL.

fun ServerResponse.BodyBuilder.sse(): ServerResponse.BodyBuilder

Shortcut for setting MediaType.TEXT_EVENT_STREAM Content-Type header.

fun ServerResponse.BodyBuilder.xml(): ServerResponse.BodyBuilder

Shortcut for setting MediaType.APPLICATION_XML Content-Type header.