Apache Struts API Documentation: Class MultipartIterator

org.apache.struts.upload Class MultipartIterator

java.lang.Object
  |
  +--org.apache.struts.upload.MultipartIterator

public class MultipartIterator

extends java.lang.Object

The MultipartIterator class is responsible for reading the input data of a multipart request and splitting it up into input elements, wrapped inside of a MultipartElement for easy definition. To use this class, create a new instance of MultipartIterator passing it a HttpServletRequest in the constructor. Then use the getNextElement method until it returns null, then you're finished. Example:

      MultipartIterator iterator = new MultipartIterator(request);
      MultipartElement element;

      while ((element = iterator.getNextElement()) != null) {
           //do something with element
      }
 

See Also:

MultipartElement

DEFAULT_ENCODING

private static final java.lang.String DEFAULT_ENCODING

Deprecated. 

The default encoding of a text element if none is specified.

TEXT_BUFFER_SIZE

private static final int TEXT_BUFFER_SIZE

Deprecated. 

The size in bytes to copy of text data at a time.

HEADER_CONTENT_TYPE

public static java.lang.String HEADER_CONTENT_TYPE

Deprecated. 

The name of the Content-Type header.

HEADER_CONTENT_DISPOSITION

public static final java.lang.String HEADER_CONTENT_DISPOSITION

Deprecated. 

The name of the Content-Disposition header.

MESSAGE_CANNOT_RETRIEVE_BOUNDARY

public static final java.lang.String MESSAGE_CANNOT_RETRIEVE_BOUNDARY

Deprecated. 

The exception message for when the boundary of a multipart request can't be determined.

PARAMETER_BOUNDARY

private static final java.lang.String PARAMETER_BOUNDARY

Deprecated. 

FILE_PREFIX

private static final java.lang.String FILE_PREFIX

Deprecated. 

request

protected javax.servlet.http.HttpServletRequest request

Deprecated. 

The request instance for this class

inputStream

protected MultipartBoundaryInputStream inputStream

Deprecated. 

The InputStream to use to read the multipart data.

boundary

protected java.lang.String boundary

Deprecated. 

The boundary for this multipart request

maxSize

protected long maxSize

Deprecated. 

The maximum file size in bytes allowed. Ignored if -1

contentLength

protected int contentLength

Deprecated. 

The content length of this request

diskBufferSize

protected int diskBufferSize

Deprecated. 

The size in bytes written to the filesystem at a time [20K]

bufferSize

protected int bufferSize

Deprecated. 

The amount of data read from a request at a time. This also represents the maximum size in bytes of a line read from the request [4KB]

tempDir

protected java.lang.String tempDir

Deprecated. 

The temporary directory to store files

contentType

protected java.lang.String contentType

Deprecated. 

The content-type.

maxLengthExceeded

protected boolean maxLengthExceeded

Deprecated. 

Whether the maximum length has been exceeded.

MultipartIterator

public MultipartIterator(javax.servlet.http.HttpServletRequest request)
                  throws java.io.IOException

Deprecated. 

Constructs a MultipartIterator with a default buffer size and no file size limit

Parameters:

request - The multipart request to iterate

MultipartIterator

public MultipartIterator(javax.servlet.http.HttpServletRequest request,
                         int bufferSize)
                  throws java.io.IOException

Deprecated. 

Constructs a MultipartIterator with the specified buffer size and no file size limit

Parameters:

request - The multipart request to iterate

bufferSize - The size in bytes that should be read from the input stream at a times

MultipartIterator

public MultipartIterator(javax.servlet.http.HttpServletRequest request,
                         int bufferSize,
                         long maxSize)
                  throws java.io.IOException

Deprecated. 

Constructs a MultipartIterator with the specified buffer size and the specified file size limit in bytes

Parameters:

request - The multipart request to iterate

bufferSize - The size in bytes that should be read from the input stream at a times

maxSize - The maximum size in bytes allowed for a multipart element's data

MultipartIterator

public MultipartIterator(javax.servlet.http.HttpServletRequest request,
                         int bufferSize,
                         long maxSize,
                         java.lang.String tempDir)
                  throws java.io.IOException

Deprecated. 

parseRequest

protected void parseRequest()
                     throws java.io.IOException

Deprecated. 

Handles retrieving the boundary and setting the input stream

getNextElement

public MultipartElement getNextElement()
                                throws java.io.IOException

Deprecated. 

Retrieves the next element in the iterator if one exists.

Returns:

a MultipartElement representing the next element in the request data

Throws:

java.io.IOException - if the post size exceeds the maximum file size passed in the 3 argument constructor or if the "ISO-8859-1" encoding isn't found

getElementEncoding

protected java.lang.String getElementEncoding()

Deprecated. 

Get the character encoding used for this current multipart element.

createTextMultipartElement

protected MultipartElement createTextMultipartElement(java.lang.String encoding)
                                               throws java.io.IOException

Deprecated. 

Create a text element from the data in the body of the element.

Parameters:

encoding - The character encoding of the string.

createFileMultipartElement

protected MultipartElement createFileMultipartElement()
                                               throws java.io.IOException

Deprecated. 

Create a multipart element instance representing the file in the stream.

setBufferSize

public void setBufferSize(int bufferSize)

Deprecated. 

Set the maximum amount of bytes read from a line at one time

See Also:

ServletInputStream.readLine(byte[], int, int)

getBufferSize

public int getBufferSize()

Deprecated. 

Get the maximum amount of bytes read from a line at one time

See Also:

ServletInputStream.readLine(byte[], int, int)

setMaxSize

public void setMaxSize(long maxSize)

Deprecated. 

Set the maximum post data size allowed for a multipart request

Parameters:

maxSize - The maximum post data size in bytes, set to -1 for no limit

getMaxSize

public long getMaxSize()

Deprecated. 

Get the maximum post data size allowed for a multipart request

Returns:

The maximum post data size in bytes

isMaxLengthExceeded

public boolean isMaxLengthExceeded()

Deprecated. 

Whether or not the maximum length has been exceeded by the client.

getBoundaryFromContentType

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

Deprecated. 

Parses a content-type String for the boundary.

getContentTypeOfRequest

private final void getContentTypeOfRequest()

Deprecated. 

Gets the value of the Content-Type header of the request.

createLocalFile

protected java.io.File createLocalFile()
                                throws java.io.IOException

Deprecated. 

Creates a file on disk from the current mulitpart element.