Tomcat 10.1.19 · org.apache.tomcat.util.http.fileupload.FileItemIterator

Method Summary

Modifier and Type	Method and Description
public List<FileItem>	getFileItems()
public long	Returns: The maximum size of a single, uploaded file. The value -1 indicates "unlimited". getFileSizeMax() Returns the maximum size of a single file.
public long	Returns: The maximum size of the complete HTTP request. The value -1 indicates "unlimited". 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() Returns, whether another instance of `FileItemStream` is available.
public FileItemStream	Returns: FileItemStream instance, which provides access to the next file item. next() Returns the next available `FileItemStream`.
public void	setFileSizeMax(long The maximum size of a single, uploaded file. The value -1 indicates "unlimited". pFileSizeMax) Sets the maximum size of a single file.
public void	setSizeMax(long The maximum size of the complete HTTP request. The value -1 indicates "unlimited". pSizeMax) Returns the maximum size of the complete HTTP request.

Method Detail

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

getFileSizeMax back to summary

getFileSizeMax	back to summary
public long 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".

public long 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".

getSizeMax back to summary

getSizeMax	back to summary
public long 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".

public long 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".

hasNext back to summary

hasNext	back to summary
public boolean hasNext() throws FileUploadException, IOException Returns, whether another instance of `FileItemStream` is available. Returns:boolean True, if one or more additional file items are available, otherwise false. Exceptions FileUploadException: Parsing or processing the file item failed. IOException: Reading the file item failed.

public boolean hasNext() throws FileUploadException, IOException

Returns, whether another instance of FileItemStream is available.

Returns:boolean

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

Exceptions

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

next back to summary

next	back to summary
public FileItemStream next() throws FileUploadException, IOException Returns the next available `FileItemStream`. Returns:FileItemStream FileItemStream instance, which provides access to the next file item. 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

Returns the next available FileItemStream.

Returns:FileItemStream

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

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(long pFileSizeMax) 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 pFileSizeMax:long The maximum size of a single, uploaded file. The value -1 indicates "unlimited".

public void setFileSizeMax(long pFileSizeMax)

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

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

setSizeMax back to summary

setSizeMax	back to summary
public void setSizeMax(long pSizeMax) 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 pSizeMax:long The maximum size of the complete HTTP request. The value -1 indicates "unlimited".

public void setSizeMax(long pSizeMax)

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

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

public Interface FileItemIterator

Method Summary

Method Detail