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

Modifier and Type	Field and Description
private static final Logger	LOG

Access	Constructor and Description
private	MultiPartFormData()

Modifier and Type	Method and Description
public static CompletableFuture<MultiPartFormData.Parts>	from(Attributes attributes, String boundary, Function<MultiPartFormData.Parser, CompletableFuture<MultiPartFormData.Parts>> parse) Deprecated for removal since 12.0.6. use `from(Attributes, ComplianceViolation.Listener, String, Function)` instead.
public static CompletableFuture<MultiPartFormData.Parts>	from(Attributes attributes, ComplianceViolation.Listener listener, String boundary, Function<MultiPartFormData.Parser, CompletableFuture<MultiPartFormData.Parts>> parse)

LOG	back to summary
private static final Logger LOG

MultiPartFormData	back to summary
private MultiPartFormData()

from	back to summary
public static CompletableFuture<MultiPartFormData.Parts> from(Attributes attributes, String boundary, Function<MultiPartFormData.Parser, CompletableFuture<MultiPartFormData.Parts>> parse) Deprecated for removal since 12.0.6. use `from(Attributes, ComplianceViolation.Listener, String, Function)` instead. This method will be removed in Jetty 12.1.0 Annotations @Deprecated since:12.0.6 forRemoval:true

from	back to summary
public static CompletableFuture<MultiPartFormData.Parts> from(Attributes attributes, ComplianceViolation.Listener listener, String boundary, Function<MultiPartFormData.Parser, CompletableFuture<MultiPartFormData.Parts>> parse)

Access	Constructor and Description
public	ContentSource(String boundary)

Modifier and Type	Method and Description
protected HttpFields	customizePartHeaders(MultiPart.Part part) Overrides org.eclipse.jetty.http.MultiPart.AbstractContentSource.customizePartHeaders.

ContentSource	back to summary
public ContentSource(String boundary)

customizePartHeaders	back to summary
protected HttpFields customizePartHeaders(MultiPart.Part part) Overrides org.eclipse.jetty.http.MultiPart.AbstractContentSource.customizePartHeaders.

public Class MultiPartFormData.Parser

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.http.MultiPartFormData.Parser

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	MultiPartFormData.Parser.PartsListener

Field Summary

Modifier and Type	Field and Description
private ComplianceViolation.Listener	complianceViolationListener
private Path	filesDirectory
private long	length
private final MultiPartFormData.Parser.PartsListener	listener
private long	maxFileSize
private long	maxLength
private long	maxMemoryFileSize
private final MultiPart.Parser	parser
private MultiPartFormData.Parts	parts
private boolean	useFilesForPartsWithoutFileName

Constructor Summary

Access	Constructor and Description
public	Parser(String boundary)
public	Parser(String boundary, ComplianceViolation.Listener complianceViolationListener)

Method Summary

Modifier and Type	Method and Description
private Path	findFilesDirectory()
public String	Returns: the boundary string getBoundary()
public Charset	Returns: the default charset specified by the `_charset_` part, or null if that part is not present getDefaultCharset() Returns the default charset as specified by RFC 7578, section 4.6, that is the charset specified by the part named `_charset_`.
public Path	Returns: the directory where files are saved getFilesDirectory()
public long	Returns: the maximum file size in bytes, or -1 for unlimited file size getMaxFileSize()
public long	Returns: the maximum length in bytes of the whole multipart content, or -1 for unlimited length getMaxLength()
public long	Returns: the maximum memory file size in bytes, or -1 for unlimited memory file size getMaxMemoryFileSize()
public long	Returns: the maximum number of parts that can be parsed from the multipart content. getMaxParts()
public int	Returns: the max length of a `MultiPart.Part` headers, in bytes, or -1 for unlimited length getPartHeadersMaxLength()
pack-priv int	getPartsSize()
public boolean	Returns: whether parts without fileName may be stored as files isUseFilesForPartsWithoutFileName()
public CompletableFuture<MultiPartFormData.Parts>	parse(Content.Source content)
public void	setFilesDirectory(Path the directory where files are saved filesDirectory) Sets the directory where the files uploaded in the parts will be saved.
public void	setMaxFileSize(long the maximum file size in bytes, or -1 for unlimited file size maxFileSize)
public void	setMaxLength(long the maximum length in bytes of the whole multipart content, or -1 for unlimited length maxLength)
public void	setMaxMemoryFileSize(long the maximum memory file size in bytes, or -1 for unlimited memory file size maxMemoryFileSize) Sets the maximum memory file size in bytes, after which files will be saved in the directory specified by `setFilesDirectory(Path)`.
public void	setMaxParts(long the maximum number of parts that can be parsed from the multipart content. maxParts)
public void	setPartHeadersMaxLength(int the max length of a `MultiPart.Part` headers, in bytes, or -1 for unlimited length partHeadersMaxLength)
public void	setUseFilesForPartsWithoutFileName(boolean whether parts without fileName may be stored as files useFilesForPartsWithoutFileName)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

