Skip to content

Commit 11f3edc

Browse files
committed
Change plain 'WebFlux' links to 'See equivalent in the Reactive stack'
Closes gh-29694
1 parent fbd4463 commit 11f3edc

File tree

8 files changed

+117
-117
lines changed

8 files changed

+117
-117
lines changed

framework-docs/src/docs/asciidoc/integration/rest-clients.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ converters to use explicitly.
215215

216216
[[rest-message-conversion]]
217217
==== Message Conversion
218-
[.small]#<<web-reactive.adoc#webflux-codecs, WebFlux>>#
218+
[.small]#<<web-reactive.adoc#webflux-codecs, See equivalent in the Reactive stack>>#
219219

220220
The `spring-web` module contains the `HttpMessageConverter` contract for reading and
221221
writing the body of HTTP requests and responses through `InputStream` and `OutputStream`.

framework-docs/src/docs/asciidoc/web/webflux-websocket.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[[webflux-websocket]]
22
= WebSockets
3-
[.small]#<<web.adoc#websocket, Same as in the Servlet stack>>#
3+
[.small]#<<web.adoc#websocket, See equivalent in the Servlet stack>>#
44

55
This part of the reference documentation covers support for reactive-stack WebSocket
66
messaging.
@@ -12,7 +12,7 @@ include::websocket-intro.adoc[leveloffset=+1]
1212

1313
[[webflux-websocket-server]]
1414
== WebSocket API
15-
[.small]#<<web.adoc#websocket-server, Same as in the Servlet stack>>#
15+
[.small]#<<web.adoc#websocket-server, See equivalent in the Servlet stack>>#
1616

1717
The Spring Framework provides a WebSocket API that you can use to write client- and
1818
server-side applications that handle WebSocket messages.
@@ -21,7 +21,7 @@ server-side applications that handle WebSocket messages.
2121

2222
[[webflux-websocket-server-handler]]
2323
=== Server
24-
[.small]#<<web.adoc#websocket-server-handler, Same as in the Servlet stack>>#
24+
[.small]#<<web.adoc#websocket-server-handler, See equivalent in the Servlet stack>>#
2525

2626
To create a WebSocket server, you can first create a `WebSocketHandler`.
2727
The following example shows how to do so:
@@ -339,7 +339,7 @@ subsequently use `DataBufferUtils.release(dataBuffer)` when the buffers are cons
339339

340340
[[webflux-websocket-server-handshake]]
341341
=== Handshake
342-
[.small]#<<web.adoc#websocket-server-handshake, Same as in the Servlet stack>>#
342+
[.small]#<<web.adoc#websocket-server-handshake, See equivalent in the Servlet stack>>#
343343

344344
`WebSocketHandlerAdapter` delegates to a `WebSocketService`. By default, that is an instance
345345
of `HandshakeWebSocketService`, which performs basic checks on the WebSocket request and
@@ -354,7 +354,7 @@ into the attributes of the `WebSocketSession`.
354354

355355
[[webflux-websocket-server-config]]
356356
=== Server Configuration
357-
[.small]#<<web.adoc#websocket-server-runtime-configuration, Same as in the Servlet stack>>#
357+
[.small]#<<web.adoc#websocket-server-runtime-configuration, See equivalent in the Servlet stack>>#
358358

359359
The `RequestUpgradeStrategy` for each server exposes configuration specific to the
360360
underlying WebSocket server engine. When using the WebFlux Java config you can customize
@@ -408,7 +408,7 @@ only Tomcat and Jetty expose such options.
408408

409409
[[webflux-websocket-server-cors]]
410410
=== CORS
411-
[.small]#<<web.adoc#websocket-server-allowed-origins, Same as in the Servlet stack>>#
411+
[.small]#<<web.adoc#websocket-server-allowed-origins, See equivalent in the Servlet stack>>#
412412

413413
The easiest way to configure CORS and restrict access to a WebSocket endpoint is to
414414
have your `WebSocketHandler` implement `CorsConfigurationSource` and return a

framework-docs/src/docs/asciidoc/web/webmvc-cors.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[[mvc-cors]]
22
= CORS
3-
[.small]#<<web-reactive.adoc#webflux-cors, WebFlux>>#
3+
[.small]#<<web-reactive.adoc#webflux-cors, See equivalent in the Reactive stack>>#
44

55
Spring MVC lets you handle CORS (Cross-Origin Resource Sharing). This section
66
describes how to do so.
@@ -10,7 +10,7 @@ describes how to do so.
1010

