com.jayway.restassured.config

Class EncoderConfig

java.lang.Object

com.jayway.restassured.config.EncoderConfig

public class EncoderConfig
extends Object

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

Methods

Modifier and Type	Method and Description
EncoderConfig	and() Syntactic sugar.
EncoderConfig	appendDefaultContentCharsetToStreamingContentTypeIfUndefined(boolean shouldAddDefaultContentCharsetToContentTypeIfMissing) Tells whether REST Assured should automatically append the content charset to the content-type header if not defined explicitly.
String	defaultContentCharset()
EncoderConfig	defaultContentCharset(String charset)
String	defaultQueryParameterCharset()
EncoderConfig	defaultQueryParameterCharset(String charset)
static EncoderConfig	encoderConfig()
boolean	shouldAppendDefaultContentCharsetToStreamingContentTypeIfUndefined() 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

defaultContentCharset

public String defaultContentCharset()

defaultQueryParameterCharset

public String defaultQueryParameterCharset()

defaultContentCharset

public EncoderConfig defaultContentCharset(String charset)

defaultQueryParameterCharset

public EncoderConfig defaultQueryParameterCharset(String charset)

appendDefaultContentCharsetToStreamingContentTypeIfUndefined

public EncoderConfig appendDefaultContentCharsetToStreamingContentTypeIfUndefined(boolean shouldAddDefaultContentCharsetToContentTypeIfMissing)

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

Note that this is only applicable for streaming data, such as byte arrays and input streams and 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

shouldAppendDefaultContentCharsetToStreamingContentTypeIfUndefined

public boolean shouldAppendDefaultContentCharsetToStreamingContentTypeIfUndefined()

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

Note that this is only applicable for streaming data, such as byte arrays and input streams and 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.