io.restassured.config

Class HeaderConfig

java.lang.Object

io.restassured.config.HeaderConfig

All Implemented Interfaces:

Config

public class HeaderConfig
extends Object
implements Config

Allow you to configure settings for headers.

Constructor Summary

Constructors

Constructor and Description
HeaderConfig() Create a new instance of HeaderConfig.

Method Summary

Modifier and Type	Method and Description
static HeaderConfig	headerConfig() Syntactic sugar, same as calling new HeaderConfig().
boolean	isUserConfigured()
HeaderConfig	mergeHeadersWithName(String headerName, String... additionalHeaderNames) Define headers that should be be merged instead of overwritten when adding headers or using request specifications.
HeaderConfig	overwriteHeadersWithName(String headerName, String... additionalHeaderNames) Define headers that should be overwritten instead of merged adding headers or using request specifications.
boolean	shouldOverwriteHeaderWithName(String headerName) Returns whether or not the specified header should be returned

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeaderConfig

public HeaderConfig()

Create a new instance of HeaderConfig.

Method Detail

overwriteHeadersWithName

public HeaderConfig overwriteHeadersWithName(String headerName,
                                             String... additionalHeaderNames)

Define headers that should be overwritten instead of merged adding headers or using request specifications. Note that by default all headers are merged except the and headers. For example, if the header with name header1 is not marked as overwritable (default) and you do the following:

 given().header("header1", "value1").header("header1, "value2"). ..
 

Then header1 will be sent twice in the request:

 header1: value1
 header1: value2
 

If you configure header1 to be overwritable by doing:

 given().
         config(RestAssured.config().headerConfig(headerConfig().overwriteHeadersWithName("header1")).
         header("header1", "value1").
         header("header1", "value2").
         ...
 

then header1 will only be sent once:

 header1: value2
 

Parameters:

headerName - The header name to overwrite.

additionalHeaderNames - Additional header names to overwrite (optional).

Returns:

A new instance of HeaderConfig.

mergeHeadersWithName

public HeaderConfig mergeHeadersWithName(String headerName,
                                         String... additionalHeaderNames)

Define headers that should be be merged instead of overwritten when adding headers or using request specifications. Note that by default all headers are merged except the and headers. This method is thus mainly used to change to merge behavior for headers that by default are overwritten or the revert changes of a request specification merge.

Parameters:

headerName - The header name to merge.

additionalHeaderNames - Additional header names to merge (optional).

Returns:

A new instance of HeaderConfig.

shouldOverwriteHeaderWithName

public boolean shouldOverwriteHeaderWithName(String headerName)

Returns whether or not the specified header should be returned

Parameters:

headerName - The header name to check.

Returns:

true if header should be overwritten, false otherwise.

headerConfig

public static HeaderConfig headerConfig()

Syntactic sugar, same as calling new HeaderConfig().

Returns:

a new instance of HeaderConfig.

isUserConfigured

public boolean isUserConfigured()

Specified by:

isUserConfigured in interface Config

Returns:

true if this config instance has been explicitly configured by the user, false if it has the default values.