1111
[[mvc-cors-intro]]
1212
== Introduction
13-
[.small]#<<web-reactive.adoc#webflux-cors-intro, WebFlux>>#
13+
[.small]#<<web-reactive.adoc#webflux-cors-intro, See equivalent in the Reactive stack>>#
1414

1515
For security reasons, browsers prohibit AJAX calls to resources outside the current origin.
1616
For example, you could have your bank account in one tab and evil.com in another. Scripts
@@ -27,7 +27,7 @@ powerful workarounds based on IFRAME or JSONP.
2727

2828
[[mvc-cors-processing]]
2929
== Processing
30-
[.small]#<<web-reactive.adoc#webflux-cors-processing, WebFlux>>#
30+
[.small]#<<web-reactive.adoc#webflux-cors-processing, See equivalent in the Reactive stack>>#
3131

3232
The CORS specification distinguishes between preflight, simple, and actual requests.
3333
To learn how CORS works, you can read
@@ -77,7 +77,7 @@ To learn more from the source or make advanced customizations, check the code be
7777

7878
[[mvc-cors-controller]]
7979
== `@CrossOrigin`
80-
[.small]#<<web-reactive.adoc#webflux-cors-controller, WebFlux>>#
80+
[.small]#<<web-reactive.adoc#webflux-cors-controller, See equivalent in the Reactive stack>>#
8181

8282
The {api-spring-framework}/web/bind/annotation/CrossOrigin.html[`@CrossOrigin`]
8383
annotation enables cross-origin requests on annotated controller methods,
@@ -226,7 +226,7 @@ as the following example shows:
226226

227227
[[mvc-cors-global]]
228228
== Global Configuration
229-
[.small]#<<web-reactive.adoc#webflux-cors-global, WebFlux>>#
229+
[.small]#<<web-reactive.adoc#webflux-cors-global, See equivalent in the Reactive stack>>#
230230

231231
In addition to fine-grained, controller method level configuration, you probably want to
232232
define some global CORS configuration, too. You can set URL-based `CorsConfiguration`
@@ -252,7 +252,7 @@ the `allowOriginPatterns` property may be used to match to a dynamic set of orig
252252

253253
[[mvc-cors-global-java]]
254254
=== Java Configuration
255-
[.small]#<<web-reactive.adoc#webflux-cors-global, WebFlux>>#
255+
[.small]#<<web-reactive.adoc#webflux-cors-global, See equivalent in the Reactive stack>>#
256256

257257
To enable CORS in the MVC Java config, you can use the `CorsRegistry` callback,
258258
as the following example shows:
@@ -329,7 +329,7 @@ as the following example shows:
329329

330330
[[mvc-cors-filter]]
331331
== CORS Filter
332-
[.small]#<<webflux-cors.adoc#webflux-cors-webfilter, WebFlux>>#
332+
[.small]#<<webflux-cors.adoc#webflux-cors-webfilter, See equivalent in the Reactive stack>>#
333333

334334
You can apply CORS support through the built-in
335335
{api-spring-framework}/web/filter/CorsFilter.html[`CorsFilter`].

framework-docs/src/docs/asciidoc/web/webmvc-functional.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[[webmvc-fn]]
22
= Functional Endpoints
3-
[.small]#<<web-reactive.adoc#webflux-fn, WebFlux>>#
3+
[.small]#<<web-reactive.adoc#webflux-fn, See equivalent in the Reactive stack>>#
44

55
Spring Web MVC includes WebMvc.fn, a lightweight functional programming model in which functions
66
are used to route and handle requests and contracts are designed for immutability.
@@ -12,7 +12,7 @@ the same <<web#mvc-servlet>>.
1212

1313
[[webmvc-fn-overview]]
1414
== Overview
15-
[.small]#<<web-reactive.adoc#webflux-fn-overview, WebFlux>>#
15+
[.small]#<<web-reactive.adoc#webflux-fn-overview, See equivalent in the Reactive stack>>#
1616

1717
In WebMvc.fn, an HTTP request is handled with a `HandlerFunction`: a function that takes
1818
`ServerRequest` and returns a `ServerResponse`.
@@ -111,7 +111,7 @@ If you register the `RouterFunction` as a bean, for instance by exposing it in a
111111

112112
[[webmvc-fn-handler-functions]]
113113
== HandlerFunction
114-
[.small]#<<web-reactive.adoc#webflux-fn-handler-functions, WebFlux>>#
114+
[.small]#<<web-reactive.adoc#webflux-fn-handler-functions, See equivalent in the Reactive stack>>#
115115

