Module org.eclipse.jetty.http

Package org.eclipse.jetty.http

Class MultiPart.Part

java.lang.Object

org.eclipse.jetty.http.MultiPart.Part

All Implemented Interfaces:

Closeable, AutoCloseable, org.eclipse.jetty.io.Content.Source.Factory

Direct Known Subclasses:

MultiPart.ByteBufferPart, MultiPart.ChunksPart, MultiPart.ContentSourcePart, MultiPart.PathPart, MultiPartByteRanges.Part

Enclosing class:

MultiPart

public abstract static class MultiPart.Part
extends Object
implements org.eclipse.jetty.io.Content.Source.Factory, Closeable

A single part of a multipart content.

A part has an optional name, an optional fileName, optional headers and an optional content.

Constructor Summary

Constructors

Constructor	Description
Part(String name, String fileName, HttpFields fields)	Deprecated, for removal: This API element is subject to removal in a future version. use Part(ByteBufferPool.Sized, String, String, HttpFields) instead.
Part(org.eclipse.jetty.io.ByteBufferPool.Sized bufferPool, long first, long length, String name, String fileName, HttpFields fields)
Part(org.eclipse.jetty.io.ByteBufferPool.Sized bufferPool, String name, String fileName, HttpFields fields)

Method Summary

Modifier and Type	Method	Description
void	close()
void	delete()
void	fail(Throwable t)
String	getContentAsString(Charset defaultCharset)	Returns the content of this part as a string.
org.eclipse.jetty.io.Content.Source	getContentSource()	Returns the content of this part as a Content.Source.
String	getFileName()	Returns the file name of this part, as specified by the HttpHeader.CONTENT_DISPOSITION's filename parameter.
HttpFields	getHeaders()
long	getLength()
String	getName()	Returns the name of this part, as specified by the HttpHeader.CONTENT_DISPOSITION's name parameter.
org.eclipse.jetty.io.Content.Source	newContentSource()	Deprecated, for removal: This API element is subject to removal in a future version. override newContentSource(ByteBufferPool.Sized, long, long) instead.
org.eclipse.jetty.io.Content.Source	newContentSource(org.eclipse.jetty.io.ByteBufferPool.Sized bufferPool, long first, long length)
void	writeTo(Path path)	Writes the content of this part to the given path.

Methods inherited from class java.lang.Object

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

Constructor Details

Part

@Deprecated(since="12.0.20",
            forRemoval=true)
public Part(String name,
 String fileName,
 HttpFields fields)

Deprecated, for removal: This API element is subject to removal in a future version.

use Part(ByteBufferPool.Sized, String, String, HttpFields) instead.

Part

public Part(org.eclipse.jetty.io.ByteBufferPool.Sized bufferPool,
 String name,
 String fileName,
 HttpFields fields)

Part

public Part(org.eclipse.jetty.io.ByteBufferPool.Sized bufferPool,
 long first,
 long length,
 String name,
 String fileName,
 HttpFields fields)

Method Details

getName

public String getName()

Returns the name of this part, as specified by the HttpHeader.CONTENT_DISPOSITION's name parameter.

While the name parameter is mandatory per RFC 7578, older HTTP clients may not send it.

Returns:

the name of this part, or null if there is no name

getFileName

public String getFileName()

Returns the file name of this part, as specified by the HttpHeader.CONTENT_DISPOSITION's filename parameter.

While the filename parameter is mandatory per RFC 7578 when uploading files, older HTTP clients may not send it.

The file name may be absent if the part is not a file upload.

Returns:

the file name of this part, or null if there is no file name

getContentSource

public org.eclipse.jetty.io.Content.Source getContentSource()

Returns the content of this part as a Content.Source.

Calling this method multiple times will return the same instance, which can only be consumed once.

The content type and content encoding are specified in this part's headers.

The content encoding may be specified by the part named _charset_, as specified in RFC 7578, section 4.6.

Returns:

the content of this part

See Also:

• newContentSource()

newContentSource

@Deprecated(since="12.0.20",
            forRemoval=true)
public org.eclipse.jetty.io.Content.Source newContentSource()

Deprecated, for removal: This API element is subject to removal in a future version.

override newContentSource(ByteBufferPool.Sized, long, long) instead.

Returns the content of this part as a new Content.Source

If the content is reproducible, invoking this method multiple times will return a different independent instance for every invocation.

If the content is not reproducible, subsequent calls to this method will return null.

The content type and content encoding are specified in this part's headers.

The content encoding may be specified by the part named _charset_, as specified in RFC 7578, section 4.6.

Returns:

the content of this part as a new Content.Source or null if the content cannot be consumed multiple times.

See Also:

• getContentSource()

newContentSource

public org.eclipse.jetty.io.Content.Source newContentSource(org.eclipse.jetty.io.ByteBufferPool.Sized bufferPool,
 long first,
 long length)

Returns the content of this part as a new Content.Source

If the content is reproducible, invoking this method multiple times will return a different independent instance for every invocation.

If the content is not reproducible, subsequent calls to this method will return null.

The content type and content encoding are specified in this part's headers.

The content encoding may be specified by the part named _charset_, as specified in RFC 7578, section 4.6.

Specified by:

newContentSource in interface org.eclipse.jetty.io.Content.Source.Factory

See Also:

• getContentSource()

getLength

public long getLength()

getContentAsString

public String getContentAsString(Charset defaultCharset)

Returns the content of this part as a string.

The charset used to decode the bytes is:

• the charset parameter of the HttpHeader.CONTENT_TYPE header, if non-null;
• otherwise, the given defaultCharset parameter, if non-null;
• otherwise, UTF-8.

Parameters:

defaultCharset - the charset to use to decode the bytes, if the charset parameter of the Content-Type header is missing

Returns:

the content of this part as a string

getHeaders

public HttpFields getHeaders()

Returns:

the headers associated with this part

writeTo

public void writeTo(Path path)
             throws IOException

Writes the content of this part to the given path.

Parameters:

path - the Path to write this part's content to

Throws:

IOException - if the write fails

delete

public void delete()
            throws IOException

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

fail

public void fail(Throwable t)