Class MultiPart

java.lang.Object

org.eclipse.jetty.http.MultiPart

public class MultiPart
extends Object

Namespace class for interrelated classes that provide support for parsing and generating multipart bytes.

Most applications should make use of MultiPartFormData or MultiPartByteRanges as they provide a simpler API.

Multipart parsing is provided by MultiPart.Parser.

Multipart generation is provided by MultiPart.AbstractContentSource and its subclasses.

A single part of a multipart content is represented by MultiPart.Part and its subclasses.

See Also:

• MultiPartFormData
• MultiPartByteRanges

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiPart.AbstractContentSource	An asynchronous Content.Source where MultiPart.Parts can be added to it to form a multipart content.
static class	MultiPart.AbstractPartsListener	A MultiPart.Parser.Listener that emits MultiPart.Part objects.
static class	MultiPart.ByteBufferPart	A MultiPart.Part that holds its content in memory, in one or more ByteBuffers.
static class	MultiPart.ChunksPart	A MultiPart.Part that holds its content in one or more Content.Chunks.
static class	MultiPart.ContentSourcePart	A MultiPart.Part whose content is a Content.Source.
static class	MultiPart.Parser	A multipart/form-data parser that follows RFC 7578.
static class	MultiPart.Part	A single part of a multipart content.
static class	MultiPart.PathPart	A MultiPart.Part whose content is in a file.

Method Summary

Modifier and Type	Method	Description
static String	encodeContentDispositionFileName(String fileName)	Encode a Content-Disposition file name according to RFC8187 using StandardCharsets.UTF_8
static String	extractBoundary(String contentType)	Extracts the value of the boundary parameter from the Content-Type header value, or returns null if the boundary parameter is missing.
static String	generateBoundary(String prefix, int randomLength)	Generates a multipart boundary, made of the given optional prefix string and the given number of random characters.

Methods inherited from class Object

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

Method Details

encodeContentDispositionFileName

public static String encodeContentDispositionFileName(String fileName)

Encode a Content-Disposition file name according to RFC8187 using StandardCharsets.UTF_8

Parameters:

fileName - The filename to encode

Returns:

The encoding of the filename suitable for a Content-Disposition header

extractBoundary

public static String extractBoundary(String contentType)

Extracts the value of the boundary parameter from the Content-Type header value, or returns null if the boundary parameter is missing.

Parameters:

contentType - the Content-Type header value

Returns:

the value of the boundary parameter, or null if the boundary parameter is missing

generateBoundary

public static String generateBoundary(String prefix,
 int randomLength)

Generates a multipart boundary, made of the given optional prefix string and the given number of random characters.

The total length of the boundary will be trimmed to at most 70 characters, as specified in RFC 2046.

Parameters:

prefix - a possibly null prefix

randomLength - a number of random characters to add after the prefix

Returns:

a boundary string