net.freeutils.httpserver

Class HTTPServer.MultipartIterator

java.lang.Object

net.freeutils.httpserver.HTTPServer.MultipartIterator

All Implemented Interfaces:

Iterator<HTTPServer.MultipartIterator.Part>

Enclosing class:

HTTPServer

public static class HTTPServer.MultipartIterator
extends Object
implements Iterator<HTTPServer.MultipartIterator.Part>

The MultipartIterator iterates over the parts of a multipart/form-data request.

For example, to support file upload from a web browser:

1. Create an HTML form which includes an input field of type "file", attributes method="post" and enctype="multipart/form-data", and an action URL of your choice, for example action="/upload". This form can be served normally like any other resource, e.g. from an HTML file on disk.
2. Add a context handler for the action path ("/upload" in this example), using either the explicit HTTPServer.VirtualHost.addContext(java.lang.String, net.freeutils.httpserver.HTTPServer.ContextHandler, java.lang.String...) method or the HTTPServer.Context annotation.
3. In the context handler implementation, construct a MultipartIterator from the client Request.
4. Iterate over the form HTTPServer.MultipartIterator.Parts, processing each named field as appropriate - for the file input field, read the uploaded file using the body input stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPServer.MultipartIterator.Part The Part class encapsulates a single part of the multipart.

Field Summary

Fields

Modifier and Type	Field and Description
protected HTTPServer.MultipartInputStream	in
protected boolean	next

Constructor Summary

Constructors

Constructor and Description
MultipartIterator(HTTPServer.Request req) Creates a new MultipartIterator from the given request.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
HTTPServer.MultipartIterator.Part	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

in

protected final HTTPServer.MultipartInputStream in

next

protected boolean next

Constructor Detail

MultipartIterator

public MultipartIterator(HTTPServer.Request req)
                  throws IOException

Creates a new MultipartIterator from the given request.

Parameters:

req - the multipart/form-data request

Throws:

IOException - if an IO error occurs

IllegalArgumentException - if the given request's content type is not multipart/form-data, or is missing the boundary

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<HTTPServer.MultipartIterator.Part>

next

public HTTPServer.MultipartIterator.Part next()

Specified by:

next in interface Iterator<HTTPServer.MultipartIterator.Part>

remove

public void remove()

Specified by:

remove in interface Iterator<HTTPServer.MultipartIterator.Part>