io.restassured.config

Class ConnectionConfig

java.lang.Object

io.restassured.config.ConnectionConfig

All Implemented Interfaces:

Config

public class ConnectionConfig
extends Object
implements Config

Lets you configure connection settings for REST Assured. For example if you want to force-close the Apache HTTP Client connection after each response. You may want to do this if you make a lot of fast consecutive requests with small amount of data in the response. How ever if you're downloading large amount of (chunked) data you must not close connections after each response. By default connections are not closed after each response.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectionConfig.CloseIdleConnectionConfig Close open connections that have idled for the amount of time specified in this config.

Constructor Summary

Constructors

Constructor and Description
ConnectionConfig() Create a new connection configuration that doesn't close the HTTP connections after each response.
ConnectionConfig(ConnectionConfig.CloseIdleConnectionConfig closeIdleConnectionConfig) Create a new Connection configuration with the supplied settings.

Method Summary

Modifier and Type	Method and Description
ConnectionConfig	and() Syntactic sugar.
ConnectionConfig.CloseIdleConnectionConfig	closeIdleConnectionConfig()
ConnectionConfig	closeIdleConnectionsAfterEachResponse() Close open connections after each response.
ConnectionConfig	closeIdleConnectionsAfterEachResponseAfter(ConnectionConfig.CloseIdleConnectionConfig closeIdleConnectionConfig) Close open connections that have idled for the amount of time specified in this config after each response.
ConnectionConfig	closeIdleConnectionsAfterEachResponseAfter(long idleTime, TimeUnit timeUnit) Close open connections that have idled for the amount of time specified in this config after each response.
static ConnectionConfig	connectionConfig()
ConnectionConfig	dontCloseIdleConnectionsAfterEachResponse() Don't close idle connections after each request.
boolean	isUserConfigured()
boolean	shouldCloseIdleConnectionsAfterEachResponse()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionConfig

public ConnectionConfig()

Create a new connection configuration that doesn't close the HTTP connections after each response.

ConnectionConfig

public ConnectionConfig(ConnectionConfig.CloseIdleConnectionConfig closeIdleConnectionConfig)

Create a new Connection configuration with the supplied settings.

Parameters:

closeIdleConnectionConfig - Configures REST Assured to close idle connections after each response. If null (default) then connections are not close after each response.

Method Detail

closeIdleConnectionsAfterEachResponse

public ConnectionConfig closeIdleConnectionsAfterEachResponse()

Close open connections after each response. This is required if you plan to make a lot of consecutive requests with small response bodies. It can also be enabled if you never receive chunked HTTP responses.

closeIdleConnectionsAfterEachResponseAfter

public ConnectionConfig closeIdleConnectionsAfterEachResponseAfter(long idleTime,
                                                                   TimeUnit timeUnit)

Close open connections that have idled for the amount of time specified in this config after each response.

Parameters:

idleTime - The idle time of connections to be closed

timeUnit - The time unit to for idleTime

Returns:

A new ConnectionConfig instance with the updated configuration

closeIdleConnectionsAfterEachResponseAfter

public ConnectionConfig closeIdleConnectionsAfterEachResponseAfter(ConnectionConfig.CloseIdleConnectionConfig closeIdleConnectionConfig)

Close open connections that have idled for the amount of time specified in this config after each response.

Parameters:

closeIdleConnectionConfig - The close connection configuration.

Returns:

A new ConnectionConfig instance with the updated configuration

dontCloseIdleConnectionsAfterEachResponse

public ConnectionConfig dontCloseIdleConnectionsAfterEachResponse()

Don't close idle connections after each request. This is the default configuration. If you downloading large amount of data using HTTP chunking this setting is required.

Returns:

A new ConnectionConfig instance with the updated configuration

closeIdleConnectionConfig

public ConnectionConfig.CloseIdleConnectionConfig closeIdleConnectionConfig()

Returns:

The close connection configuration

shouldCloseIdleConnectionsAfterEachResponse

public boolean shouldCloseIdleConnectionsAfterEachResponse()

connectionConfig

public static ConnectionConfig connectionConfig()

Returns:

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

and

public ConnectionConfig and()

Syntactic sugar.

Returns:

The same connection config instance.

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.