116116
`ServerRequest` and `ServerResponse` are immutable interfaces that offer JDK 8-friendly
117117
access to the HTTP request and response, including headers, body, method, and status code.
@@ -463,7 +463,7 @@ See <<core.adoc#validation-beanvalidation, Spring Validation>>.
463463

464464
[[webmvc-fn-router-functions]]
465465
== `RouterFunction`
466-
[.small]#<<web-reactive.adoc#webflux-fn-router-functions, WebFlux>>#
466+
[.small]#<<web-reactive.adoc#webflux-fn-router-functions, See equivalent in the Reactive stack>>#
467467

468468
Router functions are used to route the requests to the corresponding `HandlerFunction`.
469469
Typically, you do not write router functions yourself, but rather use a method on the
@@ -672,7 +672,7 @@ We can further improve by using the `nest` method together with `accept`:
672672

673673
[[webmvc-fn-running]]
674674
== Running a Server
675-
[.small]#<<web-reactive.adoc#webflux-fn-running, WebFlux>>#
675+
[.small]#<<web-reactive.adoc#webflux-fn-running, See equivalent in the Reactive stack>>#
676676

677677
You typically run router functions in a <<web.adoc#mvc-servlet, `DispatcherHandler`>>-based setup through the
678678
<<web.adoc#mvc-config>>, which uses Spring configuration to declare the
@@ -765,7 +765,7 @@ The following example shows a WebFlux Java configuration:
765765

766766
[[webmvc-fn-handler-filter-function]]
767767
== Filtering Handler Functions
768-
[.small]#<<web-reactive.adoc#webflux-fn-handler-filter-function, WebFlux>>#
768+
[.small]#<<web-reactive.adoc#webflux-fn-handler-filter-function, See equivalent in the Reactive stack>>#
769769

770770
You can filter handler functions by using the `before`, `after`, or `filter` methods on the routing
771771
function builder.

framework-docs/src/docs/asciidoc/web/webmvc-test.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[[webmvc.test]]
22
= Testing
3-
[.small]#<<web-reactive.adoc#webflux-test, Same in Spring WebFlux>>#
3+
[.small]#<<web-reactive.adoc#webflux-test, See equivalent in the Reactive stack>>#
44

55
This section summarizes the options available in `spring-test` for Spring MVC applications.
66

framework-docs/src/docs/asciidoc/web/webmvc-view.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[[mvc-view]]
22
= View Technologies
3-
[.small]#<<web-reactive.adoc#webflux-view, WebFlux>>#
3+
[.small]#<<web-reactive.adoc#webflux-view, See equivalent in the Reactive stack>>#
44

55
The use of view technologies in Spring MVC is pluggable. Whether you decide to use
66
Thymeleaf, Groovy Markup Templates, JSPs, or other technologies is primarily a matter of
@@ -14,7 +14,7 @@ the templates are editable by external sources, since this can have security imp
1414

1515
[[mvc-view-thymeleaf]]
1616
== Thymeleaf
17-
[.small]#<<web-reactive.adoc#webflux-view-thymeleaf, WebFlux>>#
17+
[.small]#<<web-reactive.adoc#webflux-view-thymeleaf, See equivalent in the Reactive stack>>#
1818

1919
Thymeleaf is a modern server-side Java template engine that emphasizes natural HTML
2020
templates that can be previewed in a browser by double-clicking, which is very helpful
@@ -34,7 +34,7 @@ See https://www.thymeleaf.org/documentation.html[Thymeleaf+Spring] for more deta
3434

3535
[[mvc-view-freemarker]]
3636
== FreeMarker
37-
[.small]#<<web-reactive.adoc#webflux-view-freemarker, WebFlux>>#
37+
[.small]#<<web-reactive.adoc#webflux-view-freemarker, See equivalent in the Reactive stack>>#
3838

3939
https://freemarker.apache.org/[Apache FreeMarker] is a template engine for generating any
4040
kind of text output from HTML to email and others. The Spring Framework has built-in
@@ -44,7 +44,7 @@ integration for using Spring MVC with FreeMarker templates.
4444

4545
[[mvc-view-freemarker-contextconfig]]
4646
=== View Configuration
47-
[.small]#<<web-reactive.adoc#webflux-view-freemarker-contextconfig, WebFlux>>#
47+
[.small]#<<web-reactive.adoc#webflux-view-freemarker-contextconfig, See equivalent in the Reactive stack>>#
4848

