Class MultiPartContentProvider

java.lang.Object

org.eclipse.jetty.client.util.AbstractTypedContentProvider

org.eclipse.jetty.client.util.MultiPartContentProvider

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ByteBuffer>, ContentProvider, ContentProvider.Typed, AsyncContentProvider

public class MultiPartContentProvider
extends AbstractTypedContentProvider
implements AsyncContentProvider, Closeable

A ContentProvider for form uploads with the "multipart/form-data" content type.

Example usage:

MultiPartContentProvider multiPart = new MultiPartContentProvider();
multiPart.addFieldPart("field", new StringContentProvider("foo"), null);
multiPart.addFilePart("icon", "img.png", new PathContentProvider(Paths.get("/tmp/img.png")), null);
multiPart.close();
ContentResponse response = client.newRequest("localhost", connector.getLocalPort())
        .method(HttpMethod.POST)
        .content(multiPart)
        .send();

The above example would be the equivalent of submitting this form:

<form method="POST" enctype="multipart/form-data"  accept-charset="UTF-8">
    <input type="text" name="field" value="foo" />
    <input type="file" name="icon" />
</form>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	MultiPartContentProvider.MultiPartIterator
private static class	MultiPartContentProvider.Part
private static enum	MultiPartContentProvider.State

Nested classes/interfaces inherited from interface AsyncContentProvider

AsyncContentProvider.Listener

Nested classes/interfaces inherited from interface ContentProvider

ContentProvider.Typed

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicBoolean	closed
private static final byte[]	COLON_SPACE_BYTES
private static final byte[]	CR_LF_BYTES
private final ByteBuffer	firstBoundary
private final ByteBuffer	lastBoundary
private long	length
private AsyncContentProvider.Listener	listener
private static final Logger	LOG
private final ByteBuffer	middleBoundary
private final ByteBuffer	onlyBoundary
private final List<MultiPartContentProvider.Part>	parts

Constructor Summary

Constructors

Constructor	Description
MultiPartContentProvider()
MultiPartContentProvider(String boundary)

Method Summary

Modifier and Type	Method	Description
void	addFieldPart(String name, ContentProvider content, HttpFields fields)	Adds a field part with the given name as field name, and the given content as part content.
void	addFilePart(String name, String fileName, ContentProvider content, HttpFields fields)	Adds a file part with the given name as field name, the given fileName as file name, and the given content as part content.
private void	addPart(MultiPartContentProvider.Part part)
private long	calculateLength()
void	close()
long	getLength()
Iterator<ByteBuffer>	iterator()
private static String	makeBoundary()
void	setListener(AsyncContentProvider.Listener listener)

Methods inherited from class AbstractTypedContentProvider

getContentType

Methods inherited from class Object

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

Methods inherited from interface ContentProvider

isReproducible

Methods inherited from interface Iterable

forEach, spliterator

Field Details

LOG

private static final Logger LOG

COLON_SPACE_BYTES

private static final byte[] COLON_SPACE_BYTES

CR_LF_BYTES

private static final byte[] CR_LF_BYTES

parts

private final List<MultiPartContentProvider.Part> parts

firstBoundary

private final ByteBuffer firstBoundary

middleBoundary

private final ByteBuffer middleBoundary

onlyBoundary

private final ByteBuffer onlyBoundary

lastBoundary

private final ByteBuffer lastBoundary

closed

private final AtomicBoolean closed

listener

private AsyncContentProvider.Listener listener

length

private long length

Constructor Details

MultiPartContentProvider

public MultiPartContentProvider()

MultiPartContentProvider

public MultiPartContentProvider(String boundary)

Method Details

makeBoundary

private static String makeBoundary()

addFieldPart

public void addFieldPart(String name,
 ContentProvider content,
 HttpFields fields)

Adds a field part with the given name as field name, and the given content as part content.

The Content-Type of this part will be obtained from:

• the Content-Type header in the fields parameter; otherwise
• the ContentProvider.Typed.getContentType() method if the content parameter implements ContentProvider.Typed; otherwise
• "text/plain"

Parameters:

name - the part name

content - the part content

fields - the headers associated with this part

addFilePart

public void addFilePart(String name,
 String fileName,
 ContentProvider content,
 HttpFields fields)

Adds a file part with the given name as field name, the given fileName as file name, and the given content as part content.

The Content-Type of this part will be obtained from:

• the Content-Type header in the fields parameter; otherwise
• the ContentProvider.Typed.getContentType() method if the content parameter implements ContentProvider.Typed; otherwise
• "application/octet-stream"

Parameters:

name - the part name

fileName - the file name associated to this part

content - the part content

fields - the headers associated with this part

addPart

private void addPart(MultiPartContentProvider.Part part)

setListener

public void setListener(AsyncContentProvider.Listener listener)

Specified by:

setListener in interface AsyncContentProvider

Parameters:

listener - the listener to be notified of content availability

calculateLength

private long calculateLength()

getLength

public long getLength()

Specified by:

getLength in interface ContentProvider

Returns:

the content length, if known, or -1 if the content length is unknown

iterator

public Iterator<ByteBuffer> iterator()

Specified by:

iterator in interface Iterable<ByteBuffer>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable