Class MockRestResponseCreators
- java.lang.Object
- org.springframework.test.web.client.response.MockRestResponseCreators
public abstract class MockRestResponseCreators extends Object
Static factory methods for obtaining aResponseCreator
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 Summary
Constructors Constructor Description MockRestResponseCreators()
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static DefaultResponseCreator
withBadRequest()
ResponseCreator
for a 400 response (BAD_REQUEST).static DefaultResponseCreator
withCreatedEntity(URI location)
ResponseCreator
for a 201 response (CREATED) with a 'Location' header.static ResponseCreator
withException(IOException ex)
ResponseCreator
with an internal applicationIOException
.static DefaultResponseCreator
withNoContent()
ResponseCreator
for a 204 response (NO_CONTENT).static DefaultResponseCreator
withServerError()
ResponseCreator
for a 500 response (SERVER_ERROR).static DefaultResponseCreator
withStatus(HttpStatus status)
ResponseCreator
with a specific HTTP status.static DefaultResponseCreator
withSuccess()
ResponseCreator
for a 200 response (OK).static DefaultResponseCreator
withSuccess(byte[] body, MediaType contentType)
ResponseCreator
for a 200 response (OK) with byte[] body.static DefaultResponseCreator
withSuccess(String body, MediaType contentType)
ResponseCreator
for a 200 response (OK) with String body.static DefaultResponseCreator
withSuccess(Resource body, MediaType contentType)
ResponseCreator
for a 200 response (OK) content withResource
-based body.static DefaultResponseCreator
withUnauthorizedRequest()
ResponseCreator
for a 401 response (UNAUTHORIZED).
Constructor Detail
MockRestResponseCreators
public MockRestResponseCreators()
Method Detail
withSuccess
public static DefaultResponseCreator withSuccess()
ResponseCreator
for a 200 response (OK).
withSuccess
public static DefaultResponseCreator withSuccess(String body, @Nullable MediaType contentType)
ResponseCreator
for a 200 response (OK) with String body.- Parameters:
body
- the response body, a "UTF-8" stringcontentType
- the type of the content (may benull
)
withSuccess
public static DefaultResponseCreator withSuccess(byte[] body, @Nullable MediaType contentType)
ResponseCreator
for a 200 response (OK) with byte[] body.- Parameters:
body
- the response bodycontentType
- the type of the content (may benull
)
withSuccess
public static DefaultResponseCreator withSuccess(Resource body, @Nullable MediaType contentType)
ResponseCreator
for a 200 response (OK) content withResource
-based body.- Parameters:
body
- the response bodycontentType
- the type of the content (may benull
)
withCreatedEntity
public static DefaultResponseCreator withCreatedEntity(URI location)
ResponseCreator
for a 201 response (CREATED) with a 'Location' header.- Parameters:
location
- the value for theLocation
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
withException
public static ResponseCreator withException(IOException ex)
ResponseCreator
with an internal applicationIOException
.For example, one could use this to simulate a
SocketTimeoutException
.- Parameters:
ex
- theException
to be thrown at HTTP call time- Since:
- 5.2.2