org.springframework.test.web.client.response

Class MockRestResponseCreators

  • java.lang.Object
    • org.springframework.test.web.client.response.MockRestResponseCreators


  • public abstract class MockRestResponseCreators
    extends java.lang.Object
    Static factory methods for obtaining a ResponseCreator instance.

    Eclipse users: consider adding this class as a Java editor favorite. To navigate, open the Preferences and type "favorites".

    Since:
    3.2
    Author:
    Rossen Stoyanchev
    • Constructor Detail

      • MockRestResponseCreators

        public MockRestResponseCreators()
    • Method Detail

      • withSuccess

        public static DefaultResponseCreator withSuccess(java.lang.String body,
                                                         @Nullable
                                                         MediaType contentType)
        ResponseCreator for a 200 response (OK) with String body.
        Parameters:
        body - the response body, a "UTF-8" string
        contentType - the type of the content (may be null)
      • withSuccess

        public static DefaultResponseCreator withSuccess(byte[] body,
                                                         @Nullable
                                                         MediaType contentType)
        ResponseCreator for a 200 response (OK) with byte[] body.
        Parameters:
        body - the response body
        contentType - the type of the content (may be null)
      • withCreatedEntity

        public static DefaultResponseCreator withCreatedEntity(java.net.URI location)
        ResponseCreator for a 201 response (CREATED) with a 'Location' header.
        Parameters:
        location - the value for the Location header
      • withNoContent

        public static DefaultResponseCreator withNoContent()
        ResponseCreator for a 204 response (NO_CONTENT).
      • withBadRequest

        public static DefaultResponseCreator withBadRequest()
        ResponseCreator for a 400 response (BAD_REQUEST).
      • withUnauthorizedRequest

        public static DefaultResponseCreator withUnauthorizedRequest()
        ResponseCreator for a 401 response (UNAUTHORIZED).
      • withServerError

        public static DefaultResponseCreator withServerError()
        ResponseCreator for a 500 response (SERVER_ERROR).
      • withStatus

        public static DefaultResponseCreator withStatus(HttpStatus status)
        ResponseCreator with a specific HTTP status.
        Parameters:
        status - the response status