com.jayway.restassured.config

Class RestAssuredConfig

java.lang.Object

com.jayway.restassured.config.RestAssuredConfig

All Implemented Interfaces:

Config

public class RestAssuredConfig
extends Object
implements Config

Main configuration for REST Assured that allows you to configure advanced settings such as redirections and HTTP Client parameters.

Usage example:

  RestAssured.config = config().redirect(redirectConfig().followRedirects(false));
 

Constructor Summary

Constructors

Constructor and Description
RestAssuredConfig() Create a new RestAssuredConfiguration with the default configurations.
RestAssuredConfig(RedirectConfig redirectConfig, HttpClientConfig httpClientConfig, LogConfig logConfig, EncoderConfig encoderConfig, DecoderConfig decoderConfig, SessionConfig sessionConfig, ObjectMapperConfig objectMapperConfig, ConnectionConfig connectionConfig, JsonConfig jsonConfig, XmlConfig xmlConfig, SSLConfig sslConfig, MatcherConfig matcherConfig, HeaderConfig headerConfig) Create a new RestAssuredConfiguration with the supplied RedirectConfig, HttpClientConfig, LogConfig, EncoderConfig, DecoderConfig, SessionConfig, ObjectMapperConfig, ConnectionConfig, JsonConfig, XmlConfig, SSLConfig, MatcherConfig.

Method Summary

Modifier and Type	Method and Description
RestAssuredConfig	and() Syntactic sugar.
static RestAssuredConfig	config()
RestAssuredConfig	connectionConfig(ConnectionConfig connectionConfig) Set the connection config.
RestAssuredConfig	decoderConfig(DecoderConfig decoderConfig) Set the Decoder config.
RestAssuredConfig	encoderConfig(EncoderConfig encoderConfig) Set the Encoder config.
ConnectionConfig	getConnectionConfig()
DecoderConfig	getDecoderConfig()
EncoderConfig	getEncoderConfig()
HeaderConfig	getHeaderConfig()
HttpClientConfig	getHttpClientConfig()
JsonConfig	getJsonConfig()
LogConfig	getLogConfig()
MatcherConfig	getMatcherConfig()
ObjectMapperConfig	getObjectMapperConfig()
RedirectConfig	getRedirectConfig()
SessionConfig	getSessionConfig()
SSLConfig	getSSLConfig()
XmlConfig	getXmlConfig()
RestAssuredConfig	headerConfig(HeaderConfig headerConfig) Set the Header config.
RestAssuredConfig	httpClient(HttpClientConfig httpClientConfig) Set the HTTP Client config.
boolean	isUserConfigured()
RestAssuredConfig	jsonConfig(JsonConfig jsonConfig) Set the Json config.
RestAssuredConfig	logConfig(LogConfig logConfig) Set the Log config.
RestAssuredConfig	matcherConfig(MatcherConfig matcherConfig) Set the Matcher config.
static RestAssuredConfig	newConfig()
RestAssuredConfig	objectMapperConfig(ObjectMapperConfig objectMapperConfig) Set the object mapper config.
RestAssuredConfig	redirect(RedirectConfig redirectConfig) Set the redirect config.
RestAssuredConfig	sessionConfig(SessionConfig sessionConfig) Set the session config.
RestAssuredConfig	set() Syntactic sugar.
RestAssuredConfig	sslConfig(SSLConfig sslConfig) Set the SSL config.
RestAssuredConfig	with() Syntactic sugar.
RestAssuredConfig	xmlConfig(XmlConfig xmlConfig) Set the Xml config.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestAssuredConfig

public RestAssuredConfig()

Create a new RestAssuredConfiguration with the default configurations.

RestAssuredConfig

public RestAssuredConfig(RedirectConfig redirectConfig,
                         HttpClientConfig httpClientConfig,
                         LogConfig logConfig,
                         EncoderConfig encoderConfig,
                         DecoderConfig decoderConfig,
                         SessionConfig sessionConfig,
                         ObjectMapperConfig objectMapperConfig,
                         ConnectionConfig connectionConfig,
                         JsonConfig jsonConfig,
                         XmlConfig xmlConfig,
                         SSLConfig sslConfig,
                         MatcherConfig matcherConfig,
                         HeaderConfig headerConfig)

Create a new RestAssuredConfiguration with the supplied RedirectConfig, HttpClientConfig, LogConfig, EncoderConfig, DecoderConfig, SessionConfig, ObjectMapperConfig, ConnectionConfig, JsonConfig, XmlConfig, SSLConfig, MatcherConfig.

Method Detail

redirect

public RestAssuredConfig redirect(RedirectConfig redirectConfig)

Set the redirect config.

Parameters:

redirectConfig - The RedirectConfig to set

Returns:

An updated RestAssuredConfiguration

httpClient

public RestAssuredConfig httpClient(HttpClientConfig httpClientConfig)