complianceViolationListener	back to summary
private ComplianceViolation.Listener complianceViolationListener

filesDirectory	back to summary
private Path filesDirectory

length	back to summary
private long length

listener	back to summary
private final MultiPartFormData.Parser.PartsListener listener

maxFileSize	back to summary
private long maxFileSize

maxLength	back to summary
private long maxLength

maxMemoryFileSize	back to summary
private long maxMemoryFileSize

parser	back to summary
private final MultiPart.Parser parser

parts	back to summary
private MultiPartFormData.Parts parts

useFilesForPartsWithoutFileName	back to summary
private boolean useFilesForPartsWithoutFileName

Constructor Detail

Parser	back to summary
public Parser(String boundary)

Parser	back to summary
public Parser(String boundary, ComplianceViolation.Listener complianceViolationListener)

Method Detail

findFilesDirectory	back to summary
private Path findFilesDirectory()

getBoundary	back to summary
public String getBoundary() Returns:String the boundary string

getDefaultCharset back to summary

getDefaultCharset	back to summary
public Charset getDefaultCharset() Returns the default charset as specified by RFC 7578, section 4.6, that is the charset specified by the part named `_charset_`. If that part is not present, returns `null`. Returns:Charset the default charset specified by the `_charset_` part, or null if that part is not present

public Charset getDefaultCharset()

Returns the default charset as specified by RFC 7578, section 4.6, that is the charset specified by the part named _charset_.

If that part is not present, returns null.

Returns:Charset: the default charset specified by the _charset_ part, or null if that part is not present

getFilesDirectory	back to summary
public Path getFilesDirectory() Returns:Path the directory where files are saved

getMaxFileSize	back to summary
public long getMaxFileSize() Returns:long the maximum file size in bytes, or -1 for unlimited file size

getMaxLength	back to summary
public long getMaxLength() Returns:long the maximum length in bytes of the whole multipart content, or -1 for unlimited length

getMaxMemoryFileSize	back to summary
public long getMaxMemoryFileSize() Returns:long the maximum memory file size in bytes, or -1 for unlimited memory file size

getMaxParts	back to summary
public long getMaxParts() Returns:long the maximum number of parts that can be parsed from the multipart content.

getPartHeadersMaxLength	back to summary
public int getPartHeadersMaxLength() Returns:int the max length of a `MultiPart.Part` headers, in bytes, or -1 for unlimited length

getPartsSize	back to summary
pack-priv int getPartsSize()

isUseFilesForPartsWithoutFileName	back to summary
public boolean isUseFilesForPartsWithoutFileName() Returns:boolean whether parts without fileName may be stored as files

parse	back to summary
public CompletableFuture<MultiPartFormData.Parts> parse(Content.Source content)

setFilesDirectory	back to summary
public void setFilesDirectory(Path filesDirectory) Sets the directory where the files uploaded in the parts will be saved. Parameters filesDirectory:Path the directory where files are saved

setFilesDirectory

back to summary

public void setFilesDirectory(Path filesDirectory)

Sets the directory where the files uploaded in the parts will be saved.

Parameters

filesDirectory:Path: the directory where files are saved

setMaxFileSize	back to summary
public void setMaxFileSize(long maxFileSize) Parameters maxFileSize:long the maximum file size in bytes, or -1 for unlimited file size

setMaxLength	back to summary
public void setMaxLength(long maxLength) Parameters maxLength:long the maximum length in bytes of the whole multipart content, or -1 for unlimited length

setMaxMemoryFileSize back to summary

setMaxMemoryFileSize	back to summary
public void setMaxMemoryFileSize(long maxMemoryFileSize) Sets the maximum memory file size in bytes, after which files will be saved in the directory specified by `setFilesDirectory(Path)`. Use value `0` to always save the files in the directory. Use value `-1` to never save the files in the directory. Parameters maxMemoryFileSize:long the maximum memory file size in bytes, or -1 for unlimited memory file size

