Package org.apache.commons.fileupload2.core

Class FileItemInputImpl

java.lang.Object

org.apache.commons.fileupload2.core.FileItemInputImpl

All Implemented Interfaces:

FileItemHeadersProvider<FileItemInput>, FileItemInput

class FileItemInputImpl
extends Object
implements FileItemInput

Default implementation of FileItemInput.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.commons.fileupload2.core.FileItemInput

FileItemInput.ItemSkippedException

Field Summary

Fields

Modifier and Type	Field	Description
private final String	contentType	The file items content type.
private final String	fieldName	The file items field name.
private final FileItemInputIteratorImpl	fileItemInputIteratorImpl	The File Item iterator implementation.
private final String	fileName	The file items file name.
private final boolean	formField	Whether the file item is a form field.
private FileItemHeaders	headers	The headers, if any.
private final InputStream	inputStream	The file items input stream.
private boolean	inputStreamClosed	The file items input stream closed flag.

Constructor Summary

Constructors

Constructor	Description
FileItemInputImpl(FileItemInputIteratorImpl fileItemIterator, String fileName, String fieldName, String contentType, boolean formField, long contentLength)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the file item.
String	getContentType()	Gets the content type, or null.
String	getFieldName()	Gets the items field name.
FileItemHeaders	getHeaders()	Gets the headers.
InputStream	getInputStream()	Gets the input stream, which may be used to read the items contents.
String	getName()	Gets the file name.
boolean	isFormField()	Tests whether this is a form field.
FileItemInputImpl	setHeaders(FileItemHeaders headers)	Sets the file item headers.

Methods inherited from class java.lang.Object

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

Field Details

fileItemInputIteratorImpl

private final FileItemInputIteratorImpl fileItemInputIteratorImpl

The File Item iterator implementation.

See Also:

• FileItemInputIteratorImpl

contentType

private final String contentType

The file items content type.

fieldName

private final String fieldName

The file items field name.

fileName

private final String fileName

The file items file name.

formField

private final boolean formField

Whether the file item is a form field.

inputStream

private final InputStream inputStream

The file items input stream.

inputStreamClosed

private boolean inputStreamClosed

The file items input stream closed flag.

headers

private FileItemHeaders headers

The headers, if any.

Constructor Details

FileItemInputImpl

FileItemInputImpl(FileItemInputIteratorImpl fileItemIterator,
 String fileName,
 String fieldName,
 String contentType,
 boolean formField,
 long contentLength)
           throws FileUploadException,
IOException

Creates a new instance.

Parameters:

fileItemIterator - The iterator, which returned this file item.

fileName - The items file name, or null.

fieldName - The items field name.

contentType - The items content type, or null.

formField - Whether the item is a form field.

contentLength - The items content length, if known, or -1

Throws:

IOException - Creating the file item failed.

FileUploadException - Parsing the incoming data stream failed.

Method Details

close

public void close()
           throws IOException

Closes the file item.

Throws:

IOException - An I/O error occurred.

getContentType

public String getContentType()

Gets the content type, or null.

Specified by:

getContentType in interface FileItemInput

Returns:

Content type, if known, or null.

getFieldName

public String getFieldName()

Gets the items field name.

Specified by:

getFieldName in interface FileItemInput

Returns:

Field name.

getHeaders

public FileItemHeaders getHeaders()

Gets the headers.

Specified by:

getHeaders in interface FileItemHeadersProvider<FileItemInput>

Returns:

The items header object

getInputStream

public InputStream getInputStream()
                           throws IOException

Gets the input stream, which may be used to read the items contents.

Specified by:

getInputStream in interface FileItemInput

Returns:

Opened input stream.

Throws:

IOException - An I/O error occurred.

See Also:

• FileItemInput.ItemSkippedException

getName

public String getName()

Gets the file name.

Specified by:

getName in interface FileItemInput

Returns:

File name, if known, or null.

Throws:

InvalidPathException - The file name is invalid, for example it 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 InvalidPathException#getInput().

isFormField

public boolean isFormField()

Tests whether this is a form field.

Specified by:

isFormField in interface FileItemInput

Returns:

True, if the item is a form field, otherwise false.

setHeaders

public FileItemInputImpl setHeaders(FileItemHeaders headers)

Sets the file item headers.

Specified by:

setHeaders in interface FileItemHeadersProvider<FileItemInput>

Parameters:

headers - The items header object

Returns:

this