4949
The following example shows how to configure FreeMarker as a view technology:
5050

@@ -125,7 +125,7 @@ returns a view name of `welcome`, the resolver looks for the
125125

126126
[[mvc-views-freemarker]]
127127
=== FreeMarker Configuration
128-
[.small]#<<web-reactive.adoc#webflux-views-freemarker, WebFlux>>#
128+
[.small]#<<web-reactive.adoc#webflux-views-freemarker, See equivalent in the Reactive stack>>#
129129

130130
You can pass FreeMarker 'Settings' and 'SharedVariables' directly to the FreeMarker
131131
`Configuration` object (which is managed by Spring) by setting the appropriate bean
@@ -164,7 +164,7 @@ with additional convenience macros for generating form input elements themselves
164164

165165
[[mvc-view-bind-macros]]
166166
==== The Bind Macros
167-
[.small]#<<web-reactive.adoc#webflux-view-bind-macros, WebFlux>>#
167+
[.small]#<<web-reactive.adoc#webflux-view-bind-macros, See equivalent in the Reactive stack>>#
168168

169169
A standard set of macros are maintained within the `spring-webmvc.jar` file for
170170
FreeMarker, so they are always available to a suitably configured application.
@@ -576,7 +576,7 @@ syntax. The following example shows a sample template for an HTML page:
576576

577577
[[mvc-view-script]]
578578
== Script Views
579-
[.small]#<<web-reactive.adoc#webflux-view-script, WebFlux>>#
579+
[.small]#<<web-reactive.adoc#webflux-view-script, See equivalent in the Reactive stack>>#
580580

581581
The Spring Framework has a built-in integration for using Spring MVC with any
582582
templating library that can run on top of the
@@ -602,7 +602,7 @@ TIP: The basic rule for integrating any other script engine is that it must impl
602602

603603
[[mvc-view-script-dependencies]]
604604
=== Requirements
605-
[.small]#<<web-reactive.adoc#webflux-view-script-dependencies, WebFlux>>#
605+
[.small]#<<web-reactive.adoc#webflux-view-script-dependencies, See equivalent in the Reactive stack>>#
606606

607607
You need to have the script engine on your classpath, the details of which vary by script engine:
608608

@@ -622,7 +622,7 @@ through https://www.webjars.org/[WebJars].
622622

623623
[[mvc-view-script-integrate]]
624624
=== Script Templates
625-
[.small]#<<web-reactive.adoc#webflux-view-script, WebFlux>>#
625+
[.small]#<<web-reactive.adoc#webflux-view-script, See equivalent in the Reactive stack>>#
626626

627627
You can declare a `ScriptTemplateConfigurer` bean to specify the script engine to use,
628628
the script files to load, what function to call to render templates, and so on.
@@ -1965,15 +1965,15 @@ an external definition (by name) or as a `View` instance from the handler method
19651965

19661966
[[mvc-view-jackson]]
19671967
== Jackson
1968-
[.small]#<<web-reactive.adoc#webflux-view-httpmessagewriter, WebFlux>>#
1968+
[.small]#<<web-reactive.adoc#webflux-view-httpmessagewriter, See equivalent in the Reactive stack>>#
19691969

19701970
Spring offers support for the Jackson JSON library.
19711971

19721972

19731973

19741974
[[mvc-view-json-mapping]]
19751975
=== Jackson-based JSON MVC Views
1976-
[.small]#<<web-reactive.adoc#webflux-view-httpmessagewriter, WebFlux>>#
1976+
[.small]#<<web-reactive.adoc#webflux-view-httpmessagewriter, See equivalent in the Reactive stack>>#
19771977

19781978
The `MappingJackson2JsonView` uses the Jackson library's `ObjectMapper` to render the response
19791979
content as JSON. By default, the entire contents of the model map (with the exception of
@@ -1992,7 +1992,7 @@ serializers and deserializers for specific types.
19921992

19931993
[[mvc-view-xml-mapping]]
19941994
=== Jackson-based XML Views
1995-
[.small]#<<web-reactive.adoc#webflux-view-httpmessagewriter, WebFlux>>#
1995+
[.small]#<<web-reactive.adoc#webflux-view-httpmessagewriter, See equivalent in the Reactive stack>>#
19961996

19971997
`MappingJackson2XmlView` uses the
19981998
https://github.com/FasterXML/jackson-dataformat-xml[Jackson XML extension's] `XmlMapper`

0 commit comments

Comments
 (0)