Skip to main content
Open source

Migrate JAX-RS Response to Spring MVC ResponseEntity

Recipe IDorg.openrewrite.java.spring.mvc.JaxrsToSpringMvcResponseEntity
Artifactorg.openrewrite.recipe:rewrite-spring

Replaces all JAX-RS Response with Spring MVC ResponseEntity.

Composite recipeJavaModerne Source Available License
Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Definition​

Recipes6

Examples​

java
Before
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;

class TestExample {

    class TestResponse {
        private String message;

        TestResponse(String message) {
            this.message = message;
        }

        String getMessage() {
            return message;
        }
    }

    Response test0() {
        return Response.ok().build();
    }

    Response test1() {
        return Response.ok("Test Response").build();
    }

    Response test2() {
        TestResponse response = new TestResponse("Test Response");
        return Response.ok().entity(response).build();
    }

    Response test3() {
        return Response.ok().entity("Test Response").header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON).build();
    }

    Response test4() {
        TestResponse response = new TestResponse("Test Response");
        return Response.ok().header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON).entity(response).build();
    }

    Response test5() {
        return Response.status(Response.Status.UNAUTHORIZED).build();
    }

    Response test6() {
        return Response.status(Response.Status.CREATED).entity("Test Response").build();
    }

    Response test7() {
        TestResponse response = new TestResponse("Test Response");
        return Response.status(Status.NOT_FOUND).entity(response).build();
    }

    Response test8() {
        return Response.status(Status.BAD_GATEWAY).header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON).entity("Test Response").build();
    }

    Response test9() {
        return Response.serverError().entity("Test Response").header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON).build();
    }

    Response test10() {
        return Response.noContent().build();
    }

    Response.ResponseBuilder test11() {
        return Response.ok().header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON);
    }

}
After
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.http.ResponseEntity.BodyBuilder;

class TestExample {

    class TestResponse {
        private String message;

        TestResponse(String message) {
            this.message = message;
        }

        String getMessage() {
            return message;
        }
    }

    ResponseEntity test0() {
        return ResponseEntity.ok().build();
    }

    ResponseEntity test1() {
        return ResponseEntity.ok("Test Response");
    }

    ResponseEntity test2() {
        TestResponse response = new TestResponse("Test Response");
        return ResponseEntity.ok().body(response);
    }

    ResponseEntity test3() {
        return ResponseEntity.ok().header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON).body("Test Response");
    }

    ResponseEntity test4() {
        TestResponse response = new TestResponse("Test Response");
        return ResponseEntity.ok().header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON).body(response);
    }

    ResponseEntity test5() {
        return ResponseEntity.status(HttpStatus.UNAUTHORIZED).build();
    }

    ResponseEntity test6() {
        return ResponseEntity.status(HttpStatus.CREATED).body("Test Response");
    }

    ResponseEntity test7() {
        TestResponse response = new TestResponse("Test Response");
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(response);
    }

    ResponseEntity test8() {
        return ResponseEntity.status(HttpStatus.BAD_GATEWAY).header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON).body("Test Response");
    }

    ResponseEntity test9() {
        return ResponseEntity.internalServerError().header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON).body("Test Response");
    }

    ResponseEntity test10() {
        return ResponseEntity.noContent().build();
    }

    BodyBuilder test11() {
        return ResponseEntity.ok().header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON);
    }

}

Usage​

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe JaxrsToSpringMvcResponseEntity

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-spring:6.34.0

Data tables​

Source files that had results
org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

ColumnDescription
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.
Source files that had search results
org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run 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.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe specific recipe that added the Search marker.
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.
Recipe performance
org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)The total time spent across the scanning phase of this recipe.
Max scanning time (ns)The max time scanning any one source file.
Cumulative edit time (ns)The total time spent across the editing phase of this recipe.
Max edit time (ns)The max time editing any one source file.