io.restassured.config

Class DecoderConfig

java.lang.Object

io.restassured.config.DecoderConfig

All Implemented Interfaces:

Config

public class DecoderConfig
extends Object
implements Config

Allows you to specify configuration for the decoder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DecoderConfig.ContentDecoder Predefined content encoders in REST Assured.

Constructor Summary

Constructors

Constructor and Description
DecoderConfig() Configure the decoder config to use the default charset as specified by Charset.defaultCharset() for content decoding.
DecoderConfig(DecoderConfig.ContentDecoder contentDecoder, DecoderConfig.ContentDecoder... additionalContentDecoders) Configure the decoder config to use Charset.defaultCharset() for content decoding.
DecoderConfig(String defaultContentCharset) Configure the decoder config to use supplied defaultContentCharset for content decoding if a charset is not specified in the response.

Method Summary

Modifier and Type	Method and Description
DecoderConfig	and() Syntactic sugar.
List<DecoderConfig.ContentDecoder>	contentDecoders()
DecoderConfig	contentDecoders(DecoderConfig.ContentDecoder contentDecoder, DecoderConfig.ContentDecoder... additionalContentDecoders) Specify the content decoders that will be presented to the server when making a request (using the Accept-Encoding header).
static DecoderConfig	decoderConfig()
DecoderConfig	defaultCharsetForContentType(Charset charset, ContentType contentType) Specify the default charset to use for the specific content-type if it's not specified in the content-type header explicitly
DecoderConfig	defaultCharsetForContentType(Charset charset, String contentType) Specify the default charset to use for the specific content-type if it's not specified in the content-type header explicitly
String	defaultCharsetForContentType(ContentType contentType)
String	defaultCharsetForContentType(String contentType)
DecoderConfig	defaultCharsetForContentType(String charset, ContentType contentType) Specify the default charset to use for the specific content-type if it's not specified in the content-type header explicitly
DecoderConfig	defaultCharsetForContentType(String charset, String contentType) Specify the default charset to use for the specific content-type if it's not specified in the content-type header explicitly
String	defaultContentCharset()
DecoderConfig	defaultContentCharset(Charset charset) Specify the default charset of the content in the response that's assumed if no charset is explicitly specified in the response.
DecoderConfig	defaultContentCharset(String charset) Specify the default charset of the content in the response that's assumed if no charset is explicitly specified in the response.
boolean	hasDefaultCharsetForContentType(String contentType)
boolean	isUserConfigured()
DecoderConfig	noContentDecoders() Specify that no content decoders should be used by REST Assured.
boolean	shouldUseNoWrapForInflateDecoding()
DecoderConfig	useNoWrapForInflateDecoding(boolean nowrap) If the parameter 'nowrap' is true then the ZLIB header and checksum fields will not be used.
DecoderConfig	with() Syntactic sugar.

Methods inherited from class java.lang.Object

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

Constructor Detail

DecoderConfig

public DecoderConfig()

Configure the decoder config to use the default charset as specified by Charset.defaultCharset() for content decoding.

DecoderConfig

public DecoderConfig(String defaultContentCharset)

Configure the decoder config to use supplied defaultContentCharset for content decoding if a charset is not specified in the response.

Parameters:

defaultContentCharset - The charset to use if not specifically specified in the response.

DecoderConfig

public DecoderConfig(DecoderConfig.ContentDecoder contentDecoder,
                     DecoderConfig.ContentDecoder... additionalContentDecoders)

Configure the decoder config to use Charset.defaultCharset() for content decoding. Also specify the content decoders that will be presented to the server when making a request (using the Accept-Encoding header). If the server supports any of these encodings then REST Assured will automatically perform decoding of the response accordingly.

By default DecoderConfig.ContentDecoder.GZIP and DecoderConfig.ContentDecoder.DEFLATE are used.

Parameters:

contentDecoder - The first content decoder

additionalContentDecoders - Optional additional content decoders

Method Detail

defaultCharsetForContentType

public DecoderConfig defaultCharsetForContentType(String charset,
                                                  String contentType)

Specify the default charset to use for the specific content-type if it's not specified in the content-type header explicitly

Parameters:

charset - The charset to use as default (unless specified explicitly)

contentType - The content-type

Returns:

A new instance of DecoderConfig

defaultCharsetForContentType

public DecoderConfig defaultCharsetForContentType(Charset charset,
                                                  String contentType)

