Package com.blackrook.small.multipart

Class MultipartParser

java.lang.Object

com.blackrook.small.multipart.MultipartParser

All Implemented Interfaces:

Iterable<Part>

Direct Known Subclasses:

MultipartFormDataParser

public abstract class MultipartParser
extends Object
implements Iterable<Part>

Abstract Multipart parser.

Author:

Matthew Tropiano

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	HEADER_DISPOSITION	Content-Disposition.
protected static final String	HEADER_TYPE	Content-Disposition.
protected final String	NEWLINE	Newline.
protected final byte[]	NEWLINE_BYTES	Newline as bytes.
protected static final String	PIECE_BOUNDARY	Content type boundary piece.
protected static final String	PIECE_CHARSET	Content type charset piece.

Constructor Summary

Constructors

Constructor	Description
MultipartParser()	Creates a new multipart parser.

Method Summary

Modifier and Type	Method	Description
protected void	addPart(Part part)	Adds a part to the multipart parser.
protected File	generateTempFile(String filename, File outputDir)	Creates a temporary file for read part data.
List<Part>	getPartList()
static boolean	isMultipart(javax.servlet.http.HttpServletRequest request)	Checks if the request is a multipart form.
Iterator<Part>	iterator()
void	parse(javax.servlet.http.HttpServletRequest request, File outputDir)	Parses the request content.
protected void	parseContentType(String line, Part part)
protected abstract void	parseData(javax.servlet.ServletInputStream inStream, File outputDir, String startBoundary, String endBoundary, byte[] startBoundaryBytes)	Parses the servlet content and generates parts.
protected void	parseDisposition(String line, Part part)
protected int	scanDataUntilBoundary(InputStream in, OutputStream out, byte[] boundaryBytes)	Scans an input stream into an output stream until it hits a part boundary.
protected String	scanLine(InputStream in)	Scans and returns the next line.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

NEWLINE

protected final String NEWLINE

Newline.

See Also:

• Constant Field Values

NEWLINE_BYTES

protected final byte[] NEWLINE_BYTES

Newline as bytes.

PIECE_BOUNDARY

protected static final String PIECE_BOUNDARY

Content type boundary piece.

See Also:

• Constant Field Values

PIECE_CHARSET

protected static final String PIECE_CHARSET

Content type charset piece.

See Also:

• Constant Field Values

HEADER_DISPOSITION

protected static final String HEADER_DISPOSITION

Content-Disposition.

See Also:

• Constant Field Values

HEADER_TYPE

protected static final String HEADER_TYPE

Content-Disposition.

See Also:

• Constant Field Values

Constructor Details

MultipartParser

public MultipartParser()

Creates a new multipart parser.

Method Details

isMultipart

public static boolean isMultipart(javax.servlet.http.HttpServletRequest request)

Checks if the request is a multipart form.

Parameters:

request - the servlet request.

Returns:

true if a request is a multipart request, false otherwise.

parse

public void parse(javax.servlet.http.HttpServletRequest request,
 File outputDir)
           throws MultipartParserException,
IOException

Parses the request content.

Parameters:

request - the servlet request to parse.

outputDir - the temporary directory for read files.

Throws:

MultipartParserException - if a parsing error occurs in parsing the content.

IOException - if a read error occurs.

parseData

protected abstract void parseData(javax.servlet.ServletInputStream inStream,
 File outputDir,
 String startBoundary,
 String endBoundary,
 byte[] startBoundaryBytes)
                           throws MultipartParserException,
UnsupportedEncodingException,
IOException

Parses the servlet content and generates parts.

Parameters:

inStream - the input servlet stream.

outputDir - the output directory

startBoundary - the boundary string for each part.

endBoundary - the last boundary string.

startBoundaryBytes - the boundary string for each part as bytes in the correct encoding.

Throws:

MultipartParserException - if something is malformed in the request body.

UnsupportedEncodingException - if the part encoding is not supported.

IOException - if a read error occurs.

parseDisposition

protected void parseDisposition(String line,
 Part part)
                         throws MultipartParserException

Throws:

MultipartParserException

parseContentType

protected void parseContentType(String line,
 Part part)

scanLine

protected String scanLine(InputStream in)
                   throws IOException

Scans and returns the next line.

Parameters:

in - the servlet input stream (for request content).

Returns:

the read string.

Throws:

IOException - if the stream could not be read.

scanDataUntilBoundary

protected int scanDataUntilBoundary(InputStream in,
 OutputStream out,
 byte[] boundaryBytes)
                             throws IOException

Scans an input stream into an output stream until it hits a part boundary.

Parameters:

in - the input stream.

out - the output stream.

boundaryBytes - the boundary as bytes.

Returns:

the amount of bytes read.

Throws:

IOException - if the input stream could not be read or the output stream could not be written to.

generateTempFile

protected File generateTempFile(String filename,
 File outputDir)
                         throws IOException

Creates a temporary file for read part data.

Parameters:

filename - the Part's file name (extension is pulled from this).

outputDir - the temporary output directory.

Returns:

the file created.

Throws:

IOException - if the canonical path could not be read.

addPart

protected void addPart(Part part)

Adds a part to the multipart parser.

Parameters:

part - the part to add.

getPartList

public List<Part> getPartList()

Returns:

all of the parts parsed by this parser.

iterator

public Iterator<Part> iterator()

Specified by:

iterator in interface Iterable<Part>