org.springframework.http.client

Class MultipartBodyBuilder

java.lang.Object

org.springframework.http.client.MultipartBodyBuilder

public final class MultipartBodyBuilder
extends Object

A mutable builder for multipart form bodies. For example:

 MultipartBodyBuilder builder = new MultipartBodyBuilder();
 builder.part("form field", "form value");

 Resource image = new ClassPathResource("image.jpg");
 builder.part("image", image).header("Baz", "Qux");

 MultiValueMap> multipartBody = builder.build();
 // use multipartBody with RestTemplate or WebClient
 

Since:

5.0.2

Author:

Arjen Poutsma, Rossen Stoyanchev

See Also:

RFC 7578

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MultipartBodyBuilder.PartBuilder Builder that allows for further customization of part headers.
static class	MultipartBodyBuilder.PublisherEntity<T,P extends org.reactivestreams.Publisher<T>> Specialization of HttpEntity for use with a Publisher-based body, for which we also need to keep track of the element type.

Constructor Summary

Constructors

Constructor and Description
MultipartBodyBuilder() Creates a new, empty instance of the MultipartBodyBuilder.

Method Summary

Modifier and Type	Method and Description
<T,P extends org.reactivestreams.Publisher<T>> MultipartBodyBuilder.PartBuilder	asyncPart(String name, P publisher, Class<T> elementClass) Add an asynchronous part with Publisher-based content.
<T,P extends org.reactivestreams.Publisher<T>> MultipartBodyBuilder.PartBuilder	asyncPart(String name, P publisher, ParameterizedTypeReference<T> typeReference) Variant of asyncPart(String, Publisher, Class) that accepts a ParameterizedTypeReference for the element type, which allows specifying generic type information.
MultiValueMap<String,HttpEntity<?>>	build() Return a MultiValueMap with the configured parts.
MultipartBodyBuilder.PartBuilder	part(String name, Object part) Add a part from an Object.
MultipartBodyBuilder.PartBuilder	part(String name, Object part, MediaType contentType) Variant of part(String, Object) that also accepts a MediaType which is used to determine how to encode the part.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipartBodyBuilder

public MultipartBodyBuilder()

Creates a new, empty instance of the MultipartBodyBuilder.

Method Detail

part

public MultipartBodyBuilder.PartBuilder part(String name,
                                             Object part)

Add a part from an Object.

Parameters:

name - the name of the part to add

part - the part data

Returns:

builder that allows for further customization of part headers

part

public MultipartBodyBuilder.PartBuilder part(String name,
                                             Object part,
                                             @Nullable
                                             MediaType contentType)

Variant of part(String, Object) that also accepts a MediaType which is used to determine how to encode the part.

Parameters:

name - the name of the part to add

part - the part data

contentType - the media type for the part

Returns:

builder that allows for further customization of part headers

asyncPart

public <T,P extends org.reactivestreams.Publisher<T>> MultipartBodyBuilder.PartBuilder asyncPart(String name,
                                                                                                 P publisher,
                                                                                                 Class<T> elementClass)

Add an asynchronous part with Publisher-based content.

Parameters:

name - the name of the part to add

publisher - the part contents

elementClass - the type of elements contained in the publisher

Returns:

builder that allows for further customization of part headers

asyncPart

public <T,P extends org.reactivestreams.Publisher<T>> MultipartBodyBuilder.PartBuilder asyncPart(String name,
                                                                                                 P publisher,
                                                                                                 ParameterizedTypeReference<T> typeReference)

Variant of asyncPart(String, Publisher, Class) that accepts a ParameterizedTypeReference for the element type, which allows specifying generic type information.

Parameters:

name - the name of the part to add

publisher - the part contents

typeReference - the type of elements contained in the publisher

Returns:

builder that allows for further customization of part headers

build

public MultiValueMap<String,HttpEntity<?>> build()

Return a MultiValueMap with the configured parts.