Module org.eclipse.jetty.http

Package org.eclipse.jetty.http

Class MultiPartFormData

java.lang.Object

org.eclipse.jetty.http.MultiPartFormData

public class MultiPartFormData
extends Object

A CompletableFuture that is completed when a multipart/form-data content has been parsed asynchronously from a Content.Source.

Once the parsing of the multipart/form-data content completes successfully, objects of this class are completed with a MultiPartFormData.Parts object.

Objects of this class may be configured to save multipart files in a configurable directory, and configure the max size of such files, etc.

Typical usage:

 // Some headers that include Content-Type.
 HttpFields headers = ...;
 String boundary = MultiPart.extractBoundary(headers.get(HttpHeader.CONTENT_TYPE));

 // Some multipart/form-data content.
 Content.Source content = ...;

 // Create and configure MultiPartFormData.
 MultiPartFormData.Parser formData = new MultiPartFormData.Parser(boundary);
 // Where to store the files.
 formData.setFilesDirectory(Path.of("/tmp"));
 // Max 1 MiB files.
 formData.setMaxFileSize(1024 * 1024);

 // Parse the content.
 formData.parse(content)
     // When complete, use the parts.
     .thenAccept(parts -> ...);
 

See Also:

• MultiPartFormData.Parts

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiPartFormData.ContentSource	The multipart/form-data specific content source.
static class	MultiPartFormData.Parser
static class	MultiPartFormData.Parts	An ordered list of MultiPart.Parts that can be accessed by index or by name, or iterated over.

Method Summary

Modifier and Type	Method	Description
static CompletableFuture<MultiPartFormData.Parts>	from(org.eclipse.jetty.io.Content.Source content, org.eclipse.jetty.util.Attributes attributes, String contentType, MultiPartConfig config)	Returns multipart/form-data parts using the given Content.Source and MultiPartConfig.
static CompletableFuture<MultiPartFormData.Parts>	from(org.eclipse.jetty.util.Attributes attributes, String boundary, Function<MultiPartFormData.Parser,CompletableFuture<MultiPartFormData.Parts>> parse)	Deprecated. use from(Content.Source, Attributes, String, MultiPartConfig).
static CompletableFuture<MultiPartFormData.Parts>	from(org.eclipse.jetty.util.Attributes attributes, MultiPartCompliance compliance, ComplianceViolation.Listener listener, String boundary, Function<MultiPartFormData.Parser,CompletableFuture<MultiPartFormData.Parts>> parse)	Deprecated. use from(Content.Source, Attributes, String, MultiPartConfig).
static CompletableFuture<MultiPartFormData.Parts>	get(org.eclipse.jetty.util.Attributes attributes)	Returns multipart/form-data parts if they have already been created.

Methods inherited from class java.lang.Object

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

Method Details

from

public static CompletableFuture<MultiPartFormData.Parts> from(org.eclipse.jetty.io.Content.Source content,
 org.eclipse.jetty.util.Attributes attributes,
 String contentType,
 MultiPartConfig config)

Returns multipart/form-data parts using the given Content.Source and MultiPartConfig.

Parameters:

content - the source of the multipart content.

attributes - the attributes where the futureParts are tracked.

contentType - the value of the HttpHeader.CONTENT_TYPE header.

config - the multipart configuration.

Returns:

the future parts

from

@Deprecated
public static CompletableFuture<MultiPartFormData.Parts> from(org.eclipse.jetty.util.Attributes attributes,
 String boundary,
 Function<MultiPartFormData.Parser,CompletableFuture<MultiPartFormData.Parts>> parse)

Deprecated.

use from(Content.Source, Attributes, String, MultiPartConfig).

Returns multipart/form-data parts using MultiPartCompliance.RFC7578.

from

@Deprecated
public static CompletableFuture<MultiPartFormData.Parts> from(org.eclipse.jetty.util.Attributes attributes,
 MultiPartCompliance compliance,
 ComplianceViolation.Listener listener,
 String boundary,
 Function<MultiPartFormData.Parser,CompletableFuture<MultiPartFormData.Parts>> parse)

Deprecated.

use from(Content.Source, Attributes, String, MultiPartConfig).

Returns multipart/form-data parts using the given MultiPartCompliance and listener.

Parameters:

attributes - the attributes where the futureParts are tracked

compliance - the compliance mode

listener - the compliance violation listener

boundary - the boundary for the multipart/form-data parts

parse - the parser completable future

Returns:

the future parts

get

public static CompletableFuture<MultiPartFormData.Parts> get(org.eclipse.jetty.util.Attributes attributes)

Returns multipart/form-data parts if they have already been created.

Parameters:

attributes - the attributes where the futureParts are tracked

Returns:

the future parts