Apache Struts API Documentation: Class MultipartBoundaryInputStream

org.apache.struts.upload Class MultipartBoundaryInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--org.apache.struts.upload.MultipartBoundaryInputStream

public class MultipartBoundaryInputStream

extends java.io.InputStream

This class encapsulates parsing functionality for RFC1867, multipart/form-data. See MultipartBoundaryInputStreamTest and MultipartIterator for usage examples.

NEWLINE_BYTE

private static final byte NEWLINE_BYTE

Deprecated. 

CARRIAGE_RETURN

private static final byte CARRIAGE_RETURN

Deprecated. 

CRLF

private static final byte[] CRLF

Deprecated. 

DOUBLE_DASH_STRING

private static final java.lang.String DOUBLE_DASH_STRING

Deprecated. 

DEFAULT_LINE_SIZE

private static final int DEFAULT_LINE_SIZE

Deprecated. 

TOKEN_EQUALS

private static final java.lang.String TOKEN_EQUALS

Deprecated. 

TOKEN_QUOTE

private static final char TOKEN_QUOTE

Deprecated. 

TOKEN_COLON

private static final char TOKEN_COLON

Deprecated. 

TOKEN_SEMI_COLON

private static final char TOKEN_SEMI_COLON

Deprecated. 

TOKEN_SPACE

private static final char TOKEN_SPACE

Deprecated. 

DEFAULT_CONTENT_DISPOSITION

private static final java.lang.String DEFAULT_CONTENT_DISPOSITION

Deprecated. 

PARAMETER_NAME

private static final java.lang.String PARAMETER_NAME

Deprecated. 

PARAMETER_FILENAME

private static final java.lang.String PARAMETER_FILENAME

Deprecated. 

PARAMETER_CHARSET

private static final java.lang.String PARAMETER_CHARSET

Deprecated. 

CONTENT_TYPE_TEXT_PLAIN

private static final java.lang.String CONTENT_TYPE_TEXT_PLAIN

Deprecated. 

CONTENT_TYPE_APPLICATION_OCTET_STREAM

private static final java.lang.String CONTENT_TYPE_APPLICATION_OCTET_STREAM

Deprecated. 

MESSAGE_INVALID_START

private static final java.lang.String MESSAGE_INVALID_START

Deprecated. 

inputStream

protected java.io.InputStream inputStream

Deprecated. 

The InputStream to read from.

boundary

protected java.lang.String boundary

Deprecated. 

The boundary.

boundaryEncountered

protected boolean boundaryEncountered

Deprecated. 

Whether or not the boundary has been encountered.

finalBoundaryEncountered

protected boolean finalBoundaryEncountered

Deprecated. 

Whether or not the final boundary has been encountered.

endOfStream

protected boolean endOfStream

Deprecated. 

Whether or not the end of the stream has been read.

elementContentDisposition

protected java.lang.String elementContentDisposition

Deprecated. 

The Content-Disposition for the current form element being read.

elementName

protected java.lang.String elementName

Deprecated. 

The name of the current form element being read.

elementContentType

protected java.lang.String elementContentType

Deprecated. 

The Content-Type of the current form element being read.

elementFileName

protected java.lang.String elementFileName

Deprecated. 

The filename of the current form element being read, null if the current form element is text data.

elementCharset

protected java.lang.String elementCharset

Deprecated. 

The character encoding of the element, specified in the element's Content-Type header.

maxLength

protected long maxLength

Deprecated. 

The maximum length in bytes to read from the stream at a time, or -1 for unlimited length.

maxLengthMet

protected boolean maxLengthMet

Deprecated. 

Whether or not the maximum length has been met.

bytesRead

protected long bytesRead

Deprecated. 

The total number of bytes read so far.

boundaryBytes

private byte[] boundaryBytes

Deprecated. 

finalBoundaryBytes

private byte[] finalBoundaryBytes

Deprecated. 

line

private byte[] line

Deprecated. 

lineSize

private int lineSize

Deprecated. 

lineLength

private int lineLength

Deprecated. 

lineHasNewline

private boolean lineHasNewline

Deprecated. 

lineHasCarriage

private boolean lineHasCarriage

Deprecated. 

lineIndex

private int lineIndex

Deprecated. 

MultipartBoundaryInputStream

public MultipartBoundaryInputStream()

Deprecated. 

setBoundary

public void setBoundary(java.lang.String boundary)

Deprecated. 

Sets the boundary that terminates the data for the stream, after adding the prefix "--"

resetForNextBoundary

public void resetForNextBoundary()
                          throws java.io.IOException

Deprecated. 

Resets this stream for use with the next element, to be used after a boundary is encountered.

setInputStream

public void setInputStream(java.io.InputStream stream)
                    throws java.io.IOException

Deprecated. 

