Package org.springframework.web.reactive.function.server

Types

CoRouterFunctionDsl

class CoRouterFunctionDsl

Provide a WebFlux.

RouterFunctionDsl

class RouterFunctionDsl

Provide a WebFlux.

Functions

attributeOrNull

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

Nullable variant of ServerRequest.attribute

awaitBody

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.

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.

awaitFormData

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.

awaitPrincipal

suspend fun ServerRequest.awaitPrincipal(): Principal?

Coroutines variant of ServerRequest.principal.

awaitSession

suspend fun ServerRequest.awaitSession(): WebSession

Coroutines variant of ServerRequest.session.

body

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.

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

Extension for ServerResponse.BodyBuilder.body providing a body(Publisher<T>) variant.

bodyAndAwait

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.

bodyToFlow

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.

bodyToFlux

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

Extension for ServerRequest.bodyToFlux providing a bodyToFlux<Foo>() variant leveraging Kotlin reified type parameters.

bodyToMono

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

Extension for ServerRequest.bodyToMono providing a bodyToMono<Foo>() variant leveraging Kotlin reified type parameters.

bodyToServerSentEvents

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

Extension for ServerResponse.BodyBuilder.body providing a bodyToServerSentEvents(Publisher<T>) variant.

bodyValueAndAwait

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

Coroutines variant of ServerResponse.BodyBuilder.bodyValue.

buildAndAwait

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

coRouter

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

Allow to create easily a WebFlux.

html

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

Shortcut for setting MediaType.TEXT_HTMLContent-Type header.

json

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

Shortcut for setting MediaType.APPLICATION_JSONContent-Type header.

plus

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

renderAndAwait

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

Coroutines variant of ServerResponse.BodyBuilder.render.

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

Coroutines variant of ServerResponse.BodyBuilder.render.

router

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

Allow to create easily a WebFlux.

sse

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

Shortcut for setting MediaType.TEXT_EVENT_STREAMContent-Type header.

xml

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

Shortcut for setting MediaType.APPLICATION_XMLContent-Type header.