Package io.restassured.module.mockmvc.config

Class MockMvcParamConfig

java.lang.Object
io.restassured.config.ParamConfig
io.restassured.module.mockmvc.config.MockMvcParamConfig
All Implemented Interfaces:
io.restassured.config.Config
public class MockMvcParamConfig extends io.restassured.config.ParamConfig implements io.restassured.config.Config
Determines how different parameter types in REST Assured MockMvc should be updated when adding multiple parameters of the same type with the same name.

  • Constructor Details

    • MockMvcParamConfig

      public MockMvcParamConfig()
      Create a new instance where all parameters are merged

    • MockMvcParamConfig

      public MockMvcParamConfig(io.restassured.config.ParamConfig.UpdateStrategy queryParamsUpdateStrategy, io.restassured.config.ParamConfig.UpdateStrategy pathParamsUpdateStrategy, io.restassured.config.ParamConfig.UpdateStrategy formParamsUpdateStrategy, io.restassured.config.ParamConfig.UpdateStrategy requestParameterUpdateStrategy, io.restassured.config.ParamConfig.UpdateStrategy attributeUpdateStrategy, io.restassured.config.ParamConfig.UpdateStrategy sessionUpdateStrategy)
      Create a new instance and specify update strategies for all parameter types.
      Parameters:
      queryParamsUpdateStrategy - The update strategy for query parameters
      formParamsUpdateStrategy - The update strategy for form parameters
      requestParameterUpdateStrategy - The update strategy for request parameters
      sessionUpdateStrategy - The update strategy for session parameters

  • Method Details

    • mergeAllParameters

      public MockMvcParamConfig mergeAllParameters()
      Merge all parameter types.
      Overrides:
      mergeAllParameters in class io.restassured.config.ParamConfig
      Returns:
      A new instance of MockMvcParamConfig

    • replaceAllParameters

      public MockMvcParamConfig replaceAllParameters()
      Replace parameter values for all kinds of parameter types.
      Overrides:
      replaceAllParameters in class io.restassured.config.ParamConfig
      Returns:
      A new instance of MockMvcParamConfig

    • formParamsUpdateStrategy

      public MockMvcParamConfig formParamsUpdateStrategy(io.restassured.config.ParamConfig.UpdateStrategy updateStrategy)
      Set form parameter update strategy to the given value.
      Overrides:
      formParamsUpdateStrategy in class io.restassured.config.ParamConfig
      Parameters:
      updateStrategy - The update strategy to use for form parameters
      Returns:
      A new instance of MockMvcParamConfig

    • requestParamsUpdateStrategy

      public MockMvcParamConfig requestParamsUpdateStrategy(io.restassured.config.ParamConfig.UpdateStrategy updateStrategy)
      Set request parameter update strategy to the given value. A "request parameter" is a parameter that will turn into a form or query parameter depending on the request. For example:

      given().param("name", "value").when().get("/x"). ..

      Overrides:
      requestParamsUpdateStrategy in class io.restassured.config.ParamConfig
      Parameters:
      updateStrategy - The update strategy to use for request parameters
      Returns:
      A new instance of MockMvcParamConfig

    • queryParamsUpdateStrategy

      public MockMvcParamConfig queryParamsUpdateStrategy(io.restassured.config.ParamConfig.UpdateStrategy updateStrategy)
      Set query parameter update strategy to the given value.
      Overrides:
      queryParamsUpdateStrategy in class io.restassured.config.ParamConfig
      Parameters:
      updateStrategy - The update strategy to use for query parameters
      Returns:
      A new instance of MockMvcParamConfig

    • attributeUpdateStrategy

      public MockMvcParamConfig attributeUpdateStrategy(io.restassured.config.ParamConfig.UpdateStrategy updateStrategy)
      Set attribute update strategy to the given value.
      Parameters:
      updateStrategy - The update strategy to use for attribute parameters
      Returns:
      A new instance of MockMvcParamConfig

    • sessionAttributesUpdateStrategy

      public MockMvcParamConfig sessionAttributesUpdateStrategy(io.restassured.config.ParamConfig.UpdateStrategy updateStrategy)
      Set session parameter update strategy to the given value.
      Parameters:
      updateStrategy - The update strategy to use for session parameters
      Returns:
      A new instance of MockMvcParamConfig

    • attributeUpdateStrategy

      public io.restassured.config.ParamConfig.UpdateStrategy attributeUpdateStrategy()
      Returns:
      The update strategy for form parameters

    • formParamsUpdateStrategy

      public io.restassured.config.ParamConfig.UpdateStrategy formParamsUpdateStrategy()
      Overrides:
      formParamsUpdateStrategy in class io.restassured.config.ParamConfig
      Returns:
      The update strategy for form parameters

    • requestParamsUpdateStrategy

      public io.restassured.config.ParamConfig.UpdateStrategy requestParamsUpdateStrategy()
      Overrides:
      requestParamsUpdateStrategy in class io.restassured.config.ParamConfig
      Returns:
      The update strategy for request parameters

    • queryParamsUpdateStrategy

      public io.restassured.config.ParamConfig.UpdateStrategy queryParamsUpdateStrategy()
      Overrides:
      queryParamsUpdateStrategy in class io.restassured.config.ParamConfig
      Returns:
      The update strategy for query parameters

    • pathParamsUpdateStrategy

      public io.restassured.config.ParamConfig.UpdateStrategy pathParamsUpdateStrategy()
      Overrides:
      pathParamsUpdateStrategy in class io.restassured.config.ParamConfig
      Returns:
      The update strategy for path parameters

    • sessionAttributesUpdateStrategy

      public io.restassured.config.ParamConfig.UpdateStrategy sessionAttributesUpdateStrategy()
      Returns:
      The update strategy for query parameters

    • isUserConfigured

      public boolean isUserConfigured()
      Specified by:
      isUserConfigured in interface io.restassured.config.Config
      Overrides:
      isUserConfigured in class io.restassured.config.ParamConfig

    • paramConfig

      public static MockMvcParamConfig paramConfig()
      Returns:
      A static way to create a new MockMvcParamConfig instance without calling "new" explicitly. Mainly for syntactic sugar.

    • and

      public MockMvcParamConfig and()
      Syntactic sugar.
      Overrides:
      and in class io.restassured.config.ParamConfig
      Returns:
      The same MockMvcParamConfig instance.

    • with

      public MockMvcParamConfig with()
      Syntactic sugar.
      Overrides:
      with in class io.restassured.config.ParamConfig
      Returns:
      The same MockMvcParamConfig instance.