Adds server-webmvc to list of config properties.

Fixes gh-3337
spring-cloud · Apr 5, 2024 · d722898 · d722898
1 parent a24f5b8
commit d722898
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/docs/modules/ROOT/partials/_configprops.adoc b/docs/modules/ROOT/partials/_configprops.adoc
@@ -115,6 +115,31 @@
 |spring.cloud.gateway.metrics.enabled | `+++false+++` | Enables the collection of metrics data.
 |spring.cloud.gateway.metrics.prefix | `+++spring.cloud.gateway+++` | The prefix of all metrics emitted by gateway.
 |spring.cloud.gateway.metrics.tags |  | Tags map that added to metrics.
+|spring.cloud.gateway.mvc.form-filter.enabled | `+++true+++` | Enables the form-filter.
+|spring.cloud.gateway.mvc.forwarded-request-headers-filter.enabled | `+++true+++` | Enables the forwarded-request-headers-filter.
+|spring.cloud.gateway.mvc.http-client.connect-timeout |  | The HttpClient connect timeout.
+|spring.cloud.gateway.mvc.http-client.read-timeout |  | The HttpClient read timeout.
+|spring.cloud.gateway.mvc.http-client.ssl-bundle |  | The name of the SSL bundle to use.
+|spring.cloud.gateway.mvc.http-client.type |  | The HttpClient type. Defaults to JDK.
+|spring.cloud.gateway.mvc.remove-content-length-request-headers-filter.enabled | `+++true+++` | Enables the remove-content-length-request-headers-filter.
+|spring.cloud.gateway.mvc.remove-hop-by-hop-request-headers-filter.enabled | `+++true+++` | Enables the forwarded-request-headers-filter.
+|spring.cloud.gateway.mvc.remove-hop-by-hop-response-headers-filter.enabled | `+++true+++` | Enables the forwarded-request-headers-filter.
+|spring.cloud.gateway.mvc.routes |  | List of Routes.
+|spring.cloud.gateway.mvc.routes-map |  | Map of Routes.
+|spring.cloud.gateway.mvc.transfer-encoding-normalization-request-headers-filter.enabled | `+++true+++` | Enables the transfer-encoding-normalization-request-headers-filter.
+|spring.cloud.gateway.mvc.weight-calculator-filter.enabled | `+++true+++` | Enables the weight-calculator-filter.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.enabled | `+++true+++` | If the XForwardedHeadersFilter is enabled.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.for-append | `+++true+++` | If appending X-Forwarded-For as a list is enabled.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.for-enabled | `+++true+++` | If X-Forwarded-For is enabled.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.host-append | `+++true+++` | If appending X-Forwarded-Host as a list is enabled.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.host-enabled | `+++true+++` | If X-Forwarded-Host is enabled.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.order | `+++0+++` | The order of the XForwardedHeadersFilter.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.port-append | `+++true+++` | If appending X-Forwarded-Port as a list is enabled.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.port-enabled | `+++true+++` | If X-Forwarded-Port is enabled.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.prefix-append | `+++true+++` | If appending X-Forwarded-Prefix as a list is enabled.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.prefix-enabled | `+++true+++` | If X-Forwarded-Prefix is enabled.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.proto-append | `+++true+++` | If appending X-Forwarded-Proto as a list is enabled.
+|spring.cloud.gateway.mvc.x-forwarded-request-headers-filter.proto-enabled | `+++true+++` | If X-Forwarded-Proto is enabled.
 |spring.cloud.gateway.observability.enabled | `+++true+++` | If Micrometer Observability support should be turned on.
 |spring.cloud.gateway.predicate.after.enabled | `+++true+++` | Enables the after predicate.
 |spring.cloud.gateway.predicate.before.enabled | `+++true+++` | Enables the before predicate.

diff --git a/docs/pom.xml b/docs/pom.xml
@@ -30,6 +30,10 @@
 			<groupId>${project.groupId}</groupId>
 			<artifactId>spring-cloud-starter-gateway</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>${project.groupId}</groupId>
+			<artifactId>spring-cloud-starter-gateway-mvc</artifactId>
+		</dependency>
 	</dependencies>
 	<build>
 		<sourceDirectory>src/main/asciidoc</sourceDirectory>

diff --git a/...c/main/java/org/springframework/cloud/gateway/server/mvc/config/GatewayMvcProperties.java b/...c/main/java/org/springframework/cloud/gateway/server/mvc/config/GatewayMvcProperties.java
@@ -79,12 +79,16 @@ public String toString() {
 
 	public static class HttpClient {
 
+		/** The HttpClient connect timeout. */
 		private Duration connectTimeout;
 
+		/** The HttpClient read timeout. */
 		private Duration readTimeout;
 
+		/** The name of the SSL bundle to use. */
 		private String sslBundle;
 
+		/** The HttpClient type. Defaults to JDK. */
 		private HttpClientType type = HttpClientType.JDK;
 
 		public Duration getConnectTimeout() {