Package io.restassured.module.mockmvc.specification

Class MockMvcRequestSpecBuilder

java.lang.Object
io.restassured.module.mockmvc.specification.MockMvcRequestSpecBuilder
public class MockMvcRequestSpecBuilder extends Object
You can use the builder to construct a request specification. The specification can be used as e.g. 
 MockMvcRequestSpecification requestSpec = new MockMvcRequestSpecBuilder().addParameter("parameter1", "value1").build();

 given().
         spec(requestSpec).
 when().
        get("/something").
 then().
         body("x.y.z", equalTo("something")).

  • Constructor Details

    • MockMvcRequestSpecBuilder

      public MockMvcRequestSpecBuilder()

  • Method Details

    • setAuth

      public MockMvcRequestSpecBuilder setAuth(MockMvcAuthenticationScheme auth)
      If you need to specify some credentials when performing a request.
      Returns:
      The request specification builder

    • setPostProcessors

      public MockMvcRequestSpecBuilder setPostProcessors(org.springframework.test.web.servlet.request.RequestPostProcessor postProcessors)
      Set the post processors for this request.
      Parameters:
      postProcessors - The post processors to use
      Returns:
      The request specification builder

    • setBody

      public MockMvcRequestSpecBuilder setBody(String body)
      Specify a String request body (such as e.g. JSON or XML) to be sent with the request. This works for the POST, PUT and PATCH methods only. Trying to do this for the other http methods will cause an exception to be thrown.

      Parameters:
      body - The body to send.
      Returns:
      The request specification builder

    • setBody

      public MockMvcRequestSpecBuilder setBody(byte[] body)
      Specify a byte array request body to be sent with the request. This only works for the POST http method. Trying to do this for the other http methods will cause an exception to be thrown.
      Parameters:
      body - The body to send.
      Returns:
      The request specification builder

    • setBody

      public MockMvcRequestSpecBuilder setBody(Object object)
      Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request. If the object is a primitive or Number the object will be converted to a String and put in the request body. This works for the POST, PUT and PATCH methods only. Trying to do this for the other http methods will cause an exception to be thrown.

      Parameters:
      object - The object to serialize and send with the request
      Returns:
      The request specification

    • setBody

      public MockMvcRequestSpecBuilder setBody(Object object, io.restassured.mapper.ObjectMapper mapper)
      Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request using a specific object mapper. This works for the POST, PATCH and PUT methods only. Trying to do this for the other http methods will cause an exception to be thrown.

      Note that setBody(Object, ObjectMapper) are the same except for the syntactic difference.

      Parameters:
      object - The object to serialize and send with the request
      mapper - The object mapper
      Returns:
      The request specification

    • setBody

      public MockMvcRequestSpecBuilder setBody(Object object, io.restassured.mapper.ObjectMapperType mapperType)
      Specify an Object request content that will automatically be serialized to JSON or XML and sent with the request using a specific object mapper type. This works for the POST, PATCH and PUT methods only. Trying to do this for the other http methods will cause an exception to be thrown.

      Example of use: 

       Message message = new Message();
 message.setMessage("My beautiful message");

 given().
         body(message, ObjectMapper.GSON).
 expect().
         content(equalTo("Response to a beautiful message")).
 when().
         post("/beautiful-message");

      Note that setBody(Object, ObjectMapperType) are the same except for the syntactic difference.

      Parameters:
      object - The object to serialize and send with the request
      mapperType - The object mapper type to be used
      Returns:
      The request specification

    • addCookies

      public MockMvcRequestSpecBuilder addCookies(Map<String,?> cookies)
      Add cookies to be sent with the request as Map e.g:
      Parameters:
      cookies - The Map containing the cookie names and their values to set in the request.
      Returns:
      The request specification builder

    • addCookie

      public MockMvcRequestSpecBuilder addCookie(io.restassured.http.Cookie cookie)
      Add a detailed cookie
      Parameters:
      cookie - The cookie to add.
      Returns:
      The request specification builder

    • addCookie

      public MockMvcRequestSpecBuilder addCookie(String key, Object value, Object... cookieNameValuePairs)
      Add a cookie to be sent with the request.
      Parameters:
      key - The cookie key
      value - The cookie value
      cookieNameValuePairs - Additional cookies values. This will actually create two cookies with the same name but with different values.
      Returns:
      The request specification builder

    • addParams

      public MockMvcRequestSpecBuilder addParams(Map<String,?> parametersMap)
      Parameters:
      parametersMap - The Map containing the parameter names and their values to send with the request.
      Returns:
      The request specification builder

    • addParam

      public MockMvcRequestSpecBuilder addParam(String parameterName, Object... parameterValues)
      Parameters:
      parameterValues - Zero to many parameter values for this parameter name.
      Returns:
      The request specification builder

    • addParam

      public MockMvcRequestSpecBuilder addParam(String parameterName, Collection<?> parameterValues)
      Parameters:
      parameterName - The parameter key
      parameterValues - The parameter values
      Returns:
      The request specification builder

    • addQueryParam

      public MockMvcRequestSpecBuilder addQueryParam(String parameterName, Collection<?> parameterValues)
      Parameters:
      parameterName - The parameter key
      parameterValues - The parameter values
      Returns:
      The request specification builder
      See Also:

    • addQueryParams

      public MockMvcRequestSpecBuilder addQueryParams(Map<String,?> parametersMap)
      Parameters:
      parametersMap - The Map containing the parameter names and their values to send with the request.
      Returns:
      The request specification builder

    • addQueryParam

      public MockMvcRequestSpecBuilder addQueryParam(String parameterName, Object... parameterValues)
      Parameters:
      parameterName - The parameter key
      parameterValues - Zero to many parameter values for this parameter name.
      Returns:
      The request specification builder

    • addPathParam

      public MockMvcRequestSpecBuilder addPathParam(String parameterName, Object parameterValue)
      Specify a path parameter. Path parameters are used to improve readability of the request path. E.g. instead of writing: 
       expect().statusCode(200).when().get("/item/"+myItem.getItemNumber()+"/buy/"+2);
      you can write: 
       given().
         pathParam("itemNumber", myItem.getItemNumber()).
         pathParam("amount", 2).
 expect().
          statusCode(200).
 when().
        get("/item/{itemNumber}/buy/{amount}");

      which improves readability and allows the path to be reusable in many tests. Another alternative is to use: 

       expect().statusCode(200).when().get("/item/{itemNumber}/buy/{amount}", myItem.getItemNumber(), 2);
      Parameters:
      parameterName - The parameter key
      parameterValue - The parameter value
      Returns:
      The request specification

    • addPathParams

      public MockMvcRequestSpecBuilder addPathParams(String firstParameterName, Object firstParameterValue, Object... parameterNameValuePairs)
      Specify multiple path parameter name-value pairs. Path parameters are used to improve readability of the request path. E.g. instead of writing: 
       expect().statusCode(200).when().get("/item/"+myItem.getItemNumber()+"/buy/"+2);
      you can write: 
       given().
         pathParam("itemNumber", myItem.getItemNumber(), "amount", 2).
 expect().
          statusCode(200).
 when().
        get("/item/{itemNumber}/buy/{amount}");

      which improves readability and allows the path to be reusable in many tests. Another alternative is to use: 

       expect().statusCode(200).when().get("/item/{itemNumber}/buy/{amount}", myItem.getItemNumber(), 2);
      Parameters:
      firstParameterName - The name of the first parameter
      firstParameterValue - The value of the first parameter
      parameterNameValuePairs - Additional parameters in name-value pairs.
      Returns:
      The request specification

    • addPathParams

      public MockMvcRequestSpecBuilder addPathParams(Map<String,Object> parameterNameValuePairs)
      Specify multiple path parameter name-value pairs. Path parameters are used to improve readability of the request path. E.g. instead of writing: 
       expect().statusCode(200).when().get("/item/"+myItem.getItemNumber()+"/buy/"+2);
      you can write: 
       Map<String,Object> pathParams = new HashMap<String,Object>();
 pathParams.add("itemNumber",myItem.getItemNumber());
 pathParams.add("amount",2);

 given().
         pathParameters(pathParams).
 expect().
          statusCode(200).
 when().
        get("/item/{itemNumber}/buy/{amount}");

      which improves readability and allows the path to be reusable in many tests. Another alternative is to use: 

       expect().statusCode(200).when().get("/item/{itemNumber}/buy/{amount}", myItem.getItemNumber(), 2);
      Parameters:
      parameterNameValuePairs - A map containing the path parameters.
      Returns:
      The request specification

    • addFormParam

      public MockMvcRequestSpecBuilder addFormParam(String parameterName, Collection<?> parameterValues)
      Parameters:
      parameterName - The parameter key
      parameterValues - The parameter values
      Returns:
      The request specification builder
      See Also:

    • addFormParams

      public MockMvcRequestSpecBuilder addFormParams(Map<String,?> parametersMap)
      Parameters:
      parametersMap - The Map containing the parameter names and their values to send with the request.
      Returns:
      The request specification builder

    • addFormParam

      public MockMvcRequestSpecBuilder addFormParam(String parameterName, Object... parameterValues)
      Parameters:
      parameterName - The parameter name
      parameterValues - Zero to many parameter values for this parameter name.
      Returns:
      The request specification builder
      See Also:

    • addAttribute

      public MockMvcRequestSpecBuilder addAttribute(String attributeName, Object attributeValue)
      Add request attribute
      Parameters:
      attributeName - The attribute name
      attributeValue - The attribute value
      Returns:
      The request specification builder

    • addAttributes

      public MockMvcRequestSpecBuilder addAttributes(Map<String,?> attributesMap)
      Add request attributes
      Parameters:
      attributesMap - The Map containing the request attribute names and their values
      Returns:
      The request specification builder

    • addHeaders

      public MockMvcRequestSpecBuilder addHeaders(Map<String,String> headers)
      Add headers to be sent with the request as Map.
      Parameters:
      headers - The Map containing the header names and their values to send with the request.
      Returns:
      The request specification builder

    • addHeader

      public MockMvcRequestSpecBuilder addHeader(String headerName, String headerValue)
      Add a header to be sent with the request
      Parameters:
      headerName - The header name
      headerValue - The header value
      Returns:
      The request specification builder

    • addHeader

      public MockMvcRequestSpecBuilder addHeader(io.restassured.http.Header header)
      Add a header to be sent with the request.
      Parameters:
      header - The header
      Returns:
      The request specification builder

    • setContentType

      public MockMvcRequestSpecBuilder setContentType(io.restassured.http.ContentType contentType)
      Specify the content type of the request.
      Parameters:
      contentType - The content type of the request
      Returns:
      The request specification builder
      See Also:
      • ContentType

    • setContentType

      public MockMvcRequestSpecBuilder setContentType(String contentType)
      Specify the content type of the request as string.
      Parameters:
      contentType - The content type of the request
      Returns:
      The request specification builder

    • addMultiPart

      public MockMvcRequestSpecBuilder addMultiPart(File file)
      Specify a file to upload to the server using multi-part form data uploading. It will assume that the control name is file and the content-type is application/octet-stream. If this is not what you want please use an overloaded method.
      Parameters:
      file - The file to upload
      Returns:
      The request specification

    • addMultiPart

      public MockMvcRequestSpecBuilder addMultiPart(String controlName, File file)
      Specify a file to upload to the server using multi-part form data uploading with a specific control name. It will use the content-type application/octet-stream. If this is not what you want please use an overloaded method.
      Parameters:
      file - The file to upload
      controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
      Returns:
      The request specification

    • addMultiPart

      public MockMvcRequestSpecBuilder addMultiPart(String controlName, File file, String mimeType)
      Specify a file to upload to the server using multi-part form data uploading with a specific control name and content-type.
      Parameters:
      file - The file to upload
      controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
      mimeType - The content-type
      Returns:
      The request specification

    • addMultiPart

      public MockMvcRequestSpecBuilder addMultiPart(String controlName, String fileName, byte[] bytes)
      Specify a byte-array to upload to the server using multi-part form data. It will use the content-type application/octet-stream. If this is not what you want please use an overloaded method.
      Parameters:
      controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
      fileName - The name of the content you're uploading
      bytes - The bytes you want to send
      Returns:
      The request specification

    • addMultiPart

      public MockMvcRequestSpecBuilder addMultiPart(String controlName, String fileName, byte[] bytes, String mimeType)
      Specify a byte-array to upload to the server using multi-part form data.
      Parameters:
      controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
      fileName - The name of the content you're uploading
      bytes - The bytes you want to send
      mimeType - The content-type
      Returns:
      The request specification

    • addMultiPart

      public MockMvcRequestSpecBuilder addMultiPart(String controlName, String fileName, InputStream stream)
      Specify an inputstream to upload to the server using multi-part form data. It will use the content-type application/octet-stream. If this is not what you want please use an overloaded method.
      Parameters:
      controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
      fileName - The name of the content you're uploading
      stream - The stream you want to send
      Returns:
      The request specification

    • addMultiPart

      public MockMvcRequestSpecBuilder addMultiPart(String controlName, String fileName, InputStream stream, String mimeType)
      Specify an inputstream to upload to the server using multi-part form data.
      Parameters:
      controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
      fileName - The name of the content you're uploading
      stream - The stream you want to send
      mimeType - The content-type
      Returns:
      The request specification

    • addMultiPart

      public MockMvcRequestSpecBuilder addMultiPart(String controlName, String contentBody)
      Specify a string to send to the server using multi-part form data. It will use the content-type text/plain. If this is not what you want please use an overloaded method.
      Parameters:
      controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
      contentBody - The string to send
      Returns:
      The request specification

    • addMultiPart

      public MockMvcRequestSpecBuilder addMultiPart(String controlName, String contentBody, String mimeType)
      Specify a string to send to the server using multi-part form data with a specific mime-type.
      Parameters:
      controlName - Defines the control name of the body part. In HTML this is the attribute name of the input tag.
      contentBody - The string to send
      mimeType - The mime-type
      Returns:
      The request specification

    • setSessionId

      public MockMvcRequestSpecBuilder setSessionId(String sessionIdValue)
      Set the session id for this request. It will use the configured session id name from the configuration (by default this is ). You can configure the session id name by using: 
           RestAssuredMockMvc.config = newConfig().sessionConfig(new SessionConfig().sessionIdName(<sessionIdName>));
      or you can use the setSessionId(String, String) method to set it for this request only.
      Parameters:
      sessionIdValue - The session id value.
      Returns:
      The request specification

    • setSessionId

      public MockMvcRequestSpecBuilder setSessionId(String sessionIdName, String sessionIdValue)
      Set the session id name and value for this request. It'll override the default session id name from the configuration (by default this is ). You can configure the default session id name by using: 
           RestAssuredMockMvc.config = newConfig().sessionConfig(new SessionConfig().sessionIdName(<sessionIdName>));
      and then you can use the setSessionId(String) method to set the session id value without specifying the name for each request.
      Parameters:
      sessionIdName - The session id name
      sessionIdValue - The session id value.
      Returns:
      The request specification

    • addMockMvcRequestSpecification

      public MockMvcRequestSpecBuilder addMockMvcRequestSpecification(MockMvcRequestSpecification specification)
      Merge this builder with settings from another specification. Note that the supplied specification can overwrite data in the current specification. The following settings are overwritten:
      • Content type
      • Request body
      • Interceptors
      • Config (if defined)
      The following settings are merged:
      • Parameters
      • Cookies
      • Headers
      Parameters:
      specification - The specification to add
      Returns:
      The request specification builder

    • setConfig

      public MockMvcRequestSpecBuilder setConfig(RestAssuredMockMvcConfig config)
      Define a configuration for redirection settings and http client parameters.
      Parameters:
      config - The configuration to use for this request. If null no config will be used.
      Returns:
      The request specification builder

    • build

      public MockMvcRequestSpecification build()
      Build the request specification.
      Returns:
      The assembled request specification

    • setBasePath

      public MockMvcRequestSpecBuilder setBasePath(String basePath)
      Set the basePath property of the MockMvcRequestSpecBuilder instead of using static field RestAssuredMockMvc.basePath. 

       MockMvcRequestSpecBuilder builder = new MockMvcRequestSpecBuilder();
 builder.setBasePath("/something");
 MockMvcRequestSpecification specs = builder.build();
 given().spec(specs)
      Parameters:
      basePath -
      Returns:
      MockMvcRequestSpecBuilder

    • setMockMvc

      public MockMvcRequestSpecBuilder setMockMvc(org.springframework.test.web.servlet.MockMvc mockMvc)
      The mock mvc instance to use.

      Note that this will override the any MockMvc instances configured by other setters.*

      Parameters:
      mockMvc - The mock mvc instance
      Returns:
      MockMvcRequestSpecBuilder

    • setStandaloneSetup

      public MockMvcRequestSpecBuilder setStandaloneSetup(Object... controllers)
      The standalone setup to be used by supplying a set of controllers.

      Note that this will override the any MockMvc instances configured by other setters.

      Parameters:
      controllers - The controllers to use
      Returns:
      MockMvcRequestSpecBuilder
      See Also:

    • setStandaloneSetup

      public MockMvcRequestSpecBuilder setStandaloneSetup(org.springframework.test.web.servlet.MockMvcBuilder builder)
      Initialize with a MockMvcBuilder that will be used to create the MockMvc instance.

      Note that this will override the any MockMvc instances configured by other setters.

      Parameters:
      builder - The builder to use
      Returns:
      MockMvcRequestSpecBuilder
      See Also:

    • setWebAppContextSetup

      public MockMvcRequestSpecBuilder setWebAppContextSetup(org.springframework.web.context.WebApplicationContext context, org.springframework.test.web.servlet.setup.MockMvcConfigurer... mockMvcConfigurers)
      Initialize with a WebApplicationContext that will be used to create the MockMvc instance.

      Note that this will override the any MockMvc instances configured by other setters.

      Parameters:
      context - The WebApplicationContext to use
      mockMvcConfigurers - MockMvcConfigurer's to be applied when creating a MockMvc instance of this WebApplicationContext (optional)
      Returns:
      MockMvcRequestSpecBuilder
      See Also:

    • setMockHttpServletRequestBuilderInterceptor

      public MockMvcRequestSpecBuilder setMockHttpServletRequestBuilderInterceptor(MockHttpServletRequestBuilderInterceptor interceptor)
      The mock mvc instance to use.
      Parameters:
      interceptor - The interceptor
      Returns:
      MockMvcRequestSpecBuilder

    • addResultHandlers

      public MockMvcRequestSpecBuilder addResultHandlers(org.springframework.test.web.servlet.ResultHandler resultHandler, org.springframework.test.web.servlet.ResultHandler... additionalResultHandlers)
      Add a result handler
      Parameters:
      resultHandler - The result handler
      Returns:
      MockMvcRequestSpecBuilder

    • log

      public MockMvcRequestSpecBuilder log(io.restassured.filter.log.LogDetail logDetail)
      Enabled logging with the specified log detail. Set a LogConfig to configure the print stream and pretty printing options.
      Parameters:
      logDetail - The log detail.
      Returns:
      MockMvcRequestSpecBuilder

    • and

      public MockMvcRequestSpecBuilder and()
      Returns the same MockMvcRequestSpecBuilder instance for syntactic sugar.
      Returns:
      MockMvcRequestSpecBuilder