io.restassured.config

Class EncoderConfig

java.lang.Object

io.restassured.config.EncoderConfig

All Implemented Interfaces:

Config

public class EncoderConfig
extends Object
implements Config

Allows you to specify configuration for the encoder

Constructor Summary

Constructors

Constructor and Description
EncoderConfig() Configure the encoder config to use "ISO-8859-1" for content encoding and UTF-8.
EncoderConfig(String defaultContentCharset, String defaultQueryParameterCharset)

Method Summary

Modifier and Type	Method and Description
EncoderConfig	and() Syntactic sugar.
EncoderConfig	appendDefaultContentCharsetToContentTypeIfUndefined(boolean shouldAddDefaultContentCharsetToContentTypeIfMissing) Tells whether REST Assured should automatically append the content charset to the content-type header if not defined explicitly.
Map<String,ContentType>	contentEncoders()
EncoderConfig	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
EncoderConfig	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)
EncoderConfig	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
EncoderConfig	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()
EncoderConfig	defaultContentCharset(Charset charset) Specify the default charset for the body/content in the request specification
EncoderConfig	defaultContentCharset(String charset) Specify the default charset for the body/content in the request specification
String	defaultQueryParameterCharset()
EncoderConfig	defaultQueryParameterCharset(Charset charset) Specify the default charset for query parameters
EncoderConfig	defaultQueryParameterCharset(String charset) Specify the default charset for query parameters
EncoderConfig	encodeContentTypeAs(String contentType, ContentType encoder) Encodes the content (body) of the request specified with the given contentType with the same encoder used by the supplied encoder.
static EncoderConfig	encoderConfig()
boolean	hasContentEncoders()
boolean	hasDefaultCharsetForContentType(String contentType)
boolean	isUserConfigured()
boolean	shouldAppendDefaultContentCharsetToContentTypeIfUndefined() Tells whether REST Assured should automatically append the content charset to the content-type header if not defined explicitly.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncoderConfig

public EncoderConfig()

Configure the encoder config to use "ISO-8859-1" for content encoding and UTF-8. for query parameter encoding.

The reason for choosing UTF-8 as default for query parameters even though US-ASCII is standard according to the URI Syntax specification is that it's nowadays recommended by w3 to use UTF-8. Different web servers seem to take different approaches though, for example Jetty uses UTF-8 as default but Tomcat uses US-ASCII. Since REST Assured is a test framework first and Jetty is more popular for testing REST Assured uses UTF-8.

EncoderConfig

public EncoderConfig(String defaultContentCharset,
                     String defaultQueryParameterCharset)

Method Detail

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 default content charset for all content-types (unless specified in defaultCharsetForContentType(String).

defaultQueryParameterCharset

public String defaultQueryParameterCharset()

Returns:

The default query parameter charset

defaultCharsetForContentType

public EncoderConfig 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 EncoderConfig

defaultCharsetForContentType

public EncoderConfig 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 EncoderConfig

defaultCharsetForContentType

public EncoderConfig 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 EncoderConfig

defaultCharsetForContentType

public EncoderConfig 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 EncoderConfig

defaultContentCharset

public EncoderConfig defaultContentCharset(Charset charset)

Specify the default charset for the body/content in the request specification

Parameters:

charset - The charset to use.

Returns:

A new instance of EncoderConfig

defaultQueryParameterCharset

public EncoderConfig defaultQueryParameterCharset(String charset)

Specify the default charset for query parameters

Parameters:

charset - The charset to use.

Returns:

A new instance of EncoderConfig

defaultQueryParameterCharset

public EncoderConfig defaultQueryParameterCharset(Charset charset)

Specify the default charset for query parameters

Parameters:

charset - The charset to use.

Returns:

A new instance of EncoderConfig

defaultContentCharset

public EncoderConfig defaultContentCharset(String charset)

Specify the default charset for the body/content in the request specification

Parameters:

charset - The charset to use.

Returns:

A new instance of EncoderConfig

appendDefaultContentCharsetToContentTypeIfUndefined

public EncoderConfig appendDefaultContentCharsetToContentTypeIfUndefined(boolean shouldAddDefaultContentCharsetToContentTypeIfMissing)

Tells whether REST Assured should automatically append the content charset to the content-type header if not defined explicitly.

Note that this does not affect multipart form data.

Default is true.

Parameters:

shouldAddDefaultContentCharsetToContentTypeIfMissing - Whether REST Assured should automatically append the content charset to the content-type header if not defined explicitly.

Returns:

A new EncoderConfig instance

shouldAppendDefaultContentCharsetToContentTypeIfUndefined

public boolean shouldAppendDefaultContentCharsetToContentTypeIfUndefined()

Tells whether REST Assured should automatically append the content charset to the content-type header if not defined explicitly.

Note that this does not affect multipart form data.

Returns:

true if REST Assured should automatically append the content charset to the content-type header if not defined explicitly.

encoderConfig

public static EncoderConfig encoderConfig()

Returns:

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

and

public EncoderConfig and()

Syntactic sugar.

Returns:

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

hasContentEncoders

public boolean hasContentEncoders()

See Also:

encodeContentTypeAs(String, ContentType)

contentEncoders

public Map<String,ContentType> contentEncoders()

Returns:

A map of all specified content encoders

See Also:

encodeContentTypeAs(String, ContentType)

encodeContentTypeAs

public EncoderConfig encodeContentTypeAs(String contentType,
                                         ContentType encoder)

Encodes the content (body) of the request specified with the given contentType with the same encoder used by the supplied encoder. This is useful only if REST Assured picks the wrong encoder (or can't recognize it) for the given content-type.

Parameters:

contentType - The content-type to encode with a specific encoder.

encoder - The encoder to use for the given content-type.

Returns:

A new EncoderConfig instance