public void setMaxMemoryFileSize(long maxMemoryFileSize)

Sets the maximum memory file size in bytes, after which files will be saved in the directory specified by setFilesDirectory(Path).

Use value 0 to always save the files in the directory.

Use value -1 to never save the files in the directory.

Parameters

maxMemoryFileSize:long: the maximum memory file size in bytes, or -1 for unlimited memory file size

setMaxParts	back to summary
public void setMaxParts(long maxParts) Parameters maxParts:long the maximum number of parts that can be parsed from the multipart content.

setPartHeadersMaxLength	back to summary
public void setPartHeadersMaxLength(int partHeadersMaxLength) Parameters partHeadersMaxLength:int the max length of a `MultiPart.Part` headers, in bytes, or -1 for unlimited length

setUseFilesForPartsWithoutFileName	back to summary
public void setUseFilesForPartsWithoutFileName(boolean useFilesForPartsWithoutFileName) Parameters useFilesForPartsWithoutFileName:boolean whether parts without fileName may be stored as files

org.eclipse.jetty.http back to summary

private Class MultiPartFormData.Parser.PartsListener

Class Inheritance

extends AbstractPartsListener

java.lang.Object
org.eclipse.jetty.http.MultiPart.AbstractPartsListener
org.eclipse.jetty.http.MultiPartFormData.Parser.PartsListener

Field Summary

Modifier and Type	Field and Description
private Throwable	failure
private SeekableByteChannel	fileChannel
private Path	filePath
private long	fileSize
private final AutoLock	lock
private long	memoryFileSize
private final List<Content.Chunk>	partChunks
private final List<MultiPart.Part>	parts

Constructor Summary

Access	Constructor and Description
private	PartsListener()

Method Summary

Modifier and Type	Method and Description
private void	close()
private void	createFileChannel()
private void	delete()
private boolean	ensureFileChannel()
private void	fail(Throwable cause)
private SeekableByteChannel	fileChannel()
pack-priv Charset	getDefaultCharset()
pack-priv int	getPartsSize()
private boolean	isFailed()
public void	onComplete() Overrides default org.eclipse.jetty.http.MultiPart.Parser.Listener.onComplete. Callback method invoked when the whole multipart content has been parsed.
public void	onFailure(Throwable the failure cause failure) Overrides default org.eclipse.jetty.http.MultiPart.Parser.Listener.onFailure. Callback method invoked when the parser cannot parse the multipart content.
public void	onPart(String the part name name, String the part fileName fileName, HttpFields the part headers headers) Implements abstract org.eclipse.jetty.http.MultiPart.AbstractPartsListener.onPart. Callback method invoked when a `Part` has been parsed.
public void	onPartContent(Content.Chunk the part content chunk chunk) Overrides default org.eclipse.jetty.http.MultiPart.Parser.Listener.onPartContent. Callback method invoked when a part content `Chunk` has been parsed.
private void	write(ByteBuffer buffer)

Inherited from org.eclipse.jetty.http.MultiPart.AbstractPartsListener:: getFileName getName onPartEnd onPartHeader

Field Detail

failure	back to summary
private Throwable failure

fileChannel	back to summary
private SeekableByteChannel fileChannel

filePath	back to summary
private Path filePath

fileSize	back to summary
private long fileSize

lock	back to summary
private final AutoLock lock

memoryFileSize	back to summary
private long memoryFileSize

partChunks	back to summary
private final List<Content.Chunk> partChunks

parts	back to summary
private final List<MultiPart.Part> parts

Constructor Detail

PartsListener	back to summary
private PartsListener()

Method Detail

close	back to summary
private void close()

createFileChannel	back to summary
private void createFileChannel()

delete	back to summary
private void delete()

ensureFileChannel	back to summary
private boolean ensureFileChannel()

fail	back to summary
private void fail(Throwable cause)

fileChannel	back to summary
private SeekableByteChannel fileChannel()

getDefaultCharset	back to summary
pack-priv Charset getDefaultCharset()

getPartsSize	back to summary
pack-priv int getPartsSize()

isFailed	back to summary
private boolean isFailed()

onComplete

back to summary

public void onComplete()

Overrides default org.eclipse.jetty.http.MultiPart.Parser.Listener.onComplete.

