com.jayway.restassured.config

Class EncoderConfig

java.lang.Object

com.jayway.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.
EncoderConfig	appendDefaultContentCharsetToStreamingContentTypeIfUndefined(boolean shouldAddDefaultContentCharsetToContentTypeIfMissing) Deprecated. Use appendDefaultContentCharsetToContentTypeIfUndefined(boolean) instead.
String	defaultContentCharset()
EncoderConfig	defaultContentCharset(Charset charset)
EncoderConfig	defaultContentCharset(String charset)
String	defaultQueryParameterCharset()
EncoderConfig	defaultQueryParameterCharset(Charset charset)
EncoderConfig	defaultQueryParameterCharset(String charset)
static EncoderConfig	encoderConfig()
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

defaultContentCharset

public String defaultContentCharset()

defaultQueryParameterCharset

public String defaultQueryParameterCharset()

defaultContentCharset

public EncoderConfig defaultContentCharset(String charset)

defaultContentCharset

public EncoderConfig defaultContentCharset(Charset charset)

defaultQueryParameterCharset

public EncoderConfig defaultQueryParameterCharset(String charset)

defaultQueryParameterCharset

public EncoderConfig defaultQueryParameterCharset(Charset charset)

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

appendDefaultContentCharsetToStreamingContentTypeIfUndefined

@Deprecated
public EncoderConfig appendDefaultContentCharsetToStreamingContentTypeIfUndefined(boolean shouldAddDefaultContentCharsetToContentTypeIfMissing)

Deprecated. Use appendDefaultContentCharsetToContentTypeIfUndefined(boolean) instead.

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

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.