io.restassured.builder

Class MultiPartSpecBuilder

java.lang.Object

io.restassured.builder.MultiPartSpecBuilder

public class MultiPartSpecBuilder
extends Object

Builder for creating more advanced multi-part requests.

Usage example:

 File myFile = ..
 given().multiPart(new MultiPartSpecBuilder(myFile).with().fileName("some-name.txt").and().with().mimeType("application/vnd.mycompany+text").build()). ..
 

Constructor Summary

Constructors

Constructor and Description
MultiPartSpecBuilder(byte[] content) Create a new multi-part specification with control name equal to file.
MultiPartSpecBuilder(File content) Create a new multi-part specification with control name equal to file.
MultiPartSpecBuilder(InputStream content) Create a new multi-part specification with control name equal to file.
MultiPartSpecBuilder(Object content) Create a new multi-part specification with control name equal to file.
MultiPartSpecBuilder(Object content, ObjectMapper objectMapper) Create a new multi-part specification with control name equal to file.
MultiPartSpecBuilder(Object content, ObjectMapperType objectMapperType) Create a new multi-part specification with control name equal to file.
MultiPartSpecBuilder(String content) Create a new multi-part specification with control name equal to file.

Method Summary

Modifier and Type	Method and Description
MultiPartSpecBuilder	and() Just a method that can be used as syntactic sugar.
MultiPartSpecification	build()
MultiPartSpecBuilder	charset(Charset charset) Specify the charset for this charset.
MultiPartSpecBuilder	charset(String charset) Specify the charset for this charset.
MultiPartSpecBuilder	controlName(String controlName) Specify the control name of this multi-part.
MultiPartSpecBuilder	emptyFileName() Set the filename of the multi-part to empty (none).
MultiPartSpecBuilder	fileName(String fileName) Specify the file name of this multi-part.
MultiPartSpecBuilder	header(String name, String value) Add a header to this multipart specification.
MultiPartSpecBuilder	headers(Map<String,String> headers) Set the headers for this multipart specification (replaces previous headers)
MultiPartSpecBuilder	mimeType(String mimeType) Specify the mime-type for this multi-part.
MultiPartSpecBuilder	with() Just a method that can be used as syntactic sugar.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiPartSpecBuilder

public MultiPartSpecBuilder(Object content)

Create a new multi-part specification with control name equal to file.

Parameters:

content - The content to include in the multi-part specification.

MultiPartSpecBuilder

public MultiPartSpecBuilder(Object content,
                            ObjectMapperType objectMapperType)

Create a new multi-part specification with control name equal to file.

Parameters:

content - The content to include in the multi-part specification.

MultiPartSpecBuilder

public MultiPartSpecBuilder(Object content,
                            ObjectMapper objectMapper)

Create a new multi-part specification with control name equal to file.

Parameters:

content - The content to include in the multi-part specification.

MultiPartSpecBuilder

public MultiPartSpecBuilder(InputStream content)

Create a new multi-part specification with control name equal to file.

Parameters:

content - The content to include in the multi-part specification.

MultiPartSpecBuilder

public MultiPartSpecBuilder(String content)

Create a new multi-part specification with control name equal to file.

Parameters:

content - The content to include in the multi-part specification.

MultiPartSpecBuilder

public MultiPartSpecBuilder(byte[] content)

Create a new multi-part specification with control name equal to file.

Parameters:

content - The content to include in the multi-part specification.

MultiPartSpecBuilder

public MultiPartSpecBuilder(File content)

Create a new multi-part specification with control name equal to file.

Parameters:

content - The content to include in the multi-part specification.

Method Detail

controlName

public MultiPartSpecBuilder controlName(String controlName)

Specify the control name of this multi-part.

Parameters:

controlName - The control name to use. Default is file.

Returns:

An instance of MultiPartSpecBuilder

fileName

public MultiPartSpecBuilder fileName(String fileName)

Specify the file name of this multi-part. Note that this is only applicable for input streams, byte arrays and files and not string content.

Parameters:

fileName - The file name to use.

Returns:

An instance of MultiPartSpecBuilder

header

public MultiPartSpecBuilder header(String name,
                                   String value)

Add a header to this multipart specification.

Parameters:

name - The name of the header

value - The value of the header

Returns:

An instance of MultiPartSpecBuilder

headers

public MultiPartSpecBuilder headers(Map<String,String> headers)

Set the headers for this multipart specification (replaces previous headers)

Parameters:

headers - The headers as a map

Returns:

An instance of MultiPartSpecBuilder

mimeType

public MultiPartSpecBuilder mimeType(String mimeType)

Specify the mime-type for this multi-part.

Parameters:

mimeType - The mime-type

Returns:

An instance of MultiPartSpecBuilder

charset

public MultiPartSpecBuilder charset(String charset)

Specify the charset for this charset.

Parameters:

charset - The charset to use

Returns:

An instance of MultiPartSpecBuilder

with

public MultiPartSpecBuilder with()

Just a method that can be used as syntactic sugar.

Returns:

The same instance of the MultiPartSpecBuilder

and

public MultiPartSpecBuilder and()

Just a method that can be used as syntactic sugar.

Returns:

The same instance of the MultiPartSpecBuilder

charset

public MultiPartSpecBuilder charset(Charset charset)

Specify the charset for this charset.

Parameters:

charset - The charset to use

Returns:

An instance of MultiPartSpecBuilder

emptyFileName

public MultiPartSpecBuilder emptyFileName()

Set the filename of the multi-part to empty (none). This means that the "filename" part will be excluded in the multi-part request.

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

Returns:

An instance of MultiPartSpecBuilder

See Also:

fileName(String)

build

public MultiPartSpecification build()