io.restassured.module.mockmvc.response.MockMvcResponse Maven / Gradle / Ivy
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.restassured.module.mockmvc.response;
import io.restassured.response.ResponseBody;
import io.restassured.response.ResponseOptions;
import io.restassured.response.Validatable;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.test.web.servlet.MvcResult;
/**
* The response of a request made by REST Assured Mock MVC.
*
* Usage example:
*
* Response response = get("/lotto");
* String body = response.getBody().asString();
* String headerValue = response.getHeader("headerName");
* String cookieValue = response.getCookie("cookieName");
*
*
* You can also map the response body to a Java object automatically. REST Assured will use
* Jackson, Gson and JAXB to accommodate this:
*
* Message message = get("/message").as(Message.class);
*
*
*/
public interface MockMvcResponse extends ResponseBody, ResponseOptions, Validatable {
/**
* Return the {@link org.springframework.test.web.servlet.MvcResult} as returned by Spring MockMvc.
*
* This method is the same as {@link #getMvcResult()} except for syntactic differences.
*
*
* @return The {@link org.springframework.test.web.servlet.MvcResult} as returned by Spring MockMvc.
*/
MvcResult mvcResult();
/**
* Return the {@link org.springframework.test.web.servlet.MvcResult} as returned by Spring MockMvc.
*
* This method is the same as {@link #mvcResult()} except for syntactic differences.
*
*
* @return The {@link org.springframework.test.web.servlet.MvcResult} as returned by Spring MockMvc.
*/
MvcResult getMvcResult();
/**
* Return the {@link org.springframework.mock.web.MockHttpServletResponse} as returned by Spring MockMvc.
*
* This method is the same as {@link #getMockHttpServletResponse()} except for syntactic differences.
*
*
* @return The {@link org.springframework.mock.web.MockHttpServletResponse} as returned by Spring MockMvc.
*/
MockHttpServletResponse mockHttpServletResponse();
/**
* Return the {@link org.springframework.mock.web.MockHttpServletResponse} as returned by Spring MockMvc.
*
* This method is the same as {@link #mockHttpServletResponse()} except for syntactic differences.
*
*
* @return The {@link org.springframework.mock.web.MockHttpServletResponse} as returned by Spring MockMvc.
*/
MockHttpServletResponse getMockHttpServletResponse();
}