You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improve documentation on using Jersey alongside Spring MVC
Previously, the documentation did not provide any guidance on using
Jersey alongside Spring MVC or any other web framework.
This improves the documentation in two ways:
1. It notes that, in the presence of both Jersey and Spring MVC, the
Actuator will prefer Spring MVC for exposing HTTP endpoints.
2. It adds a how-to describing how to configure Jersey to forward
requests for which it has no handler on to the rest of the filter
chain. When Spring MVC is the other framework, this allows them to
be handled by its dispatcher servlet.
Closesspring-projectsgh-17523
To use Jersey alongside another web framework, such as Spring MVC, it should be configured so that it will allow the other framework to handle requests that it cannot handle.
1225
+
First, configure Jersey to use a Filter rather than a Servlet by configuring the `spring.jersey.type` application property with a value of `filter`.
1226
+
Second, configure your `ResourceConfig` to forward requests that would have resulted in a 404, as shown in the following example.
Copy file name to clipboardexpand all lines: spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
+3
Original file line number
Diff line number
Diff line change
@@ -461,6 +461,7 @@ TIP: See {spring-boot-actuator-autoconfigure-module-code}/endpoint/web/CorsEndpo
461
461
=== Implementing Custom Endpoints
462
462
If you add a `@Bean` annotated with `@Endpoint`, any methods annotated with `@ReadOperation`, `@WriteOperation`, or `@DeleteOperation` are automatically exposed over JMX and, in a web application, over HTTP as well.
463
463
Endpoints can be exposed over HTTP using Jersey, Spring MVC, or Spring WebFlux.
464
+
If both Jersey and Spring MVC are available, Spring MVC will be used.
464
465
465
466
You can also write technology-specific endpoints by using `@JmxEndpoint` or `@WebEndpoint`.
466
467
These endpoints are restricted to their respective technologies.
@@ -512,6 +513,7 @@ Before calling an operation method, the input received via JMX or an HTTP reques
512
513
[[production-ready-endpoints-custom-web]]
513
514
==== Custom Web Endpoints
514
515
Operations on an `@Endpoint`, `@WebEndpoint`, or `@EndpointWebExtension` are automatically exposed over HTTP using Jersey, Spring MVC, or Spring WebFlux.
516
+
If both Jersey and Spring MVC are available, Spring MVC will be used.
515
517
516
518
517
519
@@ -968,6 +970,7 @@ The default convention is to use the `id` of the endpoint with a prefix of `/act
968
970
For example, `health` is exposed as `/actuator/health`.
969
971
970
972
TIP: Actuator is supported natively with Spring MVC, Spring WebFlux, and Jersey.
973
+
If both Jersey and Spring MVC are available, Spring MVC will be used.
0 commit comments