Class FileItemStreamImpl
- java.lang.Object
- 
- org.apache.tomcat.util.http.fileupload.impl.FileItemStreamImpl
 
- 
- All Implemented Interfaces:
- FileItemHeadersSupport,- FileItemStream
 
 public class FileItemStreamImpl extends java.lang.Object implements FileItemStream Default implementation ofFileItemStream.
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from interface org.apache.tomcat.util.http.fileupload.FileItemStreamFileItemStream.ItemSkippedException
 
- 
 - 
Constructor SummaryConstructors Constructor Description FileItemStreamImpl(FileItemIteratorImpl pFileItemIterator, java.lang.String pName, java.lang.String pFieldName, java.lang.String pContentType, boolean pFormField, long pContentLength)Creates a new instance.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes the file item.java.lang.StringgetContentType()Returns the items content type, or null.java.lang.StringgetFieldName()Returns the items field name.FileItemHeadersgetHeaders()Returns the file item headers.java.lang.StringgetName()Returns the items file name.booleanisFormField()Returns, whether this is a form field.java.io.InputStreamopenStream()Returns an input stream, which may be used to read the items contents.voidsetHeaders(FileItemHeaders pHeaders)Sets the file item headers.
 
- 
- 
- 
Constructor Detail- 
FileItemStreamImplpublic FileItemStreamImpl(FileItemIteratorImpl pFileItemIterator, java.lang.String pName, java.lang.String pFieldName, java.lang.String pContentType, boolean pFormField, long pContentLength) throws FileUploadException, java.io.IOException Creates a new instance.- Parameters:
- pFileItemIterator- The- iterator, which returned this file item.
- pName- The items file name, or null.
- pFieldName- The items field name.
- pContentType- The items content type, or null.
- pFormField- Whether the item is a form field.
- pContentLength- The items content length, if known, or -1
- Throws:
- java.io.IOException- Creating the file item failed.
- FileUploadException- Parsing the incoming data stream failed.
 
 
- 
 - 
Method Detail- 
getContentTypepublic java.lang.String getContentType() Returns the items content type, or null.- Specified by:
- getContentTypein interface- FileItemStream
- Returns:
- Content type, if known, or null.
 
 - 
getFieldNamepublic java.lang.String getFieldName() Returns the items field name.- Specified by:
- getFieldNamein interface- FileItemStream
- Returns:
- Field name.
 
 - 
getNamepublic java.lang.String getName() Returns the items file name.- Specified by:
- getNamein interface- FileItemStream
- Returns:
- File name, if known, or null.
- 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().
 
 - 
isFormFieldpublic boolean isFormField() Returns, whether this is a form field.- Specified by:
- isFormFieldin interface- FileItemStream
- Returns:
- True, if the item is a form field, otherwise false.
 
 - 
openStreampublic java.io.InputStream openStream() throws java.io.IOExceptionReturns an input stream, which may be used to read the items contents.- Specified by:
- openStreamin interface- FileItemStream
- Returns:
- Opened input stream.
- Throws:
- java.io.IOException- An I/O error occurred.
- See Also:
- FileItemStream.ItemSkippedException
 
 - 
closepublic void close() throws java.io.IOExceptionCloses the file item.- Throws:
- java.io.IOException- An I/O error occurred.
 
 - 
getHeaderspublic FileItemHeaders getHeaders() Returns the file item headers.- Specified by:
- getHeadersin interface- FileItemHeadersSupport
- Returns:
- The items header object
 
 - 
setHeaderspublic void setHeaders(FileItemHeaders pHeaders) Sets the file item headers.- Specified by:
- setHeadersin interface- FileItemHeadersSupport
- Parameters:
- pHeaders- The items header object
 
 
- 
 
-