public class IMMultipartStream extends Object
修飾子とタイプ | クラスと説明 |
---|---|
static class |
IMMultipartStream.IllegalBoundaryException
Thrown upon attempt of setting an invalid boundary token.
|
class |
IMMultipartStream.ItemInputStream
An
InputStream for reading an items contents. |
static class |
IMMultipartStream.MalformedStreamException
Thrown to indicate that the input stream fails to follow the required syntax.
|
修飾子とタイプ | フィールドと説明 |
---|---|
protected static byte[] |
BOUNDARY_PREFIX
A byte sequence that precedes a boundary (
CRLF-- ). |
static byte |
CR
The Carriage Return ASCII character value.
|
static byte |
DASH
The dash (-) ASCII character value.
|
protected static int |
DEFAULT_BUFSIZE
The default length of the buffer used for processing a request.
|
protected static byte[] |
FIELD_SEPARATOR
A byte sequence that that follows a delimiter that will be followed by an encapsulation (
CRLF ). |
static int |
HEADER_PART_SIZE_MAX
The maximum length of
header-part that will be processed (10 kilobytes = 10240 bytes.). |
protected static byte[] |
HEADER_SEPARATOR
A byte sequence that marks the end of
header-part (CRLFCRLF ). |
static byte |
LF
The Line Feed ASCII character value.
|
protected static byte[] |
STREAM_TERMINATOR
A byte sequence that that follows a delimiter of the last encapsulation in the stream (
-- ). |
コンストラクタと説明 |
---|
IMMultipartStream()
非推奨です。
Use
#MultipartStream(InputStream, byte[], org.apache.commons.fileupload.MultipartStream.ProgressNotifier)
, or
#MultipartStream(InputStream, byte[], int, org.apache.commons.fileupload.MultipartStream.ProgressNotifier) |
IMMultipartStream(InputStream input,
byte[] boundary)
非推奨です。
Use
#MultipartStream(InputStream, byte[], ProgressNotifier) . |
IMMultipartStream(InputStream input,
byte[] boundary,
int bufSize)
非推奨です。
Use
#MultipartStream(InputStream, byte[], int, org.apache.commons.fileupload.MultipartStream.ProgressNotifier)
. |
修飾子とタイプ | メソッドと説明 |
---|---|
static boolean |
arrayequals(byte[] a,
byte[] b,
int count)
Compares
count first bytes in the arrays a and b . |
void |
close() |
int |
discardBodyData()
Reads
body-data from the current encapsulation and discards it. |
protected int |
findByte(byte value,
int pos)
Searches for a byte of specified value in the
buffer , starting at the specified position . |
protected int |
findSeparator()
Searches for the
boundary in the buffer region delimited by head and
tail . |
String |
getHeaderEncoding()
Retrieves the character encoding used when reading the headers of an individual part.
|
int |
readBodyData(OutputStream output)
Reads
body-data from the current encapsulation and writes its contents into the output
Stream . |
boolean |
readBoundary()
Skips a
boundary token, and checks whether more encapsulations are contained in the stream. |
byte |
readByte()
Reads a byte from the
buffer , and refills it as necessary. |
String |
readHeaders()
Reads the
header-part of the current encapsulation . |
void |
setBoundary(byte[] boundary)
Changes the boundary token used for partitioning the stream.
|
void |
setHeaderEncoding(String encoding)
Specifies the character encoding to be used when reading the headers of individual parts.
|
boolean |
skipPreamble()
Finds the beginning of the first
encapsulation . |
public static final byte CR
public static final byte LF
public static final byte DASH
public static final int HEADER_PART_SIZE_MAX
header-part
that will be processed (10 kilobytes = 10240 bytes.).protected static final int DEFAULT_BUFSIZE
protected static final byte[] HEADER_SEPARATOR
header-part
(CRLFCRLF
).protected static final byte[] FIELD_SEPARATOR
CRLF
).protected static final byte[] STREAM_TERMINATOR
--
).protected static final byte[] BOUNDARY_PREFIX
CRLF--
).@Deprecated public IMMultipartStream()
#MultipartStream(InputStream, byte[], org.apache.commons.fileupload.MultipartStream.ProgressNotifier)
, or
#MultipartStream(InputStream, byte[], int, org.apache.commons.fileupload.MultipartStream.ProgressNotifier)
@Deprecated public IMMultipartStream(InputStream input, byte[] boundary, int bufSize)
#MultipartStream(InputStream, byte[], int, org.apache.commons.fileupload.MultipartStream.ProgressNotifier)
.
Constructs a MultipartStream
with a custom size buffer and no progress notifier.
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.
input
- The InputStream
to serve as a data source.boundary
- The token used for dividing the stream into encapsulations
.bufSize
- The size of the buffer to be used, in bytes.#MultipartStream(InputStream, byte[], ProgressNotifier)
@Deprecated public IMMultipartStream(InputStream input, byte[] boundary)
#MultipartStream(InputStream, byte[], ProgressNotifier)
.
Constructs a MultipartStream
with a default size buffer.
input
- The InputStream
to serve as a data source.boundary
- The token used for dividing the stream into encapsulations
.#MultipartStream(InputStream, byte[], int, ProgressNotifier)
public String getHeaderEncoding()
null
, the platform default encoding is used.public void setHeaderEncoding(String encoding)
null
, the platform default encoding is used.encoding
- The encoding used to read part headers.public byte readByte() throws IOException
buffer
, and refills it as necessary.IOException
- if there is no more data available.public boolean readBoundary() throws IMMultipartStream.MalformedStreamException
boundary
token, and checks whether more encapsulations
are contained in the stream.true
if there are more encapsulations in this stream; false
otherwise.IMMultipartStream.MalformedStreamException
- if the stream ends unexpecetedly or fails to follow required syntax.public void setBoundary(byte[] boundary) throws IMMultipartStream.IllegalBoundaryException
Changes 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 required
to 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.
boundary
- The boundary to be used for parsing of the nested stream.IMMultipartStream.IllegalBoundaryException
- if the boundary
has a different length than the one being currently parsed.public String readHeaders() throws IMMultipartStream.MalformedStreamException
Reads the header-part
of the current encapsulation
.
Headers are returned verbatim to the input stream, including the trailing CRLF
marker. Parsing is left to
the application.
TODO allow limiting maximum header size to protect against abuse.
header-part
of the current encapsulation.IMMultipartStream.MalformedStreamException
- if the stream ends unexpecetedly.public int readBodyData(OutputStream output) throws IMMultipartStream.MalformedStreamException, IOException
Reads body-data
from the current encapsulation
and writes its contents into the output
Stream
.
Arbitrary large amounts of data can be processed by this method using a constant size buffer. (see
constructor
).
output
- The Stream
to write data into. May be null, in which case this method is equivalent to
discardBodyData()
.IMMultipartStream.MalformedStreamException
- if the stream ends unexpectedly.IOException
- if an i/o error occurs.public int discardBodyData() throws IMMultipartStream.MalformedStreamException, IOException
Reads body-data
from the current encapsulation
and discards it.
Use this method to skip encapsulations you don't need or don't understand.
IMMultipartStream.MalformedStreamException
- if the stream ends unexpectedly.IOException
- if an i/o error occurs.public boolean skipPreamble() throws IOException
encapsulation
.true
if an encapsulation
was found in the stream.IOException
- if an i/o error occurs.public static boolean arrayequals(byte[] a, byte[] b, int count)
count
first bytes in the arrays a
and b
.a
- The first array to compare.b
- The second array to compare.count
- How many bytes should be compared.true
if count
first bytes in arrays a
and b
are equal.public void close() throws IOException
IOException
protected int findByte(byte value, int pos)
buffer
, starting at the specified position
.value
- The value to find.pos
- The starting position for searching.buffer
, or -1
if not found.protected int findSeparator()
boundary
in the buffer
region delimited by head
and
tail
.buffer
, or -1
if
not found.Copyright © 2012 NTT DATA INTRAMART CORPORATION