Specify the default charset to use for the specific content-type if it's not specified in the content-type header explicitly

Parameters:

charset - The charset to use as default (unless specified explicitly)

contentType - The content-type

Returns:

A new instance of DecoderConfig

defaultCharsetForContentType

public DecoderConfig defaultCharsetForContentType(Charset charset,
                                                  ContentType contentType)

Specify the default charset to use for the specific content-type if it's not specified in the content-type header explicitly

Parameters:

charset - The charset to use as default (unless specified explicitly)

contentType - The content-type

Returns:

A new instance of DecoderConfig

defaultCharsetForContentType

public DecoderConfig defaultCharsetForContentType(String charset,
                                                  ContentType contentType)

Specify the default charset to use for the specific content-type if it's not specified in the content-type header explicitly

Parameters:

charset - The charset to use as default (unless specified explicitly)

contentType - The content-type

Returns:

A new instance of DecoderConfig

defaultCharsetForContentType

public String defaultCharsetForContentType(String contentType)

Returns:

The default charset for a specific content-type. It will have precedence over defaultContentCharset().

defaultCharsetForContentType

public String defaultCharsetForContentType(ContentType contentType)

Returns:

A map that contains default charset for a specific content-type. It will have precedence over defaultContentCharset().

hasDefaultCharsetForContentType

public boolean hasDefaultCharsetForContentType(String contentType)

Returns:

A map that contains default charset for a specific content-type. It will have precedence over defaultContentCharset().

defaultContentCharset

public String defaultContentCharset()

Returns:

The configured default content charset that'll be used by REST Assured if no charset is specified in the response.

contentDecoders

public List<DecoderConfig.ContentDecoder> contentDecoders()

Returns:

The configured content decoders.

useNoWrapForInflateDecoding

public DecoderConfig useNoWrapForInflateDecoding(boolean nowrap)

If the parameter 'nowrap' is true then the ZLIB header and checksum fields will not be used. This provides compatibility with the compression format used by both GZIP and PKZIP.

Note: When using the 'nowrap' option it is also necessary to provide an extra "dummy" byte as input. This is required by the ZLIB native library in order to support certain optimizations.

Setting no wrap to true is required when communicating with servers not using RFC 1950 (such as PHP which uses RFC 1951). See stackoverflow for more details.

Default is .

Parameters:

nowrap - if true then support GZIP compatible compression

Returns:

A new instance of the DecoderConfig.

shouldUseNoWrapForInflateDecoding

public boolean shouldUseNoWrapForInflateDecoding()

Returns:

true if no wrap should be used for inflate encoded streams.

See Also:

useNoWrapForInflateDecoding(boolean)

defaultContentCharset

public DecoderConfig defaultContentCharset(String charset)

Specify the default charset of the content in the response that's assumed if no charset is explicitly specified in the response.

Parameters:

charset - The expected charset

Returns:

A new instance of the DecoderConfig.

defaultContentCharset

public DecoderConfig defaultContentCharset(Charset charset)

Specify the default charset of the content in the response that's assumed if no charset is explicitly specified in the response.

Parameters:

charset - The expected charset

Returns:

A new instance of the DecoderConfig.

contentDecoders

public DecoderConfig contentDecoders(DecoderConfig.ContentDecoder contentDecoder,
                                     DecoderConfig.ContentDecoder... additionalContentDecoders)

Specify the content decoders that will be presented to the server when making a request (using the Accept-Encoding header). If the server supports any of these encodings then REST Assured will automatically perform decoding of the response accordingly.

By default DecoderConfig.ContentDecoder.GZIP and DecoderConfig.ContentDecoder.DEFLATE are used.

Parameters:

contentDecoder - The first content decoder

additionalContentDecoders - Optional additional content decoders

Returns:

A new instance of the DecoderConfig.

noContentDecoders

public DecoderConfig noContentDecoders()

Specify that no content decoders should be used by REST Assured.

Returns:

A new instance of the DecoderConfig.

See Also:

contentDecoders(DecoderConfig.ContentDecoder, DecoderConfig.ContentDecoder...)

decoderConfig

public static DecoderConfig decoderConfig()

Returns:

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

and

public DecoderConfig and()

Syntactic sugar.

Returns:

The same decoder config instance.

with

public DecoderConfig with()

Syntactic sugar.

Returns:

The same decoder 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.