Class MultipartStream
- java.lang.Object
-
- org.apache.tomcat.util.http.fileupload.MultipartStream
-
public class MultipartStream extends java.lang.ObjectLow level API for processing file uploads.
This class can be used to process data streams conforming to MIME 'multipart' format as defined in RFC 1867. Arbitrarily large amounts of data in the stream can be processed under constant memory usage.
The format of the stream is defined in the following way:
multipart-body := preamble 1*encapsulation close-delimiter epilogue
encapsulation := delimiter body CRLF
delimiter := "--" boundary CRLF
close-delimiter := "--" boundary "--"
preamble := <ignore>
epilogue := <ignore>
body := header-part CRLF body-part
header-part := 1*header CRLF
header := header-name ":" header-value
header-name := <printable ascii characters except ":">
header-value := <any ascii characters except CR & LF>
body-data := <arbitrary data>
Note that body-data can contain another mulipart entity. There is limited support for single pass processing of such nested streams. The nested stream is required to have a boundary token of the same length as the parent stream (see
setBoundary(byte[])).Here is an example of usage of this class.
try { MultipartStream multipartStream = new MultipartStream(input, boundary); boolean nextPart = multipartStream.skipPreamble(); OutputStream output; while(nextPart) { String header = multipartStream.readHeaders(); // process headers // create some output stream multipartStream.readBodyData(output); nextPart = multipartStream.readBoundary(); } } catch(MultipartStream.MalformedStreamException e) { // the stream failed to follow required syntax } catch(IOException e) { // a read or write error occurred }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMultipartStream.IllegalBoundaryExceptionThrown upon attempt of setting an invalid boundary token.classMultipartStream.ItemInputStreamAnInputStreamfor reading an items contents.static classMultipartStream.MalformedStreamExceptionThrown to indicate that the input stream fails to follow the required syntax.static classMultipartStream.ProgressNotifierInternal class, which is used to invoke theProgressListener.
-
Field Summary
Fields Modifier and Type Field Description protected static byte[]BOUNDARY_PREFIXA byte sequence that precedes a boundary (CRLF--).static byteCRThe Carriage Return ASCII character value.static byteDASHThe dash (-) ASCII character value.protected static intDEFAULT_BUFSIZEThe default length of the buffer used for processing a request.protected static byte[]FIELD_SEPARATORA byte sequence that that follows a delimiter that will be followed by an encapsulation (CRLF).static intHEADER_PART_SIZE_MAXThe maximum length ofheader-partthat will be processed (10 kilobytes = 10240 bytes.).protected static byte[]HEADER_SEPARATORA byte sequence that marks the end ofheader-part(CRLFCRLF).static byteLFThe Line Feed ASCII character value.protected static byte[]STREAM_TERMINATORA byte sequence that that follows a delimiter of the last encapsulation in the stream (--).
-
Constructor Summary
Constructors Constructor Description MultipartStream(java.io.InputStream input, byte[] boundary, int bufSize, MultipartStream.ProgressNotifier pNotifier)Constructs aMultipartStreamwith a custom size buffer.MultipartStream(java.io.InputStream input, byte[] boundary, MultipartStream.ProgressNotifier pNotifier)Constructs aMultipartStreamwith a default size buffer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static booleanarrayequals(byte[] a, byte[] b, int count)Comparescountfirst bytes in the arraysaandb.intdiscardBodyData()Readsbody-datafrom the currentencapsulationand discards it.protected intfindByte(byte value, int pos)Searches for a byte of specified value in thebuffer, starting at the specifiedposition.protected intfindSeparator()Searches for theboundaryin thebufferregion delimited byheadandtail.java.lang.StringgetHeaderEncoding()Retrieves the character encoding used when reading the headers of an individual part.MultipartStream.ItemInputStreamnewInputStream()Creates a newMultipartStream.ItemInputStream.intreadBodyData(java.io.OutputStream output)Readsbody-datafrom the currentencapsulationand writes its contents into the outputStream.booleanreadBoundary()Skips aboundarytoken, and checks whether moreencapsulationsare contained in the stream.bytereadByte()Reads a byte from thebuffer, and refills it as necessary.java.lang.StringreadHeaders()Reads theheader-partof the currentencapsulation.voidsetBoundary(byte[] boundary)Changes the boundary token used for partitioning the stream.voidsetHeaderEncoding(java.lang.String encoding)Specifies the character encoding to be used when reading the headers of individual parts.booleanskipPreamble()Finds the beginning of the firstencapsulation.
-
-
-
Field Detail
-
CR
public static final byte CR
The Carriage Return ASCII character value.- See Also:
- Constant Field Values
-
LF
public static final byte LF
The Line Feed ASCII character value.- See Also:
- Constant Field Values
-
DASH
public static final byte DASH
The dash (-) ASCII character value.- See Also:
- Constant Field Values
-
HEADER_PART_SIZE_MAX
public static final int HEADER_PART_SIZE_MAX
The maximum length ofheader-partthat will be processed (10 kilobytes = 10240 bytes.).- See Also:
- Constant Field Values
-
DEFAULT_BUFSIZE
protected static final int DEFAULT_BUFSIZE
The default length of the buffer used for processing a request.- See Also:
- Constant Field Values
-
HEADER_SEPARATOR
protected static final byte[] HEADER_SEPARATOR
A byte sequence that marks the end ofheader-part(CRLFCRLF).
-
FIELD_SEPARATOR
protected static final byte[] FIELD_SEPARATOR
A byte sequence that that follows a delimiter that will be followed by an encapsulation (CRLF).
-
STREAM_TERMINATOR
protected static final byte[] STREAM_TERMINATOR
A byte sequence that that follows a delimiter of the last encapsulation in the stream (--).
-
BOUNDARY_PREFIX
protected static final byte[] BOUNDARY_PREFIX
A byte sequence that precedes a boundary (CRLF--).
-
-
Constructor Detail
-
MultipartStream
public MultipartStream(java.io.InputStream input, byte[] boundary, int bufSize, MultipartStream.ProgressNotifier pNotifier)Constructs a
MultipartStreamwith a custom size buffer.Note that the buffer must be at least big enough to contain the boundary string, plus 4 characters for CR/LF and double dash, plus at least one byte of data. Too small a buffer size setting will degrade performance.
- Parameters:
input- TheInputStreamto serve as a data source.boundary- The token used for dividing the stream intoencapsulations.bufSize- The size of the buffer to be used, in bytes.pNotifier- The notifier, which is used for calling the progress listener, if any.- Throws:
java.lang.IllegalArgumentException- If the buffer size is too small- Since:
- 1.3.1
-
MultipartStream
public MultipartStream(java.io.InputStream input, byte[] boundary, MultipartStream.ProgressNotifier pNotifier)Constructs a
MultipartStreamwith a default size buffer.- Parameters:
input- TheInputStreamto serve as a data source.boundary- The token used for dividing the stream intoencapsulations.pNotifier- An object for calling the progress listener, if any.- See Also:
MultipartStream(InputStream, byte[], int, ProgressNotifier)
-
-
Method Detail
-
getHeaderEncoding
public java.lang.String getHeaderEncoding()
Retrieves the character encoding used when reading the headers of an individual part. When not specified, ornull, the platform default encoding is used.- Returns:
- The encoding used to read part headers.
-
setHeaderEncoding
public void setHeaderEncoding(java.lang.String encoding)
Specifies the character encoding to be used when reading the headers of individual parts. When not specified, ornull, the platform default encoding is used.- Parameters:
encoding- The encoding used to read part headers.
-
readByte
public byte readByte() throws java.io.IOExceptionReads a byte from thebuffer, and refills it as necessary.- Returns:
- The next byte from the input stream.
- Throws:
java.io.IOException- if there is no more data available.
-
readBoundary
public boolean readBoundary() throws FileUploadIOException, MultipartStream.MalformedStreamExceptionSkips aboundarytoken, and checks whether moreencapsulationsare contained in the stream.- Returns:
trueif there are more encapsulations in this stream;falseotherwise.- Throws:
FileUploadIOException- if the bytes read from the stream exceeded the size limitsMultipartStream.MalformedStreamException- if the stream ends unexpectedly or fails to follow required syntax.
-
setBoundary
public void setBoundary(byte[] boundary) throws MultipartStream.IllegalBoundaryExceptionChanges the boundary token used for partitioning the stream.
This method allows single pass processing of nested multipart streams.
The boundary token of the nested stream is
requiredto be of the same length as the boundary token in parent stream.Restoring the parent stream boundary token after processing of a nested stream is left to the application.
- Parameters:
boundary- The boundary to be used for parsing of the nested stream.- Throws:
MultipartStream.IllegalBoundaryException- if theboundaryhas a different length than the one being currently parsed.
-
readHeaders
public java.lang.String readHeaders() throws FileUploadIOException, MultipartStream.MalformedStreamExceptionReads the
header-partof the currentencapsulation.Headers are returned verbatim to the input stream, including the trailing
CRLFmarker. Parsing is left to the application.TODO allow limiting maximum header size to protect against abuse.
- Returns:
- The
header-partof the current encapsulation. - Throws:
FileUploadIOException- if the bytes read from the stream exceeded the size limits.MultipartStream.MalformedStreamException- if the stream ends unexpectedly.
-
readBodyData
public int readBodyData(java.io.OutputStream output) throws MultipartStream.MalformedStreamException, java.io.IOExceptionReads
body-datafrom the currentencapsulationand writes its contents into the outputStream.Arbitrary large amounts of data can be processed by this method using a constant size buffer. (see
constructor).- Parameters:
output- TheStreamto write data into. May be null, in which case this method is equivalent todiscardBodyData().- Returns:
- the amount of data written.
- Throws:
MultipartStream.MalformedStreamException- if the stream ends unexpectedly.java.io.IOException- if an i/o error occurs.
-
newInputStream
public MultipartStream.ItemInputStream newInputStream()
Creates a newMultipartStream.ItemInputStream.- Returns:
- A new instance of
MultipartStream.ItemInputStream.
-
discardBodyData
public int discardBodyData() throws MultipartStream.MalformedStreamException, java.io.IOExceptionReads
body-datafrom the currentencapsulationand discards it.Use this method to skip encapsulations you don't need or don't understand.
- Returns:
- The amount of data discarded.
- Throws:
MultipartStream.MalformedStreamException- if the stream ends unexpectedly.java.io.IOException- if an i/o error occurs.
-
skipPreamble
public boolean skipPreamble() throws java.io.IOExceptionFinds the beginning of the firstencapsulation.- Returns:
trueif anencapsulationwas found in the stream.- Throws:
java.io.IOException- if an i/o error occurs.
-
arrayequals
public static boolean arrayequals(byte[] a, byte[] b, int count)Comparescountfirst bytes in the arraysaandb.- Parameters:
a- The first array to compare.b- The second array to compare.count- How many bytes should be compared.- Returns:
trueifcountfirst bytes in arraysaandbare equal.
-
findByte
protected int findByte(byte value, int pos)Searches for a byte of specified value in thebuffer, starting at the specifiedposition.- Parameters:
value- The value to find.pos- The starting position for searching.- Returns:
- The position of byte found, counting from beginning of the
buffer, or-1if not found.
-
findSeparator
protected int findSeparator()
Searches for theboundaryin thebufferregion delimited byheadandtail.- Returns:
- The position of the boundary found, counting from the
beginning of the
buffer, or-1if not found.
-
-