io.restassured.config

Class MultiPartConfig

java.lang.Object

io.restassured.config.MultiPartConfig

All Implemented Interfaces:

Config

public class MultiPartConfig
extends Object
implements Config

Enables default configuration of how to handle multi-parts.

Constructor Summary

Constructors

Constructor and Description
MultiPartConfig() Create a new MultiPartConfig with default control name equal to and default file name equal to and default subtype and default boundary null (which means it'll be automatically generated) and default charset US-ASCII.

Method Summary

Modifier and Type	Method and Description
MultiPartConfig	and() Syntactic sugar.
String	defaultBoundary() Get the default multipart boundary to use when sending multi-part data.
MultiPartConfig	defaultBoundary(String defaultBoundary) Specify an explicit default multipart boundary to use when sending multi-part data.
String	defaultCharset() Get the default multipart charset to use when sending multi-part data.
MultiPartConfig	defaultCharset(Charset defaultCharset) Specify a default charset to use for multi-parts (default is US-ASCII).
MultiPartConfig	defaultCharset(String defaultCharset) Specify a default charset to use for multi-parts (default is US-ASCII).
String	defaultControlName()
MultiPartConfig	defaultControlName(String defaultControlName) Specify the default control name to use if not defined explicitly in multi-part request.
String	defaultFileName()
MultiPartConfig	defaultFileName(String defaultFileName) Specify the default filename to use if not defined explicitly in multi-part request.
String	defaultSubtype()
MultiPartConfig	defaultSubtype(String defaultSubtype) Specify the default subtype to use if not defined explicitly in when making the multi-part request.
MultiPartConfig	emptyDefaultFileName() Specify default filename to be empty if not defined explicitly in multi-part request.
boolean	isUserConfigured()
static MultiPartConfig	multiPartConfig()
MultiPartConfig	with() Syntactic sugar.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiPartConfig

public MultiPartConfig()

Create a new MultiPartConfig with default control name equal to and default file name equal to and default subtype and default boundary null (which means it'll be automatically generated) and default charset US-ASCII.

Method Detail

defaultControlName

public MultiPartConfig defaultControlName(String defaultControlName)

Specify the default control name to use if not defined explicitly in multi-part request.

Default is

Parameters:

defaultControlName - The control name to use

Returns:

A new instance of MultiPartConfig

defaultFileName

public MultiPartConfig defaultFileName(String defaultFileName)

Specify the default filename to use if not defined explicitly in multi-part request.

Default is

Parameters:

defaultFileName - The file name to use

Returns:

A new instance of MultiPartConfig

defaultSubtype

public MultiPartConfig defaultSubtype(String defaultSubtype)

Specify the default subtype to use if not defined explicitly in when making the multi-part request. This will control how the Content-Type will be constructed for multipart requests when using REST Assured when no Content-Type header has been explicitly defined. For example if subtype is set to "mixed" then the Content-Type header will be "multipart/mixed" if not specified explicitly.

Default is

Parameters:

defaultSubtype - The default subtype to use in multipart requests. Default is .

Returns:

A new instance of MultiPartConfig

emptyDefaultFileName

public MultiPartConfig emptyDefaultFileName()

Specify default filename to be empty if not defined explicitly in multi-part request. This means that the "filename" field will not be added to the multi-part.

This is the same as calling defaultFileName(String) with null.

Returns:

A new instance of MultiPartConfig

defaultControlName

public String defaultControlName()

Returns:

The default control name that'll be used unless explicitly defined in multi-part request.

defaultFileName

public String defaultFileName()

Returns:

The default file name that'll be used unless explicitly defined in multi-part request.

defaultSubtype

public String defaultSubtype()

Returns:

The default subtype that'll be used unless explicitly defined in the Content-Type header.

defaultBoundary

public MultiPartConfig defaultBoundary(String defaultBoundary)

Specify an explicit default multipart boundary to use when sending multi-part data.

Parameters:

defaultBoundary - The boundary to set

Returns:

An updated MultiPartConfig

defaultCharset

public MultiPartConfig defaultCharset(String defaultCharset)

Specify a default charset to use for multi-parts (default is US-ASCII). This affects the encoding of the multipart body (such as the control name) but not the actual content (such as the a JSON or String document).

NOTE: This setting is only taken into account if HttpClientConfig.httpMultipartMode(HttpMultipartMode) is set to something other than HttpMultipartMode.STRICT (which is the default). So if you want this setting to apply you also need to explicitly change the multipart mode, for example:

 given().
         config(RestAssuredConfig.config()
                                 .httpClient(HttpClientConfig.httpClientConfig().httpMultipartMode(BROWSER_COMPATIBLE))
                                 .multiPartConfig(multiPartConfig().defaultCharset("UTF-8"))).
 when().
        post("/x"). ..
 

Parameters:

defaultCharset - The default charset to use.

Returns:

An updated MultiPartConfig

defaultCharset

public MultiPartConfig defaultCharset(Charset defaultCharset)

Specify a default charset to use for multi-parts (default is US-ASCII). This affects the encoding of the multipart body (such as the control name) but not the actual content (such as the a JSON or String document).

NOTE: This setting is only taken into account if HttpClientConfig.httpMultipartMode(HttpMultipartMode) is set to something other than HttpMultipartMode.STRICT (which is the default). So if you want this setting to apply you also need to explicitly change the multipart mode, for example:

 given().
         config(RestAssuredConfig.config()
                                 .httpClient(HttpClientConfig.httpClientConfig().httpMultipartMode(BROWSER_COMPATIBLE))
                                 .multiPartConfig(multiPartConfig().defaultCharset("UTF-8"))).
 when().
        post("/x"). ..
 

Parameters:

defaultCharset - The default charset to use.

Returns:

An updated MultiPartConfig

defaultBoundary

public String defaultBoundary()

Get the default multipart boundary to use when sending multi-part data.

Returns:

The boundary

defaultCharset

public String defaultCharset()

Get the default multipart charset to use when sending multi-part data.

Returns:

The boundary

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.

multiPartConfig

public static MultiPartConfig multiPartConfig()

Returns:

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

and

public MultiPartConfig and()

Syntactic sugar.

Returns:

The same MultiPartConfig instance.

with

public MultiPartConfig with()

Syntactic sugar.

Returns:

The same MultiPartConfig instance.