Package | Description |
---|---|
org.springframework.web.reactive.function.server |
Provides the types that make up Spring's functional web framework for Reactive environments.
|
Modifier and Type | Interface and Description |
---|---|
interface |
HandlerFilterFunction<T extends ServerResponse,R extends ServerResponse>
Represents a function that filters a handler function.
|
interface |
HandlerFilterFunction<T extends ServerResponse,R extends ServerResponse>
Represents a function that filters a handler function.
|
interface |
HandlerFunction<T extends ServerResponse>
Represents a function that handles a request.
|
interface |
RouterFunction<T extends ServerResponse>
Represents a function that routes to a handler function.
|
Modifier and Type | Interface and Description |
---|---|
interface |
EntityResponse<T>
Entity-specific subtype of
ServerResponse that exposes entity data. |
interface |
RenderingResponse
Rendering-specific subtype of
ServerResponse that exposes model and template data. |
Modifier and Type | Method and Description |
---|---|
static <T extends ServerResponse> |
RouterFunctions.changeParser(RouterFunction<T> routerFunction,
PathPatternParser parser)
Changes the
PathPatternParser on the given router function. |
default <S extends ServerResponse> |
RouterFunction.filter(HandlerFilterFunction<T,S> filterFunction)
Filter all handler functions routed by this function with the given
filter function.
|
static <T extends ServerResponse> |
RouterFunctions.nest(RequestPredicate predicate,
RouterFunction<T> routerFunction)
Route to the given router function if the given request predicate applies.
|
static <T extends ServerResponse,R extends ServerResponse> |
HandlerFilterFunction.ofResponseProcessor(Function<T,reactor.core.publisher.Mono<R>> responseProcessor)
Adapt the given response processor function to a filter function that only operates
on the
ServerResponse . |
static <T extends ServerResponse,R extends ServerResponse> |
HandlerFilterFunction.ofResponseProcessor(Function<T,reactor.core.publisher.Mono<R>> responseProcessor)
Adapt the given response processor function to a filter function that only operates
on the
ServerResponse . |
static <T extends ServerResponse> |
RouterFunctions.route(RequestPredicate predicate,
HandlerFunction<T> handlerFunction)
Route to the given handler function if the given request predicate applies.
|
Modifier and Type | Method and Description |
---|---|
reactor.core.publisher.Mono<ServerResponse> |
ServerResponse.BodyBuilder.body(BodyInserter<?,? super ServerHttpResponse> inserter)
Set the body of the response to the given
BodyInserter and return it. |
reactor.core.publisher.Mono<ServerResponse> |
ServerResponse.BodyBuilder.body(Object producer,
Class<?> elementClass)
Variant of
ServerResponse.BodyBuilder.body(Publisher, Class) that allows using any
producer that can be resolved to Publisher via
ReactiveAdapterRegistry . |
reactor.core.publisher.Mono<ServerResponse> |
ServerResponse.BodyBuilder.body(Object producer,
ParameterizedTypeReference<?> elementTypeRef)
Variant of
ServerResponse.BodyBuilder.body(Publisher, ParameterizedTypeReference) that
allows using any producer that can be resolved to Publisher
via ReactiveAdapterRegistry . |
<T,P extends Publisher<T>> |
ServerResponse.BodyBuilder.body(P publisher,
Class<T> elementClass)
Set the body from the given
Publisher . |
<T,P extends Publisher<T>> |
ServerResponse.BodyBuilder.body(P publisher,
ParameterizedTypeReference<T> elementTypeRef)
Variant of
ServerResponse.BodyBuilder.body(Publisher, Class) that allows using any
producer that can be resolved to Publisher via
ReactiveAdapterRegistry . |
reactor.core.publisher.Mono<ServerResponse> |
ServerResponse.BodyBuilder.bodyValue(Object body)
Set the body of the response to the given
Object and return it. |
RouterFunction<ServerResponse> |
RouterFunctions.Builder.build()
Builds the
RouterFunction . |
reactor.core.publisher.Mono<ServerResponse> |
ServerResponse.HeadersBuilder.build()
Build the response entity with no body.
|
reactor.core.publisher.Mono<ServerResponse> |
ServerResponse.HeadersBuilder.build(BiFunction<ServerWebExchange,ServerResponse.Context,reactor.core.publisher.Mono<Void>> writeFunction)
Build the response entity with a custom writer function.
|
reactor.core.publisher.Mono<ServerResponse> |
ServerResponse.HeadersBuilder.build(Publisher<Void> voidPublisher)
Build the response entity with no body.
|
default reactor.core.publisher.Mono<ServerResponse> |
ServerRequest.checkNotModified(Instant lastModified)
Check whether the requested resource has been modified given the
supplied last-modified timestamp (as determined by the application).
|
default reactor.core.publisher.Mono<ServerResponse> |
ServerRequest.checkNotModified(Instant lastModified,
String etag)
Check whether the requested resource has been modified given the
supplied
ETag (entity tag) and last-modified timestamp,
as determined by the application. |
default reactor.core.publisher.Mono<ServerResponse> |
ServerRequest.checkNotModified(String etag)
Check whether the requested resource has been modified given the
supplied
ETag (entity tag), as determined by the application. |
reactor.core.publisher.Mono<ServerResponse> |
ServerResponse.BodyBuilder.render(String name,
Map<String,?> model)
Render the template with the given
name using the given model . |
reactor.core.publisher.Mono<ServerResponse> |
ServerResponse.BodyBuilder.render(String name,
Object... modelAttributes)
Render the template with the given
name using the given modelAttributes . |
static RouterFunction<ServerResponse> |
RouterFunctions.resources(Function<ServerRequest,reactor.core.publisher.Mono<Resource>> lookupFunction)
Route to resources using the provided lookup function.
|
static RouterFunction<ServerResponse> |
RouterFunctions.resources(String pattern,
Resource location)
Route requests that match the given pattern to resources relative to the given root location.
|
reactor.core.publisher.Mono<ServerResponse> |
ServerResponse.BodyBuilder.syncBody(Object body)
Deprecated.
as of Spring Framework 5.2 in favor of
ServerResponse.BodyBuilder.bodyValue(Object) |
Modifier and Type | Method and Description |
---|---|
static ServerResponse.BodyBuilder |
ServerResponse.from(ServerResponse other)
Create a builder with the status code and headers of the given response.
|
Modifier and Type | Method and Description |
---|---|
RouterFunctions.Builder |
RouterFunctions.Builder.add(RouterFunction<ServerResponse> routerFunction)
Adds the given route to this builder.
|
RouterFunctions.Builder |
RouterFunctions.Builder.after(BiFunction<ServerRequest,ServerResponse,ServerResponse> responseProcessor)
Filter the response object for all routes created by this builder with the given response
processing function.
|
RouterFunctions.Builder |
RouterFunctions.Builder.after(BiFunction<ServerRequest,ServerResponse,ServerResponse> responseProcessor)
Filter the response object for all routes created by this builder with the given response
processing function.
|
RouterFunctions.Builder |
RouterFunctions.Builder.DELETE(HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles HTTP
DELETE requests. |
RouterFunctions.Builder |
RouterFunctions.Builder.DELETE(RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
DELETE requests
that match the given predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.DELETE(String pattern,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
DELETE requests
that match the given pattern. |
RouterFunctions.Builder |
RouterFunctions.Builder.DELETE(String pattern,
RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
DELETE requests
that match the given pattern and predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.filter(HandlerFilterFunction<ServerResponse,ServerResponse> filterFunction)
Filters all routes created by this builder with the given filter function.
|
RouterFunctions.Builder |
RouterFunctions.Builder.filter(HandlerFilterFunction<ServerResponse,ServerResponse> filterFunction)
Filters all routes created by this builder with the given filter function.
|
RouterFunctions.Builder |
RouterFunctions.Builder.GET(HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles HTTP
GET requests. |
RouterFunctions.Builder |
RouterFunctions.Builder.GET(RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
GET requests
that match the given predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.GET(String pattern,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
GET requests
that match the given pattern. |
RouterFunctions.Builder |
RouterFunctions.Builder.GET(String pattern,
RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
GET requests
that match the given pattern and predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.HEAD(HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles HTTP
HEAD requests. |
RouterFunctions.Builder |
RouterFunctions.Builder.HEAD(RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
HEAD requests
that match the given predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.HEAD(String pattern,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
HEAD requests
that match the given pattern. |
RouterFunctions.Builder |
RouterFunctions.Builder.HEAD(String pattern,
RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
HEAD requests
that match the given pattern and predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.nest(RequestPredicate predicate,
Supplier<RouterFunction<ServerResponse>> routerFunctionSupplier)
Route to the supplied router function if the given request predicate applies.
|
<T extends Throwable> |
RouterFunctions.Builder.onError(Class<T> exceptionType,
BiFunction<? super T,ServerRequest,reactor.core.publisher.Mono<ServerResponse>> responseProvider)
Filters all exceptions of the given type by applying the given response provider
function.
|
RouterFunctions.Builder |
RouterFunctions.Builder.onError(Predicate<? super Throwable> predicate,
BiFunction<? super Throwable,ServerRequest,reactor.core.publisher.Mono<ServerResponse>> responseProvider)
Filters all exceptions that match the predicate by applying the given response provider
function.
|
RouterFunctions.Builder |
RouterFunctions.Builder.OPTIONS(HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles HTTP
OPTIONS requests. |
RouterFunctions.Builder |
RouterFunctions.Builder.OPTIONS(RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
OPTIONS requests
that match the given predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.OPTIONS(String pattern,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
OPTIONS requests
that match the given pattern. |
RouterFunctions.Builder |
RouterFunctions.Builder.OPTIONS(String pattern,
RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
OPTIONS requests
that match the given pattern and predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.PATCH(HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles HTTP
PATCH requests. |
RouterFunctions.Builder |
RouterFunctions.Builder.PATCH(RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
PATCH requests
that match the given predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.PATCH(String pattern,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
PATCH requests
that match the given pattern. |
RouterFunctions.Builder |
RouterFunctions.Builder.PATCH(String pattern,
RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
PATCH requests
that match the given pattern and predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.path(String pattern,
Supplier<RouterFunction<ServerResponse>> routerFunctionSupplier)
Route to the supplied router function if the given path prefix pattern applies.
|
RouterFunctions.Builder |
RouterFunctions.Builder.POST(HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles HTTP
POST requests. |
RouterFunctions.Builder |
RouterFunctions.Builder.POST(RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
POST requests
that match the given predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.POST(String pattern,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
POST requests
that match the given pattern. |
RouterFunctions.Builder |
RouterFunctions.Builder.POST(String pattern,
RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
POST requests
that match the given pattern and predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.PUT(HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles HTTP
PUT requests. |
RouterFunctions.Builder |
RouterFunctions.Builder.PUT(RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
PUT requests
that match the given predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.PUT(String pattern,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
PUT requests
that match the given pattern. |
RouterFunctions.Builder |
RouterFunctions.Builder.PUT(String pattern,
RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all HTTP
PUT requests
that match the given pattern and predicate. |
RouterFunctions.Builder |
RouterFunctions.Builder.route(RequestPredicate predicate,
HandlerFunction<ServerResponse> handlerFunction)
Adds a route to the given handler function that handles all requests that match the
given predicate.
|