Sets the input stream used to read multipart data. For efficiency purposes, make sure that the stream you set on this class is buffered. The way this class reads lines is that it continually calls the read() method until it reaches a newline character. That would be terrible if you were to set a socket's input stream here, but not as bad on a buffered stream.

read

public int read()
         throws java.io.IOException

Deprecated. 

Reads from the stream. Returns -1 if it's the end of the stream or if a boundary is encountered.

Overrides:

read in class java.io.InputStream

read

public int read(byte[] buffer)
         throws java.io.IOException

Deprecated. 

Overrides:

read in class java.io.InputStream

read

public int read(byte[] buffer,
                int offset,
                int length)
         throws java.io.IOException

Deprecated. 

Overrides:

read in class java.io.InputStream

mark

public void mark(int i)

Deprecated. 

Marks the underlying stream.

Overrides:

mark in class java.io.InputStream

reset

public void reset()
           throws java.io.IOException

Deprecated. 

Resets the underlying input stream.

Overrides:

reset in class java.io.InputStream

setMaxLength

public void setMaxLength(long maxLength)

Deprecated. 

Set the maximum length in bytes to read, or -1 for an unlimited length.

getMaxLength

public long getMaxLength()

Deprecated. 

isMaxLengthMet

public boolean isMaxLengthMet()

Deprecated. 

Whether or not the maximum length has been met.

getElementContentDisposition

public java.lang.String getElementContentDisposition()

Deprecated. 

Gets the value for the "Content-Dispositio" header for the current multipart element. Usually "form-data".

getElementName

public java.lang.String getElementName()

Deprecated. 

Gets the name of the current element. The name corresponds to the value of the "name" attribute of the form element.

getElementCharset

public java.lang.String getElementCharset()

Deprecated. 

Gets the character encoding of the current element. The character encoding would have been specified in the Content-Type header for this element, if it wasn't this is null.

getElementContentType

public java.lang.String getElementContentType()

Deprecated. 

Gets the "Content-Type" of the current element. If this is a text element, the content type will probably be "text/plain", otherwise it will be the content type of the file element.

getElementFileName

public java.lang.String getElementFileName()

Deprecated. 

Gets the filename of the current element, which will be null if the current element isn't a file.

isElementFile

public boolean isElementFile()

Deprecated. 

Gets whether or not the current form element being read is a file.

isBoundaryEncountered

public boolean isBoundaryEncountered()

Deprecated. 

Returns whether or not the boundary has been encountered while reading data.

isFinalBoundaryEncountered

public boolean isFinalBoundaryEncountered()

Deprecated. 

Returns whether or not the final boundary has been encountered.

isEndOfStream

public boolean isEndOfStream()

Deprecated. 

Whether or not an EOF has been read on the stream.

setLineSize

public void setLineSize(int size)

Deprecated. 

getBytesRead

public long getBytesRead()

Deprecated. 

readFirstElement

private final void readFirstElement()
                             throws java.io.IOException

Deprecated. 

readElementHeaders

private final void readElementHeaders()
                               throws java.io.IOException

Deprecated. 

readContentDisposition

private final void readContentDisposition()
                                   throws java.io.IOException

Deprecated. 

checkAndFixFilename

private final java.lang.String checkAndFixFilename(java.lang.String filename)

Deprecated. 

parseForParameter

private final java.lang.String parseForParameter(java.lang.String parameter,
                                                 java.lang.String parseString)

Deprecated. 

readContentType

private final boolean readContentType()
                               throws java.io.IOException

Deprecated. 

parseHeaderValue

private final java.lang.String parseHeaderValue(java.lang.String headerLine)

Deprecated. 

skipCurrentLineIfBlank

private final void skipCurrentLineIfBlank()
                                   throws java.io.IOException

Deprecated. 

resetCrlf

private final void resetCrlf()

Deprecated. 

resetStream

private final void resetStream()

Deprecated. 

readLine

private final java.lang.String readLine()
                                 throws java.io.IOException

Deprecated. 

readFromLine

private final int readFromLine()
                        throws java.io.IOException

Deprecated. 

availableInLine

private final int availableInLine()

Deprecated. 

fillLine

private final void fillLine()
                     throws java.io.IOException

Deprecated. 

resetLine

private final void resetLine()

Deprecated. 

fillLineBuffer

private final void fillLineBuffer()
                           throws java.io.IOException

Deprecated. 

byteRead

private final void byteRead()

Deprecated. 

checkForBoundary

private final void checkForBoundary()

Deprecated. 

equals

private final boolean equals(byte[] comp,
                             int offset,
                             int length,
                             byte[] source)

Deprecated. 

Checks bytes for equality. Two byte arrays are equal if each of their elements are the same. This method checks comp[offset] with source[0] to source[length-1] with comp[offset + length - 1]

Parameters:

comp - The byte to compare to source

offset - The offset to start at in comp

length - The length of comp to compare to

source - The reference byte array to test for equality