Package com.helger.web.fileupload

Interface IFileItemStream

All Superinterfaces:

IFileItemHeadersSupport

All Known Implementing Classes:

FileItemStream

public interface IFileItemStream
extends IFileItemHeadersSupport

This interface provides access to a file or form item that was received within a multipart/form-data POST request. The items contents are retrieved by calling openStream().

Instances of this class are created by accessing the iterator, returned by AbstractFileUploadBase.getItemIterator(IRequestContext) .

Note: There is an interaction between the iterator and its associated instances of IFileItemStream: By invoking Iterator.hasNext() on the iterator, you discard all data, which hasn't been read so far from the previous data.

Method Summary

Modifier and Type	Method	Description
String	getContentType()	Returns the content type passed by the browser or null if not defined.
String	getFieldName()	Returns the name of the field in the multipart form corresponding to this file item.
String	getName()	Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
String	getNameSecure()	Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
String	getNameUnchecked()	Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
boolean	isFormField()	Determines whether or not a FileItem instance represents a simple form field.
InputStream	openStream()	Creates an InputStream, which allows to read the items contents.

Methods inherited from interface com.helger.web.fileupload.IFileItemHeadersSupport

getHeaders, setHeaders

Method Detail

openStream

InputStream openStream()
                throws IOException

Creates an InputStream, which allows to read the items contents.

Returns:

The input stream, from which the items data may be read.

Throws:

IllegalStateException - The method was already invoked on this item. It is not possible to recreate the data stream.

IOException - An I/O error occurred.

getContentType

String getContentType()

Returns the content type passed by the browser or null if not defined.

Returns:

The content type passed by the browser or null if not defined.

getName

String getName()

Returns the original filename in the client's filesystem, as provided by the browser (or other client software). In most cases, this will be the base file name, without path information. However, some clients, such as the Opera browser, do include path information.

Returns:

The original filename in the client's filesystem.

Throws:

InvalidFileNameException - The file name contains a NUL character, which might be an indicator of a security attack. If you intend to use the file name anyways, catch the exception and use InvalidFileNameException#getName().

getNameSecure

String getNameSecure()

Returns the original filename in the client's filesystem, as provided by the browser (or other client software). In most cases, this will be the base file name, without path information. However, some clients, such as the Opera browser, do include path information. Compared to getName() this method automatically removes everything and including a NUL byte and therefore does not throw an InvalidFileNameException.

Returns:

The original filename in the client's filesystem.

Since:

6.1.0

getNameUnchecked

@Nullable
String getNameUnchecked()

Returns the original filename in the client's filesystem, as provided by the browser (or other client software). In most cases, this will be the base file name, without path information. However, some clients, such as the Opera browser, do include path information.

Returns:

The original filename in the client's filesystem.

Since:

6.1.0

getFieldName

String getFieldName()

Returns the name of the field in the multipart form corresponding to this file item.

Returns:

The name of the form field.

isFormField

boolean isFormField()

Determines whether or not a FileItem instance represents a simple form field.

Returns:

true if the instance represents a simple form field; false if it represents an uploaded file.