org.springframework.http.client

Class MultipartBodyBuilder

java.lang.Object

org.springframework.http.client.MultipartBodyBuilder

public final class MultipartBodyBuilder
extends java.lang.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

See Also:

RFC 7578

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MultipartBodyBuilder.PartBuilder Builder interface that allows for customization of part headers.
static class	MultipartBodyBuilder.PublisherEntity<T,P extends org.reactivestreams.Publisher<T>> Specific subtype of HttpEntity for containing Publishers as body.

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(java.lang.String name, P publisher, java.lang.Class<T> elementClass) Adds a Publisher part to this builder, allowing for further header customization with the returned MultipartBodyBuilder.PartBuilder.
<T,P extends org.reactivestreams.Publisher<T>> MultipartBodyBuilder.PartBuilder	asyncPart(java.lang.String name, P publisher, ParameterizedTypeReference<T> typeReference) Adds a Publisher part to this builder, allowing for further header customization with the returned MultipartBodyBuilder.PartBuilder.
MultiValueMap<java.lang.String,HttpEntity<?>>	build() Builds the multipart body.
MultipartBodyBuilder.PartBuilder	part(java.lang.String name, java.lang.Object part) Adds a part to this builder, allowing for further header customization with the returned MultipartBodyBuilder.PartBuilder.
MultipartBodyBuilder.PartBuilder	part(java.lang.String name, java.lang.Object part, MediaType contentType) Adds a part to this builder, allowing for further header customization with the returned MultipartBodyBuilder.PartBuilder.

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

build

public MultiValueMap<java.lang.String,HttpEntity<?>> build()

Builds the multipart body.

Returns:

the built body

part

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

Adds a part to this builder, allowing for further header customization with the returned MultipartBodyBuilder.PartBuilder.

Parameters:

name - the name of the part to add (may not be empty)

part - the part to add

Returns:

a builder that allows for further header customization

part

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

Adds a part to this builder, allowing for further header customization with the returned MultipartBodyBuilder.PartBuilder.

Parameters:

name - the name of the part to add (may not be empty)

part - the part to add

contentType - the Content-Type header for the part (may be null)

Returns:

a builder that allows for further header customization

asyncPart

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

Adds a Publisher part to this builder, allowing for further header customization with the returned MultipartBodyBuilder.PartBuilder.

Parameters:

name - the name of the part to add (may not be empty)

publisher - the contents of the part to add

elementClass - the class of elements contained in the publisher

Returns:

a builder that allows for further header customization

asyncPart

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

Adds a Publisher part to this builder, allowing for further header customization with the returned MultipartBodyBuilder.PartBuilder.

Parameters:

name - the name of the part to add (may not be empty)

publisher - the contents of the part to add

typeReference - the type of elements contained in the publisher

Returns:

a builder that allows for further header customization