Set the HTTP Client config.

Parameters:

httpClientConfig - The HttpClientConfig to set

Returns:

An updated RestAssuredConfiguration

logConfig

public RestAssuredConfig logConfig(LogConfig logConfig)

Set the Log config.

Parameters:

logConfig - The LogConfig to set

Returns:

An updated RestAssuredConfiguration

encoderConfig

public RestAssuredConfig encoderConfig(EncoderConfig encoderConfig)

Set the Encoder config.

Parameters:

encoderConfig - The EncoderConfig to set

Returns:

An updated RestAssuredConfiguration

decoderConfig

public RestAssuredConfig decoderConfig(DecoderConfig decoderConfig)

Set the Decoder config.

Parameters:

decoderConfig - The DecoderConfig to set

Returns:

An updated RestAssuredConfiguration

sessionConfig

public RestAssuredConfig sessionConfig(SessionConfig sessionConfig)

Set the session config.

Parameters:

sessionConfig - The SessionConfig to set

Returns:

An updated RestAssuredConfiguration

objectMapperConfig

public RestAssuredConfig objectMapperConfig(ObjectMapperConfig objectMapperConfig)

Set the object mapper config.

Parameters:

objectMapperConfig - The ObjectMapperConfig to set

Returns:

An updated RestAssuredConfiguration

connectionConfig

public RestAssuredConfig connectionConfig(ConnectionConfig connectionConfig)

Set the connection config.

Parameters:

connectionConfig - The ConnectionConfig to set

Returns:

An updated RestAssuredConfiguration

jsonConfig

public RestAssuredConfig jsonConfig(JsonConfig jsonConfig)

Set the Json config.

Parameters:

jsonConfig - The JsonConfig to set

Returns:

An updated RestAssuredConfiguration

xmlConfig

public RestAssuredConfig xmlConfig(XmlConfig xmlConfig)

Set the Xml config.

Parameters:

xmlConfig - The XmlConfig to set

Returns:

An updated RestAssuredConfiguration

sslConfig

public RestAssuredConfig sslConfig(SSLConfig sslConfig)

Set the SSL config.

Parameters:

sslConfig - The SSLConfig to set

Returns:

An updated RestAssuredConfiguration

matcherConfig

public RestAssuredConfig matcherConfig(MatcherConfig matcherConfig)

Set the Matcher config.

Parameters:

matcherConfig - The MatcherConfig to set

Returns:

An updated RestAssuredConfiguration

headerConfig

public RestAssuredConfig headerConfig(HeaderConfig headerConfig)

Set the Header config.

Parameters:

headerConfig - The HeaderConfig to set

Returns:

An updated RestAssuredConfiguration

and

public RestAssuredConfig and()

Syntactic sugar.

Returns:

The same RestAssuredConfiguration instance.

set

public RestAssuredConfig set()

Syntactic sugar.

Returns:

The same RestAssuredConfiguration instance.

with

public RestAssuredConfig with()

Syntactic sugar.

Returns:

The same RestAssuredConfiguration instance.

getRedirectConfig

public RedirectConfig getRedirectConfig()

Returns:

The RedirectConfig

getLogConfig

public LogConfig getLogConfig()

Returns:

The LogConfig

getHttpClientConfig

public HttpClientConfig getHttpClientConfig()

Returns:

The HttpClientConfig

getEncoderConfig

public EncoderConfig getEncoderConfig()

Returns:

The EncoderConfig

getDecoderConfig

public DecoderConfig getDecoderConfig()

Returns:

The DecoderConfig

getSessionConfig

public SessionConfig getSessionConfig()

Returns:

The SessionConfig

getObjectMapperConfig

public ObjectMapperConfig getObjectMapperConfig()

Returns:

The ObjectMapperConfig

getConnectionConfig

public ConnectionConfig getConnectionConfig()

Returns:

The ConnectionConfig

getJsonConfig

public JsonConfig getJsonConfig()

Returns:

The JsonPath Config

getXmlConfig

public XmlConfig getXmlConfig()

Returns:

The Xml Config

getSSLConfig

public SSLConfig getSSLConfig()

Returns:

The SSL Config

getMatcherConfig

public MatcherConfig getMatcherConfig()

Returns:

The matcher config

getHeaderConfig

public HeaderConfig getHeaderConfig()

Returns:

The header config

newConfig

public static RestAssuredConfig newConfig()

Returns:

A static way to create a new RestAssuredConfiguration instance without calling "new" explicitly. Mainly for syntactic sugar.

config

public static RestAssuredConfig config()

Returns:

A static way to create a new RestAssuredConfiguration instance without calling "new" explicitly. Mainly for syntactic sugar.

isUserConfigured

public boolean isUserConfigured()

Specified by:

isUserConfigured in interface Config

Returns:

true if this instance is carrying any config that is user configured.