Package org.apache.commons.fileupload2.core

Class FileItemInputIteratorImpl

java.lang.Object

org.apache.commons.fileupload2.core.FileItemInputIteratorImpl

All Implemented Interfaces:

FileItemInputIterator, org.apache.commons.io.function.IOIterator<FileItemInput>

class FileItemInputIteratorImpl
extends Object
implements FileItemInputIterator

The iterator returned by AbstractFileUpload.getItemIterator(RequestContext).

Field Summary

Fields

Modifier and Type	Field	Description
private String	currentFieldName	The current items field name.
private FileItemInputImpl	currentItem	The item, which we currently process.
private boolean	eof	Whether we have seen the end of the file.
private long	fileSizeMax	The maximum allowed size of a single uploaded file.
private final AbstractFileUpload<?,?,?>	fileUpload	The file uploads processing utility.
private boolean	itemValid	Whether the current item may still be read.
private byte[]	multiPartBoundary	The boundary, which separates the various parts.
private MultipartInput	multiPartInput	The multi part stream to process.
private MultipartInput.ProgressNotifier	progressNotifier	The notifier, which used for triggering the ProgressListener.
private final RequestContext	requestContext	The request context.
private long	sizeMax	The maximum allowed size of a complete request.
private boolean	skipPreamble	Whether we are currently skipping the preamble.

Constructor Summary

Constructors

Constructor	Description
FileItemInputIteratorImpl(AbstractFileUpload<?,?,?> fileUploadBase, RequestContext requestContext)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
private boolean	findNextItem()	Finds the next item, if any.
private long	getContentLength(FileItemHeaders headers)
long	getFileSizeMax()	Gets the maximum size of a single file.
MultipartInput	getMultiPartInput()
long	getSizeMax()	Gets the maximum size of the complete HTTP request.
boolean	hasNext()	Tests whether another instance of FileItemInput is available.
protected void	init(AbstractFileUpload<?,?,?> fileUploadBase, RequestContext initContext)
FileItemInput	next()	Returns the next available FileItemInput.
void	setFileSizeMax(long fileSizeMax)	Sets the maximum size of a single file.
void	setSizeMax(long sizeMax)	Sets the maximum size of the complete HTTP request.
Iterator<FileItemInput>	unwrap()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.io.function.IOIterator

asIterator, forEachRemaining, remove

Field Details

fileUpload

private final AbstractFileUpload<?,?,?> fileUpload

The file uploads processing utility.

See Also:

• AbstractFileUpload

requestContext

private final RequestContext requestContext

The request context.

See Also:

• RequestContext

sizeMax

private long sizeMax

The maximum allowed size of a complete request.

fileSizeMax

private long fileSizeMax

The maximum allowed size of a single uploaded file.

multiPartInput

private MultipartInput multiPartInput

The multi part stream to process.

progressNotifier

private MultipartInput.ProgressNotifier progressNotifier

The notifier, which used for triggering the ProgressListener.

multiPartBoundary

private byte[] multiPartBoundary

The boundary, which separates the various parts.

currentItem

private FileItemInputImpl currentItem

The item, which we currently process.

currentFieldName

private String currentFieldName

The current items field name.

skipPreamble

private boolean skipPreamble

Whether we are currently skipping the preamble.

itemValid

private boolean itemValid

Whether the current item may still be read.

eof

private boolean eof

Whether we have seen the end of the file.

Constructor Details

FileItemInputIteratorImpl

FileItemInputIteratorImpl(AbstractFileUpload<?,?,?> fileUploadBase,
 RequestContext requestContext)
                   throws FileUploadException,
IOException

Constructs a new instance.

Parameters:

fileUploadBase - Main processor.

requestContext - The request context.

Throws:

FileUploadException - An error occurred while parsing the request.

IOException - An I/O error occurred.

Method Details

findNextItem

private boolean findNextItem()
                      throws FileUploadException,
IOException

Finds the next item, if any.

Returns:

True, if an next item was found, otherwise false.

Throws:

IOException - An I/O error occurred.

FileUploadException

getContentLength

private long getContentLength(FileItemHeaders headers)

getFileSizeMax

public long getFileSizeMax()

Description copied from interface: FileItemInputIterator

Gets the maximum size of a single file. An FileUploadByteCountLimitException will be thrown, if there is an uploaded file, which is exceeding this value. By default, this value will be copied from the FileUploadBase object, however, the user may replace the default value with a request specific value by invoking FileItemInputIterator.setFileSizeMax(long) on this object.

Specified by:

getFileSizeMax in interface FileItemInputIterator

Returns:

The maximum size of a single, uploaded file. The value -1 indicates "unlimited".

getMultiPartInput

public MultipartInput getMultiPartInput()
                                 throws FileUploadException,
IOException

Throws:

FileUploadException

IOException

getSizeMax

public long getSizeMax()

Description copied from interface: FileItemInputIterator

Gets the maximum size of the complete HTTP request. A SizeLimitExceededException will be thrown, if the HTTP request will exceed this value. By default, this value will be copied from the FileUploadBase object, however, the user may replace the default value with a request specific value by invoking FileItemInputIterator.setSizeMax(long) on this object.

Specified by:

getSizeMax in interface FileItemInputIterator

Returns:

The maximum size of the complete HTTP request. The value -1 indicates "unlimited".

hasNext

public boolean hasNext()
                throws IOException

Tests whether another instance of FileItemInput is available.

Specified by:

hasNext in interface FileItemInputIterator

Specified by:

hasNext in interface org.apache.commons.io.function.IOIterator<FileItemInput>

Returns:

True, if one or more additional file items are available, otherwise false.

Throws:

FileUploadException - Parsing or processing the file item failed.

IOException - Reading the file item failed.

init

protected void init(AbstractFileUpload<?,?,?> fileUploadBase,
 RequestContext initContext)
             throws FileUploadException,
IOException

Throws:

FileUploadException

IOException

next

public FileItemInput next()
                   throws IOException

Returns the next available FileItemInput.

Specified by:

next in interface FileItemInputIterator

Specified by:

next in interface org.apache.commons.io.function.IOIterator<FileItemInput>

Returns:

FileItemInput instance, which provides access to the next file item.

Throws:

NoSuchElementException - No more items are available. Use hasNext() to prevent this exception.

FileUploadException - Parsing or processing the file item failed.

IOException - Reading the file item failed.

setFileSizeMax

public void setFileSizeMax(long fileSizeMax)

Description copied from interface: FileItemInputIterator

Sets the maximum size of a single file. An FileUploadByteCountLimitException will be thrown, if there is an uploaded file, which is exceeding this value. By default, this value will be copied from the FileUploadBase object, however, the user may replace the default value with a request specific value by invoking FileItemInputIterator.setFileSizeMax(long) on this object, so there is no need to configure it here.

Note: Changing this value doesn't affect files, that have already been uploaded.

Specified by:

setFileSizeMax in interface FileItemInputIterator

Parameters:

fileSizeMax - The maximum size of a single, uploaded file. The value -1 indicates "unlimited".

setSizeMax

public void setSizeMax(long sizeMax)

Description copied from interface: FileItemInputIterator

Sets the maximum size of the complete HTTP request. A SizeLimitExceededException will be thrown, if the HTTP request will exceed this value. By default, this value will be copied from the FileUploadBase object, however, the user may replace the default value with a request specific value by invoking FileItemInputIterator.setSizeMax(long) on this object.

Note: Setting the maximum size on this object will work only, if the iterator is not yet initialized. In other words: If the methods FileItemInputIterator.hasNext(), FileItemInputIterator.next() have not yet been invoked.

Specified by:

setSizeMax in interface FileItemInputIterator

Parameters:

sizeMax - The maximum size of the complete HTTP request. The value -1 indicates "unlimited".

unwrap

public Iterator<FileItemInput> unwrap()

Specified by:

unwrap in interface org.apache.commons.io.function.IOIterator<FileItemInput>