Doc from org.eclipse.jetty.http.MultiPart.Parser.Listener.onComplete.

Callback method invoked when the whole multipart content has been parsed.

Annotations

@Override

onFailure

back to summary

public void onFailure(Throwable failure)

Overrides default org.eclipse.jetty.http.MultiPart.Parser.Listener.onFailure.

Doc from org.eclipse.jetty.http.MultiPart.Parser.Listener.onFailure.

Callback method invoked when the parser cannot parse the multipart content.

Parameters

failure:Throwable: the failure cause

Annotations

@Override

onPart back to summary

public void onPart(String name, String fileName, HttpFields headers)

Implements abstract org.eclipse.jetty.http.MultiPart.AbstractPartsListener.onPart.

Doc from org.eclipse.jetty.http.MultiPart.AbstractPartsListener.onPart.

Callback method invoked when a Part has been parsed.

Parameters

name:String: the part name
fileName:String: the part fileName
headers:HttpFields: the part headers

Annotations

@Override

onPartContent back to summary

public void onPartContent(Content.Chunk chunk)

Overrides default org.eclipse.jetty.http.MultiPart.Parser.Listener.onPartContent.

Doc from org.eclipse.jetty.http.MultiPart.Parser.Listener.onPartContent.

Callback method invoked when a part content Chunk has been parsed.

The Chunk must be Content.Chunk#retain() retained} if it not consumed by this method (for example, stored away for later use).

Parameters

chunk:Content.Chunk: the part content chunk

Annotations

@Override

write	back to summary
private void write(ByteBuffer buffer) throws Exception

org.eclipse.jetty.http back to summary

public Class MultiPartFormData.Parts

Class Inheritance

extends Object
implements Iterable<MultiPart.Part>, Closeable

java.lang.Object
org.eclipse.jetty.http.MultiPartFormData.Parts

All Implemented Interfaces

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable

An ordered list of MultiPart.Parts that can be accessed by index or by name, or iterated over.

Field Summary

Modifier and Type	Field and Description
private final List<MultiPart.Part>	parts

Constructor Summary

Access	Constructor and Description
private	Parts(List<MultiPart.Part> parts)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public MultiPart.Part	Returns: the `MultiPart.Part` at the given index get(int the index of the `MultiPart.Part` to return index) Returns the `MultiPart.Part` at the given index, a number between `0` included and the value returned by `size()` excluded.
public List<MultiPart.Part>	Returns: all the `MultiPart.Part`s with the given name getAll(String the `MultiPart.Part`s name name) Returns all the `MultiPart.Part`s with the given name.
public MultiPart.Part	Returns: the first `MultiPart.Part` with the given name, or `null` getFirst(String the `MultiPart.Part` name name) Returns the first `MultiPart.Part` with the given name, or `null` if no `MultiPart.Part` with that name exists.
public Iterator<MultiPart.Part>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public int	Returns: the number of parts size()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

parts	back to summary
private final List<MultiPart.Part> parts

Constructor Detail

Parts	back to summary
private Parts(List<MultiPart.Part> parts)

Method Detail

close back to summary

public void close()

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

get back to summary

public MultiPart.Part get(int index)

Returns the MultiPart.Part at the given index, a number between 0 included and the value returned by size() excluded.

Parameters

index:int: the index of the MultiPart.Part to return

Returns:MultiPart.Part

the MultiPart.Part at the given index

getAll back to summary

public List<MultiPart.Part> getAll(String name)

Returns all the MultiPart.Parts with the given name.

Parameters

name:String: the MultiPart.Parts name

Returns:List<MultiPart.Part>

all the MultiPart.Parts with the given name

getFirst back to summary

public MultiPart.Part getFirst(String name)

Returns the first MultiPart.Part with the given name, or null if no MultiPart.Part with that name exists.

Parameters

name:String: the MultiPart.Part name

Returns:MultiPart.Part

the first MultiPart.Part with the given name, or null

iterator back to summary

public Iterator<MultiPart.Part> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<MultiPart.Part>

an Iterator.

Annotations

@Override

size	back to summary
public int size() Returns:int the number of parts See Also `get(int)`

public Class MultiPartFormData

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class MultiPartFormData.ContentSource

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class MultiPartFormData.Parser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MultiPartFormData.Parser.PartsListener

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class MultiPartFormData.Parts

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail