Tomcat 10.1.19 · org.apache.tomcat.util.http.fileupload.impl.FileItemIteratorImpl

Field Summary

Modifier and Type	Field and Description
private final RequestContext	ctx The request context.
private String	currentFieldName The current items field name.
private FileItemStreamImpl	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 FileUploadBase	fileUploadBase 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 MultipartStream	multiPartStream The multi part stream to process.
private MultipartStream.ProgressNotifier	progressNotifier The notifier, which used for triggering the `ProgressListener`.
private long	sizeMax The maximum allowed size of a complete request.
private boolean	skipPreamble Whether we are currently skipping the preamble.

Constructor Summary

Access	Constructor and Description
public	FileItemIteratorImpl(final FileUploadBase Main processor. fileUploadBase, final RequestContext The request context. requestContext) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
private boolean	Returns: True, if an next item was found, otherwise false. findNextItem() Called for finding the next item, if any.
private long	getContentLength(final FileItemHeaders pHeaders)
public List<FileItem>	getFileItems() Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.getFileItems.
public long	getFileSizeMax() Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.getFileSizeMax. Returns the maximum size of a single file.
public MultipartStream	getMultiPartStream()
public long	getSizeMax() Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.getSizeMax. Returns the maximum size of the complete HTTP request.
public boolean	Returns: True, if one or more additional file items are available, otherwise false. hasNext() Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.hasNext. Returns, whether another instance of `FileItemStream` is available.
protected void	init(final FileUploadBase fileUploadBase, final RequestContext pRequestContext)
public FileItemStream	Returns: FileItemStream instance, which provides access to the next file item. next() Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.next. Returns the next available `FileItemStream`.
public void	setFileSizeMax(final long The maximum size of a single, uploaded file. The value -1 indicates "unlimited". fileSizeMax) Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.setFileSizeMax. Sets the maximum size of a single file.
public void	setSizeMax(final long The maximum size of the complete HTTP request. The value -1 indicates "unlimited". sizeMax) Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.setSizeMax. Returns the maximum size of the complete HTTP request.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ctx back to summary

ctx	back to summary
private final RequestContext ctx The request context. See Also `RequestContext`

private final RequestContext ctx

The request context.

See Also: RequestContext

currentFieldName	back to summary
private String currentFieldName The current items field name.

currentItem	back to summary
private FileItemStreamImpl currentItem The item, which we currently process.

eof	back to summary
private boolean eof Whether we have seen the end of the file.

fileSizeMax	back to summary
private long fileSizeMax The maximum allowed size of a single uploaded file.

fileUploadBase back to summary

fileUploadBase	back to summary
private final FileUploadBase fileUploadBase The file uploads processing utility. See Also `FileUploadBase`

private final FileUploadBase fileUploadBase

The file uploads processing utility.

See Also: FileUploadBase

itemValid	back to summary
private boolean itemValid Whether the current item may still be read.

multiPartBoundary	back to summary
private byte[] multiPartBoundary The boundary, which separates the various parts.

multiPartStream	back to summary
private MultipartStream multiPartStream The multi part stream to process.

progressNotifier	back to summary
private MultipartStream.ProgressNotifier progressNotifier The notifier, which used for triggering the `ProgressListener`.

sizeMax	back to summary
private long sizeMax The maximum allowed size of a complete request.

skipPreamble	back to summary
private boolean skipPreamble Whether we are currently skipping the preamble.

Constructor Detail

FileItemIteratorImpl	back to summary
public FileItemIteratorImpl(final FileUploadBase fileUploadBase, final RequestContext requestContext) throws FileUploadException, IOException Creates a new instance. Parameters fileUploadBase:FileUploadBase Main processor. requestContext:RequestContext The request context. Exceptions FileUploadException: An error occurred while parsing the request. IOException: An I/O error occurred.

FileItemIteratorImpl

back to summary

public FileItemIteratorImpl(final FileUploadBase fileUploadBase, final RequestContext requestContext) throws FileUploadException, IOException

Creates a new instance.

Parameters

fileUploadBase:FileUploadBase: Main processor.
requestContext:RequestContext: The request context.

Exceptions

FileUploadException:: An error occurred while parsing the request.
IOException:: An I/O error occurred.

Method Detail

findNextItem	back to summary
private boolean findNextItem() throws FileUploadException, IOException Called for finding the next item, if any. Returns:boolean True, if an next item was found, otherwise false. Exceptions IOException: An I/O error occurred.

findNextItem

back to summary

private boolean findNextItem() throws FileUploadException, IOException

Called for finding the next item, if any.

Returns:boolean

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

Exceptions

IOException:: An I/O error occurred.

getContentLength	back to summary
private long getContentLength(final FileItemHeaders pHeaders)

getFileItems	back to summary
public List<FileItem> getFileItems() throws FileUploadException, IOException Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.getFileItems. Annotations @Override

getFileItems

back to summary

public List<FileItem> getFileItems() throws FileUploadException, IOException

Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.getFileItems.

Annotations

@Override

getFileSizeMax back to summary

getFileSizeMax	back to summary
public long getFileSizeMax() Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.getFileSizeMax. Doc from org.apache.tomcat.util.http.fileupload.FileItemIterator.getFileSizeMax. Returns the maximum size of a single file. An `FileSizeLimitExceededException` 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 `setFileSizeMax(long)` on this object. Returns:long The maximum size of a single, uploaded file. The value -1 indicates "unlimited". Annotations @Override

public long getFileSizeMax()

Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.getFileSizeMax.

Doc from org.apache.tomcat.util.http.fileupload.FileItemIterator.getFileSizeMax.

Returns the maximum size of a single file. An FileSizeLimitExceededException 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 setFileSizeMax(long) on this object.

Returns:long

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

Annotations

@Override

getMultiPartStream	back to summary
public MultipartStream getMultiPartStream() throws FileUploadException, IOException

getSizeMax back to summary

getSizeMax	back to summary
public long getSizeMax() Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.getSizeMax. Doc from org.apache.tomcat.util.http.fileupload.FileItemIterator.getSizeMax. Returns 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 `setSizeMax(long)` on this object. Returns:long The maximum size of the complete HTTP request. The value -1 indicates "unlimited". Annotations @Override

public long getSizeMax()

Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.getSizeMax.

Doc from org.apache.tomcat.util.http.fileupload.FileItemIterator.getSizeMax.

Returns 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 setSizeMax(long) on this object.

Returns:long

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

Annotations

@Override

hasNext back to summary

hasNext	back to summary
public boolean hasNext() throws FileUploadException, IOException Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.hasNext. Returns, whether another instance of `FileItemStream` is available. Returns:boolean True, if one or more additional file items are available, otherwise false. Annotations @Override Exceptions FileUploadException: Parsing or processing the file item failed. IOException: Reading the file item failed.

public boolean hasNext() throws FileUploadException, IOException

Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.hasNext.

Returns, whether another instance of FileItemStream is available.

Returns:boolean

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

Annotations

@Override

Exceptions

FileUploadException:: Parsing or processing the file item failed.
IOException:: Reading the file item failed.

init	back to summary
protected void init(final FileUploadBase fileUploadBase, final RequestContext pRequestContext) throws FileUploadException, IOException

next back to summary

next	back to summary
public FileItemStream next() throws FileUploadException, IOException Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.next. Returns the next available `FileItemStream`. Returns:FileItemStream FileItemStream instance, which provides access to the next file item. Annotations @Override Exceptions FileUploadException: Parsing or processing the file item failed. IOException: Reading the file item failed. NoSuchElementException: No more items are available. Use `hasNext()` to prevent this exception.

public FileItemStream next() throws FileUploadException, IOException

Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.next.

Returns the next available FileItemStream.

Returns:FileItemStream

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

Annotations

@Override

Exceptions

FileUploadException:: Parsing or processing the file item failed.
IOException:: Reading the file item failed.
NoSuchElementException:: No more items are available. Use hasNext() to prevent this exception.

setFileSizeMax back to summary

setFileSizeMax	back to summary
public void setFileSizeMax(final long fileSizeMax) Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.setFileSizeMax. Doc from org.apache.tomcat.util.http.fileupload.FileItemIterator.setFileSizeMax. Sets the maximum size of a single file. An `FileSizeLimitExceededException` 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 `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. Parameters fileSizeMax:long The maximum size of a single, uploaded file. The value -1 indicates "unlimited". Annotations @Override

public void setFileSizeMax(final long fileSizeMax)

Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.setFileSizeMax.

Doc from org.apache.tomcat.util.http.fileupload.FileItemIterator.setFileSizeMax.

Sets the maximum size of a single file. An FileSizeLimitExceededException 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 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.

Parameters

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

Annotations

@Override

setSizeMax back to summary

setSizeMax	back to summary
public void setSizeMax(final long sizeMax) Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.setSizeMax. Doc from org.apache.tomcat.util.http.fileupload.FileItemIterator.setSizeMax. Returns 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 `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 `hasNext()`, `next()` have not yet been invoked. Parameters sizeMax:long The maximum size of the complete HTTP request. The value -1 indicates "unlimited". Annotations @Override

public void setSizeMax(final long sizeMax)

Implements org.apache.tomcat.util.http.fileupload.FileItemIterator.setSizeMax.

Doc from org.apache.tomcat.util.http.fileupload.FileItemIterator.setSizeMax.

Note

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

Parameters

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

Annotations

@Override

public Class FileItemIteratorImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail