Skip to main content

Rename server.max-http-header-size to server.max-http-request-header-size

org.openrewrite.java.spring.boot3.MigrateMaxHttpHeaderSize

Previously, the server.max-http-header-size was treated inconsistently across the four supported embedded web servers. When using Jetty, Netty, or Undertow it would configure the max HTTP request header size. When using Tomcat it would configure the max HTTP request and response header sizes. The renamed property is used to configure the http request header size in Spring Boot 3.0. To limit the max header size of an HTTP response on Tomcat or Jetty (the only two servers that support such a setting), use a WebServerFactoryCustomizer.

Tags​

  • spring
  • boot

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Definition​

Examples​

Example 1​
Before​
# application.properties
server.max-http-header-size=10KB
After​
# application.properties
server.max-http-request-header-size=10KB
Before​
    server:
      max-http-header-size: 10KB
After​
    server:
      max-http-request-header-size: 10KB
Unchanged​
test
Example 2​
Before​
# application.properties
server.max-http-header-size=10KB
After​
# application.properties
server.max-http-request-header-size=10KB
Before​
    server:
      max-http-header-size: 10KB
After​
    server:
      max-http-request-header-size: 10KB
Unchanged​
test

Usage​

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-spring in your build file or by running a shell command (in which case no build changes are needed):

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.1")
}

rewrite {
    activeRecipe("org.openrewrite.java.spring.boot3.MigrateMaxHttpHeaderSize")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:6.7.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.

Contributors​

Tyler Van Gorder, Knut Wannheden, Nick McKinney, Tim te Beek, Jonathan Schnéider, Patrick, Sam Snyder, Kyle Scully